Skip to main content
PATCH
Update AI Config

Authorizations

Authorization
string
header
required

Path Parameters

projectKey
string
required

The project key

configKey
string
required

The AI Config key

Body

application/json

AI Config object to update

defaultVariationKey
string

Key of the variation this config serves by default

description
string

A description of the AI Config

maintainerId
string

The ID of the member who maintains this resource

Example:

"507f1f77bcf86cd799439011"

maintainerTeamKey
string

The key of the team that maintains this resource

Example:

"example-team-key"

name
string

A human-readable name for the AI Config

tags
string[]

Tags for this resource

evaluationMetricKey
string

Evaluation metric key for this config

isInverted
boolean

The success direction of a judge. Offline evaluations use it to decide whether a score passes.

  • true: A lower score is better. Use this for a judge that scores bad output, such as a toxicity or hallucination judge.
  • false: A higher score is better. Use this for a judge that scores good output, such as an accuracy or relevance judge.

Send this field only when the AI Config's mode is judge. If you omit it, the current direction does not change. For a built-in judge key, the API always returns the built-in direction. Built-in judge keys are ld-ai-judge-accuracy, ld-ai-judge-relevance, and ld-ai-judge-toxicity, with or without a -<timestamp> suffix such as ld-ai-judge-accuracy-1760000000000.

The API returns a 400 error in these cases:

  • isInverted is only supported for judge mode: You send this field and the AI Config's mode is agent or completion. Remove the field.
  • isInverted is not supported: Custom judges are not available for your account. Remove the field from the request.
Example:

true

Response

AI Config updated

description
string
required

A description of the AI Config

key
string
required

The AI Config key

name
string
required

The AI Config name

tags
string[]
required

Tags for this resource

version
integer
required

The version number of this resource

variations
object[]
required

The variations of this AI Config

createdAt
integer<int64>
required
updatedAt
integer<int64>
required
_access
object
Example:

The location and content type of related resources

Example:
_site
object
Example:
_maintainer
object

The member or team that maintains this resource

Example:
mode
enum<string>
default:completion

The AI Config mode

Available options:
agent,
completion,
judge
evaluationMetricKey
string

Evaluation metric key for this config

evaluationMetricKeys
string[]
deprecated

List of evaluation metric keys for this config

isInverted
boolean

The success direction of a judge. Offline evaluations use it to decide whether a score passes.

  • true: A lower score is better. Use this for a judge that scores bad output, such as a toxicity or hallucination judge.
  • false: A higher score is better. Use this for a judge that scores good output, such as an accuracy or relevance judge.

The response includes this field only when mode is judge. For a built-in judge key, the value is always the built-in direction. Built-in judge keys are ld-ai-judge-accuracy, ld-ai-judge-relevance, and ld-ai-judge-toxicity, with or without a -<timestamp> suffix such as ld-ai-judge-accuracy-1760000000000. A custom judge with no stored direction omits this field.

Example:

true

dependencies
object[]

Resources that depend on this config, grouped by type