Spec-Zone.ru › AWS CLI v2

[ aws . wisdom ]

get-knowledge-base

Описание

Получает информацию о базе знаний.

См. также: Документацию 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 (строка)

Идентификатор базы знаний. Не должен быть базой знаний типа QUICK_RESPONSES, если вы сохраняете в нее ресурсы Wisdom Content. Может быть либо ID, либо ARN. URL не могут содержать ARN.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

База знаний.

description -> (строка)

Описание.

knowledgeBaseArn -> (строка)

Идентификатор Amazon Resource Name (ARN) базы знаний.

knowledgeBaseId -> (строка)

Идентификатор базы знаний. Не должен быть базой знаний типа QUICK_RESPONSES, если вы сохраняете в неё ресурсы Wisdom Content.

knowledgeBaseType -> (строка)

Тип базы знаний.

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

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

name -> (строка)

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

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

Информация о том, как отобразить содержимое.

templateUri -> (строка)

Шаблон URI, содержащий ровно одну переменную в формате ${variableName}. Это можно задать только для баз знаний типа EXTERNAL. Для Salesforce, ServiceNow и Zendesk переменная должна быть одной из следующих:

  • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus или IsDeleted
  • ServiceNow: number , short_description , sys_mod_count , workflow_state или active
  • Zendesk: id , title , updated_at или draft

Переменная заменяется фактическим значением для фрагмента содержимого при вызове GetContent.

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

Настройка информации о ключе управляемого клиентом для шифрования.

Ключ KMS должен иметь политику, которая разрешает kms:CreateGrant , kms:DescribeKey и kms:Decrypt/kms:GenerateDataKey разрешения для идентификатора IAM, использующего ключ для вызова Wisdom.

Дополнительную информацию о настройке ключа управляемого клиентом для Wisdom см. в разделе Enable Amazon Connect Wisdom for your instance.

kmsKeyId -> (строка)

Ключ управляемого клиентом для шифрования. Дополнительную информацию о настройке ключа управляемого клиентом для Wisdom см. в разделе Enable Amazon Connect Wisdom for your instance. Информацию о допустимых значениях ID см. в разделе Идентификаторы ключей (KeyId).

sourceConfiguration -> (меченый объединяемый структура)

Информация о конфигурации источника базы знаний.

Примечание

Это меченая объединяемая структура. Может быть установлено только одно из следующих ключевых слов верхнего уровня: appIntegrations.

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

Конфигурация информации для Amazon AppIntegrations для автоматического извлечения содержимого.

appIntegrationArn -> (строка)

Идентификатор Amazon Resource Name (ARN) интеграции данных AppIntegrations для извлечения содержимого.

  • Для Salesforce ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не указана, включая по меньшей мере Id , ArticleNumber , VersionNumber , Title , PublishStatus и IsDeleted в качестве исходных полей.
  • Для ServiceNow ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не указана, включая по меньшей мере number , short_description , sys_mod_count , workflow_state и active в качестве исходных полей.
  • Для Zendesk ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не указана, включая по меньшей мере id , title , updated_at и draft в качестве исходных полей.
  • Для SharePoint ваша интеграция данных AppIntegrations должна иметь FileConfiguration, включая только расширения файлов, которые находятся среди docx , pdf , html , htm и txt.
  • Для Amazon S3 ObjectConfiguration и FileConfiguration вашей интеграции данных AppIntegrations должны быть null. SourceURI вашей интеграции данных должен использовать следующий формат: s3://your_s3_bucket_name.

Предупреждение

Политика ведра соответствующего ведра S3 должна разрешать принципалу Amazon Web Services app-integrations.amazonaws.com выполнять s3:ListBucket , s3:GetObject и s3:GetBucketLocation для ведра.

objectFields -> (список)

Поля из источника, которые предоставляются вашим агентам в Wisdom. Необязательно, если ObjectConfiguration включена в предоставленную интеграцию данных.

  • Для Salesforce вы должны включить по меньшей мере Id , ArticleNumber , VersionNumber , Title , PublishStatus и IsDeleted.
  • Для ServiceNow вы должны включить по меньшей мере number , short_description , sys_mod_count , workflow_state и active.
  • Для Zendesk вы должны включить по меньшей мере id , title , updated_at и draft.

Убедитесь, что вы включили дополнительные поля. Эти поля индексируются и используются для получения рекомендаций.

(строка)

status -> (string)

Состояние базы знаний.

tags -> (map)

Теги, используемые для организации, отслеживания или контроля доступа к этому ресурсу.

key -> (string)

value -> (string)

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

Spec-Zone.ru

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