Skip to main content
POST
/
v0
/
definitions
JavaScript
import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

const definition = await client.definitions.create({
  name: 'Naturalness Check',
  type: 'NATURALNESS',
  globalConfig: {},
});

console.log(definition.data);
{
  "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
Available options:
NATURALNESS,
STYLE,
RECALL,
CUSTOM,
FACT,
OUTPUT_MATCH
globalConfig
object
styleGuideId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Successfully created evaluation definition

Response containing an eval definition

data
object
required