Documents

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 Corpus, w której zostanie utworzona ta Document. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Treść żądania

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

Pola
name string

Niezmienna. 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: 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 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.

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 przypadku Document.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa Document, której 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 Chunk do zwrócenia. Usługa może zwrócić mniej elementów typu Chunk.

Jeśli nie zostanie podana żadna wartość, zwróci się maksymalnie 10 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: w przypadku tego żądania nie można stosować filtrowania na poziomie Document, ponieważ podano już nazwę Document.

Przykładowe zapytanie: (rok >= 2020 OR rok < 2010) AND (gatunek = dramat OR gatunek = akcja)

MetadataFilter object list: metadataFilters = [ {key = &quot;chunk.custom_metadata.year&quot; warunki = [{int_value = 2020, Operations = GREATER_EQUAL}, {int_value = 2010, actions = MNIEJ}}, {klucz = "chunk.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, 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 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.list

Wyświetla wszystkie Document w 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. 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)

Zwracane 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 więcej stron.

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

Metoda: corpora.documents.get

Pobiera informacje o konkretnym 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. 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

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

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 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.

Pola
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 Semantic Retriever”

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.

Treść odpowiedzi

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

Metoda: corpora.documents.delete

usuwa Document.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa zasobu Document, który chcesz usunąć. 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

W przypadku powodzenia treść odpowiedzi jest pusta.

Zasób REST: corpora.documents

Zasób: Document

Document to zbiór Chunk. Corpus może zawierać maksymalnie 10 tysięcy 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 semantycznego narzędzia do pobierania”

customMetadata[] object (CustomMetadata)

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

updateTime string (Timestamp format)

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

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".

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

Wymagane. Klucz metadanych do przechowywania.

Pole unii value.

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

stringValue string

Wartość ciągu tekstowego metadanych do przechowywania.

stringListValue object (StringList)

Wartość StringList metadanych do przechowywania.

numericValue number

Wartość liczbowa metadanych do przechowywania.

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.
}

StringList

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

Pola
values[] string

Ciągi znaków metadanych do przechowywania.

Zapis JSON 
{
  "values": [
    string
  ]
}