Method: projects.locations.rankingConfigs.rank

Ordnet eine Liste von Texteinträgen basierend auf der angegebenen Eingabeanfrage.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
rankingConfig

string

Erforderlich. Der Ressourcenname der Dienstkonfiguration des Rankingdienstes, z. B. projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "model": string,
  "topN": integer,
  "query": string,
  "records": [
    {
      object (RankingRecord)
    }
  ],
  "ignoreRecordDetailsInResponse": boolean,
  "userLabels": {
    string: string,
    ...
  }
}
Felder
model

string

Die ID des zu verwendenden Modells. Der Wert dieses Feldes ist einer der folgenden:

  • semantic-ranker-512@latest: Semantisches Ranking-Modell mit einer maximalen Eingabetokengröße von 512.

Wenn nicht angegeben, wird standardmäßig semantic-ranker-512@latest verwendet.
topN

integer

Die Anzahl der zurückzugebenden Ergebnisse. Wenn dieser Wert nicht festgelegt oder nicht größer als null ist, werden alle Ergebnisse zurückgegeben.
query

string

Die zu verwendende Abfrage.
records[]

object (RankingRecord)

Erforderlich. Eine Liste der zu bewertenden Datensätze.
ignoreRecordDetailsInResponse

boolean

Wenn „true“, enthält die Antwort nur die Datensatz-ID und die Punktzahl. Standardmäßig ist der Wert „false“. Die Antwort enthält dann Datensatzdetails.
userLabels

map (key: string, value: string)

Für die auf Ressourcen angewendeten Nutzerlabels gilt Folgendes:

  • Jede Ressource kann bis zu 64 Labels haben.
  • Jedes Label muss ein Schlüssel/Wert-Paar sein.
  • Schlüssel sind mindestens 1 Zeichen und höchstens 63 Zeichen lang und dürfen nicht leer sein. Die Werte können leer sein und haben eine maximale Länge von 63 Zeichen.
  • Schlüssel und Werte dürfen nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche enthalten. Alle Zeichen müssen UTF-8-codiert sein. Internationale Zeichen sind zulässig.
  • Der Schlüsselabschnitt eines Labels darf nur einmal vorkommen. Sie können jedoch denselben Schlüssel für mehrere Ressourcen verwenden.
  • Schlüssel müssen mit einem Kleinbuchstaben oder einem internationalen Zeichen beginnen.

Weitere Informationen finden Sie im Google Cloud-Dokument.

Antworttext

Antwortnachricht für die Methode RankService.Rank.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
Felder
records[]

object (RankingRecord)

Eine Liste von Einträgen, sortiert nach absteigender Punktzahl.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource rankingConfig:

  • discoveryengine.rankingConfigs.rank

Weitere Informationen finden Sie in der IAM-Dokumentation.

RankingRecord

Eintragsnachricht für die Methode RankService.Rank.

JSON-Darstellung 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
Felder
id

string

Die eindeutige ID des Eintrags.
title

string

Der Titel des Eintrags. Standardmäßig leer. Es muss mindestens title oder content festgelegt werden. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben.
content

string

Der Inhalt des Eintrags. Standardmäßig leer. Es muss mindestens title oder content festgelegt werden. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben.
score

number

Die Punktzahl dieses Eintrags basierend auf der angegebenen Anfrage und dem ausgewählten Modell. Die Punktzahl wird auf 2 Dezimalstellen gerundet. Wenn der Wert nahe 0 liegt, wird er auf 0,0001 gerundet, um zu vermeiden, dass „Nicht festgelegt“ zurückgegeben wird.