Class RecognizeUtteranceRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.lexruntimev2.model.LexRuntimeV2Request
-
- software.amazon.awssdk.services.lexruntimev2.model.RecognizeUtteranceRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<RecognizeUtteranceRequest.Builder,RecognizeUtteranceRequest>
@Generated("software.amazon.awssdk:codegen") public final class RecognizeUtteranceRequest extends LexRuntimeV2Request implements ToCopyableBuilder<RecognizeUtteranceRequest.Builder,RecognizeUtteranceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRecognizeUtteranceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbotAliasId()The alias identifier in use for the bot that should receive the request.StringbotId()The identifier of the bot that should receive the request.static RecognizeUtteranceRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringlocaleId()The locale where the session is in use.StringrequestAttributes()Request-specific information passed between the client application and Amazon Lex V2StringrequestContentType()Indicates the format for audio input or that the content is text.StringresponseContentType()The message that Amazon Lex V2 returns in the response can be either text or speech based on theresponseContentTypevalue.List<SdkField<?>>sdkFields()static Class<? extends RecognizeUtteranceRequest.Builder>serializableBuilderClass()StringsessionId()The identifier of the session in use.StringsessionState()Sets the state of the session with the user.RecognizeUtteranceRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
botId
public final String botId()
The identifier of the bot that should receive the request.
- Returns:
- The identifier of the bot that should receive the request.
-
botAliasId
public final String 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
public final String localeId()
The locale where the session is in use.
- Returns:
- The locale where the session is in use.
-
sessionId
public final String sessionId()
The identifier of the session in use.
- Returns:
- The identifier of the session in use.
-
sessionState
public final 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
sessionStatefield 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
sessionStatefield must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
-
requestAttributes
public final 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 prefixx-amz-lex:.The
requestAttributesfield 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
requestAttributesfield must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.
-
requestContentType
public final 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
-
- 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
public final String responseContentType()
The message that Amazon Lex V2 returns in the response can be either text or speech based on the
responseContentTypevalue.-
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 theresponseContentTypeparameter. For example, if you specifyaudio/mpegas the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm, the speech returned isaudio/pcmat 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
responseContentTypevalue.-
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 theresponseContentTypeparameter. For example, if you specifyaudio/mpegas the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm, the speech returned isaudio/pcmat 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
public RecognizeUtteranceRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RecognizeUtteranceRequest.Builder,RecognizeUtteranceRequest>- Specified by:
toBuilderin classLexRuntimeV2Request
-
builder
public static RecognizeUtteranceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends RecognizeUtteranceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-