Method: corpora.query

Corpus üzerinden anlamsal arama gerçekleştirir.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
name

string

Zorunlu. Sorgulanacak Corpus öğesinin adı. Örnek: corpora/my-corpus-123

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:

JSON gösterimi 
{
  "query": string,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "resultsCount": integer
}
Alanlar
query

string

Zorunlu. Anlamsal arama yapmak için sorgu dizesi.
metadataFilters[]

object (MetadataFilter)

İsteğe bağlı. Chunk ve Document meta verileri için filtreleyin. Her MetadataFilter nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter nesnesi, mantıksal "AND"lerle birleştirilir.

Belge düzeyinde örnek sorgu: (yıl >= 2020 VEYA yıl < 2010) AND (tür = drama VEYA tür = aksiyon)

MetadataFilter nesne listesi: meta veri filtreleri = [ {key = "document.custom_metadata.year" koşulları = [{int_value = 2020, transaction = GREATER_EQUAL}, {int_value = 2010, transaction = LESS}]}, {key = "document.custom_metadata.year" {key = "document.custom_metadata.year" koşulları

Sayısal bir değer aralığı için yığın düzeyinde örnek sorgu: (yıl > 2015 VE yıl <= 2020)

MetadataFilter nesne listesi: metaveri filtreleri = [ {key = "chunk.custom_metadata.year" koşulları = [{int_value = 2015, transaction = GREATER}]}, {key = "chunk.custom_metadata.year" koşulları = [{int_value = 2020, işlem = LESS_EQUAL}]

Not: Aynı anahtar için "AND" (VE) değerleri yalnızca sayısal değerler için desteklenir. Dize değerleri yalnızca aynı anahtar için "VEYA" işaretlerini destekler.
resultsCount

integer

İsteğe bağlı. Döndürülecek maksimum Chunk sayısı. Hizmet daha az Chunk döndürebilir.

Belirtilmemişse en fazla 10 Chunk döndürülür. Belirtilen maksimum sonuç sayısı 100'dür.

Yanıt gövdesi

İlgili parçaların listesini içeren corpora.query yanıtı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
Alanlar
relevantChunks[]

object (RelevantChunk)

İlgili parçalar.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.