Our docs got a refresh! Check out the new content and improved navigation. For detailed API reference see our Python SDK docs and TypeScript SDK.
Description
API referenceEvaluations

Batch Create Evaluations

Batch Create Evaluations endpoint allows to import client evaluation into Patronus AI Platform.

POST
/v1/evaluations/batch
/v1/evaluations/batch

The Authorization access token

Authorization

X-API-KEY<token>

In: header

Request Body

application/jsonRequired

evaluations
Required
Evaluations

curl -X POST "https://api.patronus.ai/v1/evaluations/batch" \
  -H "X-API-KEY: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "evaluations": [
      {
        "log_id": "14b5977f-7a80-40ca-bb79-eca6c2abdb34",
        "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
        "project_name": "string",
        "app": "string",
        "experiment_id": "string",
        "evaluator_id": "string",
        "criteria": "string",
        "pass": true,
        "score": 0,
        "text_output": "string",
        "metadata": {},
        "explanation": "string",
        "evaluation_duration": "string",
        "explanation_duration": "string",
        "metric_name": "string",
        "metric_description": "string",
        "dataset_id": "string",
        "dataset_sample_id": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "tags": {},
        "trace_id": "string",
        "span_id": "string"
      }
    ]
  }'

Successful Response

{
  "evaluations": [
    {
      "id": "string",
      "log_id": "14b5977f-7a80-40ca-bb79-eca6c2abdb34",
      "created_at": "2019-08-24T14:15:22Z",
      "trace_id": "string",
      "span_id": "string",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "app": "string",
      "experiment_id": 0,
      "evaluator_family": "string",
      "evaluator_id": "string",
      "criteria_id": "2139c95e-d32e-497b-94da-8263b88244e6",
      "criteria": "string",
      "criteria_revision": 0,
      "criteria_config": {},
      "explain_strategy": "string",
      "pass": true,
      "score": 0,
      "text_output": "string",
      "metadata": {},
      "explanation": "string",
      "evaluation_duration": "string",
      "explanation_duration": "string",
      "usage": {},
      "metric_name": "string",
      "metric_description": "string",
      "evaluation_type": "patronus_evaluation",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "dataset_id": "string",
      "dataset_sample_id": "string",
      "feedback": "positive"
    }
  ]
}