Method: corpora.query

Melakukan penelusuran semantik melalui Corpus.

Permintaan HTTP

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama Corpus untuk kueri. Contoh: corpora/my-corpus-123

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "query": string,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "resultsCount": integer
}
Kolom
query

string

Wajib. String kueri untuk melakukan penelusuran semantik.
metadataFilters[]

object (MetadataFilter)

Opsional. Filter untuk metadata Chunk dan Document. Setiap objek MetadataFilter harus sesuai dengan kunci unik. Beberapa objek MetadataFilter digabungkan dengan "AND" yang logis.

Contoh kueri di level dokumen: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadataFilters = [ {key = "document.custom_metadata.year" Conditions = [{int_value = 2020, Operations = GREATER_EQUAL}, {int_value = 2010, Operations = LESS}]}, {key = "document.custom_metadata.year" Conditions = [{int_value = EQUAL_value} = 2

Contoh kueri pada tingkat potongan untuk rentang nilai numerik: (year > 2015 AND year <= 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.
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.

Isi respons

Respons dari corpora.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.

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.