HydraCore
API by router

Evaluations

List Evaluations

GET
/v1/evaluations

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/evaluations" \  -H "X-Api-Key: string"
[
  {
    "config": {},
    "created_at": "2019-08-24T14:15:22Z",
    "description": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
    "name": "string",
    "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135",
    "results_summary": {},
    "status": "string",
    "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Evaluation

POST
/v1/evaluations

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Request Body

config?Config
Default{}

Empty Object

description?Description
instance_id?Instance Id
nameName
Lengthlength <= 200
recipe_id?Recipe Id

Response Body

curl -X POST "https://loading/v1/evaluations" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "config": {},
  "created_at": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
  "name": "string",
  "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135",
  "results_summary": {},
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Evaluation

GET
/v1/evaluations/{evaluation_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evaluation_idEvaluation Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
{
  "config": {},
  "created_at": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
  "name": "string",
  "recipe_id": "fa7d15d4-7670-4586-a94b-5079ed028135",
  "results_summary": {},
  "status": "string",
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Evaluation

DELETE
/v1/evaluations/{evaluation_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evaluation_idEvaluation Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X DELETE "https://loading/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Results

GET
/v1/evaluations/{evaluation_id}/results

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evaluation_idEvaluation Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/results" \  -H "X-Api-Key: string"
[
  {
    "agent_response": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "latency_ms": 0,
    "score": 0,
    "score_reason": "string",
    "status": "string",
    "test_case_id": "738e7d5d-48c4-4b50-859a-47ff022bef7f",
    "tokens_used": 0,
    "tool_calls_made": [
      {}
    ]
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Override Score

PATCH
/v1/evaluations/{evaluation_id}/results/{result_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evaluation_idEvaluation Id
Formatuuid
result_idResult Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

scoreScore
Range0 <= value <= 100
score_reason?Score Reason

Response Body

curl -X PATCH "https://loading/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/results/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "score": 100  }'
{
  "agent_response": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "latency_ms": 0,
  "score": 0,
  "score_reason": "string",
  "status": "string",
  "test_case_id": "738e7d5d-48c4-4b50-859a-47ff022bef7f",
  "tokens_used": 0,
  "tool_calls_made": [
    {}
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Run Evaluation

POST
/v1/evaluations/{evaluation_id}/run

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evaluation_idEvaluation Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X POST "https://loading/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/run" \  -H "X-Api-Key: string"
{
  "status": "string",
  "task_id": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Test Cases

GET
/v1/evaluations/{evaluation_id}/test-cases

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evaluation_idEvaluation Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/test-cases" \  -H "X-Api-Key: string"
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",
    "expected_behavior": "string",
    "expected_tool_calls": [
      {}
    ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "input_message": "string",
    "sort_order": 0,
    "tags": [
      null
    ]
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Add Test Case

POST
/v1/evaluations/{evaluation_id}/test-cases

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evaluation_idEvaluation Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

expected_behavior?Expected Behavior
expected_tool_calls?Expected Tool Calls
input_messageInput Message
sort_order?Sort Order
Default0
tags?Tags
Default[]

Response Body

curl -X POST "https://loading/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/test-cases" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "input_message": "string"  }'
{
  "created_at": "2019-08-24T14:15:22Z",
  "evaluation_id": "4108ec8e-6efd-4b9b-bace-0bb4c296c324",
  "expected_behavior": "string",
  "expected_tool_calls": [
    {}
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "input_message": "string",
  "sort_order": 0,
  "tags": [
    null
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Test Case

DELETE
/v1/evaluations/{evaluation_id}/test-cases/{case_id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

evaluation_idEvaluation Id
Formatuuid
case_idCase Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X DELETE "https://loading/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08/test-cases/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Entity store

Previous Page

Finance

Next Page