Spec-Zone.ru › AWS CLI v2

[ aws . wisdom ]

создать-базу-знаний

Описание

Создает базу знаний.

Примечание

При использовании этого API вы не можете повторно использовать Amazon AppIntegrations DataIntegrations с внешними базами знаний, такими как Salesforce и ServiceNow. В противном случае вы получите ошибку InvalidRequestException.

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

  • Вызовите DeleteKnowledgeBase .
  • Вызовите DeleteDataIntegration .
  • Вызовите CreateDataIntegration для повторного создания DataIntegration или создания другого.
  • Вызовите CreateKnowledgeBase.

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

Синтаксис

  create-knowledge-base
[--client-token <value>]
[--description <value>]
--knowledge-base-type <value>
--name <value>
[--rendering-configuration <value>]
[--server-side-encryption-configuration <value>]
[--source-configuration <value>]
[--tags <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]

Параметры

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы гарантировать идемпотентность запроса. Если не предоставлен, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API .

--description (строка)

Описание.

--knowledge-base-type (строка)

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

Возможные значения:

  • EXTERNAL
  • CUSTOM
  • QUICK_RESPONSES

--name (строка)

Имя базы знаний.

--rendering-configuration (структура)

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

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 .

Синтаксис сокращенной записи:

templateUri=string

Синтаксис JSON:

{
  "templateUri": "string"
}

--server-side-encryption-configuration (структура)

Конфигурация информации для управляемого клиентом ключа, используемого для шифрования.

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

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

kmsKeyId -> (строка)

Управляемый клиентом ключ, используемый для шифрования. Дополнительную информацию о настройке управляемого клиентом ключа для Wisdom см. в разделе Включение Amazon Connect Wisdom для вашего экземпляра . Сведения о допустимых значениях ID см. в разделе Идентификаторы ключей (KeyId) .

Синтаксис сокращенной записи:

kmsKeyId=string

Синтаксис JSON:

{
  "kmsKeyId": "string"
}

--source-configuration (структура помеченного союза)

Источник содержимого базы знаний. Укажите этот аргумент только для внешних баз знаний.

Примечание

Это структура помеченного союза. Можно задать только один из следующих ключей верхнего уровня: 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 .

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

(строка)

Синтаксис сокращенной записи:

appIntegrations={appIntegrationArn=string,objectFields=[string,string]}

Синтаксис JSON:

{
  "appIntegrations": {
    "appIntegrationArn": "string",
    "objectFields": ["string", ...]
  }
}

--tags (карта)

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

key -> (строка)

value -> (строка)

Синтаксис сокращенной записи:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 (boolean)

Включить отладочную запись журналов.

--endpoint-url (string)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверит SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы входных параметров 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