Method: corpora.query

Przeprowadza wyszukiwanie semantyczne w polu Corpus.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

To pole jest wymagane. Nazwa elementu Corpus, którego dotyczy zapytanie. Przykład: corpora/my-corpus-123

Treść żądania

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

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

string

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

metadataFilters[]

object (MetadataFilter)

Opcjonalnie. Filtruj według metadanych Chunk i Document. Każdy obiekt MetadataFilter powinien odpowiadać unikalnemu kluczowi. Wiele obiektów MetadataFilter jest połączonych za pomocą operatorów logicznych „AND”.

Przykładowe zapytanie na poziomie dokumentu: (rok >= 2020 LUB rok < 2010) AND (gatunek = dramat LUB gatunek = akcja)

MetadataFilter,object list: MetadataFilters = [ {key = "document.custom_metadata.year" rights = [{int_value = 2020, równość = GREATER_EQUAL}, {int_value = 2010, równość = LESS}]}, {key = "document.custom_metadata.year"warranty = "document.custom_metadata.year" terms = [int_value}.

Przykładowe zapytanie na poziomie fragmentu dla zakresu 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”.

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.

Treść odpowiedzi

Odpowiedź z corpora.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)

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.