Method: projects.locations.rankingConfigs.rank

Classe une liste d'enregistrements de texte en fonction de la requête d'entrée donnée.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
rankingConfig

string

Obligatoire. Nom de ressource de la configuration du service de classement, par exemple projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "model": string,
  "topN": integer,
  "query": string,
  "records": [
    {
      object (RankingRecord)
    }
  ],
  "ignoreRecordDetailsInResponse": boolean,
  "userLabels": {
    string: string,
    ...
  }
}
Champs
model

string

Identifiant du modèle à utiliser. Il s'agit de l'un des éléments suivants :

  • semantic-ranker-512@latest : modèle de classement sémantique avec une taille maximale de jetons d'entrée de 512.

Si aucune valeur n'est spécifiée, la valeur par défaut est semantic-ranker-512@latest.
topN

integer

Nombre de résultats à renvoyer. Si cette valeur n'est pas définie ou n'est pas supérieure à zéro, tous les résultats sont renvoyés.
query

string

Requête à utiliser.
records[]

object (RankingRecord)

Obligatoire. Liste des enregistrements à classer.
ignoreRecordDetailsInResponse

boolean

Si la valeur est "true", la réponse ne contient que l'ID et le score de l'enregistrement. Par défaut, la valeur est "false" et la réponse contient les détails de l'enregistrement.
userLabels

map (key: string, value: string)

Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :

  • Chaque ressource peut posséder plusieurs libellés, jusqu'à un maximum de 64.
  • Chaque étiquette doit correspondre à une paire clé/valeur.
  • Les clés doivent comporter un (1) caractère au minimum et 63 au maximum, et ne peuvent pas être vides. Les valeurs peuvent être vides et comporter 63 caractères au maximum.
  • Les clés et les valeurs ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. Tous les caractères doivent être au format d'encodage UTF-8. Les caractères internationaux sont autorisés.
  • La partie clé d'un libellé doit être unique. Cependant, vous pouvez utiliser la même clé avec plusieurs ressources.
  • Les clés doivent commencer par une lettre minuscule ou un caractère international.

Pour en savoir plus, consultez la documentation Google Cloud.

Corps de la réponse

Message de réponse pour la méthode RankService.Rank.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
Champs
records[]

object (RankingRecord)

Liste des enregistrements triés par score décroissant.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource rankingConfig :

  • discoveryengine.rankingConfigs.rank

Pour en savoir plus, consultez la documentation IAM.

RankingRecord

Message d'enregistrement pour la méthode RankService.Rank.

Représentation JSON 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
Champs
id

string

Identifiant unique représentant l'enregistrement.
title

string

Titre de l'enregistrement. Vide par défaut. Vous devez définir au moins l'une des valeurs title ou content. Sinon, une erreur INVALID_ARGUMENT sera générée.
content

string

Contenu de l'enregistrement. Vide par défaut. Vous devez définir au moins l'une des valeurs title ou content. Sinon, une erreur INVALID_ARGUMENT sera générée.
score

number

Score de cet enregistrement en fonction de la requête donnée et du modèle sélectionné. Le score sera arrondi à deux décimales. Si le score est proche de 0, il est arrondi à 0,0001 pour éviter de renvoyer une valeur non définie.