Kirim masukan
Method: corpora.documents.query
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Melakukan penelusuran semantik melalui Document
.
Permintaan HTTP
POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
URL menggunakan sintaksis gRPC Transcoding .
Parameter jalur
Parameter
name
string
Wajib. Nama Document
untuk kueri. Contoh: corpora/my-corpus-123/documents/the-doc-abc
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON
{
"query" : string ,
"resultsCount" : integer ,
"metadataFilters" : [
{
object (MetadataFilter
)
}
]
}
Kolom
query
string
Wajib. String kueri untuk melakukan penelusuran semantik.
resultsCount
integer
Opsional. Jumlah maksimum Chunk
untuk ditampilkan. Layanan mungkin menampilkan lebih sedikit Chunk
.
Jika tidak ditentukan, maksimal 10 Chunk
akan ditampilkan. Jumlah hasil maksimum yang ditentukan adalah 100.
metadataFilters[]
object (MetadataFilter
)
Opsional. Filter untuk metadata Chunk
. Setiap objek MetadataFilter
harus sesuai dengan kunci unik. Beberapa objek MetadataFilter
digabungkan dengan "AND" yang logis.
Catatan: Pemfilteran tingkat Document
tidak didukung untuk permintaan ini karena nama Document
sudah ditentukan.
Contoh kueri: (year >= 2020 OR year < 2010) AND (genre = drama ATAU genre = action)
MetadataFilter
daftar objek: metadataFilters = [ {key = "chunk.custom_metadata.year" Conditions = [{int_value = 2020, Operations = GREATER_EQUAL}, {int_value = 2010, Operations = LESS}}, {key = "chunk.custom_metadata.genre" Conditions = [{stringValueUAL EQ = "dramaValue}},
Contoh kueri untuk rentang nilai numerik: (tahun > 2015 DAN tahun <= 2020)
Daftar objek MetadataFilter
: metadataFilters = [ {key = "chunk.custom_metadata.year" Conditions = [{int_value = 2015, Operations = GREATER}]}, {key = "chunk.custom_metadata.year" Conditions = [{int_value = 2020, Operations = LESS_EQUAL}]}]
Catatan: "AND" untuk kunci yang sama hanya didukung untuk nilai numerik. Nilai string hanya mendukung "OR" untuk kunci yang sama.
Isi respons
Respons dari documents.query
yang berisi daftar potongan yang relevan.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON
{
"relevantChunks" : [
{
object (RelevantChunk
)
}
]
}
Kolom
relevantChunks[]
object (RelevantChunk
)
Potongan yang relevan ditampilkan.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
Untuk informasi selengkapnya, lihat Ringkasan Autentikasi .
Kirim masukan
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0 , sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0 . Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers . Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-06-25 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Informasi yang saya butuhkan tidak ada"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Terlalu rumit/langkahnya terlalu banyak"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Sudah usang"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"Masalah terjemahan"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Masalah kode / contoh"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Lainnya"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Mudah dipahami"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Memecahkan masalah saya"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Lainnya"
}]
Ada masukan untuk kami?