Class: Aws::LexModelBuildingService::Types::PutBotRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

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
    },
  ],
  clarification_prompt: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    max_attempts: 1, # required
    response_card: "ResponseCard",
  },
  abort_statement: {
    messages: [ # required
      {
        content_type: "PlainText", # required, accepts PlainText, SSML
        content: "ContentString", # required
      },
    ],
    response_card: "ResponseCard",
  },
  idle_session_ttl_in_seconds: 1,
  voice_id: "String",
  checksum: "String",
  process_behavior: "SAVE", # accepts SAVE, BUILD
  locale: "en-US", # required, accepts en-US
  child_directed: false, # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#abort_statement ⇒ Types::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 aborts 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.

Returns:



2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#checksum ⇒ String

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.

Returns:

  • (String) 


2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#child_directed ⇒ Boolean

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]: aws.amazon.com/lex/faqs#data-security

Returns:

  • (Boolean) 


2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#clarification_prompt ⇒ Types::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 repeate 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.’”

Returns:



2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#description ⇒ String

A description of the bot.

Returns:

  • (String) 


2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#idle_session_ttl_in_seconds ⇒ Integer

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

Returns:

  • (Integer) 


2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#intents ⇒ Array<Types::Intent>

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.

Returns:



2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#locale ⇒ String

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

Returns:

  • (String) 


2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#name ⇒ String

The name of the bot. The name is not case sensitive.

Returns:

  • (String) 


2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#process_behavior ⇒ String

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 ‘Save`.

Returns:

  • (String) 


2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end

#voice_id ⇒ String

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 [Available Voices] in the *Amazon Polly Developer Guide*.

[1]: docs.aws.amazon.com/polly/latest/dg/voicelist.html

Returns:

  • (String) 


2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2489

class PutBotRequest < Struct.new(
  :name,
  :description,
  :intents,
  :clarification_prompt,
  :abort_statement,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :process_behavior,
  :locale,
  :child_directed)
  include Aws::Structure
end