Update AI evaluation

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

Updates one or more fields of an existing AI 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 AI evaluation to update.

Body

application/json

Request to update an existing AI evaluation.

application#string

Name of the AI application this evaluation belongs to.

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

config# object
Type-specific configuration (oneof).
isEnabled#boolean

Whether the evaluation is active.

subsystem#string

Subsystem within the application.

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

target#EvaluationTarget

What the evaluation runs against: PROMPT, RESPONSE, or CONVERSATION.

Possible values: [PROMPT, RESPONSE, CONVERSATION]

threshold#double

Score threshold. Must be between 0.0 and 1.0 inclusive.

Possible values: >= 0 and <= 1

updateMask#string

Comma-separated list of top-level field paths to update. Dotted paths are rejected. When provided, only the listed fields are touched; a listed field that is absent from the request body is cleared, except application, subsystem, target, config, and isEnabled, which cannot be 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_]*)*$

Response

200application/json

Response returned after updating an AI evaluation.

aiEvaluation# objectrequired
The updated AI evaluation.