Method: projects.locations.rankingConfigs.rank

Classifica uma lista de registros de texto com base na consulta de entrada fornecida.

Solicitação HTTP

POST https://discoveryengine.googleapis.com/v1beta/{rankingConfig=projects/*/locations/*/rankingConfigs/*}:rank

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

Parâmetros de caminho

Parâmetros
rankingConfig

string

Obrigatório. O nome do recurso da configuração do serviço de classificação, como projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "model": string,
  "topN": integer,
  "query": string,
  "records": [
    {
      object (RankingRecord)
    }
  ],
  "ignoreRecordDetailsInResponse": boolean,
  "userLabels": {
    string: string,
    ...
  }
}
Campos
model

string

O identificador do modelo a ser usado. É uma destas opções:

  • semantic-ranker-512@latest: modelo de classificação semântica com tamanho máximo de token de entrada de 512.

Se não for especificado, o padrão será semantic-ranker-512@latest.
topN

integer

O número de resultados a serem mostrados. Se não for definido ou for menor ou igual a zero, todos os resultados serão retornados.
query

string

A consulta a ser usada.
records[]

object (RankingRecord)

Obrigatório. Uma lista de registros a serem classificados.
ignoreRecordDetailsInResponse

boolean

Se for "true", a resposta vai conter apenas o ID do registro e a pontuação. Por padrão, é "false", e a resposta contém detalhes do registro.
userLabels

map (key: string, value: string)

Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos:

  • Cada recurso pode ter vários rótulos, até um máximo de 64.
  • Cada rótulo precisa ser um par de chave-valor.
  • As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres.
  • As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos.
  • A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos.
  • As chaves precisam começar com uma letra minúscula ou um caractere internacional.

Consulte o documento do Google Cloud para mais detalhes.

Corpo da resposta

Mensagem de resposta para o método RankService.Rank.

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

Representação JSON 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
Campos
records[]

object (RankingRecord)

Uma lista de registros classificados por pontuação decrescente.

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 rankingConfig:

  • discoveryengine.rankingConfigs.rank

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

RankingRecord

Grave uma mensagem para o método RankService.Rank.

Representação JSON 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
Campos
id

string

O ID exclusivo para representar o registro.
title

string

O título do registro. Vazio por padrão. Pelo menos uma das propriedades title ou content precisa ser definida. Caso contrário, um erro INVALID_ARGUMENT será gerado.
content

string

O conteúdo do registro. Vazio por padrão. Pelo menos uma das propriedades title ou content precisa ser definida. Caso contrário, um erro INVALID_ARGUMENT será gerado.
score

number

A pontuação deste registro com base na consulta e no modelo selecionados. A pontuação será arredondada para duas casas decimais. Se a pontuação estiver próxima de 0, ela será arredondada para 0,0001 para evitar o retorno de "não definido".