Spec-Zone.ru › AWS CLI v2

[ aws . wisdom ]

обновить-шаблон-uri-базы-знаний

Описание

Обновляет URI шаблона базы знаний. Поддерживается только для баз знаний типа EXTERNAL. Включите одну переменную в формате ${variable}; эта переменная интерполируется Wisdom с использованием загруженного контента. Например, если вы загружаете статью Salesforce, у неё есть значение Id, и вы можете установить URI шаблона на https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

См. также: документацию API AWS

Синтаксис

  update-knowledge-base-template-uri
--knowledge-base-id <value>
--template-uri <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.

--template-uri (строка)

URI шаблона для обновления.

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

Обновляемая база знаний.

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 DataIntegration для загрузки контента.

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

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

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

objectFields -> (список)

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

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

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

(строка)

status -> (строка)

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

tags -> (карта)

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

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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