Skip to main content
Theme
Home

Create custom evaluation

POSThttps://api.coralogix.com/mgmt/openapi/5/ai/custom-evaluations/v3

Creates a new custom evaluation in the catalog.

Authorizations

Authorizationstringheaderrequired
API key authentication
The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request​

Body

application/json

Request to create a custom evaluation in the catalog.

    applicationIds#string[]

    IDs of AI applications to link this custom evaluation to.

    Possible values: <= 1024

    description#string

    Human-readable description.

    Possible values: <= 65536 characters, Value must match regular expression ^[\s\S]*$

    Example conversations and expected scores.

    Possible values: <= 100

    instructions#string

    Instructions sent to the LLM evaluator.

    Possible values: non-empty and <= 1048576 characters, Value must match regular expression ^[\s\S]+$

    name#string

    Display name of the custom evaluation.

    Possible values: non-empty and <= 256 characters, Value must match regular expression ^[\s\S]+$

    policyType#string

    Policy type identifier.

    Possible values: non-empty and <= 256 characters, Value must match regular expression ^[\s\S]+$

    safe#string

    Description of what counts as safe.

    Possible values: <= 65536 characters, Value must match regular expression ^[\s\S]*$

    shouldIncludeSystemPrompt#boolean

    Whether to include the system prompt in the LLM input.

    violates#string

    Description of what counts as violating the policy.

    Possible values: <= 65536 characters, Value must match regular expression ^[\s\S]*$

Response

application/json

Response returned after creating a custom evaluation.

    The newly created custom evaluation.