[ aws . bedrock-agent ]
получение-документов-базы-знаний
Описание
Извлекает конкретные документы из источника данных, подключенного к базе знаний. Дополнительную информацию см. в руководстве пользователя Amazon Bedrock в разделе «Прямое внесение изменений в базу знаний».
См. также: Документация API AWS
Синтаксис
get-knowledge-base-documents
--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]
Параметры
--data-source-id (строка)
--document-identifiers (список)
Список объектов, каждый из которых содержит информацию для идентификации документа, для которого требуется получить информацию.
(структура)
Содержит информацию, идентифицирующую документ.
custom -> (структура)
Содержит информацию, идентифицирующую документ в пользовательском источнике данных.
id -> (строка)
dataSourceType -> (строка)
s3 -> (структура)
Содержит информацию, идентифицирующую документ в источнике данных S3.
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 -> (строка)
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.
|
|