Description
API ReferenceAnnotations

Annotate

POST
/v1/annotate
/v1/annotate

The Authorization access token

Authorization

X-API-KEY<token>

In: header

Request Body

application/jsonRequired

annotation_criteria_id
Required
Annotation Criteria Id

Format: "uuid"

log_id
Required
Log Id

Format: "uuid"

value_passValue Pass

value_scoreValue Score

value_textValue Text

explanationExplanation

curl -X POST "https://api.patronus.ai/v1/annotate" \
  -H "X-API-KEY: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "annotation_criteria_id": "e5d4b10b-c239-4b00-9620-5b9e8428bf29",
    "log_id": "14b5977f-7a80-40ca-bb79-eca6c2abdb34",
    "value_pass": true,
    "value_score": 0,
    "value_text": "string",
    "explanation": "string"
  }'

Successful Response

{
  "evaluation": {
    "id": "string",
    "log_id": "14b5977f-7a80-40ca-bb79-eca6c2abdb34",
    "evaluator_family": "string",
    "evaluator_id": "string",
    "criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
    "criteria": "string",
    "criteria_config": {},
    "explain_strategy": "string",
    "pass": true,
    "score": 0,
    "text_output": "string",
    "metadata": {},
    "explanation": "string",
    "evaluation_duration": "string",
    "explanation_duration": "string",
    "evaluation_feedback": true,
    "usage": {},
    "metric_name": "string",
    "metric_description": "string",
    "annotation_criteria_id": "e5d4b10b-c239-4b00-9620-5b9e8428bf29",
    "evaluation_type": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

Previous

Delete Project

Next

Create Annotation Criteria