Class: Aws::LexModelBuildingService::Types::CreateBotVersionResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#abort_statementTypes::Statement

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

Returns:



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#checksumString

Checksum identifying the version of the bot that was created.

Returns:

  • (String)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#child_directedBoolean

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)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#clarification_promptTypes::Prompt

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

Returns:



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#created_dateTime

The date when the bot version was created.

Returns:

  • (Time)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#descriptionString

A description of the bot.

Returns:

  • (String)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#detect_sentimentBoolean

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

Returns:

  • (Boolean)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#enable_model_improvementsBoolean

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

Returns:

  • (Boolean)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#failure_reasonString

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

Returns:

  • (String)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#idle_session_ttl_in_secondsInteger

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

Returns:

  • (Integer)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#intentsArray<Types::Intent>

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

Returns:



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#last_updated_dateTime

The date when the $LATEST version of this bot was updated.

Returns:

  • (Time)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#localeString

Specifies the target locale for the bot.

Returns:

  • (String)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#nameString

The name of the bot.

Returns:

  • (String)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#statusString

When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

Returns:

  • (String)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#versionString

The version of the bot.

Returns:

  • (String)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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

#voice_idString

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

Returns:

  • (String)


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 508

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