Skip to main content
POST
/
v0
/
definitions
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"
    }
  }
}

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 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
​
styleGuideId
string<uuid>

Response

Successfully created evaluation definition

Response containing an eval definition

​
data
object
required