[ aws . bedrock-agent ]
получить-базу-знаний
Описание
Получает информацию о базе знаний.
См. также: Документация API AWS
Синтаксис
get-knowledge-base
--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]
Параметры
--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.
Вывод
knowledgeBase -> (структура)
Содержит сведения о базе знаний.
createdAt -> (метка времени)
description -> (строка)
failureReasons -> (список)
Список причин, по которым операция API над базой знаний завершилась неудачно.
(строка)
knowledgeBaseArn -> (строка)
knowledgeBaseConfiguration -> (структура)
Содержит сведения о конфигурации встраивания для базы знаний.
kendraKnowledgeBaseConfiguration -> (структура)
Настройки базы знаний Amazon Kendra.
kendraIndexArn -> (строка)
sqlKnowledgeBaseConfiguration -> (структура)
Указывает конфигурации для базы знаний, подключенной к базе данных SQL.
redshiftConfiguration -> (структура)
Указывает конфигурации для базы знаний, подключенной к базе данных Amazon Redshift.
queryEngineConfiguration -> (структура)
Указывает конфигурации для движка запросов Amazon Redshift.
provisionedConfiguration -> (структура)
Указывает конфигурации для выделенного движка запросов Amazon Redshift.
authConfiguration -> (структура)
Указывает конфигурации для аутентификации в Amazon Redshift.
databaseUser -> (строка)
type -> (строка)
usernamePasswordSecretArn -> (строка)
clusterIdentifier -> (строка)
serverlessConfiguration -> (структура)
Указывает конфигурации для серверного движка запросов Amazon Redshift.
authConfiguration -> (структура)
Указывает конфигурации для аутентификации в выделенном хранилище данных Amazon Redshift.
type -> (строка)
usernamePasswordSecretArn -> (строка)
workgroupArn -> (строка)
type -> (строка)
queryGenerationConfiguration -> (структура)
Указывает конфигурации для генерации запросов.
executionTimeoutSeconds -> (целое число)
generationContext -> (структура)
Указывает конфигурации контекста для использования при генерации запросов.
curatedQueries -> (список)
Массив объектов, каждый из которых определяет информацию об образце запросов для помощи движку запросов в генерации соответствующих запросов SQL.
(структура)
Содержит конфигурации запроса, каждая из которых определяет информацию об образцах запросов для помощи движку запросов в генерации соответствующих запросов SQL.
naturalLanguage -> (строка)
sql -> (строка)
tables -> (список)
Массив объектов, каждый из которых определяет информацию о таблице в базе данных.
(структура)
Содержит информацию о таблице, которую движок запросов должен учитывать.
columns -> (список)
Массив объектов, каждый из которых определяет информацию о столбце в таблице.
(структура)
Содержит информацию о столбце в текущей таблице, которую движок запросов должен учитывать.
description -> (строка)
inclusion -> (строка)
EXCLUDE, столбец будет пропущен. Если вы укажете INCLUDE, все остальные столбцы в таблице будут пропущены.name -> (строка)
description -> (строка)
inclusion -> (строка)
EXCLUDE, таблица будет пропущена. Если вы укажете INCLUDE, все остальные таблицы будут пропущены.name -> (строка)
storageConfigurations -> (список)
Указывает конфигурации для хранения данных Amazon Redshift.
(структура)
Содержит конфигурации для хранения данных Amazon Redshift. Укажите используемую службу хранения данных в поле type и включите соответствующее поле. Дополнительную информацию см. в разделе «Создание базы знаний путем подключения к структурированному источнику данных» в Руководстве пользователя Amazon Bedrock.
awsDataCatalogConfiguration -> (структура)
Указывает конфигурации для хранения в каталоге данных Glue.
tableNames -> (список)
Список имен таблиц для использования.
(строка)
redshiftConfiguration -> (структура)
Указывает конфигурации для хранения в Amazon Redshift.
databaseName -> (строка)
type -> (строка)
type -> (строка)
type -> (строка)
vectorKnowledgeBaseConfiguration -> (структура)
Содержит сведения о модели, используемой для преобразования источника данных в векторные встраивания.
embeddingModelArn -> (строка)
embeddingModelConfiguration -> (структура)
Подробные сведения о конфигурации модели встраивания для векторной модели, используемой в базе знаний.
bedrockEmbeddingModelConfiguration -> (структура)
Подробные сведения о векторной конфигурации модели встраивания Bedrock.
dimensions -> (целое число)
embeddingDataType -> (строка)
supplementalDataStorageConfiguration -> (структура)
Если вы включаете мультимодальные данные из источника данных, используйте этот объект для указания конфигураций местоположения хранения изображений, извлеченных из документов. Эти изображения могут быть получены и возвращены конечному пользователю. Они также могут быть использованы в генерации при использовании RetrieveAndGenerate.
storageLocations -> (список)
Список объектов, указывающих местоположения хранения изображений, извлеченных из мультимодальных документов в вашем источнике данных.
(структура)
Содержит информацию о местоположении хранения изображений, извлеченных из мультимодальных документов в вашем источнике данных.
s3Location -> (структура)
Содержит информацию об Amazon S3 местоположении извлеченных изображений.
uri -> (строка)
s3://my-bucket/chunk-processor/.type -> (строка)
knowledgeBaseId -> (строка)
name -> (строка)
roleArn -> (строка)
status -> (строка)
Статус базы знаний. Возможные статусы:
- CREATING – База знаний создается.
- ACTIVE – База знаний готова к запросам.
- DELETING – База знаний удаляется.
- UPDATING – База знаний обновляется.
- FAILED – Операция API базы знаний завершилась неудачно.
storageConfiguration -> (структура)
Содержит подробности о конфигурации хранения базы знаний.
mongoDbAtlasConfiguration -> (структура)
Содержит конфигурацию хранения базы знаний в MongoDB Atlas.
collectionName -> (строка)
credentialsSecretArn -> (строка)
databaseName -> (строка)
endpoint -> (строка)
endpointServiceName -> (строка)
fieldMapping -> (структура)
Содержит имена полей, к которым следует сопоставить информацию о векторном хранилище.
metadataField -> (строка)
textField -> (строка)
vectorField -> (строка)
textIndexName -> (строка)
vectorIndexName -> (строка)
neptuneAnalyticsConfiguration -> (структура)
Содержит подробности о конфигурации Neptune Analytics для базы знаний в Amazon Neptune. Для получения дополнительной информации см. Создайте индекс векторов в Amazon Neptune Analytics.
fieldMapping -> (структура)
Содержит имена полей, к которым следует сопоставить информацию о векторном хранилище.
metadataField -> (строка)
textField -> (строка)
graphArn -> (строка)
opensearchManagedClusterConfiguration -> (структура)
Содержит подробности о конфигурации хранения базы знаний в OpenSearch Managed Cluster. Для получения дополнительной информации см. Создайте индекс векторов в Amazon OpenSearch Service.
domainArn -> (строка)
domainEndpoint -> (строка)
fieldMapping -> (структура)
Содержит имена полей, к которым следует сопоставить информацию о векторном хранилище.
metadataField -> (строка)
textField -> (строка)
vectorField -> (строка)
vectorIndexName -> (строка)
opensearchServerlessConfiguration -> (структура)
Содержит конфигурацию хранения базы знаний в Amazon OpenSearch Service.
collectionArn -> (строка)
fieldMapping -> (структура)
Содержит имена полей, к которым следует сопоставить информацию о векторном хранилище.
metadataField -> (строка)
textField -> (строка)
vectorField -> (строка)
vectorIndexName -> (строка)
pineconeConfiguration -> (структура)
Содержит конфигурацию хранения базы знаний в Pinecone.
connectionString -> (строка)
credentialsSecretArn -> (строка)
fieldMapping -> (структура)
Содержит имена полей, к которым следует сопоставить информацию о векторном хранилище.
metadataField -> (строка)
textField -> (строка)
namespace -> (строка)
rdsConfiguration -> (структура)
Содержит подробности о конфигурации хранения базы знаний в Amazon RDS. Для получения дополнительной информации см. Создайте индекс векторов в Amazon RDS.
credentialsSecretArn -> (строка)
databaseName -> (строка)
fieldMapping -> (структура)
Содержит имена полей, к которым следует сопоставить информацию о векторном хранилище.
customMetadataField -> (строка)
metadataField -> (строка)
primaryKeyField -> (строка)
textField -> (строка)
vectorField -> (строка)
resourceArn -> (строка)
tableName -> (строка)
redisEnterpriseCloudConfiguration -> (структура)
Содержит конфигурацию хранения базы знаний в Redis Enterprise Cloud.
credentialsSecretArn -> (строка)
endpoint -> (строка)
fieldMapping -> (структура)
Содержит имена полей, к которым следует сопоставить информацию о векторном хранилище.
metadataField -> (строка)
textField -> (строка)
vectorField -> (строка)
vectorIndexName -> (строка)
type -> (строка)
updatedAt -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.