Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

ingest-knowledge-base-documents

Описание

Загружает документы напрямую в базу знаний, подключенную к источнику данных. dataSourceType, указанное в содержимом каждого документа, должно соответствовать типу источника данных, который вы указываете в заголовке. Дополнительную информацию см. в руководстве пользователя Amazon Bedrock в разделе «Загрузка изменений непосредственно в базу знаний».

См. также: Документация API AWS

Синтаксис

  ingest-knowledge-base-documents
[--client-token <value>]
--data-source-id <value>
--documents <value>
--knowledge-base-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, гарантирующий, что запрос API выполняется не более одного раза. Если этот токен соответствует предыдущему запросу, Amazon Bedrock игнорирует запрос, но не возвращает ошибку. Дополнительную информацию см. в разделе Обеспечение идемпотентности.

--data-source-id (строка)

Уникальный идентификатор источника данных, подключенного к базе знаний, в которую вы добавляете документы.

--documents (список)

Список объектов, каждый из которых содержит информацию о добавляемых документах.

(структура)

Содержит информацию о документе для загрузки в базу знаний и метаданные, которые необходимо с ним связать.

content -> (структура)

Содержит содержимое документа.

custom -> (структура)

Содержит информацию о содержимом для загрузки в базу знаний, подключенную к пользовательскому источнику данных.

customDocumentIdentifier -> (структура)

Уникальный идентификатор документа.

id -> (строка)

Идентификатор документа для загрузки в пользовательский источник данных.

inlineContent -> (структура)

Содержит информацию о содержимом, определенном внутри, для загрузки в базу знаний.

byteContent -> (структура)

Содержит информацию о содержимом, определенном внутри в байтах.

data -> (байт)

Строка содержимого, закодированная в base64.

mimeType -> (строка)

Тип MIME содержимого. Список типов MIME см. в разделе Типы медиа. Поддерживаются следующие типы MIME:

  • text/plain
  • text/html
  • text/csv
  • text/vtt
  • message/rfc822
  • application/xhtml+xml
  • application/pdf
  • application/msword
  • application/vnd.ms-word.document.macroenabled.12
  • application/vnd.ms-word.template.macroenabled.12
  • application/vnd.ms-excel
  • application/vnd.ms-excel.addin.macroenabled.12
  • application/vnd.ms-excel.sheet.macroenabled.12
  • application/vnd.ms-excel.template.macroenabled.12
  • application/vnd.ms-excel.sheet.binary.macroenabled.12
  • application/vnd.ms-spreadsheetml
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • application/vnd.openxmlformats-officedocument.spreadsheetml.template
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.openxmlformats-officedocument.wordprocessingml.template

textContent -> (структура)

Содержит информацию о содержимом, определенном внутри в текстовом формате.

data -> (строка)

Текст содержимого.

type -> (строка)

Тип содержимого для определения.

s3Location -> (структура)

Содержит информацию об расположении файла Amazon S3, из которого необходимо загрузить данные.

bucketOwnerAccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей ведром S3, содержащим содержимое для загрузки.

uri -> (строка)

URI S3 файла, содержащего содержимое для загрузки.

sourceType -> (строка)

Источник данных для загрузки.

dataSourceType -> (строка)

Тип источника данных, подключенного к базе знаний, в которую необходимо загрузить этот документ.

s3 -> (структура)

Содержит информацию о содержимом для загрузки в базу знаний, подключенную к источнику данных Amazon S3.

s3Location -> (структура)

Расположение S3 файла, содержащего содержимое для загрузки.

uri -> (строка)

URI расположения. Например, s3://my-bucket/chunk-processor/.

metadata -> (структура)

Содержит метаданные, которые необходимо связать с документом.

inlineAttributes -> (список)

Массив объектов, каждый из которых определяет атрибут метаданных для связывания с содержимым для загрузки. Вы определяете атрибуты внутри.

(структура)

Содержит информацию об атрибуте метаданных.

key -> (строка)

Ключ атрибута метаданных.

value -> (структура)

Содержит значение атрибута метаданных.

booleanValue -> (булево)

Значение булевого атрибута метаданных.

numberValue -> (двойное)

Значение числового атрибута метаданных.

stringListValue -> (список)

Массив строк, определяющий значение атрибута метаданных.

(строка)

stringValue -> (строка)

Значение строкового атрибута метаданных.

type -> (строка)

Тип атрибута метаданных.

s3Location -> (структура)

Расположение файла Amazon S3, содержащего метаданные для связывания с содержимым для загрузки.

bucketOwnerAccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей ведром S3, содержащим содержимое для загрузки.

uri -> (строка)

URI S3 файла, содержащего содержимое для загрузки.

type -> (строка)

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

Синтаксис JSON:

[
  {
    "content": {
      "custom": {
        "customDocumentIdentifier": {
          "id": "string"
        },
        "inlineContent": {
          "byteContent": {
            "data": blob,
            "mimeType": "string"
          },
          "textContent": {
            "data": "string"
          },
          "type": "BYTE"|"TEXT"
        },
        "s3Location": {
          "bucketOwnerAccountId": "string",
          "uri": "string"
        },
        "sourceType": "IN_LINE"|"S3_LOCATION"
      },
      "dataSourceType": "CUSTOM"|"S3",
      "s3": {
        "s3Location": {
          "uri": "string"
        }
      }
    },
    "metadata": {
      "inlineAttributes": [
        {
          "key": "string",
          "value": {
            "booleanValue": true|false,
            "numberValue": double,
            "stringListValue": ["string", ...],
            "stringValue": "string",
            "type": "BOOLEAN"|"NUMBER"|"STRING"|"STRING_LIST"
          }
        }
        ...
      ],
      "s3Location": {
        "bucketOwnerAccountId": "string",
        "uri": "string"
      },
      "type": "IN_LINE_ATTRIBUTE"|"S3_LOCATION"
    }
  }
  ...
]

--knowledge-base-id (строка)

Уникальный идентификатор базы знаний, в которую нужно загрузить документы.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если не указано значение или значение input, выводит пример JSON-ввода, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет напечатан пример YAML-ввода, который может быть использован с --cli-input-yaml. Если указано значение output, оно проверяет вводимые команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включает отладочную регистрацию.

--endpoint-url (строка)

Переопределяет стандартный URL команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (булево)

Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображает версию этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл CA-сертификатов для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, который следует использовать для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо правильно отформатировать для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запрошение параметров ввода CLI.

Вывод

documentDetails -> (список)

Список объектов, каждый из которых содержит информацию о документе, который был загружен.

(структура)

Содержит подробности о документе, который был загружен или удалён.

dataSourceId -> (строка)

Идентификатор источника данных, подключённого к базе знаний, в которую был загружен или из которой был удалён документ.

identifier -> (структура)

Содержит информацию, идентифицирующую документ.

custom -> (структура)

Содержит информацию, идентифицирующую документ в пользовательском источнике данных.

id -> (строка)

Идентификатор документа для загрузки в пользовательский источник данных.

dataSourceType -> (строка)

Тип источника данных, подключённого к базе знаний, содержащей документ.

s3 -> (структура)

Содержит информацию, идентифицирующую документ в источнике данных S3.

uri -> (строка)

URI расположения. Например, s3://my-bucket/chunk-processor/ .

knowledgeBaseId -> (строка)

Идентификатор базы знаний, в которую был загружен или из которой был удалён документ.

status -> (строка)

Статус загрузки документа. Возможные статусы:

  • STARTED – Вы отправили задание на загрузку, содержащее документ.
  • PENDING – Документ ожидает загрузки.
  • IN_PROGRESS – Документ загружается.
  • INDEXED – Документ успешно проиндексирован.
  • PARTIALLY_INDEXED – Документ частично проиндексирован.
  • METADATA_PARTIALLY_INDEXED – Вы отправили метаданные для существующего документа, и они были частично проиндексированы.
  • METADATA_UPDATE_FAILED – Вы отправили обновление метаданных для существующего документа, но оно не удалось.
  • FAILED – Загрузка документа не удалась.
  • NOT_FOUND – Документ не найден.
  • IGNORED – Документ был пропущен при загрузке.
  • DELETING – Вы отправили задание на удаление, содержащее документ.
  • DELETE_IN_PROGRESS – Документ удаляется.

statusReason -> (строка)

Причина статуса. Появляется вместе со статусом IGNORED .

updatedAt -> (временная метка)

Дата и время последнего обновления документа.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API