Method: corpora.documents.query

Document üzerinden anlamsal arama gerçekleştirir.

HTTP isteği

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

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

Yol parametreleri

Parametreler
name

string

Zorunlu. Sorgulanacak Document öğesinin adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc

İstek içeriği

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

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

string

Zorunlu. Anlamsal arama yapmak için sorgu dizesi.
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.
metadataFilters[]

object (MetadataFilter)

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

Not: Zaten bir Document adı belirtildiğinden bu istek için Document düzeyinde filtreleme desteklenmiyor.

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

MetadataFilter nesne listesi: metaveri filtreleri = [ {key = "chunk.custom_metadata.year" koşullar = [{int_value = 2020, transaction = GREATER_EQUAL}, {int_value = 2010, transaction = LESS}}, {key = "chunk.custom_metadata.year" condition = "chunk.custom_metadata.year", işlem "chunk.custom_metadata.genre" Value

Sayısal değer aralığı için ö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.

Yanıt gövdesi

İlgili parçaların listesini içeren documents.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)

Döndürülen ilgili gruplar.

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.