start-import

Описание

Начинает импорт бота, языкового локализованного бота или пользовательского словаря из zip-архива, загруженного в ведро S3.

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

Синтаксис

  start-import
--import-id <value>
--resource-specification <value>
--merge-strategy <value>
[--file-password <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]

Параметры

--import-id (строка)

Уникальный идентификатор импорта. Он включен в ответ от операции CreateUploadUrl.

--resource-specification (структура)

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

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

Параметры для импорта бота.

botName -> (строка)

Имя, которое Amazon Lex должен использовать для бота.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, используемой для построения и запуска бота.

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

По умолчанию данные, хранящиеся Amazon Lex, шифруются. Структура DataPrivacy предоставляет параметры, определяющие, как Amazon Lex обрабатывает особые случаи обеспечения безопасности данных для вашего бота.

childDirected -> (логическое значение)

Для каждого бота Amazon Lex, созданного с помощью Amazon Lex Model Building Service, необходимо указать, относится ли ваше использование Amazon Lex к веб-сайту, программе или другому приложению, направленному или ориентированному, полностью или частично, на детей младше 13 лет и подпадающему под действие Закона о защите частной жизни детей в интернете (COPPA), указав true или false в поле childDirected. Указав true в поле childDirected, вы подтверждаете, что ваше использование Amazon Lex действительно относится к веб-сайту, программе или другому приложению, которое направлено или ориентировано полностью или частично на детей младше 13 лет и подпадает под действие COPPA. Указав false в поле childDirected, вы подтверждаете, что ваше использование Amazon Lex **не** относится к веб-сайту, программе или другому приложению, которое направлено или ориентировано полностью или частично на детей младше 13 лет и подпадает под действие COPPA. Вы не можете указать значение по умолчанию для поля childDirected, которое не точно отражает, относится ли ваше использование Amazon Lex к веб-сайту, программе или другому приложению, направленному или ориентированному полностью или частично на детей младше 13 лет и подпадающему под действие COPPA. Если ваше использование Amazon Lex относится к веб-сайту, программе или другому приложению, направленному полностью или частично на детей младше 13 лет, вы должны получить требуемое подтвержденное родительское согласие в соответствии с COPPA. Сведения об использовании Amazon Lex в связи с веб-сайтами, программами или другими приложениями, направленными или ориентированными, полностью или частично, на детей младше 13 лет, см. в FAQ Amazon Lex.

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

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

enabled -> (логическое значение)

Параметры настроек для журналов ошибок, если они включены.

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

Время в секундах, которое Amazon Lex должен хранить информацию о разговоре пользователя с ботом.

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

Вы можете указать от 60 (1 минута) до 86 400 (24 часа) секунд.

botTags -> (карта)

Список тегов для добавления к боту. Вы можете добавить теги только при импорте бота. Вы не можете использовать операцию UpdateBot для обновления тегов. Для обновления тегов используйте операцию TagResource.

key -> (строка)

value -> (строка)

testBotAliasTags -> (карта)

Список тегов для добавления к тестовому псевдониму бота. Вы можете добавить теги только при импорте бота. Вы не можете использовать операцию UpdateAlias для обновления тегов. Для обновления тегов тестового псевдонима используйте операцию TagResource.

key -> (строка)

value -> (строка)

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

Параметры для импорта локализованного бота.

botId -> (строка)

Идентификатор бота, к которому нужно импортировать локаль.

botVersion -> (строка)

Версия бота, к которой нужно импортировать локаль. Это может быть только версия DRAFT бота.

localeId -> (строка)

Идентификатор языка и локали, в которых будет использоваться бот. Строка должна соответствовать одному из поддерживаемых языков. Все используемые в боте намерения, типы слотов и слоты должны иметь одну и ту же локаль. Дополнительные сведения см. в разделе Поддерживаемые языки.

nluIntentConfidenceThreshold -> (двойное число)

Определяет порог, на котором Amazon Lex вставит AMAZON.FallbackIntent, AMAZON.KendraSearchIntent или оба, при возврате альтернативных намерений. AMAZON.FallbackIntent и AMAZON.KendraSearchIntent вставляются только в том случае, если они настроены для бота.

Например, предположим, что бот настроен на порог уверенности 0,80 и AMAZON.FallbackIntent. Amazon Lex возвращает три альтернативных намерения со следующими баллами уверенности: намерениеA (0,70), намерениеB (0,60), намерениеC (0,50). Ответ от операции PostText будет:

AMAZON.FallbackIntent
IntentA
IntentB
IntentC

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

Определяет параметры использования голоса Amazon Polly для общения с пользователем.

Допустимые значения:

standard
neural
long-form
generative

voiceId -> (строка)

Идентификатор голоса Amazon Polly, который следует использовать.

engine -> (строка)

Указывает тип голоса Amazon Polly, который Amazon Lex должен использовать для голосового взаимодействия с пользователем. Дополнительные сведения см. в параметре ` engine операции SynthesizeSpeech <https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine>`__ в руководстве разработчика Amazon Polly.

Если вы не укажете значение, по умолчанию будет standard.

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

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

botId -> (строка)

Идентификатор бота, к которому нужно импортировать пользовательский словарь.

botVersion -> (строка)

Версия бота, к которому нужно импортировать пользовательский словарь.

localeId -> (строка)

Идентификатор локали для импорта пользовательского словаря. Значение должно быть en_GB.

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

Характеристики набора тестов, который импортируется.

testSetName -> (строка)

Имя набора тестов.

description -> (строка)

Описание набора тестов.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, имеющей разрешения на доступ к набору тестов.

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

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

s3BucketName -> (строка)

Имя ведра Amazon S3, в котором хранится набор тестов.

s3Path -> (строка)

Путь внутри ведра Amazon S3, где хранится набор тестов.

kmsKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа управления ключами Amazon Web Services (KMS) для шифрования набора тестов.

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

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

s3BucketName -> (строка)

Имя ведра Amazon S3.

s3Path -> (строка)

Путь внутри ведра Amazon S3, указывающий на файл CSV набора тестов.

modality -> (строка)

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

testSetTags -> (карта)

Список тегов для добавления к набору тестов. Вы можете добавить теги только при импорте/создании нового набора тестов. Вы не можете использовать операцию UpdateTestSet для обновления тегов. Для обновления тегов используйте операцию TagResource.

key -> (строка)

value -> (строка)

Упрощенный синтаксис:

botImportSpecification={botName=string,roleArn=string,dataPrivacy={childDirected=boolean},errorLogSettings={enabled=boolean},idleSessionTTLInSeconds=integer,botTags={KeyName1=string,KeyName2=string},testBotAliasTags={KeyName1=string,KeyName2=string}},botLocaleImportSpecification={botId=string,botVersion=string,localeId=string,nluIntentConfidenceThreshold=double,voiceSettings={voiceId=string,engine=string}},customVocabularyImportSpecification={botId=string,botVersion=string,localeId=string},testSetImportResourceSpecification={testSetName=string,description=string,roleArn=string,storageLocation={s3BucketName=string,s3Path=string,kmsKeyArn=string},importInputLocation={s3BucketName=string,s3Path=string},modality=string,testSetTags={KeyName1=string,KeyName2=string}}

Синтаксис JSON:

{
  "botImportSpecification": {
    "botName": "string",
    "roleArn": "string",
    "dataPrivacy": {
      "childDirected": true|false
    },
    "errorLogSettings": {
      "enabled": true|false
    },
    "idleSessionTTLInSeconds": integer,
    "botTags": {"string": "string"
      ...},
    "testBotAliasTags": {"string": "string"
      ...}
  },
  "botLocaleImportSpecification": {
    "botId": "string",
    "botVersion": "string",
    "localeId": "string",
    "nluIntentConfidenceThreshold": double,
    "voiceSettings": {
      "voiceId": "string",
      "engine": "standard"|"neural"|"long-form"|"generative"
    }
  },
  "customVocabularyImportSpecification": {
    "botId": "string",
    "botVersion": "string",
    "localeId": "string"
  },
  "testSetImportResourceSpecification": {
    "testSetName": "string",
    "description": "string",
    "roleArn": "string",
    "storageLocation": {
      "s3BucketName": "string",
      "s3Path": "string",
      "kmsKeyArn": "string"
    },
    "importInputLocation": {
      "s3BucketName": "string",
      "s3Path": "string"
    },
    "modality": "Text"|"Audio",
    "testSetTags": {"string": "string"
      ...}
  }
}

--merge-strategy (строка)

Стратегия, используемая при конфликте имен между импортируемым ресурсом и существующим ресурсом. При стратегии слияния FailOnConflict существующие ресурсы не перезаписываются, и импорт завершается неудачно.

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

Overwrite
FailOnConflict
Append

--file-password (строка)

Пароль, используемый для шифрования zip-архива, содержащего определение ресурса. Вы всегда должны шифровать zip-архив, чтобы защитить его во время передачи между вашим сайтом и Amazon Lex.

--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.

Вывод

importId -> (строка)

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

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

Параметры, используемые при импорте ресурса.

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

Параметры импорта бота.

botName -> (строка)

Имя, которое Amazon Lex должен использовать для бота.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, используемой для создания и запуска бота.

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

По умолчанию данные, хранящиеся Amazon Lex, зашифрованы. Структура DataPrivacy предоставляет настройки, определяющие, как Amazon Lex обрабатывает особые случаи защиты данных для вашего бота.

childDirected -> (булево)

Для каждого бота Amazon Lex, созданного с помощью Amazon Lex Model Building Service, вы должны указать, относится ли ваше использование Amazon Lex к веб-сайту, программе или другому приложению, которое целиком или частично направлено или ориентировано на детей младше 13 лет и подпадает под Закон о защите частной жизни детей онлайн (COPPA), указав true или false в поле childDirected. Указав true в поле childDirected, вы подтверждаете, что ваше использование Amazon Lex относится к веб-сайту, программе или другому приложению, которое целиком или частично направлено или ориентировано на детей младше 13 лет и подпадает под COPPA. Указав false в поле childDirected, вы подтверждаете, что ваше использование Amazon Lex не относится к веб-сайту, программе или другому приложению, которое целиком или частично направлено или ориентировано на детей младше 13 лет и подпадает под COPPA. Вы не можете указать значение по умолчанию для поля childDirected, которое неточно отражает, относится ли ваше использование Amazon Lex к веб-сайту, программе или другому приложению, которое целиком или частично направлено или ориентировано на детей младше 13 лет и подпадает под COPPA. Если ваше использование Amazon Lex относится к веб-сайту, программе или другому приложению, которое целиком или частично направлено на детей младше 13 лет, вы должны получить необходимую проверенную родительскую санкцию в соответствии с COPPA. Дополнительную информацию об использовании Amazon Lex в связи с веб-сайтами, программами или другими приложениями, которые целиком или частично направлены или ориентированы на детей младше 13 лет, см. в разделе Часто задаваемые вопросы Amazon Lex.

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

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

enabled -> (булево)

Параметры настроек журналов ошибок, когда они включены.

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

Время в секундах, которое Amazon Lex должен хранить информацию о разговоре пользователя с ботом.

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

Вы можете указать значение от 60 (1 минута) до 86 400 (24 часа) секунд.

botTags -> (карта)

Список тегов для добавления к боту. Вы можете добавлять теги только при импорте бота. Вы не можете использовать операцию UpdateBot для обновления тегов. Для обновления тегов используйте операцию TagResource.

key -> (строка)

value -> (строка)

testBotAliasTags -> (карта)

Список тегов для добавления к тестовому псевдониму бота. Вы можете добавлять теги только при импорте бота. Вы не можете использовать операцию UpdateAlias для обновления тегов. Для обновления тегов тестового псевдонима используйте операцию TagResource.

key -> (строка)

value -> (строка)

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

Параметры импорта локали бота.

botId -> (строка)

Идентификатор бота, к которому импортируется локализация.

botVersion -> (строка)

Версия бота, к которой импортируется локализация. Это может быть только версия DRAFT бота.

localeId -> (строка)

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

nluIntentConfidenceThreshold -> (двойное число)

Определяет порог, при котором Amazon Lex вставит AMAZON.FallbackIntent , AMAZON.KendraSearchIntent или оба при возврате альтернативных интентов. AMAZON.FallbackIntent и AMAZON.KendraSearchIntent вставляются только в том случае, если они настроены для бота.

Например, предположим, что для бота настроен порог уверенности 0,80 и AMAZON.FallbackIntent . Amazon Lex возвращает три альтернативных интента со следующими значениями уверенности: IntentA (0,70), IntentB (0,60), IntentC (0,50). Ответ от операции PostText будет:

AMAZON.FallbackIntent
IntentA
IntentB
IntentC

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

Определяет настройки использования голоса Amazon Polly для общения с пользователем.

Допустимые значения:

standard
neural
long-form
generative

voiceId -> (строка)

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

engine -> (строка)

Указывает тип голоса Amazon Polly, который Amazon Lex должен использовать для голосового взаимодействия с пользователем. Дополнительную информацию см. в параметре `engine` операции SynthesizeSpeech в руководстве разработчика Amazon Polly.

Если вы не укажете значение, по умолчанию будет standard.

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

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

botId -> (строка)

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

botVersion -> (строка)

Версия бота, к которой импортируется пользовательский словарь.

localeId -> (строка)

Идентификатор локали для импорта пользовательского словаря. Значение должно быть en_GB.

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

Спецификации набора тестов, который импортируется.

testSetName -> (строка)

Название набора тестов.

description -> (строка)

Описание набора тестов.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, имеющей разрешение на доступ к набору тестов.

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

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

s3BucketName -> (строка)

Название ведра Amazon S3, в котором хранится набор тестов.

s3Path -> (строка)

Путь внутри ведра Amazon S3, где хранится набор тестов.

kmsKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа управления ключами Amazon Web Services (KMS) для шифрования набора тестов.

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

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

s3BucketName -> (строка)

Название ведра Amazon S3.

s3Path -> (строка)

Путь внутри ведра Amazon S3, указывающий на CSV-файл набора тестов.

modality -> (строка)

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

testSetTags -> (карта)

Список тегов для добавления к набору тестов. Вы можете добавлять теги только при импорте/создании нового набора тестов. Вы не можете использовать операцию UpdateTestSet для обновления тегов. Для обновления тегов используйте операцию TagResource.

key -> (строка)

value -> (строка)

mergeStrategy -> (строка)

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

importStatus -> (строка)

Текущий статус импорта. Когда статус равен Complete, бот, псевдоним бота или пользовательский словарь готовы к использованию.

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

Дата и время создания запроса на импорт.

END_OF_DOCUMENT_MARKER