Skip to main content
Theme
Home

Update custom evaluation

PATCHhttps://api.coralogix.com/mgmt/openapi/5/ai/custom-evaluations/v3/{id}

Updates one or more fields of an existing custom evaluation.

Authorizations

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

Request​

Path Parameters

    id# stringrequired

    Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    Unique identifier of the custom evaluation to update.

Body

application/json

Request to update a custom evaluation in the catalog.

    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.

    updateMask#string

    Comma-separated list of field paths to update. When provided, only the listed fields are touched; a listed field that is absent from the request body is cleared. When omitted, only fields present in the body are updated.

    Possible values: non-empty and <= 1024 characters, Value must match regular expression ^[a-zA-Z_][a-zA-Z0-9_]*(,[a-zA-Z_][a-zA-Z0-9_]*)*$

    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 updating a custom evaluation.

    The updated custom evaluation.