Documents

Metoda: corpora.documents.create

Tworzy pusty element Document.

Punkt końcowy

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

parent string

Wymagany. Nazwa Corpus, w której zostanie utworzona ta Document. Przykład: corpora/my-corpus-123. Ma on postać corpora/{corpora}.

Treść żądania

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

Pola
name string

Niezmienna. Identyfikator. Nazwa zasobu Document. Identyfikator (nazwa bez prefiksu „corpora/*/documents/”) może zawierać maksymalnie 40 małych liter, cyfr lub łączników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa jest pusta, zostanie utworzona unikalna nazwa na podstawie displayName oraz 12-znakowego losowego sufiksu. Przykład: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

Opcjonalnie: Wyświetlana nazwa Document w formie czytelnej dla człowieka. Wyświetlana nazwa nie może mieć więcej niż 512 znaków (w tym spacje). Przykład: „Dokumentacja Semantic Retriever”

customMetadata[] object (CustomMetadata)

Opcjonalnie: Niestandardowe metadane przesłane przez użytkownika, przechowywane jako pary klucz-wartość, używane do wykonywania zapytań. W grupie Document może być maksymalnie 20 elementów CustomMetadata.

Treść odpowiedzi

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

Metoda: corpora.documents.query

Wykonuje wyszukiwanie semantyczne w dokumentach Document.

Punkt końcowy

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

name string

Wymagany. Nazwa Document, której dotyczy zapytanie. Przykład: corpora/my-corpus-123/documents/the-doc-abc. Ma on postać corpora/{corpora}/documents/{document}.

Treść żądania

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

Pola
query string

Wymagany. Ciąg zapytania do przeprowadzenia wyszukiwania semantycznego.

resultsCount integer

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

Jeśli nie zostanie podana żadna wartość, zwróci się 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ć niepowtarzalnemu kluczowi. Wiele obiektów MetadataFilter jest połączonych za pomocą operatora logicznego „ORAZ”.

Uwaga: w przypadku tego żądania nie można stosować filtrowania na poziomie Document, ponieważ podano już nazwę Document.

Przykładowe zapytanie: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter lista obiektów: 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ład zapytania dotyczącego zakresu wartości liczbowych: (year > 2015 AND year <= 2020)

MetadataFilter lista obiektów: 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: warunki „AND” dla tego samego klucza są obsługiwane tylko w przypadku wartości liczbowych. Wartości ciągu obsługują tylko warunki „OR” 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)
    }
  ]
}

Metoda: corpora.documents.list

Wyświetla wszystkie Document w Corpus.

Punkt końcowy

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

parent string

Wymagany. Nazwa Corpus zawierającej Document. Przykład: corpora/my-corpus-123. Ma on postać corpora/{corpora}.

Parametry zapytania

pageSize integer

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

Jeśli nie zostanie podana żadna wartość, zwróci się maksymalnie 10 Document. Maksymalny limit rozmiaru to 20 Document na stronę.

pageToken string

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

Aby pobrać kolejną stronę, podaj jako argument kolejnego żądania nextPageToken zwrócony w odpowiedzi.

Podczas podziału na strony 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 documents.list zawierająca pogrupowaną 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że być wysyłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie kolejnych stron.

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

Metoda: corpora.documents.get

Pobiera informacje o konkretnym Document.

Punkt końcowy

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

name string

Wymagany. Nazwa Document do pobrania. Przykład: corpora/my-corpus-123/documents/the-doc-abc. Ma on 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

Zaktualizowano Document.

Punkt końcowy

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

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

document.name string

Niezmienna. Identyfikator. Nazwa zasobu Document. Identyfikator (nazwa bez prefiksu „corpora/*/documents/”) może zawierać maksymalnie 40 małych liter, cyfr lub łączników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa jest pusta, zostanie utworzona unikalna nazwa na podstawie displayName oraz 12-znakowego losowego sufiksu. Przykład: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c. Ma on postać corpora/{corpora}/documents/{document}.

Parametry zapytania

updateMask string (FieldMask format)

Wymagany. Lista pól do zaktualizowania. Obecnie ta funkcja obsługuje tylko aktualizacje displayName i customMetadata.

Jest to lista pełnych nazw pól rozdzielona przecinkami. Przykład: "user.displayName,photo".

Treść żądania

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

Pola
displayName string

Opcjonalnie: Wyświetlana nazwa Document w formie czytelnej dla człowieka. Wyświetlana nazwa nie może mieć więcej niż 512 znaków (w tym spacje). Przykład: „Dokumentacja Semantic Retriever”

customMetadata[] object (CustomMetadata)

Opcjonalnie: Niestandardowe metadane przesłane przez użytkownika, przechowywane jako pary klucz-wartość, używane do wykonywania zapytań. W grupie Document może być maksymalnie 20 elementów CustomMetadata.

Treść odpowiedzi

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

Metoda: corpora.documents.delete

usuwa Document.

Punkt końcowy

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

name string

Wymagany. Nazwa zasobu Document, który chcesz usunąć. Przykład: corpora/my-corpus-123/documents/the-doc-abc. Ma on postać corpora/{corpora}/documents/{document}.

Parametry zapytania

force boolean

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

Jeśli wartość jest równa fałsz (domyślnie), zwracany jest błąd FAILED_PRECONDITION, jeśli Document zawiera jakiekolwiek wartości Chunk.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi to pusty obiekt JSON.

Zasób REST: corpora.documents

Zasób: dokument

Document to zbiór Chunk. Corpus może zawierać maksymalnie 10 tys. Document.

Pola
name string

Niezmienna. Identyfikator. Nazwa zasobu Document. Identyfikator (nazwa bez prefiksu „corpora/*/documents/”) może zawierać maksymalnie 40 małych liter, cyfr lub łączników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa jest pusta, zostanie utworzona unikalna nazwa na podstawie displayName oraz 12-znakowego losowego sufiksu. Przykład: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName string

Opcjonalnie: Wyświetlana nazwa Document w formie czytelnej dla człowieka. Wyświetlana nazwa nie może mieć więcej niż 512 znaków (w tym spacje). Przykład: „Dokumentacja Semantic Retriever”

customMetadata[] object (CustomMetadata)

Opcjonalnie: Niestandardowe metadane przesłane przez użytkownika, przechowywane jako pary klucz-wartość, używane do wykonywania zapytań. W grupie Document może być maksymalnie 20 elementów CustomMetadata.

updateTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy element Document został ostatnio zaktualizowany.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. 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 elementu Document.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. 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".

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

CustomMetadata

metadane przesłane przez użytkownika, zapisane jako pary klucz-wartość;

Pola
key string

Wymagany. Klucz metadanych do przechowywania.

value Union type
value może być tylko jednym z tych elementów:
stringValue string

Ciąg znaków będący metadanymi do przechowywania.

stringListValue object (StringList)

Wartość StringList metadanych do przechowywania.

numericValue number

Wartość liczbowa metadanych do przechowywania.

Zapis JSON 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

Wartości ciągu podane przez użytkownika i przypisane do jednego klucza metadanych.

Pola
values[] string

Ciągi znaków metadanych do przechowywania.

Zapis JSON 
{
  "values": [
    string
  ]
}