Method: projects.locations.rankingConfigs.rank

Clasifica una lista de registros de texto según la consulta de entrada determinada.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
rankingConfig

string

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

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

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

string

El identificador del modelo que se 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.

Se establece en semantic-ranker-512@latest de forma predeterminada si no se especifica.
topN

integer

La cantidad de resultados que se mostrarán. Si no se establece o no es mayor que cero, se muestran todos los resultados.
query

string

La consulta que se usará.
records[]

object (RankingRecord)

Obligatorio. Una lista de registros para clasificar.
ignoreRecordDetailsInResponse

boolean

Si es verdadero, la respuesta solo contendrá el ID y la puntuación del registro. De forma predeterminada, es falso, la respuesta contendrá detalles del registro.
userLabels

map (key: string, value: string)

Las etiquetas de usuario que se aplican a un recurso deben cumplir los siguientes requisitos:

  • Cada recurso puede tener varias etiquetas, hasta 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 pueden contener solo letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales.
  • La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos.
  • Las claves deben comenzar con una letra en minúscula o un carácter internacional.

Consulta el documento de Google Cloud para obtener más detalles.

Cuerpo de la respuesta

Mensaje de respuesta para el método RankService.Rank.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

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

object (RankingRecord)

Una lista de registros ordenados por puntuación descendente.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso rankingConfig:

  • discoveryengine.rankingConfigs.rank

Para obtener más información, consulta la documentación de IAM.

RankingRecord

Mensaje de registro para el método RankService.Rank.

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

string

El ID único para representar el registro.
title

string

El título del registro. Está vacío de forma predeterminada. Se debe establecer al menos uno de los valores title o content; de lo contrario, se arroja un error INVALID_ARGUMENT.
content

string

El contenido del registro. Está vacío de forma predeterminada. Se debe establecer al menos uno de los valores title o content; de lo contrario, se arroja un error INVALID_ARGUMENT.
score

number

La puntuación de este registro según la consulta determinada y el modelo seleccionado. La puntuación se redondeará a 4 decimales. Si la puntuación está cerca de 0, se redondeará a 0.00001 para evitar que se muestre sin configurar.