SearchSpec

Spesifikasi penelusuran.

Representasi JSON
{

  // Union field input can be only one of the following:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of list of possible types for union field input.
}
Kolom
Kolom union input. Parameter penelusuran untuk mengontrol perilaku penelusuran. Atau berikan daftar hasil penelusuran untuk membuat jawaban. input hanya ada berupa salah satu diantara berikut:
searchParams

object (SearchParams)

Parameter penelusuran.

searchResultList

object (SearchResultList)

Daftar hasil penelusuran.

SearchParams

Parameter penelusuran.

Representasi JSON
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ]
}
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 peningkatan untuk meningkatkan kualitas dokumen tertentu dalam hasil penelusuran yang dapat memengaruhi respons kueri jawaban. Untuk mengetahui informasi selengkapnya tentang promosi, lihat Promosi

orderBy

string

Urutan dokumen yang ditampilkan. Dokumen dapat diurutkan berdasarkan kolom dalam objek Document. Biarkan tidak disetel jika diurutkan berdasarkan relevansi. Ekspresi orderBy 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

dataStoreSpecs[]

object (DataStoreSpec)

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

SearchResultList

Daftar hasil penelusuran.

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

object (SearchResult)

Hasil penelusuran.

SearchResult

Hasil penelusuran.

Representasi JSON
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of list of possible types for union field content.
}
Kolom
Kolom union content. Konten hasil penelusuran. content hanya ada berupa salah satu diantara berikut:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informasi dokumen tidak terstruktur.

chunkInfo

object (ChunkInfo)

Informasi bagian.

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 akan digunakan untuk Pembuatan Jawaban. Bagian ini seharusnya menjadi konten utama dokumen yang bisa panjang dan komprehensif.

extractiveSegments[]

object (ExtractiveSegment)

Daftar segmen ekstraktif.

extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

Tidak digunakan lagi: Kolom ini tidak digunakan lagi dan tidak akan memengaruhi Pembuatan jawaban. 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 pembuatan jawaban.

ExtractiveSegment

Segmen ekstraktif. Panduan Pembuatan jawaban hanya akan menggunakannya jika documentContexts kosong. 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 chunk 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.