Class: Aws::LexModelBuildingService::Types::GetBotResponse

Inherits:

Struct

Object
Struct
Aws::LexModelBuildingService::Types::GetBotResponse

show all

Defined in:: gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#abort_statement ⇒ Types::Statement
The message that Amazon Lex returns when the user elects to end the conversation without completing it.
#checksum ⇒ String
Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
#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 message Amazon Lex uses when it doesn't understand the user's request.
#created_date ⇒ Time
The date that the bot was created.
#description ⇒ String
A description of the bot.
#detect_sentiment ⇒ Boolean
Indicates whether user utterances should be sent 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 explains why it failed to build the bot.
#idle_session_ttl_in_seconds ⇒ Integer
The maximum time in seconds 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][1] or [PostText][2] response.
#status ⇒ String
The status of 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 returns when the user elects to end the conversation without completing it. For more information, see PutBot.

Returns:

(Types::Statement)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#checksum ⇒ `String`

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

Returns:

(String)

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

class GetBotResponse < 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,
  :detect_sentiment)
  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.

Returns:

(Boolean)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#clarification_prompt ⇒ `Types::Prompt`

The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

Returns:

(Types::Prompt)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ `Time`

The date that the bot was created.

Returns:

(Time)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description of the bot.

Returns:

(String)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#detect_sentiment ⇒ `Boolean`

Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.

Returns:

(Boolean)

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

class GetBotResponse < 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,
  :detect_sentiment)
  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 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 1403

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ `String`

If status is FAILED, Amazon Lex explains why it failed to build the bot.

Returns:

(String)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  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. For more information, see PutBot.

Returns:

(Integer)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#intents ⇒ `Array<Types::Intent>`

An array of intent objects. For more information, see PutBot.

Returns:

(Array<Types::Intent>)

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

class GetBotResponse < 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,
  :detect_sentiment)
  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 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 1403

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#locale ⇒ `String`

The target locale for the bot.

Returns:

(String)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the bot.

Returns:

(String)

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

class GetBotResponse < 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,
  :detect_sentiment)
  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.

Returns:

(Float)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the bot.

When the status is BUILDING Amazon Lex is building the bot for testing and use.

If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY.

If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build.

If the bot was saved but not built, the status is NOT_BUILT.

Returns:

(String)

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

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ `String`

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

Returns:

(String)

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

class GetBotResponse < 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,
  :detect_sentiment)
  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 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 1403

class GetBotResponse < 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,
  :detect_sentiment)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::LexModelBuildingService::Types::GetBotResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#abort_statement ⇒ Types::Statement

#checksum ⇒ String

#child_directed ⇒ Boolean

#clarification_prompt ⇒ Types::Prompt

#created_date ⇒ Time

#description ⇒ String

#detect_sentiment ⇒ Boolean

#enable_model_improvements ⇒ Boolean

#failure_reason ⇒ String

#idle_session_ttl_in_seconds ⇒ Integer

#intents ⇒ Array<Types::Intent>

#last_updated_date ⇒ Time

#locale ⇒ String

#name ⇒ String

#nlu_intent_confidence_threshold ⇒ Float

#status ⇒ String

#version ⇒ String

#voice_id ⇒ String

#abort_statement ⇒ `Types::Statement`

#checksum ⇒ `String`

#child_directed ⇒ `Boolean`

#clarification_prompt ⇒ `Types::Prompt`

#created_date ⇒ `Time`

#description ⇒ `String`

#detect_sentiment ⇒ `Boolean`

#enable_model_improvements ⇒ `Boolean`

#failure_reason ⇒ `String`

#idle_session_ttl_in_seconds ⇒ `Integer`

#intents ⇒ `Array<Types::Intent>`

#last_updated_date ⇒ `Time`

#locale ⇒ `String`

#name ⇒ `String`

#nlu_intent_confidence_threshold ⇒ `Float`

#status ⇒ `String`

#version ⇒ `String`

#voice_id ⇒ `String`