Method: projects.locations.evaluations.listResults

指定された Evaluation の結果のリストを取得します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 の評価によって生成された指標。