Documents

Interfejs File Search API odwołuje się do Twoich surowych plików źródłowych lub dokumentów jako tymczasowych obiektów File.

Metoda: fileSearchStores.documents.delete

Usuwa Document.

Punkt końcowy

delete https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}

Parametry ścieżki

name string

Wymagane. Nazwa zasobu Document, który chcesz usunąć. Przykład: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Ma on postać fileSearchStores/{filesearchstore}/documents/{document}.

Parametry zapytania

force boolean

Opcjonalnie: Jeśli ta wartość jest ustawiona na „true”, wszystkie Chunk i obiekty powiązane z tym Document również zostaną usunięte.

Jeśli ma wartość false (domyślną), zwracany jest błąd FAILED_PRECONDITION, jeśli Document zawiera jakiekolwiek znaki Chunk.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pustym obiektem JSON.

Metoda: fileSearchStores.documents.get

Pobiera informacje o konkretnym Document.

Punkt końcowy

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}

Parametry ścieżki

name string

Wymagane. Nazwa Document do pobrania. Przykład: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Ma on postać fileSearchStores/{filesearchstore}/documents/{document}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Document.

Metoda: fileSearchStores.documents.list

Wyświetla listę wszystkich Document w Corpus.

Punkt końcowy

get https://generativelanguage.googleapis.com/v1beta/{parent=fileSearchStores/*}/documents

Parametry ścieżki

parent string

Wymagane. Nazwa FileSearchStore zawierającego Document. Przykład: fileSearchStores/my-file-search-store-123 Ma on postać fileSearchStores/{filesearchstore}.

Parametry zapytania

pageSize integer

Opcjonalnie: Maksymalna liczba zwracanych Document (na stronę). Usługa może zwrócić mniej Document.

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 10 Document. Maksymalny limit rozmiaru to 20 Document na stronę.

pageToken string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania documents.list.

Podaj token nextPageToken zwrócony w odpowiedzi jako argument następnego żądania, aby pobrać następną stronę.

Podczas paginacji wszystkie inne parametry przekazane do funkcji documents.list muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z usługi documents.list zawierająca podzieloną na strony listę Document. Document są posortowane rosnąco według kolumny document.create_time.

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

Pola
documents[] object (Document)

Zwrócone Document.

nextPageToken string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zapis JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Metoda: fileSearchStores.documents.query

Przeprowadza wyszukiwanie semantyczne w Document.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}:query

Parametry ścieżki

name string

Wymagane. Nazwa Document, której ma dotyczyć zapytanie. Przykład: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Ma on postać fileSearchStores/{filesearchstore}/documents/{document}.

Treść żądania

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

Pola
query string

Wymagane. Ciąg zapytania do przeprowadzenia wyszukiwania semantycznego.

resultsCount integer

Opcjonalnie: Maksymalna liczba zwracanych Chunk. Usługa może zwrócić mniej Chunk.

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 10 Chunk. Maksymalna liczba określonych wyników to 100.

metadataFilters[] object (MetadataFilter)

Opcjonalnie: Filtruj według metadanych Chunk. Każdy obiekt MetadataFilter powinien odpowiadać unikalnemu kluczowi. Wiele obiektów MetadataFilter jest połączonych za pomocą operatora logicznego „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: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

Przykładowe zapytanie dotyczące zakresu wartości liczbowych: (year > 2015 AND year <= 2020)

MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Uwaga: operatory „AND” dla tego samego klucza są obsługiwane tylko w przypadku wartości liczbowych. Wartości ciągu obsługują tylko warunki „LUB” dla tego samego klucza.

Treść odpowiedzi

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

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

Pola
relevantChunks[] object (RelevantChunk)

Zwrócone odpowiednie fragmenty.

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

Zasób REST: fileSearchStores.documents

Zasób: Document

Document to zbiór Chunk.

Pola
name string

Niezmienne. Identyfikator. Nazwa zasobu Document. Identyfikator (nazwa bez prefiksu „fileSearchStores/*/documents/”) może zawierać maksymalnie 40 znaków, które są małymi literami, cyframi lub myślnikami (-). Identyfikator nie może zaczynać się ani kończyć myślnikiem. Jeśli nazwa jest pusta podczas tworzenia, unikalna nazwa zostanie utworzona na podstawie displayName wraz z 12-znakowym losowym sufiksem. Przykład: fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c

displayName string

Opcjonalnie: Czytelna nazwa wyświetlana dla Document. Wyświetlana nazwa nie może mieć więcej niż 512 znaków, w tym spacji. Przykład: „Dokumentacja wyszukiwarki semantycznej”

customMetadata[] object (CustomMetadata)

Opcjonalnie: Zdefiniowane przez użytkownika metadane niestandardowe przechowywane w postaci par klucz-wartość, które są używane do wysyłania zapytań. Document może mieć maksymalnie 20 CustomMetadata.

updateTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji Document.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

createTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia Document.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

state enum (State)

Tylko dane wyjściowe. Obecny stan Document.

sizeBytes string (int64 format)

Tylko dane wyjściowe. Rozmiar surowych bajtów wczytanych do dokumentu.

mimeType string

Tylko dane wyjściowe. Typ MIME dokumentu.

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

Stan

Stany cyklu życia Document.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna. Ta wartość jest używana, jeśli stan jest pominięty.
STATE_PENDING Trwa przetwarzanie niektórych Chunks z Document (osadzanie i przechowywanie wektorów).
STATE_ACTIVE Wszystkie Chunks w Document są przetwarzane i dostępne do wysyłania zapytań.
STATE_FAILED Nie udało się przetworzyć niektórych Chunks z Document.