Menelusuri Dokumen dari satu DataStore.
Menampilkan segmen sub-dokumen yang diberi peringkat, yang masing-masing merujuk kembali ke Dokumen asalnya dan membawa asal-usul yang diperlukan untuk mengutipnya.
Permintaan HTTP
POST https://vectorsearch.googleapis.com/v1beta/{parent}/documents:search
Parameter jalur
| Parameter | |
|---|---|
parent |
Wajib. DataStore yang akan ditelusuri. Format: |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
| Representasi JSON |
|---|
{ "topK": integer, "documentIds": [ string ], "rankingSpec": { object ( |
| Kolom | |
|---|---|
topK |
Opsional. Jumlah hasil yang akan ditampilkan. Setelan defaultnya adalah 10. Nilai di atas 100 akan diubah menjadi 100. |
documentIds[] |
Opsional. Membatasi penelusuran ke ID Dokumen ini. Maks. 100. Jika kosong, seluruh DataStore akan ditelusuri. |
rankingSpec |
Opsional. Mengontrol cara hasil diberi peringkat. |
filter |
Opsional. Membatasi penelusuran ke segmen yang cocok dengan filter ini, objek JSON di jalur kolom
Perbandingan: {"$and": [{"metadata.year": {"$gte": 2025}}, {"unstructured_details.page_range.start_page": {"$lte": 20}}]} |
outputFields |
Opsional. Kolom yang akan ditampilkan pada setiap hasil. |
| Wajib. Kueri yang akan ditelusuri. Tepatnya satu jenis kueri yang harus ditetapkan. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
textQuery |
Kueri teks. |
| Akhir kolom yang saling eksklusif. | |
Isi respons
Pesan respons untuk DocumentSearchService.SearchDocuments.
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
|---|
{ "results": [ { object ( |
| Kolom | |
|---|---|
results[] |
Hanya output. Segmen dokumen yang cocok dengan kriteria penelusuran, diurutkan berdasarkan relevansi. |
warnings[] |
Hanya output. Peringatan atau error tidak fatal yang terjadi selama eksekusi. |
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/vectorsearchhttps://www.googleapis.com/auth/vectorsearch.readonly
Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
TextQuery
Kueri teks.
| Representasi JSON |
|---|
{ "text": string } |
| Kolom | |
|---|---|
text |
Wajib. Teks yang akan ditelusuri. |
RankingSpec
Mengontrol cara hasil diberi peringkat.
| Representasi JSON |
|---|
{
"rerankingSpec": {
object ( |
| Kolom | |
|---|---|
rerankingSpec |
Opsional. Mengontrol tahap pemeringkatan ulang. |
RerankingSpec
Konfigurasi untuk pemeringkatan ulang semantik yang diterapkan ke hasil kandidat setelah pengambilan campuran dan Reciprocal Rank Fusion (RRF).
| Representasi JSON |
|---|
{ "enabled": boolean, "rankOversamplingFactor": integer } |
| Kolom | |
|---|---|
enabled |
Opsional. Apakah akan melakukan pemeringkatan ulang pada hasil gabungan. Defaultnya adalah false: hasil ditampilkan dalam urutan gabungan RRF, kecuali jika pemanggil memilih untuk mengaktifkannya. Jika diaktifkan, pemeringkatan ulang akan menggunakan Tidak didukung untuk DataStore |
rankOversamplingFactor |
Opsional. Faktor untuk melakukan oversampling kandidat sebelum pemeringkatan ulang. Jumlah total kandidat yang diambil untuk pemeringkatan ulang adalah Diabaikan kecuali jika Untuk memberi peringkat ulang tanpa oversampling, tetapkan kolom ini ke 1. |
OutputFields
Kolom yang akan ditampilkan pada setiap DocumentSearchResult, selain yang dibawa oleh setiap hasil.
| Representasi JSON |
|---|
{ "metadata": [ string ] } |
| Kolom | |
|---|---|
metadata[] |
Opsional. Properti metadata yang akan ditampilkan di |
DocumentSearchResult
Satu segmen Dokumen yang cocok.
| Representasi JSON |
|---|
{ "document": { object ( |
| Kolom | |
|---|---|
document |
Hanya output. Dokumen asal segmen ini, termasuk nama resource-nya dan lokasi Cloud Storage tempat segmen tersebut diserap. Perhatikan bahwa tidak semua kolom Dokumen diisi. Untuk Dokumen lengkap, panggil documents.get pada nama dokumen yang ditampilkan. |
Detail tempat segmen berada dalam Dokumennya. Kolom yang ditetapkan mengikuti document_type DataStore induk. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: |
|
videoDetails |
Ditetapkan saat |
unstructuredDetails |
Ditetapkan saat |
| Akhir kolom yang saling eksklusif. | |
VideoSegmentDetails
Menemukan segmen dalam Dokumen video.
| Representasi JSON |
|---|
{ "startOffset": string, "endOffset": string } |
| Kolom | |
|---|---|
startOffset |
Hanya output. Tempat segmen ini dimulai, relatif terhadap awal video sumber. Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan ' |
endOffset |
Hanya output. Tempat segmen ini berakhir, relatif terhadap awal video sumber. Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan ' |
UnstructuredSegmentDetails
Menemukan segmen dalam Dokumen tidak terstruktur, dan membawa teksnya.
| Representasi JSON |
|---|
{
"contentSnippet": string,
"pageRange": {
object ( |
| Kolom | |
|---|---|
contentSnippet |
Hanya output. Konten teks segmen. |
pageRange |
Hanya output. Tempat segmen berada dalam dokumen sumber. Ditetapkan untuk file PDF, PowerPoint, dan Excel, dengan halaman berupa halaman PDF, slide, atau sheet. Untuk file HTML, teks biasa, Markdown, JSON, XML, dan Word, tetapkan hanya jika file dibagi menjadi beberapa halaman ( |
PageRange
Rentang halaman dalam dokumen sumber. Halaman berbasis 1 dan rentangnya inklusif; satu halaman direpresentasikan sebagai startPage == endPage.
| Representasi JSON |
|---|
{ "startPage": string, "endPage": string } |
| Kolom | |
|---|---|
startPage |
Hanya output. Halaman pertama rentang. |
endPage |
Hanya output. Halaman terakhir rentang. |