Method: projects.locations.evaluations.listResults

Obtient une liste de résultats pour un Evaluation donné.

Requête HTTP


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

Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
evaluation

string

Obligatoire. Nom de ressource de l'évaluation, par exemple projects/{project}/locations/{location}/evaluations/{evaluation}.

Si l'appelant n'est pas autorisé à lister ListEvaluationResultsResponse.EvaluationResult dans cette évaluation, qu'elle existe ou non, une erreur PERMISSION_DENIED est renvoyée.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de ListEvaluationResultsResponse.EvaluationResult à renvoyer. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. La valeur maximale autorisée est de 1 000. Les valeurs supérieures à 1 000 seront réduites à 1 000.

Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée.
pageToken

string

Facultatif. Jeton de page ListEvaluationResultsResponse.next_page_token reçu d'un appel EvaluationService.ListEvaluationResults précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à EvaluationService.ListEvaluationResults doivent correspondre à l'appel ayant fourni le jeton de page. Sinon, une erreur INVALID_ARGUMENT est renvoyée.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la méthode EvaluationService.ListEvaluationResults.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "evaluationResults": [
    {
      object (EvaluationResult)
    }
  ],
  "nextPageToken": string
}
Champs
evaluationResults[]

object (EvaluationResult)

Résultats de l'évaluation pour les SampleQuery.
nextPageToken

string

Jeton pouvant être envoyé en tant que ListEvaluationResultsRequest.page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource evaluation :

  • discoveryengine.evaluations.get

Pour en savoir plus, consultez la documentation IAM.

EvaluationResult

Représente les résultats d'une évaluation pour un seul SampleQuery.

Représentation JSON 
{
  "sampleQuery": {
    object (SampleQuery)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  }
}
Champs
sampleQuery

object (SampleQuery)

Uniquement en sortie. Le SampleQuery qui a été évalué.
qualityMetrics

object (QualityMetrics)

Uniquement en sortie. Métriques produites par l'évaluation pour un SampleQuery donné.