[ aws . bedrock-agent ]
list-knowledge-base-documents
Описание
Извлекает все документы, содержащиеся в источнике данных, подключенном к базе знаний. Дополнительную информацию см. в руководстве пользователя Amazon Bedrock по загрузке изменений непосредственно в базу знаний.
См. также: документацию API AWS
list-knowledge-base-documents это постраничная операция. Для извлечения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе постраничного запроса аргумент --query должен извлечь данные из результатов следующих выражений запроса: documentDetails
Синтаксис
list-knowledge-base-documents
--data-source-id <value>
--knowledge-base-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--data-source-id (строка)
--knowledge-base-id (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, значения этих аргументов перекроют значения, указанные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер, определяющий, с какой точки начать постраничную обработку. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--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
- text
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для использования при фильтрации данных ответа.
--profile (строка)
Использовать конкретный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию данного инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включен
- выключен
- автоматически
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, который будет использоваться для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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 -> (строка)
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 -> (временная метка)
nextToken -> (строка)
maxResults, предоставленного в запросе, используйте этот маркер при выполнении другого запроса в поле nextToken, чтобы вернуть следующую партию результатов.
© Copyright 2025, Amazon Web Services. Created using Sphinx.