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 s. Пример: 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.

nextPageToken string PageToken

Токен, который можно отправить как 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} .

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

строка updateMask string ( FieldMask format)

Необходимый. Список полей для обновления. В настоящее время это поддерживает только обновление 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} .

Тело запроса

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

Тело ответа

В случае успеха тело ответа пустое.

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

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

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

опубликуйте 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 s.

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

Поля
объект chunks[] object ( Chunk )

Chunk создан.

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

СоздатьЧанкЗапрос

Запрос на создание 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 s.

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

опубликуйте 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 s.

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

Поля
объект chunks[] object ( Chunk )

Chunk обновлен.

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

Запрос обновления чанка

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

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

Необходимый. Chunk для обновления.

строка updateMask string ( FieldMask format)

Необходимый. Список полей для обновления. В настоящее время это поддерживает только обновление 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 для удаления.

Тело ответа

В случае успеха тело ответа пустое.

УдалитьЧанкЗапрос

Запрос на удаление 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 s.

Поля
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 .

Временная метка в формате 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 .

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

ЧанкДанные

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

Поля

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

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

stringValue string

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

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

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

Состояние

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

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