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 |
To pole jest wymagane. Nazwa elementu |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"query": string,
"resultsCount": integer,
"metadataFilters": [
{
object ( |
Pola | |
---|---|
query |
To pole jest wymagane. Ciąg zapytania służący do wyszukiwania semantycznego. |
resultsCount |
Opcjonalnie. Maksymalna liczba elementów Jeśli wartość ta nie zostanie określona, zwróconych zostanie maksymalnie 10 s ( |
metadataFilters[] |
Opcjonalnie. Użyj filtra, aby wyświetlić metadane Uwaga: filtrowanie na poziomie Przykładowe zapytanie: (rok >= 2020 OR rok < 2010) AND (gatunek = dramat OR gatunek = akcja)
Przykładowe zapytanie o zakres wartości liczbowych: (rok > 2015 ORAZ rok <= 2020)
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 ( |
Pola | |
---|---|
relevantChunks[] |
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.