Method: corpora.documents.query

Przeprowadza wyszukiwanie semantyczne w polu Document.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

To pole jest wymagane. Nazwa elementu Document, którego dotyczy zapytanie. Przykład: corpora/my-corpus-123/documents/the-doc-abc

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

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

string

To pole jest wymagane. Ciąg zapytania służący do wyszukiwania semantycznego.

resultsCount

integer

Opcjonalnie. Maksymalna liczba elementów Chunk do zwrócenia. Usługa może zwrócić mniej Chunk.

Jeśli wartość ta nie zostanie określona, zwróconych zostanie maksymalnie 10 s (Chunk). Maksymalna określona liczba wyników to 100.

metadataFilters[]

object (MetadataFilter)

Opcjonalnie. Użyj filtra, aby wyświetlić metadane Chunk. Każdy obiekt MetadataFilter powinien odpowiadać unikalnemu kluczowi. Wiele obiektów MetadataFilter jest połączonych za pomocą operatorów logicznych „AND”.

Uwaga: filtrowanie na poziomie Document nie jest obsługiwane w przypadku tego żądania, ponieważ nazwa Document została już określona.

Przykładowe zapytanie: (rok >= 2020 OR rok < 2010) AND (gatunek = dramat OR gatunek = akcja)

MetadataFilter Object list: metadataFilters = [ {key = "chunk.custom_metadata.year" środek = [{int_value = 2020, Ta operacja = GREATER_EQUAL}, {int_value = 2010, Operacja = LESS}}, {key = "chunk.custom_metadata.year" środek = ["string.custom_metadata.genre" terms = [{string}

Przykładowe zapytanie o zakres wartości liczbowych: (rok > 2015 ORAZ rok <= 2020)

MetadataFilter Object list: metadataFilters = [ {key = "chunk.custom_metadata.year" środek = [{int_value = 2015, actions = GREATER}]}, {key = "chunk.custom_metadata.year" rights = [{int_value = 2020, operator = LESS_EQUAL}]}]

Uwaga: operatory „AND” dla tego samego klucza są obsługiwane tylko w przypadku wartości liczbowych. W przypadku tego samego klucza ciąg znaków obsługują tylko operatory „LUB”.

Treść odpowiedzi

Odpowiedź z documents.query zawierająca listę odpowiednich fragmentów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
Pola
relevantChunks[]

object (RelevantChunk)

Zwrócono odpowiednie fragmenty.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.