Method: projects.locations.evaluations.listResults

Obtém uma lista de resultados para um determinado Evaluation.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de 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 autorização para listar ListEvaluationResultsResponse.EvaluationResult nesta avaliação, independentemente de este conjunto de avaliação existir ou não, é devolvido um erro PERMISSION_DENIED.

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Número máximo de ListEvaluationResultsResponse.EvaluationResult a devolver. Se não for especificado, a predefinição é 100. O valor máximo permitido é 1000. Os valores acima de 1000 são forçados a 1000.

Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.
pageToken

string

Opcional. Um token de página ListEvaluationResultsResponse.next_page_token, recebido de uma chamada EvaluationService.ListEvaluationResults anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a EvaluationService.ListEvaluationResults têm de corresponder à chamada que forneceu o token da página. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

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

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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 obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de 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.