Method: projects.locations.evaluations.listResults

Obtiene una lista de resultados para un Evaluation determinado.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
evaluation

string

Obligatorio. Es el nombre del recurso de evaluación, como projects/{project}/locations/{location}/evaluations/{evaluation}.

Si el emisor no tiene permiso para enumerar ListEvaluationResultsResponse.EvaluationResult en esta evaluación, independientemente de si existe o no este conjunto de evaluación, se devuelve un error PERMISSION_DENIED.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Cantidad máxima de ListEvaluationResultsResponse.EvaluationResult que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1,000. Los valores superiores a 1,000 se convertirán a 1,000.

Si este campo es negativo, se muestra un error INVALID_ARGUMENT.

pageToken

string

Opcional. Un token de página ListEvaluationResultsResponse.next_page_token, recibido desde una llamada a EvaluationService.ListEvaluationResults anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a EvaluationService.ListEvaluationResults deben coincidir con la llamada que proporcionó el token de la página. De lo contrario, se muestra un error INVALID_ARGUMENT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para el método EvaluationService.ListEvaluationResults.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "evaluationResults": [
    {
      object (EvaluationResult)
    }
  ],
  "nextPageToken": string
}
Campos
evaluationResults[]

object (EvaluationResult)

Son los resultados de la evaluación de los SampleQuery.

nextPageToken

string

Es un token que se puede enviar como ListEvaluationResultsRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso evaluation:

  • discoveryengine.evaluations.get

Para obtener más información, consulta la documentación de IAM.

EvaluationResult

Representa los resultados de una evaluación para un solo SampleQuery.

Representación JSON
{
  "sampleQuery": {
    object (SampleQuery)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  }
}
Campos
sampleQuery

object (SampleQuery)

Solo salida. Es el SampleQuery que se evaluó.

qualityMetrics

object (QualityMetrics)

Solo salida. Son las métricas que produce la evaluación para un SampleQuery determinado.