Method: projects.locations.rankingConfigs.rank

Menentukan peringkat daftar rekaman teks berdasarkan kueri input yang diberikan.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
rankingConfig

string

Wajib diisi. Nama resource konfigurasi layanan peringkat, seperti projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

string

ID model yang akan digunakan. ID model adalah salah satu dari:

  • semantic-ranker-512@latest: Model peringkat semantik dengan ukuran token input maksimum 512.

ID model ditetapkan ke semantic-ranker-512@latest secara default jika tidak ditentukan.
topN

integer

Jumlah hasil yang akan ditampilkan. Jika tidak ditetapkan atau tidak lebih besar dari nol, semua hasil akan ditampilkan.
query

string

Kueri yang akan digunakan.
records[]

object (RankingRecord)

Wajib diisi. Daftar rekaman yang akan diberi peringkat.
ignoreRecordDetailsInResponse

boolean

Jika benar (true), respons hanya akan berisi ID rekaman dan skor. Secara default, nilainya adalah salah (false), respons akan berisi detail rekaman.
userLabels

map (key: string, value: string)

Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut:

  • Setiap resource dapat memiliki beberapa label, hingga maksimum 64.
  • Setiap label harus berupa pasangan nilai kunci.
  • Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter dan tidak boleh kosong. Nilai dapat kosong dan memiliki panjang maksimum 63 karakter.
  • Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda pisah. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan.
  • Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource.
  • Kunci harus diawali dengan huruf kecil atau karakter internasional.

Lihat Dokumen Google Cloud untuk mengetahui detail selengkapnya.

Isi respons

Pesan respons untuk metode RankService.Rank.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
Kolom
records[]

object (RankingRecord)

Daftar rekaman yang diurutkan berdasarkan skor menurun.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource rankingConfig:

  • discoveryengine.rankingConfigs.rank

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

RankingRecord

Pesan rekaman untuk metode RankService.Rank.

Representasi JSON 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
Kolom
id

string

ID unik untuk mewakili rekaman.
title

string

Judul rekaman. Kosong secara default. Setidaknya salah satu dari title atau content harus ditetapkan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
content

string

Konten rekaman. Kosong secara default. Setidaknya salah satu dari title atau content harus ditetapkan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
score

number

Skor rekaman ini berdasarkan kueri yang diberikan dan model yang dipilih. Skor akan dibulatkan ke 4 angka di belakang koma. Jika skor mendekati 0, skor akan dibulatkan menjadi 0,00001 untuk menghindari nilai yang tidak ditetapkan.