Reliability Guardrails API
Parameters
-
context: This is the context document for the judge. It contains the document which is used to evaluate whether the query is hallucinated or not.
-
conv_prefix: This is the conversation prefix in OpenAI format. It should be a list of dictionaries with keys
role
andcontent
. -
response: This is the response from the model. It should be in OpenAI format.
-
judge_id: The unique identifier for the judge. Learn more about obtaining a judge ID.
-
space_id: The unique identifier for your space. Learn more about obtaining a space ID.
Response
The response will be a JSON object with the following fields:
judgement : The reliability judgement of the model output. The possible values are
- 1: Which means the output is reliable
- 0: Which means the output is unreliable
extra: Contains the raw output from the judge for further inspection.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.