Method: projects.locations.rankingConfigs.rank

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

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
rankingConfig

string

Obligatorio. Es 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

Es el identificador del modelo que se usará. Puede ser uno de los siguientes:

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

Si no se especifica, el valor predeterminado es semantic-ranker-512@latest.
topN

integer

Es la cantidad de resultados que se devolverán. Si no se configura o no es mayor que cero, se devuelven todos los resultados.
query

string

Es la consulta que se usará.
records[]

object (RankingRecord)

Obligatorio. Es una lista de registros que se deben clasificar.
ignoreRecordDetailsInResponse

boolean

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

map (key: string, value: string)

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

  • Cada recurso puede tener varias etiquetas, hasta 64.
  • Cada etiqueta debe ser un par clave-valor.
  • Las claves deben tener 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 su longitud máxima es de 63 caracteres.
  • Las claves y los valores solo pueden contener letras en minúscula, números, 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 en varios recursos.
  • Las claves deben comenzar con una letra en minúscula o un carácter internacional.

Consulta Google Cloud Document 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)

Es 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

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

Es el ID único que representa el registro.
title

string

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

string

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

number

Es la puntuación de este registro según la búsqueda determinada y el modelo seleccionado. La puntuación se redondeará a 2 decimales. Si la puntuación se acerca a 0, se redondeará a 0.0001 para evitar que se muestre como no establecida.