Evaluation Rules

Create or update an evaluation rule

PUT /evaluationrules/{id}

Creates a new evaluation rule, or replaces the existing rule when the identifier matches.

Parametri di query

api-version string necessario

The API version to use for this operation.

Parametri del percorso

id string necessario

Unique identifier for the evaluation rule.

Parametri di intestazione

Foundry-Features enum

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

Evaluations=V1Preview

Corpo della richiesta

Evaluation rule resource

Content-Type: application/json

id string necessario

Unique identifier for the evaluation rule.

displayName string

Display Name for the evaluation rule.

description string

Description for the evaluation rule.

action continuousEvaluation | humanEvaluationPreview necessario

Evaluation action model.

Uno dei seguenti:

continuousEvaluation ContinuousEvaluationRuleAction

Evaluation rule action for continuous evaluation.

type enum necessario

continuousEvaluation

evalId string necessario

Eval Id to add continuous evaluation runs to.

maxHourlyRuns integer

Maximum number of evaluation runs allowed per hour.

samplingRate number

Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100.

humanEvaluationPreview HumanEvaluationPreviewRuleAction

Evaluation rule action for human evaluation.

type enum necessario

humanEvaluationPreview

templateId string necessario

Identifier of a saved asset.

filter EvaluationRuleFilter

Evaluation filter model.

agentName string necessario

Filter by agent name.

eventType string | enum necessario

Type of the evaluation rule event.

Uno qualsiasi dei seguenti:

string

enum

responseCompletedmanual

enabled boolean necessario

Indicates whether the evaluation rule is enabled. Default is true.

systemData object necessario

System metadata for the evaluation rule.

[key: string] string

Risposte

The request has succeeded.

Corpo

Content-Type: application/json

id string necessario

Unique identifier for the evaluation rule.

displayName string

Display Name for the evaluation rule.

description string

Description for the evaluation rule.

action continuousEvaluation | humanEvaluationPreview necessario

Evaluation action model.

Uno dei seguenti:

continuousEvaluation ContinuousEvaluationRuleAction

Evaluation rule action for continuous evaluation.

type enum necessario

continuousEvaluation

evalId string necessario

Eval Id to add continuous evaluation runs to.

maxHourlyRuns integer

Maximum number of evaluation runs allowed per hour.

samplingRate number

Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100.

humanEvaluationPreview HumanEvaluationPreviewRuleAction

Evaluation rule action for human evaluation.

type enum necessario

humanEvaluationPreview

templateId string necessario

Identifier of a saved asset.

filter EvaluationRuleFilter

Evaluation filter model.

agentName string necessario

Filter by agent name.

eventType string | enum necessario

Type of the evaluation rule event.

Uno qualsiasi dei seguenti:

string

enum

responseCompletedmanual

enabled boolean necessario

Indicates whether the evaluation rule is enabled. Default is true.

systemData object necessario

System metadata for the evaluation rule.

[key: string] string

The request has succeeded and a new resource has been created as a result.

Corpo

Content-Type: application/json

id string necessario

Unique identifier for the evaluation rule.

displayName string

Display Name for the evaluation rule.

description string

Description for the evaluation rule.

action continuousEvaluation | humanEvaluationPreview necessario

Evaluation action model.

Uno dei seguenti:

continuousEvaluation ContinuousEvaluationRuleAction

Evaluation rule action for continuous evaluation.

type enum necessario

continuousEvaluation

evalId string necessario

Eval Id to add continuous evaluation runs to.

maxHourlyRuns integer

Maximum number of evaluation runs allowed per hour.

samplingRate number

Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate every event, which is equivalent to setting a sampling rate of 100.

humanEvaluationPreview HumanEvaluationPreviewRuleAction

Evaluation rule action for human evaluation.

type enum necessario

humanEvaluationPreview

templateId string necessario

Identifier of a saved asset.

filter EvaluationRuleFilter

Evaluation filter model.

agentName string necessario

Filter by agent name.

eventType string | enum necessario

Type of the evaluation rule event.

Uno qualsiasi dei seguenti:

string

enum

responseCompletedmanual

enabled boolean necessario

Indicates whether the evaluation rule is enabled. Default is true.

systemData object necessario

System metadata for the evaluation rule.

[key: string] string

Richiedi

PUT /evaluationrules/{id} HTTP/1.1

Response

Status: 200
Content-Type: application/json

Status: 201
Content-Type: application/json

Status: 4XX
Content-Type: application/json

Status: 5XX
Content-Type: application/json

Create or update an evaluation rule

Parametri di query

Parametri del percorso

Parametri di intestazione

Corpo della richiesta

Risposte

Corpo

Corpo

Intestazioni

Corpo

Intestazioni

Corpo

Richiedi

Response