software.amazon.awssdk.services.lexruntimev2.model

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(value="software.amazon.awssdk:codegen")
public final class RecognizeUtteranceRequest
extends LexRuntimeV2Request
implements ToCopyableBuilder<RecognizeUtteranceRequest.Builder,RecognizeUtteranceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecognizeUtteranceRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	botAliasId() The alias identifier in use for the bot that should receive the request.
String	botId() The identifier of the bot that should receive the request.
static RecognizeUtteranceRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	localeId() The locale where the session is in use.
String	requestAttributes() Request-specific information passed between the client application and Amazon Lex
String	requestContentType() Indicates the format for audio input or that the content is text.
String	responseContentType() The message that Amazon Lex returns in the response can be either text or speech based on the responseContentType value.
List<SdkField<?>>	sdkFields()
static Class<? extends RecognizeUtteranceRequest.Builder>	serializableBuilderClass()
String	sessionId() The identifier of the session in use.
String	sessionState() Sets the state of the session with the user.
RecognizeUtteranceRequest.Builder	toBuilder()
String	toString() 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 should use in the conversation with the user.

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 should use in the conversation with the user.

requestAttributes

public final String requestAttributes()

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

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

Returns:

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

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

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 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 returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex 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 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 returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex 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

toBuilder

public RecognizeUtteranceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecognizeUtteranceRequest.Builder,RecognizeUtteranceRequest>

Specified by:

toBuilder in class LexRuntimeV2Request

builder

public static RecognizeUtteranceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RecognizeUtteranceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo