RecognizeUtteranceResult (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.lexruntimev2.model

Class RecognizeUtteranceResult

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.lexruntimev2.model.RecognizeUtteranceResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RecognizeUtteranceResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RecognizeUtteranceResult ()

Constructors
Constructor and Description
`RecognizeUtteranceResult ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`RecognizeUtteranceResult`	`clone ()`
`boolean`	`equals (Object obj)`
`InputStream`	`getAudioStream ()` The prompt or statement to send to the user.
`String`	`getContentType ()` Content type as specified in the `responseContentType` in the request.
`String`	`getInputMode ()` Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
`String`	`getInputTranscript ()` The text used to process the request.
`String`	`getInterpretations ()` A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
`String`	`getMessages ()` A list of messages that were last sent to the user.
`String`	`getRecognizedBotMember ()` The bot member that recognized the utterance.
`String`	`getRequestAttributes ()` The attributes sent in the request.
`String`	`getSessionId ()` The identifier of the session in use.
`String`	`getSessionState ()` Represents the current state of the dialog between the user and the bot.
`int`	`hashCode ()`
`void`	`setAudioStream (InputStream audioStream)` The prompt or statement to send to the user.
`void`	`setContentType (String contentType)` Content type as specified in the `responseContentType` in the request.
`void`	`setInputMode (String inputMode)` Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
`void`	`setInputTranscript (String inputTranscript)` The text used to process the request.
`void`	`setInterpretations (String interpretations)` A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
`void`	`setMessages (String messages)` A list of messages that were last sent to the user.
`void`	`setRecognizedBotMember (String recognizedBotMember)` The bot member that recognized the utterance.
`void`	`setRequestAttributes (String requestAttributes)` The attributes sent in the request.
`void`	`setSessionId (String sessionId)` The identifier of the session in use.
`void`	`setSessionState (String sessionState)` Represents the current state of the dialog between the user and the bot.
`String`	`toString ()` Returns a string representation of this object.
`RecognizeUtteranceResult`	`withAudioStream (InputStream audioStream)` The prompt or statement to send to the user.
`RecognizeUtteranceResult`	`withContentType (String contentType)` Content type as specified in the `responseContentType` in the request.
`RecognizeUtteranceResult`	`withInputMode (String inputMode)` Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
`RecognizeUtteranceResult`	`withInputTranscript (String inputTranscript)` The text used to process the request.
`RecognizeUtteranceResult`	`withInterpretations (String interpretations)` A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
`RecognizeUtteranceResult`	`withMessages (String messages)` A list of messages that were last sent to the user.
`RecognizeUtteranceResult`	`withRecognizedBotMember (String recognizedBotMember)` The bot member that recognized the utterance.
`RecognizeUtteranceResult`	`withRequestAttributes (String requestAttributes)` The attributes sent in the request.
`RecognizeUtteranceResult`	`withSessionId (String sessionId)` The identifier of the session in use.
`RecognizeUtteranceResult`	`withSessionState (String sessionState)` Represents the current state of the dialog between the user and the bot.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RecognizeUtteranceResult
```
public RecognizeUtteranceResult()
```
- Method Detail
  - setInputMode
```
public void setInputMode(String inputMode)
```
    Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
    
    Parameters:
    
    inputMode - Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
  - getInputMode
```
public String getInputMode()
```
    Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
    
    Returns:
    
    Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
  - withInputMode
```
public RecognizeUtteranceResult withInputMode(String inputMode)
```
    Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
    
    Parameters:
    
    inputMode - Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentType
```
public void setContentType(String contentType)
```
    Content type as specified in the responseContentType in the request.
    
    Parameters:
    
    contentType - Content type as specified in the responseContentType in the request.
  - getContentType
```
public String getContentType()
```
    Content type as specified in the responseContentType in the request.
    
    Returns:
    
    Content type as specified in the responseContentType in the request.
  - withContentType
```
public RecognizeUtteranceResult withContentType(String contentType)
```
    Content type as specified in the responseContentType in the request.
    
    Parameters:
    
    contentType - Content type as specified in the responseContentType in the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessages
```
public void setMessages(String messages)
```
    A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
    
    The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Parameters:
    
    messages - A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
    
    The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
  - getMessages
```
public String getMessages()
```
    A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
    
    The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Returns:
    
    A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
    
    The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
  - withMessages
```
public RecognizeUtteranceResult withMessages(String messages)
```
    A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
    
    The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Parameters:
    
    messages - A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
    
    The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInterpretations
```
public void setInterpretations(String interpretations)
```
    A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
    
    Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
    
    The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Parameters:
    
    interpretations - A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
    
    Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
    
    The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
  - getInterpretations
```
public String getInterpretations()
```
    A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
    
    Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
    
    The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Returns:
    
    A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
    
    Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
    
    The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
  - withInterpretations
```
public RecognizeUtteranceResult withInterpretations(String interpretations)
```
    A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
    
    Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
    
    The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Parameters:
    
    interpretations - A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
    
    Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
    
    The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSessionState
```
public void setSessionState(String sessionState)
```
    Represents the current state of the dialog between the user and the bot.
    
    Use this to determine the progress of the conversation and what the next action might be.
    
    The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Parameters:
    
    sessionState - Represents the current state of the dialog between the user and the bot.
    
    Use this to determine the progress of the conversation and what the next action might be.
    
    The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
  - getSessionState
```
public String getSessionState()
```
    Represents the current state of the dialog between the user and the bot.
    
    Use this to determine the progress of the conversation and what the next action might be.
    
    The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Returns:
    
    Represents the current state of the dialog between the user and the bot.
    
    Use this to determine the progress of the conversation and what the next action might be.
    
    The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
  - withSessionState
```
public RecognizeUtteranceResult withSessionState(String sessionState)
```
    Represents the current state of the dialog between the user and the bot.
    
    Use this to determine the progress of the conversation and what the next action might be.
    
    The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Parameters:
    
    sessionState - Represents the current state of the dialog between the user and the bot.
    
    Use this to determine the progress of the conversation and what the next action might be.
    
    The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequestAttributes
```
public void setRequestAttributes(String requestAttributes)
```
    The attributes sent in the request.
    
    The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.
    
    Parameters:
    
    requestAttributes - The attributes sent in the request.
    
    The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.
  - getRequestAttributes
```
public String getRequestAttributes()
```
    The attributes sent in the request.
    
    The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.
    
    Returns:
    
    The attributes sent in the request.
    
    The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.
  - withRequestAttributes
```
public RecognizeUtteranceResult withRequestAttributes(String requestAttributes)
```
    The attributes sent in the request.
    
    The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.
    
    Parameters:
    
    requestAttributes - The attributes sent in the request.
    
    The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSessionId
```
public void setSessionId(String sessionId)
```
    The identifier of the session in use.
    
    Parameters:
    
    sessionId - The identifier of the session in use.
  - getSessionId
```
public String getSessionId()
```
    The identifier of the session in use.
    
    Returns:
    
    The identifier of the session in use.
  - withSessionId
```
public RecognizeUtteranceResult withSessionId(String sessionId)
```
    The identifier of the session in use.
    
    Parameters:
    
    sessionId - The identifier of the session in use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputTranscript
```
public void setInputTranscript(String inputTranscript)
```
    The text used to process the request.
    
    If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.
    
    The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Parameters:
    
    inputTranscript - The text used to process the request.
    
    If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.
    
    The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
  - getInputTranscript
```
public String getInputTranscript()
```
    The text used to process the request.
    
    If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.
    
    The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Returns:
    
    The text used to process the request.
    
    If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.
    
    The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
  - withInputTranscript
```
public RecognizeUtteranceResult withInputTranscript(String inputTranscript)
```
    The text used to process the request.
    
    If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.
    
    The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Parameters:
    
    inputTranscript - The text used to process the request.
    
    If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.
    
    The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAudioStream
```
public void setAudioStream(InputStream audioStream)
```
    The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.
    
    Parameters:
    
    audioStream - The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.
  - getAudioStream
```
public InputStream getAudioStream()
```
    The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.
    
    Returns:
    
    The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.
  - withAudioStream
```
public RecognizeUtteranceResult withAudioStream(InputStream audioStream)
```
    The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.
    
    Parameters:
    
    audioStream - The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecognizedBotMember
```
public void setRecognizedBotMember(String recognizedBotMember)
```
    The bot member that recognized the utterance.
    
    Parameters:
    
    recognizedBotMember - The bot member that recognized the utterance.
  - getRecognizedBotMember
```
public String getRecognizedBotMember()
```
    The bot member that recognized the utterance.
    
    Returns:
    
    The bot member that recognized the utterance.
  - withRecognizedBotMember
```
public RecognizeUtteranceResult withRecognizedBotMember(String recognizedBotMember)
```
    The bot member that recognized the utterance.
    
    Parameters:
    
    recognizedBotMember - The bot member that recognized the utterance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 RecognizeUtteranceResult clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class RecognizeUtteranceResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

RecognizeUtteranceResult

Method Detail

setInputMode

getInputMode

withInputMode

setContentType

getContentType

withContentType

setMessages

getMessages

withMessages

setInterpretations

getInterpretations

withInterpretations

setSessionState

getSessionState

withSessionState

setRequestAttributes

getRequestAttributes

withRequestAttributes

setSessionId

getSessionId

withSessionId

setInputTranscript

getInputTranscript

withInputTranscript

setAudioStream

getAudioStream

withAudioStream

setRecognizedBotMember

getRecognizedBotMember

withRecognizedBotMember

toString

equals

hashCode

clone