# Liveness ## livenessCheck > This method submits a biometric sample for liveness check. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness":{"post":{"description":"This method submits a biometric sample for liveness check.","tags":["liveness"],"operationId":"livenessCheck","summary":"livenessCheck","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessCheckRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessCheckResponse"}}}}},"parameters":[]}}},"components":{"schemas":{"LivenessCheckRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LivenessCheckBiometric"}}},"LivenessCheckBiometric":{"type":"object","properties":{"source":{"description":"How the biometric data was obtained. The value must be `ORIGINAL`.","type":"string","enum":["ORIGINAL"]},"type":{"description":"Type of the biometric data. The value must be `FACE`.","type":"string","enum":["FACE"]},"format":{"description":"Format of the biometric data. `REQUIRED`.","type":"string","enum":["JPEG","JPEG2000","PNG","TIFF","GIF","BMP"]},"content":{"description":"Base64 encoded biometric data. `REQUIRED`.","type":"string"}}},"LivenessCheckResponse":{"type":"object","properties":{"tguid":{"description":"Global unique ID of the transaction.","type":"string"},"bonafideScore":{"description":"Bonafide score of the liveness verification. Ranges from 0 to 100 (0=attack, 100=genuine).","type":"integer","format":"int32"}}}}}} ``` ## getLivenessResult > This method returns the liveness check result using the TGUID. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/{tguid}":{"get":{"description":"This method returns the liveness check result using the TGUID.","tags":["liveness"],"operationId":"getLivenessResult","summary":"getLivenessResult","parameters":[{"name":"tguid","required":true,"in":"path","description":"Global unique ID of the transaction.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLivenessResultResponse"}}}}}}}},"components":{"schemas":{"GetLivenessResultResponse":{"type":"object","properties":{"tguid":{"description":"Global unique ID of the transaction.","type":"string"},"biometric":{"description":"Biometric data used for the liveness verification.","$ref":"#/components/schemas/LivenessCheckBiometric"},"bonafideScore":{"description":"Bonafide score of the liveness verification. Ranges from 0 to 100 (0=attack, 100=genuine).","type":"integer","format":"int32"}}},"LivenessCheckBiometric":{"type":"object","properties":{"source":{"description":"How the biometric data was obtained. The value must be `ORIGINAL`.","type":"string","enum":["ORIGINAL"]},"type":{"description":"Type of the biometric data. The value must be `FACE`.","type":"string","enum":["FACE"]},"format":{"description":"Format of the biometric data. `REQUIRED`.","type":"string","enum":["JPEG","JPEG2000","PNG","TIFF","GIF","BMP"]},"content":{"description":"Base64 encoded biometric data. `REQUIRED`.","type":"string"}}}}}} ``` ## Get liveness configuration > Retrieves the heuristic liveness configuration, including score thresholds and other parameters used in fraud detection. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/settings":{"get":{"tags":["liveness"],"operationId":"getHeuridsticSettings","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessSettings"}}}}},"description":"Retrieves the heuristic liveness configuration, including score thresholds and other parameters used in fraud detection.","summary":"Get liveness configuration","parameters":[]}}},"components":{"schemas":{"LivenessSettings":{"type":"object","properties":{"settings":{"type":"object","additionalProperties":{"type":"string"}},"tings":{"$ref":"#/components/schemas/LivenessSettings"}}}}}} ``` ## Set liveness configuration > Fully updates the heuristic liveness settings, changing thresholds and parameters used in proof-of-life evaluation. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/settings":{"post":{"tags":["liveness"],"operationId":"setHeuristicSettings","summary":"Set liveness configuration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessSettings"}}}}},"description":"Fully updates the heuristic liveness settings, changing thresholds and parameters used in proof-of-life evaluation.","parameters":[]}}},"components":{"schemas":{"LivenessSettings":{"type":"object","properties":{"settings":{"type":"object","additionalProperties":{"type":"string"}},"tings":{"$ref":"#/components/schemas/LivenessSettings"}}}}}} ``` ## Get liveness transactions > Lists evaluated liveness transactions, allowing filtering by period, person, device, status and quality/score thresholds, returning paginated records. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/transaction":{"get":{"tags":["liveness"],"operationId":"listHeuristicTransactions","summary":"Get liveness transactions","parameters":[{"name":"start","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"personKey","in":"query","required":false,"schema":{"type":"string"}},{"name":"deviceId","in":"query","required":false,"schema":{"type":"string"}},{"name":"success","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"minScore","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"minImageQuality","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"minBonafideScore","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"minAdjustedBonafideScore","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageIndex","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LivenessHeuristicTransaction"}}}}}},"description":"Lists evaluated liveness transactions, allowing filtering by period, person, device, status and quality/score thresholds, returning paginated records."}}},"components":{"schemas":{"LivenessHeuristicTransaction":{"type":"object","properties":{"tguid":{"type":"string"},"personKey":{"type":"string"},"deviceId":{"type":"string"},"model":{"type":"string"},"soVersion":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"bccMobileVersion":{"type":"string"},"liveness":{"type":"boolean"},"ipAddress":{"type":"string"},"success":{"type":"boolean"},"description":{"type":"string"},"score":{"type":"integer","format":"int32"},"imageQuality":{"type":"integer","format":"int32"},"originalBonafideScore":{"type":"integer","format":"int32"},"adjustedBonafideScore":{"type":"integer","format":"int32"}}}}}} ``` ## Get specific liveness transaction > Retrieves the full record of a liveness transaction identified by TGUID, including scores and metadata. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/transaction/{tguid}":{"get":{"tags":["liveness"],"operationId":"getHeuristicTransaction","summary":"Get specific liveness transaction","parameters":[{"name":"tguid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessHeuristicTransaction"}}}}},"description":"Retrieves the full record of a liveness transaction identified by TGUID, including scores and metadata."}}},"components":{"schemas":{"LivenessHeuristicTransaction":{"type":"object","properties":{"tguid":{"type":"string"},"personKey":{"type":"string"},"deviceId":{"type":"string"},"model":{"type":"string"},"soVersion":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"bccMobileVersion":{"type":"string"},"liveness":{"type":"boolean"},"ipAddress":{"type":"string"},"success":{"type":"boolean"},"description":{"type":"string"},"score":{"type":"integer","format":"int32"},"imageQuality":{"type":"integer","format":"int32"},"originalBonafideScore":{"type":"integer","format":"int32"},"adjustedBonafideScore":{"type":"integer","format":"int32"}}}}}} ``` ## List PPE heuristics > Lists the PPE heuristic parameters/inputs (mask, glasses, etc.) used by the liveness check to consider or disregard facial coverings. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/ppe":{"get":{"tags":["liveness"],"operationId":"getHeuristicPPE","summary":"List PPE heuristics","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LivenessHeuristicPPE"}}}}}},"description":"Lists the PPE heuristic parameters/inputs (mask, glasses, etc.) used by the liveness check to consider or disregard facial coverings.","parameters":[]}}},"components":{"schemas":{"LivenessHeuristicPPE":{"type":"object","properties":{"personKey":{"type":"string"},"description":{"type":"string"}}}}}} ``` ## Register PPE information for an individual > Registers or updates the PPE information (mask, helmet, etc.) for an individual so that the liveness heuristic takes into account their permanent or temporary use. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/ppe":{"post":{"tags":["liveness"],"operationId":"putHeuristicPPE","summary":"Register PPE information for an individual","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessHeuristicPPE"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessHeuristicPPE"}}}}},"description":"Registers or updates the PPE information (mask, helmet, etc.) for an individual so that the liveness heuristic takes into account their permanent or temporary use.","parameters":[]}}},"components":{"schemas":{"LivenessHeuristicPPE":{"type":"object","properties":{"personKey":{"type":"string"},"description":{"type":"string"}}}}}} ``` ## Get PPE information of a person > Retrieves the PPE parameters configured for the identified person, indicating which protective equipment is expected or allowed during capture. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/ppe/{personKey}":{"get":{"tags":["liveness"],"operationId":"getHeuristicPPE_1","summary":"Get PPE information of a person","parameters":[{"name":"personKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessHeuristicPPE"}}}}},"description":"Retrieves the PPE parameters configured for the identified person, indicating which protective equipment is expected or allowed during capture."}}},"components":{"schemas":{"LivenessHeuristicPPE":{"type":"object","properties":{"personKey":{"type":"string"},"description":{"type":"string"}}}}}} ``` ## Delete PPE information of a person > Removes the PPE registration for the specified person, reverting to using general proof-of-life rules for that individual. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/ppe/{personKey}":{"delete":{"tags":["liveness"],"operationId":"deleteHeuristicPPE","summary":"Delete PPE information of a person","parameters":[{"name":"personKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}},"description":"Removes the PPE registration for the specified person, reverting to using general proof-of-life rules for that individual."}}}} ``` ## List people with liveness heuristic information > Lists people with liveness heuristic information, allowing filtering by PPE flag, presence in watchlist or block, and controlling pagination. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/person":{"get":{"tags":["liveness"],"operationId":"listHeuristicPerson","summary":"List people with liveness heuristic information","parameters":[{"name":"ppe","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"watchlist","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"blocked","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"pageIndex","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LivenessHeuristicPerson"}}}}}},"description":"Lists people with liveness heuristic information, allowing filtering by PPE flag, presence in watchlist or block, and controlling pagination."}}},"components":{"schemas":{"LivenessHeuristicPerson":{"type":"object","properties":{"personKey":{"type":"string"},"ppe":{"type":"boolean"},"watchlist":{"type":"boolean"},"timeout":{"type":"integer","format":"int64"},"tries":{"type":"integer","format":"int32"},"devices":{"type":"integer","format":"int32"},"success":{"type":"integer","format":"int32"},"matchFails":{"type":"integer","format":"int32"},"livenessFails":{"type":"integer","format":"int32"}}}}}} ``` ## Get liveness heuristic details of a person > Retrieves the liveness heuristic details of a specific person, including allowed PPE, watchlist status and block. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/person/{personKey}":{"get":{"tags":["liveness"],"operationId":"getHeuristicPerson","summary":"Get liveness heuristic details of a person","parameters":[{"name":"personKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessHeuristicPerson"}}}}},"description":"Retrieves the liveness heuristic details of a specific person, including allowed PPE, watchlist status and block."}}},"components":{"schemas":{"LivenessHeuristicPerson":{"type":"object","properties":{"personKey":{"type":"string"},"ppe":{"type":"boolean"},"watchlist":{"type":"boolean"},"timeout":{"type":"integer","format":"int64"},"tries":{"type":"integer","format":"int32"},"devices":{"type":"integer","format":"int32"},"success":{"type":"integer","format":"int32"},"matchFails":{"type":"integer","format":"int32"},"livenessFails":{"type":"integer","format":"int32"}}}}}} ``` ## Remove person from the watchlist > Removes the specified person from the watchlist and ends any associated timeout, restoring their regular evaluation. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/person/{personKey}/watchlist":{"delete":{"tags":["liveness"],"operationId":"removeHeuristicPersonWatchlistAndTimeout","summary":"Remove person from the watchlist","parameters":[{"name":"personKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}},"description":"Removes the specified person from the watchlist and ends any associated timeout, restoring their regular evaluation."}}}} ``` ## Get heuristic settings for person-device pair > Queries the heuristic settings for a person-device pair, indicating whether the device is approved or blocked for that person. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/person/{personKey}/device/{deviceId}":{"get":{"tags":["liveness"],"operationId":"getHeuridsticPersonDevice","summary":"Get heuristic settings for person-device pair","parameters":[{"name":"personKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessHeuristicPersonDevice"}}}}},"description":"Queries the heuristic settings for a person-device pair, indicating whether the device is approved or blocked for that person."}}},"components":{"schemas":{"LivenessHeuristicPersonDevice":{"type":"object","properties":{"personKey":{"type":"string"},"deviceId":{"type":"string"},"approved":{"type":"boolean"},"success":{"type":"integer","format":"int32"},"matchFails":{"type":"integer","format":"int32"},"livenessFails":{"type":"integer","format":"int32"}}}}}} ``` ## Set device status of a person > Updates the approval status of a device for a person, marking whether the device is authorized or restricted for liveness captures. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/person/{personKey}/device/{deviceId}/approval/{approval}":{"put":{"tags":["liveness"],"operationId":"setHeuridsticPersonDeviceApproval","summary":"Set device status of a person","parameters":[{"name":"personKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"approval","in":"path","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessHeuristicPersonDevice"}}}}},"description":"Updates the approval status of a device for a person, marking whether the device is authorized or restricted for liveness captures."}}},"components":{"schemas":{"LivenessHeuristicPersonDevice":{"type":"object","properties":{"personKey":{"type":"string"},"deviceId":{"type":"string"},"approved":{"type":"boolean"},"success":{"type":"integer","format":"int32"},"matchFails":{"type":"integer","format":"int32"},"livenessFails":{"type":"integer","format":"int32"}}}}}} ``` ## List relationships between people and devices > Lists the relationships between people and devices with their approval statuses, accepting filters by person key, device id and whether it is approved. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/person/device":{"get":{"tags":["liveness"],"operationId":"listHeuridsticPersonDevice","summary":"List relationships between people and devices","parameters":[{"name":"personKey","in":"query","required":false,"schema":{"type":"string"}},{"name":"deviceId","in":"query","required":false,"schema":{"type":"string"}},{"name":"approved","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"pageIndex","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LivenessHeuristicPersonDevice"}}}}}},"description":"Lists the relationships between people and devices with their approval statuses, accepting filters by person key, device id and whether it is approved."}}},"components":{"schemas":{"LivenessHeuristicPersonDevice":{"type":"object","properties":{"personKey":{"type":"string"},"deviceId":{"type":"string"},"approved":{"type":"boolean"},"success":{"type":"integer","format":"int32"},"matchFails":{"type":"integer","format":"int32"},"livenessFails":{"type":"integer","format":"int32"}}}}}} ``` ## List devices registered in liveness heuristic > Lists devices registered in the liveness heuristic, allowing filtering by being on watchlist or blocked, and controlling pagination. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/device":{"get":{"tags":["liveness"],"operationId":"listHeuristicDevice","summary":"List devices registered in liveness heuristic","parameters":[{"name":"watchlist","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"blocked","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"pageIndex","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LivenessHeuristicDevice"}}}}}},"description":"Lists devices registered in the liveness heuristic, allowing filtering by being on watchlist or blocked, and controlling pagination."}}},"components":{"schemas":{"LivenessHeuristicDevice":{"type":"object","properties":{"deviceId":{"type":"string"},"watchlist":{"type":"boolean"},"timeout":{"type":"integer","format":"int64"},"tries":{"type":"integer","format":"int32"},"personCount":{"type":"integer","format":"int32"},"success":{"type":"integer","format":"int32"},"matchFails":{"type":"integer","format":"int32"},"livenessFails":{"type":"integer","format":"int32"}}}}}} ``` ## Get device details > Retrieves the liveness heuristic details of a specific device, such as watchlist or block flags. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/device/{deviceId}":{"get":{"tags":["liveness"],"operationId":"getHeuristicDevice","summary":"Get device details","parameters":[{"name":"deviceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessHeuristicDevice"}}}}},"description":"Retrieves the liveness heuristic details of a specific device, such as watchlist or block flags."}}},"components":{"schemas":{"LivenessHeuristicDevice":{"type":"object","properties":{"deviceId":{"type":"string"},"watchlist":{"type":"boolean"},"timeout":{"type":"integer","format":"int64"},"tries":{"type":"integer","format":"int32"},"personCount":{"type":"integer","format":"int32"},"success":{"type":"integer","format":"int32"},"matchFails":{"type":"integer","format":"int32"},"livenessFails":{"type":"integer","format":"int32"}}}}}} ``` ## Remove device > Removes the device from the watchlist and clears related timeouts, restoring its normal use. ```json {"openapi":"3.0.1","info":{"title":"GBDS API","version":"5.1.16"},"servers":[{"url":"http://:8085/gbds/v2"}],"paths":{"/liveness/heuristic/device/{deviceId}/watchlist":{"delete":{"tags":["liveness"],"operationId":"removeHeuristicDeviceWatchlistAndTimeout","summary":"Remove device","parameters":[{"name":"deviceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}},"description":"Removes the device from the watchlist and clears related timeouts, restoring its normal use."}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.griaule.com/apis/gbds-5/liveness.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.