com.amazonaws.services.lexruntimev2.model

Class RecognizeUtteranceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lexruntimev2.model.RecognizeUtteranceRequest

All Implemented Interfaces:

SignerTypeAware, HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RecognizeUtteranceRequest()

Method Summary

Modifier and Type	Method and Description
RecognizeUtteranceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getBotAliasId() The alias identifier in use for the bot that should receive the request.
String	getBotId() The identifier of the bot that should receive the request.
InputStream	getInputStream() User input in PCM or Opus audio format or text format as described in the requestContentType parameter.
String	getLocaleId() The locale where the session is in use.
String	getRequestAttributes() Request-specific information passed between the client application and Amazon Lex V2
String	getRequestContentType() Indicates the format for audio input or that the content is text.
String	getResponseContentType() The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.
String	getSessionId() The identifier of the session in use.
String	getSessionState() Sets the state of the session with the user.
String	getSignerType()
int	hashCode()
void	setBotAliasId(String botAliasId) The alias identifier in use for the bot that should receive the request.
void	setBotId(String botId) The identifier of the bot that should receive the request.
void	setInputStream(InputStream inputStream) User input in PCM or Opus audio format or text format as described in the requestContentType parameter.
void	setLocaleId(String localeId) The locale where the session is in use.
void	setRequestAttributes(String requestAttributes) Request-specific information passed between the client application and Amazon Lex V2
void	setRequestContentType(String requestContentType) Indicates the format for audio input or that the content is text.
void	setResponseContentType(String responseContentType) The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.
void	setSessionId(String sessionId) The identifier of the session in use.
void	setSessionState(String sessionState) Sets the state of the session with the user.
String	toString() Returns a string representation of this object.
RecognizeUtteranceRequest	withBotAliasId(String botAliasId) The alias identifier in use for the bot that should receive the request.
RecognizeUtteranceRequest	withBotId(String botId) The identifier of the bot that should receive the request.
RecognizeUtteranceRequest	withInputStream(InputStream inputStream) User input in PCM or Opus audio format or text format as described in the requestContentType parameter.
RecognizeUtteranceRequest	withLocaleId(String localeId) The locale where the session is in use.
RecognizeUtteranceRequest	withRequestAttributes(String requestAttributes) Request-specific information passed between the client application and Amazon Lex V2
RecognizeUtteranceRequest	withRequestContentType(String requestContentType) Indicates the format for audio input or that the content is text.
RecognizeUtteranceRequest	withResponseContentType(String responseContentType) The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.
RecognizeUtteranceRequest	withSessionId(String sessionId) The identifier of the session in use.
RecognizeUtteranceRequest	withSessionState(String sessionState) Sets the state of the session with the user.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecognizeUtteranceRequest

public RecognizeUtteranceRequest()

Method Detail

setBotId

public void setBotId(String botId)

The identifier of the bot that should receive the request.

Parameters:

botId - The identifier of the bot that should receive the request.

getBotId

public String getBotId()

The identifier of the bot that should receive the request.

Returns:

The identifier of the bot that should receive the request.

withBotId

public RecognizeUtteranceRequest withBotId(String botId)

The identifier of the bot that should receive the request.

Parameters:

botId - The identifier of the bot that should receive the request.

Returns:

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

setBotAliasId

public void setBotAliasId(String botAliasId)

The alias identifier in use for the bot that should receive the request.

Parameters:

botAliasId - The alias identifier in use for the bot that should receive the request.

getBotAliasId

public String getBotAliasId()

The alias identifier in use for the bot that should receive the request.

Returns:

The alias identifier in use for the bot that should receive the request.

withBotAliasId

public RecognizeUtteranceRequest withBotAliasId(String botAliasId)

The alias identifier in use for the bot that should receive the request.

Parameters:

botAliasId - The alias identifier in use for the bot that should receive the request.

Returns:

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

setLocaleId

public void setLocaleId(String localeId)

The locale where the session is in use.

Parameters:

localeId - The locale where the session is in use.

getLocaleId

public String getLocaleId()

The locale where the session is in use.

Returns:

The locale where the session is in use.

withLocaleId

public RecognizeUtteranceRequest withLocaleId(String localeId)

The locale where the session is in use.

Parameters:

localeId - The locale where the session is in use.

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 RecognizeUtteranceRequest 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.

setSessionState

public void setSessionState(String sessionState)

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

Parameters:

sessionState - Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

getSessionState

public String getSessionState()

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

Returns:

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

withSessionState

public RecognizeUtteranceRequest withSessionState(String sessionState)

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

Parameters:

sessionState - Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

Returns:

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

setRequestAttributes

public void setRequestAttributes(String requestAttributes)

Request-specific information passed between the client application and Amazon Lex V2

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

Parameters:

requestAttributes - Request-specific information passed between the client application and Amazon Lex V2

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

getRequestAttributes

public String getRequestAttributes()

Request-specific information passed between the client application and Amazon Lex V2

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

Returns:

Request-specific information passed between the client application and Amazon Lex V2

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

withRequestAttributes

public RecognizeUtteranceRequest withRequestAttributes(String requestAttributes)

Request-specific information passed between the client application and Amazon Lex V2

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

Parameters:

requestAttributes - Request-specific information passed between the client application and Amazon Lex V2

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

Returns:

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

setRequestContentType

public void setRequestContentType(String requestContentType)

Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

• PCM format, audio data must be in little-endian byte order.

  • audio/l16; rate=16000; channels=1

  • audio/x-l16; sample-rate=16000; channel-count=1

  • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

• Opus format

  • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

• Text format

  • text/plain; charset=utf-8

Parameters:

requestContentType - Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

• PCM format, audio data must be in little-endian byte order.

  • audio/l16; rate=16000; channels=1

  • audio/x-l16; sample-rate=16000; channel-count=1

  • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

• Opus format

  • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

• Text format

  • text/plain; charset=utf-8

getRequestContentType

public String getRequestContentType()

Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

• PCM format, audio data must be in little-endian byte order.

  • audio/l16; rate=16000; channels=1

  • audio/x-l16; sample-rate=16000; channel-count=1

  • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

• Opus format

  • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

• Text format

  • text/plain; charset=utf-8

Returns:

Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

• PCM format, audio data must be in little-endian byte order.

  • audio/l16; rate=16000; channels=1

  • audio/x-l16; sample-rate=16000; channel-count=1

  • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

• Opus format

  • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

• Text format

  • text/plain; charset=utf-8

withRequestContentType

public RecognizeUtteranceRequest withRequestContentType(String requestContentType)

Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

• PCM format, audio data must be in little-endian byte order.

  • audio/l16; rate=16000; channels=1

  • audio/x-l16; sample-rate=16000; channel-count=1

  • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

• Opus format

  • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

• Text format

  • text/plain; charset=utf-8

Parameters:

requestContentType - Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

• PCM format, audio data must be in little-endian byte order.

  • audio/l16; rate=16000; channels=1

  • audio/x-l16; sample-rate=16000; channel-count=1

  • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

• Opus format

  • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

• Text format

  • text/plain; charset=utf-8

Returns:

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

setResponseContentType

public void setResponseContentType(String responseContentType)

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

• If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

• If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

Parameters:

responseContentType - The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

• If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

• If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

getResponseContentType

public String getResponseContentType()

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

• If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

• If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

Returns:

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

• If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

• If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

withResponseContentType

public RecognizeUtteranceRequest withResponseContentType(String responseContentType)

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

• If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

• If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

Parameters:

responseContentType - The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

• If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

• If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm (16 KHz)

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

Returns:

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

setInputStream

public void setInputStream(InputStream inputStream)

User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

Parameters:

inputStream - User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

getInputStream

public InputStream getInputStream()

User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

Returns:

User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

withInputStream

public RecognizeUtteranceRequest withInputStream(InputStream inputStream)

User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

Parameters:

inputStream - User input in PCM or Opus audio format or text format as described in the requestContentType parameter.

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 RecognizeUtteranceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()

getSignerType

public String getSignerType()

Specified by:

getSignerType in interface SignerTypeAware