Evaluations - Create Agent Evaluation

服务:

AI Foundry

API 版本:

2025-05-15-preview

创建代理评估运行。

POST {endpoint}/evaluations/runs:runAgent?api-version=2025-05-15-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	Project 端点。 在格式 “https://.services.ai.azure.com/api/projects/_project"如果您的 Foundry Hub 只有一个 Project，或者使用 Hub 中的默认 Project。 或以 “https://.services.ai.azure.com/api/projects/"如果要显式指定 Foundry Project 名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
appInsightsConnectionString	True	string	将 AppInsights 连接字符串传递给代理评估，以获取评估结果和错误日志。
evaluators	True	<string,  EvaluatorConfiguration>	用于评估的 Evaluator。
runId	True	string	代理运行的标识符。
redactionConfiguration		AgentEvaluationRedactionConfiguration	评估的修订配置。
samplingConfiguration		AgentEvaluationSamplingConfiguration	评估的采样配置。
threadId		string	代理线程的标识符。 此字段目前是必填字段，但将来将是可选的。

响应

名称	类型	说明
201 Created	AgentEvaluation	请求已成功，因此创建了一个新资源。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://ai.azure.com/.default

示例

Evaluations_CreateAgentEvaluation_MaximumSet

Evaluations_CreateAgentEvaluation_MinimumSet

Evaluations_CreateAgentEvaluation_MaximumSet

示例请求

HTTP

POST {endpoint}/evaluations/runs:runAgent?api-version=2025-05-15-preview

{
  "runId": "ecfcffqsrdhpecocrufffiqz",
  "threadId": "cxjjsyhkeezgnaqqyerrdrbbth",
  "evaluators": {
    "key2653": {
      "id": "gujwtvhptykq",
      "initParams": {},
      "dataMapping": {
        "key7400": "ijkjfvoswni"
      }
    }
  },
  "samplingConfiguration": {
    "name": "tj",
    "samplingPercent": 7,
    "maxRequestRate": 8
  },
  "redactionConfiguration": {
    "redactScoreProperties": true
  },
  "appInsightsConnectionString": "dvcnrcwar"
}

示例响应

状态代码:

201

{
  "id": "gji",
  "status": "ozywrhiasll",
  "error": "stcjbhxgmqvjqwzmbvaa",
  "result": [
    {
      "evaluator": "upnt",
      "evaluatorId": "upnt",
      "score": 13,
      "status": "eoxw",
      "reason": "kfrjetziuketgioobeydlugonzfxo",
      "version": "lfqwtzuktnbmcxxwkghmlpdtuu",
      "threadId": "sldwqklyuxeayfmxpbl",
      "runId": "lauehlf",
      "error": "lrutmshl",
      "additionalDetails": {
        "key3590": "vhhneubavtiklsjcdexij"
      }
    }
  ]
}

Evaluations_CreateAgentEvaluation_MinimumSet

示例请求

HTTP

POST {endpoint}/evaluations/runs:runAgent?api-version=2025-05-15-preview

{
  "runId": "ecfcffqsrdhpecocrufffiqz",
  "evaluators": {},
  "appInsightsConnectionString": "dvcnrcwar"
}

示例响应

状态代码:

201

{
  "id": "gji",
  "status": "ozywrhiasll"
}

定义

名称	说明
AgentEvaluation	代理评估运行的评估响应。
AgentEvaluationRedactionConfiguration	密文配置将允许用户控制要编辑的内容。
AgentEvaluationRequest	代理运行的评估请求。
AgentEvaluationResult	代理评估评估程序运行的结果。
AgentEvaluationSamplingConfiguration	采样策略的定义。
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。
EvaluatorConfiguration	Evaluator 配置

AgentEvaluation

Object

代理评估运行的评估响应。

名称	类型	说明
error	string	长时间运行的进程请求失败的原因（如果适用）。
id	string	代理评估运行的标识符。
result	AgentEvaluationResult[]	代理评估结果。
status	string	代理评估的状态。 选项：正在运行、已完成、失败。

AgentEvaluationRedactionConfiguration

Object

密文配置将允许用户控制要编辑的内容。

名称	类型	说明
redactScoreProperties	boolean	密文分数属性。 如果未指定，则默认值为 in production 中修订。

AgentEvaluationRequest

Object

代理运行的评估请求。

名称	类型	说明
appInsightsConnectionString	string	将 AppInsights 连接字符串传递给代理评估，以获取评估结果和错误日志。
evaluators	<string,  EvaluatorConfiguration>	用于评估的 Evaluator。
redactionConfiguration	AgentEvaluationRedactionConfiguration	评估的修订配置。
runId	string	代理运行的标识符。
samplingConfiguration	AgentEvaluationSamplingConfiguration	评估的采样配置。
threadId	string	代理线程的标识符。 此字段目前是必填字段，但将来将是可选的。

AgentEvaluationResult

Object

代理评估评估程序运行的结果。

名称	类型	说明
additionalDetails	object	与赋值器相关的其他属性。 这些值会因评估员而异。
error	string	一个字符串，说明出现错误的原因（如果适用）。
evaluator	string	测评员的姓名。 这是用于评估代理完成情况的评估器的名称。
evaluatorId	string	赋值器的标识符。
reason	string	评估结果的推理。
runId	string	运行的唯一标识符。
score	number (float)	给定评估者的分数。 对范围没有限制。
status	string	赋值器结果的状态。 选项：正在运行、已完成、失败、NotApplicable。
threadId	string	线程的唯一标识符。
version	string	用于评估代理完成情况的评估程序的版本。

AgentEvaluationSamplingConfiguration

Object

采样策略的定义。

名称	类型	说明
maxRequestRate	number (float)	每小时最大请求速率（0 到 1000）。
name	string	采样策略的名称。
samplingPercent	number (float)	每小时采样百分比 （0-100）。

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	有关错误的可读的表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

EvaluatorConfiguration

Object

Evaluator 配置

名称	类型	说明
dataMapping	object	赋值器的数据参数。
id	string	赋值器的标识符。
initParams		赋值器的初始化参数。