Class RecognizeUtteranceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RecognizeUtteranceRequest.Builder,
RecognizeUtteranceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The alias identifier in use for the bot that should receive the request.final String
botId()
The identifier of the bot that should receive the request.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
localeId()
The locale where the session is in use.final String
Request-specific information passed between the client application and Amazon Lex V2final String
Indicates the format for audio input or that the content is text.final String
The message that Amazon Lex V2 returns in the response can be either text or speech based on theresponseContentType
value.static Class
<? extends RecognizeUtteranceRequest.Builder> final String
The identifier of the session in use.final String
Sets the state of the session with the user.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
botId
The identifier of the bot that should receive the request.
- Returns:
- The identifier of the bot that should receive the request.
-
botAliasId
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.
-
localeId
The locale where the session is in use.
- Returns:
- The locale where the session is in use.
-
sessionId
The identifier of the session in use.
- Returns:
- The identifier of the session in use.
-
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:
- 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.
-
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 prefixx-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 prefixx-amz-lex:
.The
requestAttributes
field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
-
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:
- 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
-
-
-
-
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 theresponseContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned isaudio/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 theresponseContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned isaudio/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
-
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RecognizeUtteranceRequest.Builder,
RecognizeUtteranceRequest> - Specified by:
toBuilder
in classLexRuntimeV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-