Docuents

Zasób REST: corpora.documents

Zasób: Document

Element Document to zbiór elementów Chunk. Element Corpus może mieć maksymalnie 10 000 elementów Document.

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Pola
name string

Stała. Identyfikator. Nazwa zasobu Document. Identyfikator (nazwa bez prefiksu „korpus/*/dokumenty/”) może zawierać do 40 znaków (małych liter i myślników (-)). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa będzie pusta, zostanie ona pobrana z displayName i dodany 12-znakowy losowy sufiks. Przykład: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

Opcjonalnie: Zrozumiała dla człowieka wyświetlana nazwa elementu Document. Wyświetlana nazwa może mieć maksymalnie 512 znaków łącznie ze spacjami. Przykład: „Dokumentacja semantycznego narzędzia do pobierania”

customMetadata[] object (CustomMetadata)

Opcjonalnie: Podane przez użytkownika niestandardowe metadane przechowywane jako pary klucz-wartość używane do zapytań. W elemencie Document może być maksymalnie 20 elementów CustomMetadata.

updateTime string (Timestamp format)

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

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

createTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia elementu Document.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Metoda: corpora.documents.create

Tworzy pusty element Document.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
.

Parametry ścieżki

parent string

Wymagane. Nazwa jednostki Corpus, w której zostanie utworzony element Document. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Treść żądania

Treść żądania zawiera wystąpienie elementu Document.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowo utworzoną instancję Document.

Metoda: corpora.documents.list

Zawiera listę wszystkich elementów Document w elemencie Corpus.

Punkt końcowy

pobierz https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
.

Parametry ścieżki

parent string

Wymagane. Nazwa elementu Corpus zawierającego elementy Document. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Parametry zapytania

pageSize integer

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

Jeśli nie określono inaczej, zwróconych zostanie maksymalnie 10 elementów Document. Maksymalny rozmiar pliku to 20 Document na stronę.

pageToken string

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

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

Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu documents.list muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź od użytkownika documents.list zawierająca podzielona na strony listę elementów Document. Elementy typu Document są posortowane rosnąco według wartości document.create_time.

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

Pola
documents[] object (Document)

Zwrócone elementy Document.

nextPageToken string

Token, który może zostać wysłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie więcej stron.

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

Metoda: corpora.documents.query

Przeprowadza wyszukiwanie semantyczne w elemencie Document.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa elementu Document, którego ma dotyczyć zapytanie. Przykład: corpora/my-corpus-123/documents/the-doc-abc przybiera postać corpora/{corpora}/documents/{document}.

Treść żądania

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

Pola
query string

Wymagane. Ciąg zapytania używany do wyszukiwania semantycznego.

resultsCount integer

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

Jeśli nie określono inaczej, zwróconych zostanie maksymalnie 10 elementów Chunk. Maksymalna określona liczba 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 warunkiem logicznym „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)

Lista obiektów MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" warunki = [{int_value = 2020, Operations = GREATER_EQUAL}, {int_value = 2010, actions = MNIEJ}}, {klucz = "chunk.custom_metadata.genre" warunki = [{stringValue = "dramat", Operation = RÓWNOW.}, {stringValue = "działanie", operacja = EQUAL}}]

Przykład zapytania dla liczbowego zakresu wartości: (rok > 2015 ORAZ rok <= 2020)

Lista obiektów MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; warunki = [{int_value = 2020, action = LESS_EQUAL}]}]

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

Treść odpowiedzi

Odpowiedź od: 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)
    }
  ]
}

Metoda: corpora.documents.get

Pobiera informacje na temat: Document.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa elementu Document do pobrania. Przykład: corpora/my-corpus-123/documents/the-doc-abc przybiera postać corpora/{corpora}/documents/{document}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Metoda: corpora.documents.patch

Aktualizuje Document.

Punkt końcowy

poprawka https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

Parametry ścieżki

document.name string

Stała. Identyfikator. Nazwa zasobu Document. Identyfikator (nazwa bez prefiksu „korpus/*/dokumenty/”) może zawierać do 40 znaków (małych liter i myślników (-)). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa będzie pusta, zostanie ona pobrana z displayName i dodany 12-znakowy losowy sufiks. Przykład: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c przybiera postać corpora/{corpora}/documents/{document}.

Parametry zapytania

updateMask string (FieldMask format)

Wymagane. Lista pól do zaktualizowania. Obecnie dotyczy to tylko aktualizacji displayName i customMetadata.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera wystąpienie elementu Document.

Treść odpowiedzi

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

Metoda: corpora.documents.delete

Usuwa element Document.

Punkt końcowy

usuń https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}
.

Parametry ścieżki

name string

Wymagane. Nazwa zasobu Document do usunięcia. Przykład: corpora/my-corpus-123/documents/the-doc-abc przybiera postać corpora/{corpora}/documents/{document}.

Parametry zapytania

force boolean

Opcjonalnie: Jeśli ma wartość Prawda, wszystkie elementy Chunk i obiekty powiązane z tym elementem Document również zostaną usunięte.

Jeśli zasada ma wartość fałsz (domyślna), a pole Document zawiera wartości Chunk, zwracany jest błąd FAILED_PRECONDITION.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pusta.

CustomMetadata

Metadane dostarczone przez użytkownika przechowywane jako pary klucz-wartość.

Zapis JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
Pola
key string

Wymagane. Klucz metadanych do przechowywania.

Pole sumy value.

value może mieć tylko jedną z tych wartości:

stringValue string

Wartość ciągu znaków metadanych do przechowywania.

stringListValue object (StringList)

Wartość StringList metadanych do przechowywania.

numericValue number

Wartość liczbowa metadanych do przechowywania.

StringList

Podane przez użytkownika wartości ciągu znaków przypisane do jednego klucza metadanych.

Zapis JSON 
{
  "values": [
    string
  ]
}
Pola
values[] string

Wartości ciągu znaków metadanych do przechowywania.