Start Bot Recommendation

lexmodelsv2_start_bot_recommendation

R Documentation

Use this to provide your transcript data, and to start the bot recommendation process¶

Description¶

Use this to provide your transcript data, and to start the bot recommendation process.

Usage¶

lexmodelsv2_start_bot_recommendation(botId, botVersion, localeId,
  transcriptSourceSetting, encryptionSetting)

Arguments¶

botId: [required] The unique identifier of the bot containing the bot recommendation.
botVersion: [required] The version of the bot containing the bot recommendation.
localeId: [required] The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
transcriptSourceSetting: [required] The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
encryptionSetting: The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

Value¶

A list with the following syntax:

list(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  botRecommendationStatus = "Processing"|"Deleting"|"Deleted"|"Downloading"|"Updating"|"Available"|"Failed"|"Stopping"|"Stopped",
  botRecommendationId = "string",
  creationDateTime = as.POSIXct(
    "2015-01-01"
  ),
  transcriptSourceSetting = list(
    s3BucketTranscriptSource = list(
      s3BucketName = "string",
      pathFormat = list(
        objectPrefixes = list(
          "string"
        )
      ),
      transcriptFormat = "Lex",
      transcriptFilter = list(
        lexTranscriptFilter = list(
          dateRangeFilter = list(
            startDateTime = as.POSIXct(
              "2015-01-01"
            ),
            endDateTime = as.POSIXct(
              "2015-01-01"
            )
          )
        )
      ),
      kmsKeyArn = "string"
    )
  ),
  encryptionSetting = list(
    kmsKeyArn = "string",
    botLocaleExportPassword = "string",
    associatedTranscriptsPassword = "string"
  )
)

Request syntax¶

svc$start_bot_recommendation(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  transcriptSourceSetting = list(
    s3BucketTranscriptSource = list(
      s3BucketName = "string",
      pathFormat = list(
        objectPrefixes = list(
          "string"
        )
      ),
      transcriptFormat = "Lex",
      transcriptFilter = list(
        lexTranscriptFilter = list(
          dateRangeFilter = list(
            startDateTime = as.POSIXct(
              "2015-01-01"
            ),
            endDateTime = as.POSIXct(
              "2015-01-01"
            )
          )
        )
      ),
      kmsKeyArn = "string"
    )
  ),
  encryptionSetting = list(
    kmsKeyArn = "string",
    botLocaleExportPassword = "string",
    associatedTranscriptsPassword = "string"
  )
)