Class: Aws::LexRuntimeV2::Types::RecognizeUtteranceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lexruntimev2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:session_state, :request_attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_alias_id ⇒ String

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

Returns:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end

#bot_id ⇒ String

The identifier of the bot that should receive the request.

Returns:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end

#input_stream ⇒ IO

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

Returns:

  • (IO) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end

#locale_id ⇒ String

The locale where the session is in use.

Returns:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end

#request_attributes ⇒ String

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:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end

#request_content_type ⇒ String

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:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end

#response_content_type ⇒ String

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:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the session in use.

Returns:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end

#session_state ⇒ String

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:

  • (String) 


1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1183

class RecognizeUtteranceRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :session_state,
  :request_attributes,
  :request_content_type,
  :response_content_type,
  :input_stream)
  SENSITIVE = [:session_state, :request_attributes]
  include Aws::Structure
end