Method: projects.locations.rankingConfigs.rank

Classifica un elenco di record di testo in base alla query di input specificata.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
rankingConfig

string

Obbligatorio. Il nome risorsa della configurazione del servizio di ranking, ad esempio projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

string

L'identificatore del modello da utilizzare. È uno dei seguenti:

  • semantic-ranker-512@latest: Modello di ranking semantico con dimensione massima del token di input pari a 512.

Se non specificato, il valore predefinito è semantic-ranker-512@latest.
topN

integer

Il numero di risultati da restituire. Se questo valore non è impostato o non è maggiore di zero, vengono restituiti tutti i risultati.
query

string

La query da utilizzare.
records[]

object (RankingRecord)

Obbligatorio. Un elenco di record da classificare.
ignoreRecordDetailsInResponse

boolean

Se true, la risposta conterrà solo l'ID record e il punteggio. Per impostazione predefinita, è false e la risposta conterrà i dettagli del record.
userLabels

map (key: string, value: string)

Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti:

  • Ogni risorsa può avere più etichette, fino a un massimo di 64.
  • Ogni etichetta deve essere una coppia chiave-valore.
  • Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri.
  • Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali.
  • La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse.
  • Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale.

Per ulteriori dettagli, consulta il documento Google Cloud.

Corpo della risposta

Messaggio di risposta per il metodo RankService.Rank.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
Campi
records[]

object (RankingRecord)

Un elenco di record ordinati per punteggio decrescente.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa rankingConfig:

  • discoveryengine.rankingConfigs.rank

Per saperne di più, consulta la documentazione di IAM.

RankingRecord

Registra un messaggio per il metodo RankService.Rank.

Rappresentazione JSON 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
Campi
id

string

L'ID univoco per rappresentare il record.
title

string

Il titolo del disco. Vuoto per impostazione predefinita. È necessario impostare almeno uno tra title o content, altrimenti viene generato un errore INVALID_ARGUMENT.
content

string

Il contenuto del record. Vuoto per impostazione predefinita. È necessario impostare almeno uno tra title o content, altrimenti viene generato un errore INVALID_ARGUMENT.
score

number

Il punteggio di questo record in base alla query fornita e al modello selezionato. Il punteggio verrà arrotondato a due cifre decimali. Se il punteggio è vicino a 0, verrà arrotondato a 0,0001 per evitare di restituire il valore non impostato.