REST Resource: corpora.documents.chunks

Ресурс: Чанк

Chunk — это часть Document , которая рассматривается как независимая единица для целей векторного представления и хранения. Corpus может содержать максимум 1 миллион Chunk s.

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

string

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

data

object ( ChunkData )

Необходимый. Содержимое Chunk , например текстовая строка. Максимальное количество токенов на чанк — 2043.

customMetadata[]

object ( CustomMetadata )

Необязательный. Предоставленные пользователем пользовательские метаданные хранятся в виде пар ключ-значение. Максимальное количество CustomMetadata на фрагмент — 20.

createTime

string ( Timestamp format)

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

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

updateTime

string ( Timestamp format)

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

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

state

enum ( State )

Только вывод. Текущее состояние Chunk .

ЧанкДанные

Извлеченные данные, представляющие содержимое Chunk .

JSON-представление
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
Поля

data поля объединения.

data могут быть только одним из следующих:

stringValue

string

Содержимое Chunk в виде строки. Максимальное количество токенов на чанк — 2043.

Состояние

Состояния жизненного цикла Chunk .

Перечисления
STATE_UNSPECIFIED Значение по умолчанию. Это значение используется, если состояние опущено.
STATE_PENDING_PROCESSING Chunk находится в обработке (встраивание и векторное хранение).
STATE_ACTIVE Chunk обработан и доступен для запроса.
STATE_FAILED Не удалось обработать Chunk .

Методы

batchCreate

Пакетное создание Chunk s.

batchDelete

Пакетное удаление Chunk .

batchUpdate

Пакетное обновление Chunk s.

create

Создает Chunk .

delete

Удаляет Chunk .

get

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

list

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

patch

Обновляет Chunk .