Create an evaluation definition

curl --request POST \
  --url https://api.avidoai.com/v0/definitions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "name": "Naturalness Check",
  "type": "NATURALNESS",
  "applicationId": "123e4567-e89b-12d3-a456-426614174000",
  "globalConfig": {}
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "type": "NATURALNESS",
    "name": "<string>",
    "globalConfig": {
      "criterion": "<string>"
    },
    "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "application": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "title": "Customer Support Bot",
      "slug": "customer-support-bot",
      "description": "AI assistant for customer support inquiries",
      "context": "You are a helpful customer support assistant...",
      "language": "en",
      "type": "CHATBOT",
      "environment": "DEV",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z"
    }
  }
}

POST

definitions

curl --request POST \
  --url https://api.avidoai.com/v0/definitions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "name": "Naturalness Check",
  "type": "NATURALNESS",
  "applicationId": "123e4567-e89b-12d3-a456-426614174000",
  "globalConfig": {}
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "type": "NATURALNESS",
    "name": "<string>",
    "globalConfig": {
      "criterion": "<string>"
    },
    "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "application": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "title": "Customer Support Bot",
      "slug": "customer-support-bot",
      "description": "AI assistant for customer support inquiries",
      "context": "You are a helpful customer support assistant...",
      "language": "en",
      "type": "CHATBOT",
      "environment": "DEV",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z"
    }
  }
}

Authorizations

x-api-key

string

header

required

Your unique Avido API key

x-application-id

string

header

required

Your unique Avido Application ID

Body

application/json

name

string

required

Minimum string length: 1

type

enum<string>

required

The type of evaluation

Available options:

NATURALNESS,

STYLE,

RECALL,

CUSTOM,

FACT,

OUTPUT_MATCH

Example:

"NATURALNESS"

globalConfig

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

globalConfig.criterion

string

required

The criterion describes what our evaluation LLM must look for in the response. Remember that the answer to the criterion must be as a pass/fail.

Minimum string length: 1

styleGuideId

string<uuid>

Response

Successfully created evaluation definition

Response containing an eval definition

data

object

required

Show child attributes

data.id

string<uuid>

required

data.createdAt

string<date-time>

required

When the eval definition was created

Example:

"2024-01-05T12:34:56.789Z"

data.modifiedAt

string<date-time>

required

When the eval definition was last modified

Example:

"2024-01-05T12:34:56.789Z"

data.type

enum<string>

required

The type of evaluation

Available options:

NATURALNESS,

STYLE,

RECALL,

CUSTOM,

FACT,

OUTPUT_MATCH

Example:

"NATURALNESS"

data.name

string

required

data.globalConfig

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.globalConfig.criterion

string

required

The criterion describes what our evaluation LLM must look for in the response. Remember that the answer to the criterion must be as a pass/fail.

Minimum string length: 1

data.styleGuideId

string<uuid> | null

data.application

Application · object

Application configuration and metadata

Show child attributes

data.application.id

string<uuid>

required

Unique identifier of the application

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.application.orgId

string

required

Organization ID that owns this application

Example:

"org_123456"

data.application.title

string

required

Title of the application

Minimum string length: 1

Example:

"Customer Support Bot"

data.application.slug

string

required

URL-friendly slug for the application

Minimum string length: 1

Example:

"customer-support-bot"

data.application.description

string

required

Description of the application

Example:

"AI assistant for customer support inquiries"

data.application.context

string

required

Context/instructions for the application

Example:

"You are a helpful customer support assistant..."

data.application.language

string

required

Language of the application

Example:

"en"

data.application.type

enum<string>

required

Type of the application. Valid values are CHATBOT or AGENT.

Available options:

CHATBOT,

AGENT

Example:

"CHATBOT"

data.application.environment

enum<string>

default:DEV

required

Environment of the application. Defaults to DEV.

Available options:

DEV,

PROD

Example:

"DEV"

data.application.createdAt

string<date-time>

required

When the application was created

Example:

"2024-01-05T12:34:56.789Z"

data.application.modifiedAt

string<date-time>

required

When the application was last modified

Example:

"2024-01-05T12:34:56.789Z"

List evaluation definitions Update an evaluation definition

⌘I

Webhook

Applications

Threads

Ingestion

Tasks

Task Schedules

Eval Definitions

Experiments

Inference Steps

Evals

Tests

Topics

Annotations

Issues

Runs

Style Guides

Documents

Document Chunks

Document Versions

Tags

Document Tags

Task Tags

Scrape Jobs

Quickstarts

Create an evaluation definition

Authorizations

Body

Response