com.amazonaws.services.lexruntimev2.model

Class Interpretation

java.lang.Object

com.amazonaws.services.lexruntimev2.model.Interpretation

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Interpretation
extends Object
implements Serializable, Cloneable, StructuredPojo

An object containing information about an intent that Amazon Lex V2 determined might satisfy the user's utterance. The intents are ordered by the confidence score.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Interpretation()

Method Summary

Modifier and Type	Method and Description
Interpretation	clone()
boolean	equals(Object obj)
Intent	getIntent() A list of intents that might satisfy the user's utterance.
String	getInterpretationSource() Specifies the service that interpreted the input.
ConfidenceScore	getNluConfidence() Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response.
SentimentResponse	getSentimentResponse() The sentiment expressed in an utterance.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setIntent(Intent intent) A list of intents that might satisfy the user's utterance.
void	setInterpretationSource(String interpretationSource) Specifies the service that interpreted the input.
void	setNluConfidence(ConfidenceScore nluConfidence) Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response.
void	setSentimentResponse(SentimentResponse sentimentResponse) The sentiment expressed in an utterance.
String	toString() Returns a string representation of this object.
Interpretation	withIntent(Intent intent) A list of intents that might satisfy the user's utterance.
Interpretation	withInterpretationSource(InterpretationSource interpretationSource) Specifies the service that interpreted the input.
Interpretation	withInterpretationSource(String interpretationSource) Specifies the service that interpreted the input.
Interpretation	withNluConfidence(ConfidenceScore nluConfidence) Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response.
Interpretation	withSentimentResponse(SentimentResponse sentimentResponse) The sentiment expressed in an utterance.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Interpretation

public Interpretation()

Method Detail

setNluConfidence

public void setNluConfidence(ConfidenceScore nluConfidence)

Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

Parameters:

nluConfidence - Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

getNluConfidence

public ConfidenceScore getNluConfidence()

Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

Returns:

Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

withNluConfidence

public Interpretation withNluConfidence(ConfidenceScore nluConfidence)

Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

Parameters:

nluConfidence - Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSentimentResponse

public void setSentimentResponse(SentimentResponse sentimentResponse)

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

Parameters:

sentimentResponse - The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

getSentimentResponse

public SentimentResponse getSentimentResponse()

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

Returns:

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

withSentimentResponse

public Interpretation withSentimentResponse(SentimentResponse sentimentResponse)

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

Parameters:

sentimentResponse - The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIntent

public void setIntent(Intent intent)

A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

Parameters:

intent - A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

getIntent

public Intent getIntent()

A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

Returns:

A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

withIntent

public Interpretation withIntent(Intent intent)

A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

Parameters:

intent - A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInterpretationSource

public void setInterpretationSource(String interpretationSource)

Specifies the service that interpreted the input.

Parameters:

interpretationSource - Specifies the service that interpreted the input.

See Also:

InterpretationSource

getInterpretationSource

public String getInterpretationSource()

Specifies the service that interpreted the input.

Returns:

Specifies the service that interpreted the input.

See Also:

InterpretationSource

withInterpretationSource

public Interpretation withInterpretationSource(String interpretationSource)

Specifies the service that interpreted the input.

Parameters:

interpretationSource - Specifies the service that interpreted the input.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InterpretationSource

withInterpretationSource

public Interpretation withInterpretationSource(InterpretationSource interpretationSource)

Specifies the service that interpreted the input.

Parameters:

interpretationSource - Specifies the service that interpreted the input.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InterpretationSource

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Interpretation clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.