Method: projects.locations.evaluations.listResults

Ruft eine Liste von Ergebnissen für ein bestimmtes Evaluation ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
evaluation

string

Erforderlich. Der Ressourcenname der Bewertung, z. B. projects/{project}/locations/{location}/evaluations/{evaluation}.

Wenn der Aufrufer keine Berechtigung hat, ListEvaluationResultsResponse.EvaluationResult in dieser Auswertung aufzulisten, wird unabhängig davon, ob dieser Auswertungssatz vorhanden ist oder nicht, ein PERMISSION_DENIED-Fehler zurückgegeben.

Abfrageparameter

Parameter
pageSize

integer

Optional. Maximale Anzahl der zurückzugebenden ListEvaluationResultsResponse.EvaluationResult. Wenn nicht angegeben, lautet die Standardeinstellung 100. Der maximal zulässige Wert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.

Wenn dieses Feld negativ ist, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageToken

string

Optional. Ein Seitentoken ListEvaluationResultsResponse.next_page_token, das von einem vorherigen EvaluationService.ListEvaluationResults-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für EvaluationService.ListEvaluationResults bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode EvaluationService.ListEvaluationResults.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "evaluationResults": [
    {
      object (EvaluationResult)
    }
  ],
  "nextPageToken": string
}
Felder
evaluationResults[]

object (EvaluationResult)

Die Auswertungsergebnisse für die SampleQuery.
nextPageToken

string

Ein Token, das als ListEvaluationResultsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource evaluation:

  • discoveryengine.evaluations.get

Weitere Informationen finden Sie in der IAM-Dokumentation.

EvaluationResult

Stellt die Ergebnisse einer Auswertung für ein einzelnes SampleQuery dar.

JSON-Darstellung 
{
  "sampleQuery": {
    object (SampleQuery)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  }
}
Felder
sampleQuery

object (SampleQuery)

Nur Ausgabe. Die SampleQuery, die ausgewertet wurde.
qualityMetrics

object (QualityMetrics)

Nur Ausgabe. Die Messwerte, die bei der Bewertung für ein bestimmtes SampleQuery generiert werden.