REST Resource: corpora.documents

Zasób: Document

Element Document jest zbiorem 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

Niezmienne. Identyfikator. Nazwa zasobu Document. Identyfikator (nazwa bez prefiksu „corpora/*/documents/”) może zawierać do 40 znaków, które są małymi znakami alfanumerycznymi lub myślnikami (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa będzie pusta, zostanie pobrana unikalna nazwa z elementu displayName wraz z losowym 12-znakowym sufiksem. Przykład: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

Opcjonalnie. Czytelna dla człowieka nazwa wyświetlana elementu Document. Wyświetlana nazwa nie może mieć więcej niż 512 znaków łącznie ze spacjami. Przykład: „Semantic Retriever Dokumentacja”

customMetadata[]

object (CustomMetadata)

Opcjonalnie. Niestandardowe metadane podane przez użytkownika, przechowywane w postaci par klucz-wartość używanych do wysyłania zapytań. Element Document może zawierać maksymalnie 20 elementów CustomMetadata.

updateTime

string (Timestamp format)

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

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy 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 formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Metody

create

Tworzy pusty element Document.

delete

Usuwa Document.

get

Zbiera informacje o konkretnym elemencie Document.

list

Wyświetla listę wszystkich elementów Document w elemencie Corpus.

patch

Aktualizuje: Document.

query

Przeprowadza wyszukiwanie semantyczne w polu Document.