Chunks

Метод: corpora.documents.chunks.create

Создает Chunk .

Конечная точка

пост https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /* /documents /*} /chunks

Параметры пути

parent string

Обязательно. Имя Document , в котором будет создан этот Chunk . Пример: corpora/my-corpus-123/documents/the-doc-abc Имя имеет вид corpora/{corpora}/documents/{document} .

Текст запроса

Тело запроса содержит экземпляр Chunk .

Поля
string name

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

объект data object ( ChunkData )

Обязательно. Содержимое Chunk , например, текстовая строка. Максимальное количество токенов в фрагменте — 2043.

object ( CustomMetadata ) customMetadata[] ( CustomMetadata )

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

Тело ответа

В случае успеха тело ответа содержит вновь созданный экземпляр Chunk .

Метод: corpora.documents.chunks.list

Выводит список всех Chunk в Document .

Конечная точка

получить https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /* /documents /*} /chunks

Параметры пути

parent string

Обязательно. Имя Document , содержащего Chunk . Пример: corpora/my-corpus-123/documents/the-doc-abc Оно имеет вид corpora/{corpora}/documents/{document} .

Параметры запроса

pageSize integer

Необязательно. Максимальное количество возвращаемых Chunk (на страницу). Сервис может возвращать меньше Chunk .

Если не указано иное, будет возвращено не более 10 Chunk . Максимальный размер — 100 Chunk на страницу.

string pageToken

Необязательно. Токен страницы, полученный в результате предыдущего вызова chunks.list .

Предоставьте nextPageToken возвращенный в ответе, в качестве аргумента для следующего запроса для получения следующей страницы.

При пагинации все остальные параметры, предоставленные chunks.list , должны соответствовать вызову, который предоставил токен страницы.

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ от chunks.list содержащий постраничный список фрагментов ( Chunk ). Chunk отсортированы по возрастанию chunk.create_time .

В случае успеха тело ответа содержит данные со следующей структурой:

Поля
chunks[] object ( Chunk )

Возвращенный Chunk s.

string nextPageToken

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле пропущено, значит, страниц больше нет.

JSON-представление 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

Метод: corpora.documents.chunks.get

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

Конечная точка

получить https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /* /chunks /*}

Параметры пути

string name

Обязательно. Имя извлекаемого Chunk . Пример: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Формат corpora/{corpora}/documents/{document}/chunks/{chunk} .

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит экземпляр Chunk .

Метод: corpora.documents.chunks.patch

Обновляет Chunk .

Конечная точка

патч https: / /generativelanguage.googleapis.com /v1beta /{chunk.name=corpora /* /documents /* /chunks /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

Параметры пути

string chunk.name

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

Параметры запроса

string ( FieldMask format) updateMask (формат FieldMask)

Обязательно. Список полей для обновления. В настоящее время поддерживается только обновление customMetadata и data .

Это список полных имён полей, разделённых запятыми. Пример: "user.displayName,photo" .

Текст запроса

Тело запроса содержит экземпляр Chunk .

Поля
объект data object ( ChunkData )

Обязательно. Содержимое Chunk , например, текстовая строка. Максимальное количество токенов в фрагменте — 2043.

object ( CustomMetadata ) customMetadata[] ( CustomMetadata )

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

Тело ответа

В случае успеха тело ответа содержит экземпляр Chunk .

Метод: corpora.documents.chunks.delete

Удаляет Chunk .

Конечная точка

удалить https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /* /chunks /*}

Параметры пути

string name

Обязательно. Имя ресурса удаляемого Chunk . Пример: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Формат corpora/{corpora}/documents/{document}/chunks/{chunk} .

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа представляет собой пустой объект JSON.

Метод: corpora.documents.chunks.batchCreate

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

Конечная точка

пост https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /* /documents /*} /chunks:batchCreate

Параметры пути

parent string

Необязательно. Имя Document , в котором будет создан этот пакет фрагментов Chunk ). Родительское поле в каждом CreateChunkRequest должно соответствовать этому значению. Пример: corpora/my-corpus-123/documents/the-doc-abc Оно имеет вид corpora/{corpora}/documents/{document} .

Текст запроса

Тело запроса содержит данные со следующей структурой:

Поля
объект requests[] object ( CreateChunkRequest )

Обязательно. Сообщения-запросы, указывающие Chunk для создания. В одном пакете можно создать не более 100 Chunk .

Тело ответа

Ответ от chunks.batchCreate , содержащий список созданных Chunk .

В случае успеха тело ответа содержит данные со следующей структурой:

Поля
chunks[] object ( Chunk )

Chunk создан.

JSON-представление 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

Запрос на создание Chunk .

Поля
parent string

Обязательно. Имя Document , в котором будет создан этот Chunk . Пример: corpora/my-corpus-123/documents/the-doc-abc

объект chunk object ( Chunk )

Обязательно. Chunk , который нужно создать.

JSON-представление 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}

Метод: corpora.documents.chunks.batchUpdate

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

Конечная точка

пост https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /* /documents /*} /chunks:batchUpdate

Параметры пути

parent string

Необязательно. Имя Document , содержащего обновляемые Chunk . Родительское поле в каждом UpdateChunkRequest должно соответствовать этому значению. Пример: corpora/my-corpus-123/documents/the-doc-abc Оно имеет вид corpora/{corpora}/documents/{document} .

Текст запроса

Тело запроса содержит данные со следующей структурой:

Поля
объект requests[] object ( UpdateChunkRequest )

Обязательно. Сообщения-запросы, указывающие Chunk для обновления. За один пакет можно обновить не более 100 Chunk .

Тело ответа

Ответ от chunks.batchUpdate , содержащий список обновленных Chunk .

В случае успеха тело ответа содержит данные со следующей структурой:

Поля
chunks[] object ( Chunk )

Chunk обновлен.

JSON-представление 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

Запрос на обновление Chunk .

Поля
объект chunk object ( Chunk )

Обязательно. Chunk для обновления.

string ( FieldMask format) updateMask (формат FieldMask)

Обязательно. Список полей для обновления. В настоящее время поддерживается только обновление customMetadata и data .

Это список полных имён полей, разделённых запятыми. Пример: "user.displayName,photo" .

JSON-представление 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}

Метод: corpora.documents.chunks.batchDelete

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

Конечная точка

пост https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /* /documents /*} /chunks:batchDelete

Параметры пути

parent string

Необязательно. Имя Document , содержащего удаляемые Chunk . Родительское поле в каждом DeleteChunkRequest должно совпадать с этим значением. Пример: corpora/my-corpus-123/documents/the-doc-abc Оно имеет вид corpora/{corpora}/documents/{document} .

Текст запроса

Тело запроса содержит данные со следующей структурой:

Поля
объект requests[] object ( DeleteChunkRequest )

Обязательно. Сообщения-запросы, указывающие Chunk , которые необходимо удалить.

Тело ответа

В случае успеха тело ответа представляет собой пустой объект JSON.

DeleteChunkRequest

Запрос на удаление Chunk .

Поля
string name

Обязательно. Имя ресурса Chunk , который нужно удалить. Пример: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

JSON-представление 
{
  "name": string
}

Ресурс REST: corpora.documents.chunks

Ресурс: Кусок

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

Поля
string name

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

объект data object ( ChunkData )

Обязательно. Содержимое Chunk , например, текстовая строка. Максимальное количество токенов в фрагменте — 2043.

object ( CustomMetadata ) customMetadata[] ( CustomMetadata )

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

createTime string ( Timestamp format)

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

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

строка updateTime string ( Timestamp format)

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

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

state enum ( State )

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

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

ChunkData

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

Поля
Union type data
data могут быть только одним из следующих:
stringValue string

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

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

  // data
  "stringValue": string
  // Union type
}

Состояние

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

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