SearchSpec

Spesifikasi penelusuran.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of mutually exclusive fields.
}
Kolom
Parameter penelusuran untuk mengontrol perilaku penelusuran. Atau berikan daftar hasil penelusuran untuk membuat jawaban. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
searchParams

object (SearchParams)

Parameter penelusuran.
searchResultList

object (SearchResultList)

Daftar hasil penelusuran.
Akhir kolom yang saling eksklusif.

SearchParams

Parameter penelusuran.

Representasi JSON 
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "customFineTuningSpec": {
    object (CustomFineTuningSpec)
  },
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  }
}
Kolom
maxReturnResults

integer

Jumlah hasil penelusuran yang akan ditampilkan. Nilai defaultnya adalah 10.
filter

string

Sintaksis filter terdiri dari bahasa ekspresi untuk membuat predikat dari satu atau beberapa kolom dokumen yang difilter. Ekspresi filter peka huruf besar/kecil. Hal ini akan digunakan untuk memfilter hasil penelusuran yang dapat memengaruhi respons Jawaban.

Jika kolom ini tidak dapat dikenali, INVALID_ARGUMENT akan ditampilkan.

Pemfilteran di Vertex AI Search dilakukan dengan memetakan kunci filter LHS ke properti kunci yang ditentukan di backend Vertex AI Search -- pemetaan ini ditentukan oleh pelanggan dalam skemanya. Misalnya, pelanggan media mungkin memiliki kolom 'name' dalam skemanya. Dalam hal ini, filter akan terlihat seperti ini: filter --> name:'ANY("king kong")'

Untuk mengetahui informasi selengkapnya tentang pemfilteran, termasuk sintaksis dan operator filter, lihat Filter
boostSpec

object (BoostSpec)

Spesifikasi penguatan untuk menguatkan dokumen tertentu dalam hasil penelusuran yang dapat memengaruhi respons kueri jawaban. Untuk mengetahui informasi selengkapnya tentang penguatan, lihat Penguatan
orderBy

string

Urutan dokumen yang ditampilkan. Dokumen dapat diurutkan berdasarkan kolom dalam objek Document. Biarkan tidak disetel jika diurutkan berdasarkan relevansi. Ekspresi orderBy bersifat peka huruf besar/kecil. Untuk mengetahui informasi selengkapnya tentang pemesanan, lihat Pemesanan

Jika kolom ini tidak dapat dikenali, INVALID_ARGUMENT akan ditampilkan.
searchResultMode

enum (SearchResultMode)

Menentukan mode hasil penelusuran. Jika tidak ditentukan, mode hasil penelusuran ditetapkan ke DOCUMENTS secara default. Lihat mengurai dan memotong dokumen
customFineTuningSpec

object (CustomFineTuningSpec)

Opsional. Konfigurasi penyesuaian kustom.
dataStoreSpecs[]

object (DataStoreSpec)

Spesifikasi yang menentukan dataStore yang akan difilter dalam panggilan penelusuran dan konfigurasi untuk dataStore tersebut. Hal ini hanya dipertimbangkan untuk mesin dengan kasus penggunaan beberapa penyimpanan data. Untuk satu dataStore dalam mesin, mereka harus menggunakan spesifikasi di tingkat teratas.
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

Opsional. Spesifikasi untuk mengaktifkan kemampuan pemahaman bahasa alami untuk permintaan penelusuran.

SearchResultList

Daftar hasil penelusuran.

Representasi JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Kolom
searchResults[]

object (SearchResult)

Hasil penelusuran.

SearchResult

Hasil penelusuran.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of mutually exclusive fields.
}
Kolom
Konten hasil penelusuran. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informasi dokumen tidak terstruktur.
chunkInfo

object (ChunkInfo)

Informasi bagian.
Akhir kolom yang saling eksklusif.

UnstructuredDocumentInfo

Informasi dokumen tidak terstruktur.

Representasi JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
Kolom
document

string

Nama resource dokumen.
uri

string

URI untuk dokumen.
title

string

Judul.
documentContexts[]

object (DocumentContext)

Daftar konteks dokumen. Konten tersebut akan digunakan untuk pembuatan jawaban. Ini seharusnya menjadi isi utama dokumen yang bisa panjang dan komprehensif.
extractiveSegments[]

object (ExtractiveSegment)

Daftar segmen ekstraktif.
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

Tidak digunakan lagi: Kolom ini sudah tidak digunakan lagi dan tidak akan berpengaruh pada pembuatan Jawaban. Harap gunakan kolom documentContexts dan extractiveSegments. Daftar jawaban ekstraktif.

DocumentContext

Konteks dokumen.

Representasi JSON 
{
  "pageIdentifier": string,
  "content": string
}
Kolom
pageIdentifier

string

ID halaman.
content

string

Konten dokumen yang akan digunakan untuk menghasilkan jawaban.

ExtractiveSegment

Segmen ekstraktif. Panduan Pembuatan jawaban hanya akan menggunakannya jika documentContexts kosong. Bagian ini seharusnya berupa cuplikan yang lebih pendek.

Representasi JSON 
{
  "pageIdentifier": string,
  "content": string
}
Kolom
pageIdentifier

string

ID halaman.
content

string

Konten segmen ekstraktif.

ExtractiveAnswer

Jawaban ekstraktif. Panduan

Representasi JSON 
{
  "pageIdentifier": string,
  "content": string
}
Kolom
pageIdentifier

string

ID halaman.
content

string

Konten jawaban ekstraktif.

ChunkInfo

Informasi bagian.

Representasi JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Kolom
chunk

string

Nama resource chunk.
content

string

Mengelompokkan konten tekstual.
documentMetadata

object (DocumentMetadata)

Metadata dokumen dari potongan saat ini.

DocumentMetadata

Metadata dokumen berisi informasi dokumen potongan saat ini.

Representasi JSON 
{
  "uri": string,
  "title": string
}
Kolom
uri

string

URI dokumen.
title

string

Judul dokumen.