Method: projects.locations.evaluations.listResults

Gets a list of results for a given a Evaluation.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
evaluation

string

Required. The evaluation resource name, such as projects/{project}/locations/{location}/evaluations/{evaluation}.

If the caller does not have permission to list [EvaluationResult][] under this evaluation, regardless of whether or not this evaluation set exists, a PERMISSION_DENIED error is returned.

Query parameters

Parameters
pageSize

integer

Maximum number of [EvaluationResult][] to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.
pageToken

string

A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Request body

The request body must be empty.

Response body

Response message for EvaluationService.ListEvaluationResults method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "evaluationResults": [
    {
      object (EvaluationResult)
    }
  ],
  "nextPageToken": string
}
Fields
evaluationResults[]

object (EvaluationResult)

The EvaluationResults.
nextPageToken

string

A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the evaluation resource:

  • discoveryengine.evaluations.get

For more information, see the IAM documentation.

EvaluationResult

Represents the results of an evaluation for a single SampleQuery.

JSON representation 
{
  "sampleQuery": {
    object (SampleQuery)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  }
}
Fields
sampleQuery

object (SampleQuery)

Output only. The SampleQuery that was evaluated.
qualityMetrics

object (QualityMetrics)

Output only. The metrics produced by the evaluation, for a given SampleQuery.