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.

查询参数

api-version string 必需

The API version to use for this operation.

路径参数

id string 必需

Unique identifier for the evaluation rule.

标头参数

Foundry-Features enum

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

Evaluations=V1Preview

请求正文

Evaluation rule resource

Content-Type: application/json

id string 必需

Unique identifier for the evaluation rule.

displayName string

Display Name for the evaluation rule.

description string

Description for the evaluation rule.

action continuousEvaluation | humanEvaluationPreview 必需

Evaluation action model.

下列类型作之一：

continuousEvaluation ContinuousEvaluationRuleAction

Evaluation rule action for continuous evaluation.

type enum 必需

continuousEvaluation

evalId string 必需

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 必需

humanEvaluationPreview

templateId string 必需

Identifier of a saved asset.

filter EvaluationRuleFilter

Evaluation filter model.

agentName string 必需

Filter by agent name.

eventType string | enum 必需

Type of the evaluation rule event.

以下任何项：

string

enum

responseCompletedmanual

enabled boolean 必需

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

systemData object 必需

System metadata for the evaluation rule.

[key: string] string

响应

The request has succeeded.

正文

Content-Type: application/json

id string 必需

Unique identifier for the evaluation rule.

displayName string

Display Name for the evaluation rule.

description string

Description for the evaluation rule.

action continuousEvaluation | humanEvaluationPreview 必需

Evaluation action model.

下列类型作之一：

continuousEvaluation ContinuousEvaluationRuleAction

Evaluation rule action for continuous evaluation.

type enum 必需

continuousEvaluation

evalId string 必需

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 必需

humanEvaluationPreview

templateId string 必需

Identifier of a saved asset.

filter EvaluationRuleFilter

Evaluation filter model.

agentName string 必需

Filter by agent name.

eventType string | enum 必需

Type of the evaluation rule event.

以下任何项：

string

enum

responseCompletedmanual

enabled boolean 必需

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

systemData object 必需

System metadata for the evaluation rule.

[key: string] string

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

正文

Content-Type: application/json

id string 必需

Unique identifier for the evaluation rule.

displayName string

Display Name for the evaluation rule.

description string

Description for the evaluation rule.

action continuousEvaluation | humanEvaluationPreview 必需

Evaluation action model.

下列类型作之一：

continuousEvaluation ContinuousEvaluationRuleAction

Evaluation rule action for continuous evaluation.

type enum 必需

continuousEvaluation

evalId string 必需

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 必需

humanEvaluationPreview

templateId string 必需

Identifier of a saved asset.

filter EvaluationRuleFilter

Evaluation filter model.

agentName string 必需

Filter by agent name.

eventType string | enum 必需

Type of the evaluation rule event.

以下任何项：

string

enum

responseCompletedmanual

enabled boolean 必需

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

systemData object 必需

System metadata for the evaluation rule.

[key: string] string