Spec-Zone.ru › AWS CLI v2

[ 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 -> (строка)

Amazon Resource Name (ARN) базы знаний.

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

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

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

Настройки базы знаний Amazon Kendra.

kendraIndexArn -> (строка)

ARN индекса Amazon Kendra.

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

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

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

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

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

Указывает конфигурации для движка запросов Amazon Redshift.

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

Указывает конфигурации для выделенного движка запросов Amazon Redshift.

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

Указывает конфигурации для аутентификации в Amazon Redshift.

databaseUser -> (строка)

Имя пользователя базы данных для аутентификации в выделенном хранилище данных Amazon Redshift.

type -> (строка)

Тип используемой аутентификации.

usernamePasswordSecretArn -> (строка)

ARN секрета службы Secrets Manager для аутентификации.

clusterIdentifier -> (строка)

Идентификатор кластера Amazon Redshift.

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

Указывает конфигурации для серверного движка запросов Amazon Redshift.

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

Указывает конфигурации для аутентификации в выделенном хранилище данных Amazon Redshift.

type -> (строка)

Тип используемой аутентификации.

usernamePasswordSecretArn -> (строка)

ARN секрета службы Secrets Manager для аутентификации.

workgroupArn -> (строка)

ARN группы Amazon Redshift.

type -> (строка)

Тип движка запросов.

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

Указывает конфигурации для генерации запросов.

executionTimeoutSeconds -> (целое число)

Время ожидания генерации запроса.

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

Указывает конфигурации контекста для использования при генерации запросов.

curatedQueries -> (список)

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

(структура)

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

naturalLanguage -> (строка)

Пример запроса на естественном языке.

sql -> (строка)

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 -> (строка)

Имя базы данных Amazon Redshift.

type -> (строка)

Используемая служба хранения данных.

type -> (строка)

Тип базы данных SQL, к которой подключается база знаний.

type -> (строка)

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

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

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

embeddingModelArn -> (строка)

Amazon Resource Name (ARN) модели, используемой для создания векторных встраиваний для базы знаний.

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

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

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

Подробные сведения о векторной конфигурации модели встраивания Bedrock.

dimensions -> (целое число)

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

embeddingDataType -> (строка)

Тип данных для векторов при использовании модели для преобразования текста в векторные встраивания. Модель должна поддерживать указанный тип данных для векторных встраиваний. По умолчанию используется тип данных с плавающей запятой (float32), который поддерживается большинством моделей для векторных встраиваний. Дополнительную информацию о доступных моделях и их типах данных для векторов см. в разделе Поддерживаемые модели встраиваний.

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

Если вы включаете мультимодальные данные из источника данных, используйте этот объект для указания конфигураций местоположения хранения изображений, извлеченных из документов. Эти изображения могут быть получены и возвращены конечному пользователю. Они также могут быть использованы в генерации при использовании RetrieveAndGenerate.

storageLocations -> (список)

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

(структура)

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

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

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

uri -> (строка)

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

type -> (строка)

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

knowledgeBaseId -> (строка)

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

name -> (строка)

Название базы знаний.

roleArn -> (строка)

Amazon Resource Name (ARN) роли IAM с разрешениями для вызова операций API в базе знаний.

status -> (строка)

Статус базы знаний. Возможные статусы:

  • CREATING – База знаний создается.
  • ACTIVE – База знаний готова к запросам.
  • DELETING – База знаний удаляется.
  • UPDATING – База знаний обновляется.
  • FAILED – Операция API базы знаний завершилась неудачно.

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

Содержит подробности о конфигурации хранения базы знаний.

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

Содержит конфигурацию хранения базы знаний в MongoDB Atlas.

collectionName -> (строка)

Имя коллекции базы знаний в MongoDB Atlas.

credentialsSecretArn -> (строка)

Amazon Resource Name (ARN) секрета, который вы создали в Secrets Manager, содержащий учетные данные пользователя для вашего кластера MongoDB Atlas.

databaseName -> (строка)

Имя базы данных в вашем кластере MongoDB Atlas для вашей базы знаний.

endpoint -> (строка)

URL конечной точки вашего кластера MongoDB Atlas для вашей базы знаний.

endpointServiceName -> (строка)

Имя службы VPC-конечной точки в вашем аккаунте, подключенной к вашему кластеру MongoDB Atlas.

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

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

metadataField -> (строка)

Имя поля, в котором Amazon Bedrock хранит метаданные о векторном хранилище.

textField -> (строка)

Имя поля, в котором Amazon Bedrock хранит исходный текст из ваших данных. Текст разделен в соответствии с выбранной стратегией фрагментации.

vectorField -> (строка)

Имя поля, в котором Amazon Bedrock хранит векторные вложения для ваших источников данных.

textIndexName -> (строка)

Имя индекса текстового поиска в коллекции MongoDB. Это требуется для использования гибридной функции поиска.

vectorIndexName -> (строка)

Имя индекса векторного поиска MongoDB Atlas.

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

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

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

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

metadataField -> (строка)

Имя поля, в котором Amazon Bedrock хранит метаданные о векторном хранилище.

textField -> (строка)

Имя поля, в котором Amazon Bedrock хранит исходный текст из ваших данных. Текст разделен в соответствии с выбранной стратегией фрагментации.

graphArn -> (строка)

Amazon Resource Name (ARN) векторного хранилища Neptune Analytics.

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

Содержит подробности о конфигурации хранения базы знаний в OpenSearch Managed Cluster. Для получения дополнительной информации см. Создайте индекс векторов в Amazon OpenSearch Service.

domainArn -> (строка)

Amazon Resource Name (ARN) домена OpenSearch.

domainEndpoint -> (строка)

URL конечной точки домена OpenSearch.

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

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

metadataField -> (строка)

Имя поля, в котором Amazon Bedrock хранит метаданные о векторном хранилище.

textField -> (строка)

Имя поля, в котором Amazon Bedrock хранит исходный текст из ваших данных. Текст разделен в соответствии с выбранной стратегией фрагментации.

vectorField -> (строка)

Имя поля, в котором Amazon Bedrock хранит векторные вложения для ваших источников данных.

vectorIndexName -> (строка)

Имя векторного хранилища.

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

Содержит конфигурацию хранения базы знаний в Amazon OpenSearch Service.

collectionArn -> (строка)

Amazon Resource Name (ARN) векторного хранилища OpenSearch Service.

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

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

metadataField -> (строка)

Имя поля, в котором Amazon Bedrock хранит метаданные о векторном хранилище.

textField -> (строка)

Имя поля, в котором Amazon Bedrock хранит исходный текст из ваших данных. Текст разделен в соответствии с выбранной стратегией фрагментации.

vectorField -> (строка)

Имя поля, в котором Amazon Bedrock хранит векторные вложения для ваших источников данных.

vectorIndexName -> (строка)

Имя векторного хранилища.

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

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

connectionString -> (строка)

URL конечной точки для вашей страницы управления индексом.

credentialsSecretArn -> (строка)

Amazon Resource Name (ARN) секрета, который вы создали в Secrets Manager, связанного с вашим API-ключом Pinecone.

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

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

metadataField -> (строка)

Имя поля, в котором Amazon Bedrock хранит метаданные о векторном хранилище.

textField -> (строка)

Имя поля, в котором Amazon Bedrock хранит исходный текст из ваших данных. Текст разделен в соответствии с выбранной стратегией фрагментации.

namespace -> (строка)

Пространство имен для записи новых данных в вашу базу данных.

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

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

credentialsSecretArn -> (строка)

Amazon Resource Name (ARN) секрета, который вы создали в Secrets Manager, связанного с вашей базой данных Amazon RDS.

databaseName -> (строка)

Имя вашей базы данных Amazon RDS.

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

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

customMetadataField -> (строка)

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

metadataField -> (строка)

Имя поля, в котором Amazon Bedrock хранит метаданные о векторном хранилище.

primaryKeyField -> (строка)

Имя поля, в котором Amazon Bedrock хранит идентификатор каждой записи.

textField -> (строка)

Имя поля, в котором Amazon Bedrock хранит исходный текст из ваших данных. Текст разделен в соответствии с выбранной стратегией фрагментации.

vectorField -> (строка)

Имя поля, в котором Amazon Bedrock хранит векторные вложения для ваших источников данных.

resourceArn -> (строка)

Amazon Resource Name (ARN) векторного хранилища.

tableName -> (строка)

Имя таблицы в базе данных.

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

Содержит конфигурацию хранения базы знаний в Redis Enterprise Cloud.

credentialsSecretArn -> (строка)

Amazon Resource Name (ARN) секрета, который вы создали в Secrets Manager, связанного с вашей базой данных Redis Enterprise Cloud.

endpoint -> (строка)

URL конечной точки базы данных Redis Enterprise Cloud.

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

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

metadataField -> (строка)

Имя поля, в котором Amazon Bedrock хранит метаданные о векторном хранилище.

textField -> (строка)

Имя поля, в котором Amazon Bedrock хранит исходный текст из ваших данных. Текст разделен в соответствии с выбранной стратегией фрагментации.

vectorField -> (строка)

Имя поля, в котором Amazon Bedrock хранит векторные вложения для ваших источников данных.

vectorIndexName -> (строка)

Имя индекса векторов.

type -> (строка)

Сервис векторного хранилища, в котором хранится база знаний.

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

Время последнего обновления базы знаний.

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

Spec-Zone.ru

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