class Aws::LexModelBuildingService::Types::PutBotRequest

@note When making an API call, you may pass PutBotRequest

data as a hash:

    {
      name: "BotName", # required
      description: "Description",
      intents: [
        {
          intent_name: "IntentName", # required
          intent_version: "Version", # required
        },
      ],
      enable_model_improvements: false,
      nlu_intent_confidence_threshold: 1.0,
      clarification_prompt: {
        messages: [ # required
          {
            content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
            content: "ContentString", # required
            group_number: 1,
          },
        ],
        max_attempts: 1, # required
        response_card: "ResponseCard",
      },
      abort_statement: {
        messages: [ # required
          {
            content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
            content: "ContentString", # required
            group_number: 1,
          },
        ],
        response_card: "ResponseCard",
      },
      idle_session_ttl_in_seconds: 1,
      voice_id: "String",
      checksum: "String",
      process_behavior: "SAVE", # accepts SAVE, BUILD
      locale: "de-DE", # required, accepts de-DE, en-AU, en-GB, en-IN, en-US, es-419, es-ES, es-US, fr-FR, fr-CA, it-IT, ja-JP, ko-KR
      child_directed: false, # required
      detect_sentiment: false,
      create_version: false,
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    }

@!attribute [rw] name

The name of the bot. The name is *not* case sensitive.
@return [String]

@!attribute [rw] description

A description of the bot.
@return [String]

@!attribute [rw] intents

An array of `Intent` objects. Each intent represents a command that
a user can express. For example, a pizza ordering bot might support
an OrderPizza intent. For more information, see how-it-works.
@return [Array<Types::Intent>]

@!attribute [rw] enable_model_improvements

Set to `true` to enable access to natural language understanding
improvements.

When you set the `enableModelImprovements` parameter to `true` you
can use the `nluIntentConfidenceThreshold` parameter to configure
confidence scores. For more information, see [Confidence Scores][1].

You can only set the `enableModelImprovements` parameter in certain
Regions. If you set the parameter to `true`, your bot has access to
accuracy improvements.

The Regions where you can set the `enableModelImprovements`
parameter to `true` are:

* US East (N. Virginia) (us-east-1)

* US West (Oregon) (us-west-2)

* Asia Pacific (Sydney) (ap-southeast-2)

* EU (Ireland) (eu-west-1)

In other Regions, the `enableModelImprovements` parameter is set to
`true` by default. In these Regions setting the parameter to `false`
throws a `ValidationException` exception.

[1]: https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html
@return [Boolean]

@!attribute [rw] nlu_intent_confidence_threshold

Determines the threshold where Amazon Lex will insert the
`AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when
returning alternative intents in a [PostContent][1] or [PostText][2]
response. `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent`
are only inserted if they are configured for the bot.

You must set the `enableModelImprovements` parameter to `true` to
use confidence scores in the following regions.

* US East (N. Virginia) (us-east-1)

* US West (Oregon) (us-west-2)

* Asia Pacific (Sydney) (ap-southeast-2)

* EU (Ireland) (eu-west-1)

In other Regions, the `enableModelImprovements` parameter is set to
`true` by default.

For example, suppose a bot is configured with the confidence
threshold of 0.80 and the `AMAZON.FallbackIntent`. Amazon Lex
returns three alternative intents with the following confidence
scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response
from the `PostText` operation would be:

* AMAZON.FallbackIntent

* IntentA

* IntentB

* IntentC

[1]: https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html
[2]: https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html
@return [Float]

@!attribute [rw] clarification_prompt

When Amazon Lex doesn't understand the user's intent, it uses this
message to get clarification. To specify how many times Amazon Lex
should repeat the clarification prompt, use the `maxAttempts` field.
If Amazon Lex still doesn't understand, it sends the message in the
`abortStatement` field.

When you create a clarification prompt, make sure that it suggests
the correct response from the user. for example, for a bot that
orders pizza and drinks, you might create this clarification prompt:
"What would you like to do? You can say 'Order a pizza' or
'Order a drink.'"

If you have defined a fallback intent, it will be invoked if the
clarification prompt is repeated the number of times defined in the
`maxAttempts` field. For more information, see [
AMAZON.FallbackIntent][1].

If you don't define a clarification prompt, at runtime Amazon Lex
will return a 400 Bad Request exception in three cases:

* Follow-up prompt - When the user responds to a follow-up prompt
  but does not provide an intent. For example, in response to a
  follow-up prompt that says "Would you like anything else today?"
  the user says "Yes." Amazon Lex will return a 400 Bad Request
  exception because it does not have a clarification prompt to send
  to the user to get an intent.

* Lambda function - When using a Lambda function, you return an
  `ElicitIntent` dialog type. Since Amazon Lex does not have a
  clarification prompt to get an intent from the user, it returns a
  400 Bad Request exception.

* PutSession operation - When using the `PutSession` operation, you
  send an `ElicitIntent` dialog type. Since Amazon Lex does not have
  a clarification prompt to get an intent from the user, it returns
  a 400 Bad Request exception.

[1]: https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html
@return [Types::Prompt]

@!attribute [rw] abort_statement

When Amazon Lex can't understand the user's input in context, it
tries to elicit the information a few times. After that, Amazon Lex
sends the message defined in `abortStatement` to the user, and then
cancels the conversation. To set the number of retries, use the
`valueElicitationPrompt` field for the slot type.

For example, in a pizza ordering bot, Amazon Lex might ask a user
"What type of crust would you like?" If the user's response is
not one of the expected responses (for example, "thin crust, "deep
dish," etc.), Amazon Lex tries to elicit a correct response a few
more times.

For example, in a pizza ordering application, `OrderPizza` might be
one of the intents. This intent might require the `CrustType` slot.
You specify the `valueElicitationPrompt` field when you create the
`CrustType` slot.

If you have defined a fallback intent the cancel statement will not
be sent to the user, the fallback intent is used instead. For more
information, see [ AMAZON.FallbackIntent][1].

[1]: https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html
@return [Types::Statement]

@!attribute [rw] idle_session_ttl_in_seconds

The maximum time in seconds that Amazon Lex retains the data
gathered in a conversation.

A user interaction session remains active for the amount of time
specified. If no conversation occurs during this time, the session
expires and Amazon Lex deletes any data provided before the timeout.

For example, suppose that a user chooses the OrderPizza intent, but
gets sidetracked halfway through placing an order. If the user
doesn't complete the order within the specified time, Amazon Lex
discards the slot information that it gathered, and the user must
start over.

If you don't include the `idleSessionTTLInSeconds` element in a
`PutBot` operation request, Amazon Lex uses the default value. This
is also true if the request replaces an existing bot.

The default is 300 seconds (5 minutes).
@return [Integer]

@!attribute [rw] voice_id

The Amazon Polly voice ID that you want Amazon Lex to use for voice
interactions with the user. The locale configured for the voice must
match the locale of the bot. For more information, see [Voices in
Amazon Polly][1] in the *Amazon Polly Developer Guide*.

[1]: https://docs.aws.amazon.com/polly/latest/dg/voicelist.html
@return [String]

@!attribute [rw] checksum

Identifies a specific revision of the `$LATEST` version.

When you create a new bot, leave the `checksum` field blank. If you
specify a checksum you get a `BadRequestException` exception.

When you want to update a bot, set the `checksum` field to the
checksum of the most recent revision of the `$LATEST` version. If
you don't specify the ` checksum` field, or if the checksum does
not match the `$LATEST` version, you get a
`PreconditionFailedException` exception.
@return [String]

@!attribute [rw] process_behavior

If you set the `processBehavior` element to `BUILD`, Amazon Lex
builds the bot so that it can be run. If you set the element to
`SAVE` Amazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is `BUILD`.
@return [String]

@!attribute [rw] locale

Specifies the target locale for the bot. Any intent used in the bot
must be compatible with the locale of the bot.

The default is `en-US`.
@return [String]

@!attribute [rw] child_directed

For each Amazon Lex bot created with the Amazon Lex Model Building
Service, you must specify whether your use of Amazon Lex is related
to a website, program, or other application that is directed or
targeted, in whole or in part, to children under age 13 and subject
to the Children's Online Privacy Protection Act (COPPA) by
specifying `true` or `false` in the `childDirected` field. By
specifying `true` in the `childDirected` field, you confirm that
your use of Amazon Lex **is** related to a website, program, or
other application that is directed or targeted, in whole or in part,
to children under age 13 and subject to COPPA. By specifying `false`
in the `childDirected` field, you confirm that your use of Amazon
Lex **is not** related to a website, program, or other application
that is directed or targeted, in whole or in part, to children under
age 13 and subject to COPPA. You may not specify a default value for
the `childDirected` field that does not accurately reflect whether
your use of Amazon Lex is related to a website, program, or other
application that is directed or targeted, in whole or in part, to
children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other
application that is directed in whole or in part, to children under
age 13, you must obtain any required verifiable parental consent
under COPPA. For information regarding the use of Amazon Lex in
connection with websites, programs, or other applications that are
directed or targeted, in whole or in part, to children under age 13,
see the [Amazon Lex FAQ.][1]

[1]: https://aws.amazon.com/lex/faqs#data-security
@return [Boolean]

@!attribute [rw] detect_sentiment

When set to `true` user utterances are sent to Amazon Comprehend for
sentiment analysis. If you don't specify `detectSentiment`, the
default is `false`.
@return [Boolean]

@!attribute [rw] create_version

When set to `true` a new numbered version of the bot is created.
This is the same as calling the `CreateBotVersion` operation. If you
don't specify `createVersion`, the default is `false`.
@return [Boolean]

@!attribute [rw] tags

A list of tags to add to the bot. You can only add tags when you
create a bot, you can't use the `PutBot` operation to update the
tags on a bot. To update tags, use the `TagResource` operation.
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/PutBotRequest AWS API Documentation

Constants

SENSITIVE