Method: projects.locations.evaluations.listResults

Recebe uma lista de resultados para um determinado Evaluation.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
evaluation

string

Obrigatório. O nome do recurso de avaliação, como projects/{project}/locations/{location}/evaluations/{evaluation}.

Se o autor da chamada não tiver permissão para listar ListEvaluationResultsResponse.EvaluationResult nessa avaliação, independente de o conjunto de avaliação existir ou não, um erro PERMISSION_DENIED será retornado.

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Número máximo de ListEvaluationResultsResponse.EvaluationResult a serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores acima de 1.000 serão convertidos para 1.000.

Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.
pageToken

string

Opcional. Um token de página ListEvaluationResultsResponse.next_page_token recebido de uma chamada EvaluationService.ListEvaluationResults anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para EvaluationService.ListEvaluationResults precisam corresponder à chamada que forneceu o token da página. Caso contrário, um erro INVALID_ARGUMENT será retornado.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método EvaluationService.ListEvaluationResults.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "evaluationResults": [
    {
      object (EvaluationResult)
    }
  ],
  "nextPageToken": string
}
Campos
evaluationResults[]

object (EvaluationResult)

Os resultados da avaliação para os SampleQuerys.
nextPageToken

string

Um token que pode ser enviado como ListEvaluationResultsRequest.page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso evaluation:

  • discoveryengine.evaluations.get

Para mais informações, consulte a documentação do IAM.

EvaluationResult

Representa os resultados de uma avaliação para um único SampleQuery.

Representação JSON 
{
  "sampleQuery": {
    object (SampleQuery)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  }
}
Campos
sampleQuery

object (SampleQuery)

Apenas saída. O SampleQuery que foi avaliado.
qualityMetrics

object (QualityMetrics)

Apenas saída. As métricas produzidas pela avaliação para um determinado SampleQuery.