REST Resource: corpora.documents

Ресурс: Документ

Document представляет собой коллекцию Chunk s. Corpus может содержать максимум 10 000 Document s.

JSON-представление
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Поля
name

string

Неизменный. Идентификатор. Имя ресурса Document . Идентификатор (имя, за исключением префикса «corpora/*/documents/») может содержать до 40 символов, состоящих из строчных букв, цифр или дефисов (-). Идентификатор не может начинаться или заканчиваться тире. Если при создании имя пустое, уникальное имя будет получено из displayName вместе со случайным суффиксом из 12 символов. Пример: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

Необязательный. Удобочитаемое отображаемое имя Document . Отображаемое имя должно содержать не более 512 символов, включая пробелы. Пример: «Документация по семантическому ретриверу».

customMetadata[]

object ( CustomMetadata )

Необязательный. Предоставленные пользователем пользовательские метаданные хранятся в виде пар ключ-значение, используемых для запросов. Document может иметь максимум 20 CustomMetadata .

updateTime

string ( Timestamp format)

Только вывод. Временная метка последнего обновления Document .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

createTime

string ( Timestamp format)

Только вывод. Временная метка создания Document .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

Методы

create

Создает пустой Document .

delete

Удаляет Document .

get

Получает информацию о конкретном Document .

list

Перечисляет все Document в Corpus .

patch

Обновляет Document .

query

Выполняет семантический поиск по Document .