Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

удаление-документов-базы-знаний

Описание

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

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

Синтаксис

  delete-knowledge-base-documents
[--client-token <value>]
--data-source-id <value>
--document-identifiers <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 (строка)

Уникальный идентификатор источника данных, содержащего документы.

--document-identifiers (список)

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

(структура)

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

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

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

id -> (строка)

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

dataSourceType -> (строка)

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

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

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

uri -> (строка)

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

Сокращенный синтаксис:

custom={id=string},dataSourceType=string,s3={uri=string} ...

Синтаксис JSON:

[
  {
    "custom": {
      "id": "string"
    },
    "dataSourceType": "CUSTOM"|"S3",
    "s3": {
      "uri": "string"
    }
  }
  ...
]

--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.

Spec-Zone.ru

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