REST Resource: projects.locations.collections.engines.servingConfigs

Resource: ServingConfig

Mengonfigurasi metadata yang digunakan untuk menghasilkan hasil waktu penayangan (misalnya, hasil penelusuran atau prediksi rekomendasi). ServingConfig diteruskan dalam permintaan penelusuran dan prediksi serta menghasilkan hasil.

Representasi JSON
{
  "name": string,
  "displayName": string,
  "solutionType": enum (SolutionType),
  "modelId": string,
  "diversityLevel": string,
  "embeddingConfig": {
    object (EmbeddingConfig)
  },
  "rankingExpression": string,
  "createTime": string,
  "updateTime": string,
  "filterControlIds": [
    string
  ],
  "boostControlIds": [
    string
  ],
  "redirectControlIds": [
    string
  ],
  "synonymsControlIds": [
    string
  ],
  "onewaySynonymsControlIds": [
    string
  ],
  "dissociateControlIds": [
    string
  ],
  "replacementControlIds": [
    string
  ],
  "ignoreControlIds": [
    string
  ],
  "promoteControlIds": [
    string
  ],
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },

  // Union field vertical_config can be only one of the following:
  "mediaConfig": {
    object (MediaConfig)
  },
  "genericConfig": {
    object (GenericConfig)
  }
  // End of list of possible types for union field vertical_config.
}
Kolom
name

string

Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}/servingConfigs/{servingConfigId}

displayName

string

Wajib. Nama tampilan konfigurasi penayangan yang dapat dibaca manusia. Digunakan di UI Discovery.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

solutionType

enum (SolutionType)

Wajib. Tidak dapat diubah. Menentukan jenis solusi yang dapat dikaitkan dengan konfigurasi penayangan.

modelId

string

ID model yang akan digunakan pada waktu penyaluran. Saat ini hanya RecommendationModel yang didukung. Dapat diubah, tetapi hanya ke model yang kompatibel (misalnya, CTR "mungkin Anda suka" ke CVR "mungkin Anda suka").

Wajib jika SolutionType adalah SOLUTION_TYPE_RECOMMENDATION.

diversityLevel

string

Seberapa banyak keragaman yang akan digunakan dalam hasil model rekomendasi, misalnya medium-diversity atau high-diversity. Nilai yang saat ini didukung:

  • no-diversity
  • low-diversity
  • medium-diversity
  • high-diversity
  • auto-diversity

Jika tidak ditentukan, kami akan memilih default berdasarkan jenis model rekomendasi. Nilai default: no-diversity.

Hanya dapat disetel jika SolutionType adalah SOLUTION_TYPE_RECOMMENDATION.

embeddingConfig

object (EmbeddingConfig)

Gunakan konfigurasi penyematan Anda sendiri. Konfigurasi ini digunakan untuk pengambilan semantik penelusuran. Pengambilan didasarkan pada produk titik SearchRequest.EmbeddingSpec.EmbeddingVector.vector dan penyematan dokumen yang disediakan oleh EmbeddingConfig ini. Jika SearchRequest.EmbeddingSpec.EmbeddingVector.vector diberikan, SearchRequest.EmbeddingSpec.EmbeddingVector.vector akan menggantikan ServingConfig.embedding_config ini.

rankingExpression

string

Ekspresi peringkat mengontrol peringkat yang disesuaikan pada dokumen pengambilan. Untuk memanfaatkannya, penyematan dokumen diperlukan. Setelan ekspresi peringkat di ServingConfig berlaku untuk semua permintaan penelusuran yang ditayangkan oleh konfigurasi penayangan. Namun, jika SearchRequest.ranking_expression ditentukan, SearchRequest.ranking_expression akan menggantikan ekspresi peringkat ServingConfig.

Ekspresi peringkat adalah satu fungsi atau beberapa fungsi yang digabungkan dengan "+".

  • rankingExpression = function, { " + ", function };

Fungsi yang didukung:

  • double * relevanceScore
  • double * dotProduct(embedding_field_path)

Variabel fungsi:

  • relevanceScore: kata kunci yang telah ditentukan sebelumnya, digunakan untuk mengukur relevansi antara kueri dan dokumen.
  • embedding_field_path: kolom embedding dokumen yang digunakan dengan vektor embedding kueri.
  • dotProduct: fungsi embedding antara embedding_field_path dan vektor embedding kueri.

Contoh ekspresi peringkat:

Jika dokumen memiliki kolom penyematan doc_embedding, ekspresi peringkatnya bisa berupa 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding).

createTime

string (Timestamp format)

Hanya output. Stempel waktu pembuatan ServingConfig.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Hanya output. Stempel waktu ServingConfig diperbarui.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

filterControlIds[]

string

Kontrol filter yang akan digunakan di jalur penayangan. Semua kontrol filter yang dipicu akan diterapkan. Kontrol filter harus berada di penyimpanan data yang sama dengan konfigurasi penayangan. Maksimum 20 kontrol filter.

boostControlIds[]

string

Kontrol peningkat untuk digunakan di jalur penayangan. Semua kontrol peningkat yang dipicu akan diterapkan. Kontrol peningkat harus berada di penyimpanan data yang sama dengan konfigurasi penayangan. Maksimum 20 kontrol peningkat.

redirectControlIds[]

string

ID kontrol pengalihan. Hanya tindakan pengalihan yang dipicu pertama yang diterapkan, meskipun ada beberapa tindakan. Jumlah maksimum spesifikasi adalah 100.

Hanya dapat disetel jika SolutionType adalah SOLUTION_TYPE_SEARCH.

synonymsControlIds[]

string

Spesifikasi sinonim kondisi. Jika beberapa kondisi sinonim cocok, semua kontrol sinonim yang cocok dalam daftar akan dieksekusi. Jumlah maksimum spesifikasi adalah 100.

Hanya dapat disetel jika SolutionType adalah SOLUTION_TYPE_SEARCH.

onewaySynonymsControlIds[]

string

Kondisi spesifikasi sinonim satu arah. Jika beberapa kondisi sinonim satu arah cocok, semua kontrol sinonim satu arah yang cocok dalam daftar akan dieksekusi. Jumlah maksimum spesifikasi adalah 100.

Hanya dapat disetel jika SolutionType adalah SOLUTION_TYPE_SEARCH.

dissociateControlIds[]

string

Kondisi tidak mengaitkan spesifikasi. Jika beberapa kondisi jangan kaitkan cocok, semua kontrol jangan kaitkan yang cocok dalam daftar akan dieksekusi. Urutan tidak menjadi masalah. Jumlah maksimum spesifikasi adalah 100.

Hanya dapat disetel jika SolutionType adalah SOLUTION_TYPE_SEARCH.

replacementControlIds[]

string

Spesifikasi penggantian kondisi. Diterapkan sesuai urutan dalam daftar. Istilah yang sebelumnya diganti tidak dapat diganti lagi. Jumlah maksimum spesifikasi adalah 100.

Hanya dapat disetel jika SolutionType adalah SOLUTION_TYPE_SEARCH.

ignoreControlIds[]

string

Spesifikasi pengabaian kondisi. Jika beberapa kondisi pengabaian cocok, semua kontrol pengabaian yang cocok dalam daftar akan dieksekusi. Urutan tidak menjadi masalah. Jumlah maksimum spesifikasi adalah 100.

promoteControlIds[]

string

Spesifikasi promosi kondisi.

Jumlah maksimum spesifikasi adalah 100.

personalizationSpec

object (PersonalizationSpec)

Spesifikasi untuk spesifikasi personalisasi.

Perhatikan bahwa jika ServingConfig.personalization_spec dan SearchRequest.personalization_spec ditetapkan, SearchRequest.personalization_spec akan menggantikan ServingConfig.personalization_spec.

answerGenerationSpec

object (AnswerGenerationSpec)

Opsional. Spesifikasi untuk pembuatan jawaban.

Kolom union vertical_config. Konfigurasi khusus vertical industri. vertical_config hanya ada berupa salah satu diantara berikut:
mediaConfig

object (MediaConfig)

MediaConfig dari konfigurasi penayangan.

genericConfig

object (GenericConfig)

GenericConfig dari konfigurasi inferensi.

Metode

answer

Metode kueri jawaban.

get

Mendapatkan ServingConfig.

list

Mencantumkan semua ServingConfig yang ditautkan ke dataStore ini.

patch

Mengupdate ServingConfig.

recommend

Membuat rekomendasi, yang memerlukan peristiwa pengguna kontekstual.
Melakukan penelusuran.

searchLite

Melakukan penelusuran.

streamAnswer

Metode kueri jawaban (streaming).