software.amazon.awssdk.services.lexmodelbuilding.model

Class GetBotResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse

software.amazon.awssdk.services.lexmodelbuilding.model.GetBotResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetBotResponse.Builder,GetBotResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetBotResponse
extends LexModelBuildingResponse
implements ToCopyableBuilder<GetBotResponse.Builder,GetBotResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetBotResponse.Builder

Method Summary

Modifier and Type	Method and Description
Statement	abortStatement() The message that Amazon Lex returns when the user elects to end the conversation without completing it.
static GetBotResponse.Builder	builder()
String	checksum() Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
Boolean	childDirected() 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.
Prompt	clarificationPrompt() The message Amazon Lex uses when it doesn't understand the user's request.
Instant	createdDate() The date that the bot was created.
String	description() A description of the bot.
Boolean	detectSentiment() Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.
Boolean	enableModelImprovements() Indicates whether the bot uses accuracy improvements.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If status is FAILED, Amazon Lex explains why it failed to build the bot.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIntents() For responses, this returns true if the service returned a value for the Intents property.
Integer	idleSessionTTLInSeconds() The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
List<Intent>	intents() An array of intent objects.
Instant	lastUpdatedDate() The date that the bot was updated.
Locale	locale() The target locale for the bot.
String	localeAsString() The target locale for the bot.
String	name() The name of the bot.
Double	nluIntentConfidenceThreshold() 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.
List<SdkField<?>>	sdkFields()
static Class<? extends GetBotResponse.Builder>	serializableBuilderClass()
Status	status() The status of the bot.
String	statusAsString() The status of the bot.
GetBotResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The version of the bot.
String	voiceId() The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

Methods inherited from class software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the bot.

Returns:

The name of the bot.

description

public final String description()

A description of the bot.

Returns:

A description of the bot.

hasIntents

public final boolean hasIntents()

For responses, this returns true if the service returned a value for the Intents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

intents

public final List<Intent> intents()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIntents() method.

Returns:

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

enableModelImprovements

public final Boolean enableModelImprovements()

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

Returns:

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

nluIntentConfidenceThreshold

public final Double nluIntentConfidenceThreshold()

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:

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.

clarificationPrompt

public final Prompt clarificationPrompt()

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

Returns:

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

abortStatement

public final Statement abortStatement()

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

Returns:

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

status

public final Status status()

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.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

Status

statusAsString

public final String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

Status

failureReason

public final String failureReason()

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

Returns:

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

lastUpdatedDate

public final Instant lastUpdatedDate()

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

Returns:

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

createdDate

public final Instant createdDate()

The date that the bot was created.

Returns:

The date that the bot was created.

idleSessionTTLInSeconds

public final Integer idleSessionTTLInSeconds()

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

Returns:

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

voiceId

public final String voiceId()

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

Returns:

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

checksum

public final String checksum()

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

Returns:

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

version

public final String version()

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

Returns:

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

locale

public final Locale locale()

The target locale for the bot.

If the service returns an enum value that is not available in the current SDK version, locale will return Locale.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localeAsString().

Returns:

The target locale for the bot.

See Also:

Locale

localeAsString

public final String localeAsString()

The target locale for the bot.

If the service returns an enum value that is not available in the current SDK version, locale will return Locale.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localeAsString().

Returns:

The target locale for the bot.

See Also:

Locale

childDirected

public final Boolean childDirected()

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:

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.

detectSentiment

public final Boolean detectSentiment()

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

Returns:

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

toBuilder

public GetBotResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetBotResponse.Builder,GetBotResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetBotResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetBotResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo