- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- EvaluationResult
Gets a list of results for a given a Evaluation
.
HTTP request
GET https://discoveryengine.googleapis.com/v1beta/{evaluation=projects/*/locations/*/evaluations/*}:listResults
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
evaluation |
Required. The evaluation resource name, such as If the caller does not have permission to list [EvaluationResult][] under this evaluation, regardless of whether or not this evaluation set exists, a |
Query parameters
Parameters | |
---|---|
page |
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 |
page |
A page token When paginating, all other parameters provided to |
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 ( |
Fields | |
---|---|
evaluation |
The |
next |
A token that can be sent as |
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 ( |
Fields | |
---|---|
sample |
Output only. The |
quality |
Output only. The metrics produced by the evaluation, for a given |