Method: projects.locations.evaluations.listResults

获取给定 Evaluation 的结果列表。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1alpha/{evaluation=projects/*/locations/*/evaluations/*}:listResults

网址采用 gRPC 转码语法。

路径参数

参数
evaluation

string

必需。评估的资源名称，例如 projects/{project}/locations/{location}/evaluations/{evaluation}。

如果调用方无权列出相应评估下的 ListEvaluationResultsResponse.EvaluationResult，则无论该评估集是否存在，系统都会返回 PERMISSION_DENIED 错误。

查询参数

参数
pageSize

integer

可选。要返回的 ListEvaluationResultsResponse.EvaluationResult 的数量上限。如果未指定，则默认为 100。允许的最大值为 1,000。大于 1,000 的值会强制转换为 1,000。

如果此字段为负数，则会返回 INVALID_ARGUMENT 错误。
pageToken

string

可选。从之前的 EvaluationService.ListEvaluationResults 调用接收的页面令牌 ListEvaluationResultsResponse.next_page_token。利用其进行后续页面检索。

进行分页时，提供给 EvaluationService.ListEvaluationResults 的所有其他参数必须与提供页面令牌的调用匹配。 否则，系统会返回 INVALID_ARGUMENT 错误。

请求正文

请求正文必须为空。

响应正文

EvaluationService.ListEvaluationResults 方法的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "evaluationResults": [
    {
      object (EvaluationResult)
    }
  ],
  "nextPageToken": string
}
字段
evaluationResults[]

object (EvaluationResult)

SampleQuery 的评估结果。
nextPageToken

string

可作为 ListEvaluationResultsRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 evaluation 资源的以下 IAM 权限：

  • discoveryengine.evaluations.get

如需了解详情，请参阅 IAM 文档。

EvaluationResult

表示单个 SampleQuery 的评估结果。

JSON 表示法 
{
  "sampleQuery": {
    object (SampleQuery)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  }
}
字段
sampleQuery

object (SampleQuery)

仅限输出。已评估的 SampleQuery。
qualityMetrics

object (QualityMetrics)

仅限输出。评估针对给定 SampleQuery 生成的指标。