Method: projects.locations.rankingConfigs.rank

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

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de 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 do pedido

O corpo do pedido 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 usar. É uma das seguintes opções:

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

Por predefinição, está definido como semantic-ranker-512@latest se não for especificado.
topN

integer

O número de resultados a devolver. Se esta opção não estiver definida ou não for superior a zero, devolve todos os resultados.
query

string

A consulta a usar.
records[]

object (RankingRecord)

Obrigatório. Uma lista de registos a classificar.
ignoreRecordDetailsInResponse

boolean

Se for verdadeiro, a resposta contém apenas o ID do registo e a pontuação. Por predefinição, é falso e a resposta contém detalhes do registo.
userLabels

map (key: string, value: string)

As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos:

  • Cada recurso pode ter várias etiquetas, até um máximo de 64.
  • Cada etiqueta tem de ser um par chave-valor.
  • As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres.
  • As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais.
  • A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos.
  • As chaves têm de começar com uma letra minúscula ou um caráter internacional.

Consulte o documento do Google Cloud para ver mais detalhes.

Corpo da resposta

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

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

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

object (RankingRecord)

Uma lista de registos ordenada por pontuação descendente.

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

  • discoveryengine.rankingConfigs.rank

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

RankingRecord

Método de gravação de mensagens para RankService.Rank.

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

string

O ID exclusivo para representar o registo.
title

string

O título do registo. Vazio por predefinição. Tem de definir, pelo menos, um dos elementos title ou content. Caso contrário, é gerado um erro INVALID_ARGUMENT.
content

string

O conteúdo do registo. Vazio por predefinição. Tem de definir, pelo menos, um dos elementos title ou content. Caso contrário, é gerado um erro INVALID_ARGUMENT.
score

number

A pontuação deste registo com base na consulta fornecida e no modelo selecionado. A pontuação é arredondada às 2 casas decimais. Se a pontuação estiver perto de 0, é arredondada para 0,0001 para evitar a devolução de valores não definidos.