Method: projects.locations.rankingConfigs.rank

Clasifica una lista de registros de texto en función de la consulta de entrada proporcionada.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
rankingConfig

string

Obligatorio. Nombre de recurso de la configuración del servicio de ranking, como projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "model": string,
  "topN": integer,
  "query": string,
  "records": [
    {
      object (RankingRecord)
    }
  ],
  "ignoreRecordDetailsInResponse": boolean,
  "userLabels": {
    string: string,
    ...
  }
}
Campos
model

string

Identificador del modelo que se va a usar. Es uno de los siguientes:

  • semantic-ranker-512@latest: modelo de clasificación semántica con un tamaño máximo de token de entrada de 512.

Si no se especifica, se asigna el valor semantic-ranker-512@latest de forma predeterminada.
topN

integer

El número de resultados que se van a devolver. Si no se define o no es mayor que cero, devuelve todos los resultados.
query

string

Consulta que se va a usar.
records[]

object (RankingRecord)

Obligatorio. Lista de registros que se van a clasificar.
ignoreRecordDetailsInResponse

boolean

Si es true, la respuesta solo contendrá el ID de registro y la puntuación. De forma predeterminada, es false, por lo que la respuesta contendrá los detalles del registro.
userLabels

map (key: string, value: string)

Las etiquetas de usuario aplicadas a un recurso deben cumplir los siguientes requisitos:

  • Cada recurso puede tener varias etiquetas, hasta un máximo de 64.
  • Cada etiqueta debe ser un par clave-valor.
  • Las claves tienen una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y tener una longitud máxima de 63 caracteres.
  • Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales.
  • La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos.
  • Las claves deben empezar por una letra minúscula o un carácter internacional.

Consulta más información en el documento de Google Cloud.

Cuerpo de la respuesta

Mensaje de respuesta del método RankService.Rank.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Representación JSON 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
Campos
records[]

object (RankingRecord)

Lista de registros ordenados por puntuación de mayor a menor.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso rankingConfig:

  • discoveryengine.rankingConfigs.rank

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

RankingRecord

Graba un mensaje para el método RankService.Rank.

Representación JSON 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
Campos
id

string

ID único que representa el registro.
title

string

El título del registro. Está vacío de forma predeterminada. Se debe definir al menos uno de los dos, ya que, de lo contrario, se producirá un error INVALID_ARGUMENT.titlecontent
content

string

El contenido del registro. Está vacío de forma predeterminada. Se debe definir al menos uno de los dos, ya que, de lo contrario, se producirá un error INVALID_ARGUMENT.titlecontent
score

number

La puntuación de este registro en función de la consulta proporcionada y el modelo seleccionado. La puntuación se redondeará a dos decimales. Si la puntuación se acerca a 0, se redondeará a 0,0001 para evitar que se devuelva el valor predeterminado.