Class: Aws::LexModelBuildingService::Types::PutBotResponse

Inherits:

Struct

• Object
• Struct
• Aws::LexModelBuildingService::Types::PutBotResponse

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #abort_statement ⇒ Types::Statement

  The message that Amazon Lex uses to cancel a conversation.

• #checksum ⇒ String

  Checksum of the bot that you created.

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

• #clarification_prompt ⇒ Types::Prompt

  The prompts that Amazon Lex uses when it doesn’t understand the user’s intent.

• #create_version ⇒ Boolean

  ‘True` if a new version of the bot was created.

• #created_date ⇒ Time

  The date that the bot was created.

• #description ⇒ String

  A description of the bot.

• #detect_sentiment ⇒ Boolean

  ‘true` if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis.

• #enable_model_improvements ⇒ Boolean

  Indicates whether the bot uses accuracy improvements.

• #failure_reason ⇒ String

  If ‘status` is `FAILED`, Amazon Lex provides the reason that it failed to build the bot.

• #idle_session_ttl_in_seconds ⇒ Integer

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

• #intents ⇒ Array<Types::Intent>

  An array of ‘Intent` objects.

• #last_updated_date ⇒ Time

  The date that the bot was updated.

• #locale ⇒ String

  The target locale for the bot.

• #name ⇒ String

  The name of the bot.

• #nlu_intent_confidence_threshold ⇒ Float

  The score that determines where Amazon Lex inserts the ‘AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a [PostContent] or [PostText] response.

• #status ⇒ String

  When you send a request to create a bot with ‘processBehavior` set to `BUILD`, Amazon Lex sets the `status` response element to `BUILDING`.

• #tags ⇒ Array<Types::Tag>

  A list of tags associated with the bot.

• #version ⇒ String

  The version of the bot.

• #voice_id ⇒ String

  The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

Instance Attribute Details

#abort_statement ⇒ Types::Statement

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

Returns:

• (Types::Statement)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#checksum ⇒ String

Checksum of the bot that you created.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#clarification_prompt ⇒ Types::Prompt

The prompts that Amazon Lex uses when it doesn’t understand the user’s intent. For more information, see PutBot.

Returns:

• (Types::Prompt)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#create_version ⇒ Boolean

‘True` if a new version of the bot was created. If the `createVersion` field was not specified in the request, the `createVersion` field is set to false in the response.

Returns:

• (Boolean)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

The date that the bot was created.

Returns:

• (Time)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the bot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#detect_sentiment ⇒ Boolean

‘true` if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the `detectSentiment` field was not specified in the request, the `detectSentiment` field is `false` in the response.

Returns:

• (Boolean)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enable_model_improvements ⇒ Boolean

Indicates whether the bot uses accuracy improvements. ‘true` indicates that the bot is using the improvements, otherwise, `false`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If ‘status` is `FAILED`, Amazon Lex provides the reason that it failed to build the bot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#idle_session_ttl_in_seconds ⇒ Integer

The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

Returns:

• (Integer)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#intents ⇒ Array<Types::Intent>

An array of ‘Intent` objects. For more information, see PutBot.

Returns:

• (Array<Types::Intent>)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date ⇒ Time

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

Returns:

• (Time)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#locale ⇒ String

The target locale for the bot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the bot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nlu_intent_confidence_threshold ⇒ Float

The score that determines where Amazon Lex inserts the ‘AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a [PostContent] or [PostText] response. `AMAZON.FallbackIntent` is inserted if the confidence score for all intents is below this value. `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot.

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

Returns:

• (Float)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

When you send a request to create a bot with ‘processBehavior` set to `BUILD`, Amazon Lex sets the `status` response element to `BUILDING`.

In the ‘READY_BASIC_TESTING` state you can test the bot with user inputs that exactly match the utterances configured for the bot’s intents and values in the slot types.

If Amazon Lex can’t build the bot, Amazon Lex sets ‘status` to `FAILED`. Amazon Lex returns the reason for the failure in the `failureReason` response element.

When you set ‘processBehavior` to `SAVE`, Amazon Lex sets the status code to `NOT BUILT`.

When the bot is in the ‘READY` state you can test and publish the bot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags associated with the bot.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version of the bot. For a new bot, the version is always ‘$LATEST`.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#voice_id ⇒ String

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3424

class PutBotResponse < Struct.new(
  :name,
  :description,
  :intents,
  :enable_model_improvements,
  :nlu_intent_confidence_threshold,
  :clarification_prompt,
  :abort_statement,
  :status,
  :failure_reason,
  :last_updated_date,
  :created_date,
  :idle_session_ttl_in_seconds,
  :voice_id,
  :checksum,
  :version,
  :locale,
  :child_directed,
  :create_version,
  :detect_sentiment,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end