Method: projects.locations.evaluations.listResults
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://discoveryengine.googleapis.com/v1beta/{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 ListEvaluationResultsResponse.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 ListEvaluationResultsResponse.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 evaluation results for the SampleQuerys.
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This document outlines the process for retrieving a list of evaluation results via the `GET` method using the `https://discoveryengine.googleapis.com/v1beta/{evaluation=projects/*/locations/*/evaluations/*}:listResults` endpoint."],["The `evaluation` path parameter is required, specifying the evaluation resource from which results are being retrieved, and a `PERMISSION_DENIED` error will be returned if the caller lacks permission."],["You can control the number of results returned per page using the `pageSize` query parameter, which defaults to 100 and has a maximum value of 1000."],["The `pageToken` query parameter allows for pagination, enabling retrieval of subsequent result pages from the list."],["The response body contains an array of `evaluationResults`, each of which represents the results for a `SampleQuery`, and `nextPageToken` to help retrieve more pages, alongside requiring `https://www.googleapis.com/auth/cloud-platform` OAuth scope and `discoveryengine.evaluations.get` IAM permission."]]],[]]
