guardResults

Get detailed detection results

The results endpoint screens submitted content according to the policy assigned to the specified project. It then returns the confidence level results of the detectors. It doesn't make a flagging decision or create a request log in Guard. It can be used to analyze data and calibrate detector threshold levels for policies.

You can use the results endpoint to analyze historic LLM prompt and response data without worrying about triggering alerts or affecting monitoring, as they are not logged as screening requests by AI Guardrails.

If no project ID is passed in the request, then the default AI Guardrails policy is used, which runs all Guard defenses and detectors at the highest sensitivity level.

A request must contain messages, tools, or both.

<Warning>results requests are not logged as screening requests in AI Guardrails and do not appear in the platform or exported logs. It should not be used in runtime GenAI application security decisions as it removes the ability to control your defenses using policies.</Warning>

post/v2/guard/results

Request

  • Base URL: https://api.lakera.ai
  • URL: https://api.lakera.ai/v2/guard/results
  • Auth: HTTP bearer

Request body

project_idstring

ID of the relevant project. The request will be screened according to the policy assigned to the project. If no project ID is passed then the AI Guardrails Default Policy will be used for screening.

metadataobject

Metadata tags can be attached to screening requests as an object that can contain any arbitrary key-value pairs. Common use cases include specifying the user or session ID.

dev_infoboolean

When true the response will return an object with developer information about the build of AI Guardrails.

Response

Successful retrieval

Changes

No recorded changes to this operation across all 1 revision of this API.