AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest Class Reference

#include <RecognizeUtteranceRequest.h>

+ Inheritance diagram for Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest:

Public Member Functions

 RecognizeUtteranceRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
bool SignBody () const override
 
const Aws::StringGetBotId () const
 
bool BotIdHasBeenSet () const
 
void SetBotId (const Aws::String &value)
 
void SetBotId (Aws::String &&value)
 
void SetBotId (const char *value)
 
RecognizeUtteranceRequestWithBotId (const Aws::String &value)
 
RecognizeUtteranceRequestWithBotId (Aws::String &&value)
 
RecognizeUtteranceRequestWithBotId (const char *value)
 
const Aws::StringGetBotAliasId () const
 
bool BotAliasIdHasBeenSet () const
 
void SetBotAliasId (const Aws::String &value)
 
void SetBotAliasId (Aws::String &&value)
 
void SetBotAliasId (const char *value)
 
RecognizeUtteranceRequestWithBotAliasId (const Aws::String &value)
 
RecognizeUtteranceRequestWithBotAliasId (Aws::String &&value)
 
RecognizeUtteranceRequestWithBotAliasId (const char *value)
 
const Aws::StringGetLocaleId () const
 
bool LocaleIdHasBeenSet () const
 
void SetLocaleId (const Aws::String &value)
 
void SetLocaleId (Aws::String &&value)
 
void SetLocaleId (const char *value)
 
RecognizeUtteranceRequestWithLocaleId (const Aws::String &value)
 
RecognizeUtteranceRequestWithLocaleId (Aws::String &&value)
 
RecognizeUtteranceRequestWithLocaleId (const char *value)
 
const Aws::StringGetSessionId () const
 
bool SessionIdHasBeenSet () const
 
void SetSessionId (const Aws::String &value)
 
void SetSessionId (Aws::String &&value)
 
void SetSessionId (const char *value)
 
RecognizeUtteranceRequestWithSessionId (const Aws::String &value)
 
RecognizeUtteranceRequestWithSessionId (Aws::String &&value)
 
RecognizeUtteranceRequestWithSessionId (const char *value)
 
const Aws::StringGetSessionState () const
 
bool SessionStateHasBeenSet () const
 
void SetSessionState (const Aws::String &value)
 
void SetSessionState (Aws::String &&value)
 
void SetSessionState (const char *value)
 
RecognizeUtteranceRequestWithSessionState (const Aws::String &value)
 
RecognizeUtteranceRequestWithSessionState (Aws::String &&value)
 
RecognizeUtteranceRequestWithSessionState (const char *value)
 
const Aws::StringGetRequestAttributes () const
 
bool RequestAttributesHasBeenSet () const
 
void SetRequestAttributes (const Aws::String &value)
 
void SetRequestAttributes (Aws::String &&value)
 
void SetRequestAttributes (const char *value)
 
RecognizeUtteranceRequestWithRequestAttributes (const Aws::String &value)
 
RecognizeUtteranceRequestWithRequestAttributes (Aws::String &&value)
 
RecognizeUtteranceRequestWithRequestAttributes (const char *value)
 
const Aws::StringGetRequestContentType () const
 
bool RequestContentTypeHasBeenSet () const
 
void SetRequestContentType (const Aws::String &value)
 
void SetRequestContentType (Aws::String &&value)
 
void SetRequestContentType (const char *value)
 
RecognizeUtteranceRequestWithRequestContentType (const Aws::String &value)
 
RecognizeUtteranceRequestWithRequestContentType (Aws::String &&value)
 
RecognizeUtteranceRequestWithRequestContentType (const char *value)
 
const Aws::StringGetResponseContentType () const
 
bool ResponseContentTypeHasBeenSet () const
 
void SetResponseContentType (const Aws::String &value)
 
void SetResponseContentType (Aws::String &&value)
 
void SetResponseContentType (const char *value)
 
RecognizeUtteranceRequestWithResponseContentType (const Aws::String &value)
 
RecognizeUtteranceRequestWithResponseContentType (Aws::String &&value)
 
RecognizeUtteranceRequestWithResponseContentType (const char *value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsEventStreamRequest () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file RecognizeUtteranceRequest.h.

Constructor & Destructor Documentation

◆ RecognizeUtteranceRequest()

Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::RecognizeUtteranceRequest ( )

Member Function Documentation

◆ BotAliasIdHasBeenSet()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::BotAliasIdHasBeenSet ( ) const
inline

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

Definition at line 87 of file RecognizeUtteranceRequest.h.

◆ BotIdHasBeenSet()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::BotIdHasBeenSet ( ) const
inline

The identifier of the bot that should receive the request.

Definition at line 46 of file RecognizeUtteranceRequest.h.

◆ GetBotAliasId()

const Aws::String& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetBotAliasId ( ) const
inline

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

Definition at line 82 of file RecognizeUtteranceRequest.h.

◆ GetBotId()

const Aws::String& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetBotId ( ) const
inline

The identifier of the bot that should receive the request.

Definition at line 41 of file RecognizeUtteranceRequest.h.

◆ GetLocaleId()

const Aws::String& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetLocaleId ( ) const
inline

The locale where the session is in use.

Definition at line 123 of file RecognizeUtteranceRequest.h.

◆ GetRequestAttributes()

const Aws::String& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetRequestAttributes ( ) const
inline

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.

Definition at line 283 of file RecognizeUtteranceRequest.h.

◆ GetRequestContentType()

const Aws::String& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetRequestContentType ( ) const
inline

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

Definition at line 368 of file RecognizeUtteranceRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Override this method to put data members from a subclass into the headers collection.

Reimplemented from Aws::AmazonStreamingWebServiceRequest.

◆ GetResponseContentType()

const Aws::String& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetResponseContentType ( ) const
inline

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 requestContentType 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

Definition at line 485 of file RecognizeUtteranceRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file RecognizeUtteranceRequest.h.

◆ GetSessionId()

const Aws::String& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetSessionId ( ) const
inline

The identifier of the session in use.

Definition at line 164 of file RecognizeUtteranceRequest.h.

◆ GetSessionState()

const Aws::String& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::GetSessionState ( ) const
inline

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.

Definition at line 209 of file RecognizeUtteranceRequest.h.

◆ LocaleIdHasBeenSet()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::LocaleIdHasBeenSet ( ) const
inline

The locale where the session is in use.

Definition at line 128 of file RecognizeUtteranceRequest.h.

◆ RequestAttributesHasBeenSet()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::RequestAttributesHasBeenSet ( ) const
inline

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.

Definition at line 293 of file RecognizeUtteranceRequest.h.

◆ RequestContentTypeHasBeenSet()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::RequestContentTypeHasBeenSet ( ) const
inline

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

Definition at line 382 of file RecognizeUtteranceRequest.h.

◆ ResponseContentTypeHasBeenSet()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::ResponseContentTypeHasBeenSet ( ) const
inline

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 requestContentType 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

Definition at line 503 of file RecognizeUtteranceRequest.h.

◆ SessionIdHasBeenSet()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SessionIdHasBeenSet ( ) const
inline

The identifier of the session in use.

Definition at line 169 of file RecognizeUtteranceRequest.h.

◆ SessionStateHasBeenSet()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SessionStateHasBeenSet ( ) const
inline

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.

Definition at line 218 of file RecognizeUtteranceRequest.h.

◆ SetBotAliasId() [1/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetBotAliasId ( Aws::String &&  value)
inline

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

Definition at line 97 of file RecognizeUtteranceRequest.h.

◆ SetBotAliasId() [2/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetBotAliasId ( const Aws::String value)
inline

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

Definition at line 92 of file RecognizeUtteranceRequest.h.

◆ SetBotAliasId() [3/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetBotAliasId ( const char *  value)
inline

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

Definition at line 102 of file RecognizeUtteranceRequest.h.

◆ SetBotId() [1/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetBotId ( Aws::String &&  value)
inline

The identifier of the bot that should receive the request.

Definition at line 56 of file RecognizeUtteranceRequest.h.

◆ SetBotId() [2/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetBotId ( const Aws::String value)
inline

The identifier of the bot that should receive the request.

Definition at line 51 of file RecognizeUtteranceRequest.h.

◆ SetBotId() [3/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetBotId ( const char *  value)
inline

The identifier of the bot that should receive the request.

Definition at line 61 of file RecognizeUtteranceRequest.h.

◆ SetLocaleId() [1/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetLocaleId ( Aws::String &&  value)
inline

The locale where the session is in use.

Definition at line 138 of file RecognizeUtteranceRequest.h.

◆ SetLocaleId() [2/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetLocaleId ( const Aws::String value)
inline

The locale where the session is in use.

Definition at line 133 of file RecognizeUtteranceRequest.h.

◆ SetLocaleId() [3/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetLocaleId ( const char *  value)
inline

The locale where the session is in use.

Definition at line 143 of file RecognizeUtteranceRequest.h.

◆ SetRequestAttributes() [1/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetRequestAttributes ( Aws::String &&  value)
inline

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.

Definition at line 313 of file RecognizeUtteranceRequest.h.

◆ SetRequestAttributes() [2/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetRequestAttributes ( const Aws::String value)
inline

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.

Definition at line 303 of file RecognizeUtteranceRequest.h.

◆ SetRequestAttributes() [3/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetRequestAttributes ( const char *  value)
inline

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.

Definition at line 323 of file RecognizeUtteranceRequest.h.

◆ SetRequestContentType() [1/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetRequestContentType ( Aws::String &&  value)
inline

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

Definition at line 410 of file RecognizeUtteranceRequest.h.

◆ SetRequestContentType() [2/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetRequestContentType ( const Aws::String value)
inline

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

Definition at line 396 of file RecognizeUtteranceRequest.h.

◆ SetRequestContentType() [3/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetRequestContentType ( const char *  value)
inline

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

Definition at line 424 of file RecognizeUtteranceRequest.h.

◆ SetResponseContentType() [1/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetResponseContentType ( Aws::String &&  value)
inline

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 requestContentType 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

Definition at line 539 of file RecognizeUtteranceRequest.h.

◆ SetResponseContentType() [2/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetResponseContentType ( const Aws::String value)
inline

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 requestContentType 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

Definition at line 521 of file RecognizeUtteranceRequest.h.

◆ SetResponseContentType() [3/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetResponseContentType ( const char *  value)
inline

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 requestContentType 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

Definition at line 557 of file RecognizeUtteranceRequest.h.

◆ SetSessionId() [1/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetSessionId ( Aws::String &&  value)
inline

The identifier of the session in use.

Definition at line 179 of file RecognizeUtteranceRequest.h.

◆ SetSessionId() [2/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetSessionId ( const Aws::String value)
inline

The identifier of the session in use.

Definition at line 174 of file RecognizeUtteranceRequest.h.

◆ SetSessionId() [3/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetSessionId ( const char *  value)
inline

The identifier of the session in use.

Definition at line 184 of file RecognizeUtteranceRequest.h.

◆ SetSessionState() [1/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetSessionState ( Aws::String &&  value)
inline

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.

Definition at line 236 of file RecognizeUtteranceRequest.h.

◆ SetSessionState() [2/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetSessionState ( const Aws::String value)
inline

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.

Definition at line 227 of file RecognizeUtteranceRequest.h.

◆ SetSessionState() [3/3]

void Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SetSessionState ( const char *  value)
inline

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.

Definition at line 245 of file RecognizeUtteranceRequest.h.

◆ SignBody()

bool Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::SignBody ( ) const
inlineoverridevirtual

Defaults to true, if this is set to false, then signers, if they support body signing, will not do so

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 35 of file RecognizeUtteranceRequest.h.

◆ WithBotAliasId() [1/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithBotAliasId ( Aws::String &&  value)
inline

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

Definition at line 112 of file RecognizeUtteranceRequest.h.

◆ WithBotAliasId() [2/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithBotAliasId ( const Aws::String value)
inline

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

Definition at line 107 of file RecognizeUtteranceRequest.h.

◆ WithBotAliasId() [3/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithBotAliasId ( const char *  value)
inline

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

Definition at line 117 of file RecognizeUtteranceRequest.h.

◆ WithBotId() [1/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithBotId ( Aws::String &&  value)
inline

The identifier of the bot that should receive the request.

Definition at line 71 of file RecognizeUtteranceRequest.h.

◆ WithBotId() [2/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithBotId ( const Aws::String value)
inline

The identifier of the bot that should receive the request.

Definition at line 66 of file RecognizeUtteranceRequest.h.

◆ WithBotId() [3/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithBotId ( const char *  value)
inline

The identifier of the bot that should receive the request.

Definition at line 76 of file RecognizeUtteranceRequest.h.

◆ WithLocaleId() [1/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithLocaleId ( Aws::String &&  value)
inline

The locale where the session is in use.

Definition at line 153 of file RecognizeUtteranceRequest.h.

◆ WithLocaleId() [2/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithLocaleId ( const Aws::String value)
inline

The locale where the session is in use.

Definition at line 148 of file RecognizeUtteranceRequest.h.

◆ WithLocaleId() [3/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithLocaleId ( const char *  value)
inline

The locale where the session is in use.

Definition at line 158 of file RecognizeUtteranceRequest.h.

◆ WithRequestAttributes() [1/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithRequestAttributes ( Aws::String &&  value)
inline

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.

Definition at line 343 of file RecognizeUtteranceRequest.h.

◆ WithRequestAttributes() [2/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithRequestAttributes ( const Aws::String value)
inline

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.

Definition at line 333 of file RecognizeUtteranceRequest.h.

◆ WithRequestAttributes() [3/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithRequestAttributes ( const char *  value)
inline

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.

Definition at line 353 of file RecognizeUtteranceRequest.h.

◆ WithRequestContentType() [1/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithRequestContentType ( Aws::String &&  value)
inline

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

Definition at line 452 of file RecognizeUtteranceRequest.h.

◆ WithRequestContentType() [2/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithRequestContentType ( const Aws::String value)
inline

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

Definition at line 438 of file RecognizeUtteranceRequest.h.

◆ WithRequestContentType() [3/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithRequestContentType ( const char *  value)
inline

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

Definition at line 466 of file RecognizeUtteranceRequest.h.

◆ WithResponseContentType() [1/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithResponseContentType ( Aws::String &&  value)
inline

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 requestContentType 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

Definition at line 593 of file RecognizeUtteranceRequest.h.

◆ WithResponseContentType() [2/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithResponseContentType ( const Aws::String value)
inline

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 requestContentType 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

Definition at line 575 of file RecognizeUtteranceRequest.h.

◆ WithResponseContentType() [3/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithResponseContentType ( const char *  value)
inline

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 requestContentType 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

Definition at line 611 of file RecognizeUtteranceRequest.h.

◆ WithSessionId() [1/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithSessionId ( Aws::String &&  value)
inline

The identifier of the session in use.

Definition at line 194 of file RecognizeUtteranceRequest.h.

◆ WithSessionId() [2/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithSessionId ( const Aws::String value)
inline

The identifier of the session in use.

Definition at line 189 of file RecognizeUtteranceRequest.h.

◆ WithSessionId() [3/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithSessionId ( const char *  value)
inline

The identifier of the session in use.

Definition at line 199 of file RecognizeUtteranceRequest.h.

◆ WithSessionState() [1/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithSessionState ( Aws::String &&  value)
inline

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.

Definition at line 263 of file RecognizeUtteranceRequest.h.

◆ WithSessionState() [2/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithSessionState ( const Aws::String value)
inline

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.

Definition at line 254 of file RecognizeUtteranceRequest.h.

◆ WithSessionState() [3/3]

RecognizeUtteranceRequest& Aws::LexRuntimeV2::Model::RecognizeUtteranceRequest::WithSessionState ( const char *  value)
inline

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.

Definition at line 272 of file RecognizeUtteranceRequest.h.


The documentation for this class was generated from the following file: