Method: projects.locations.evaluations.listResults

取得指定 Evaluation 的結果清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
evaluation

string

這是必要旗標，評估資源名稱，例如 projects/{project}/locations/{location}/evaluations/{evaluation}。

如果呼叫者沒有權限列出這項評估中的 ListEvaluationResultsResponse.EvaluationResult，無論這項評估集是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

查詢參數

參數
pageSize

integer

(選用步驟) 要傳回的 ListEvaluationResultsResponse.EvaluationResult 數量上限。如未指定，則預設為 100。允許的最大值為 1000。超出的數值將一律指定為 1000。

如果這個欄位為負數，系統會傳回 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。