Class: Aws::LexRuntimeV2::Types::RecognizeUtteranceResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audio_streamIO

The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex V2 did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex V2 sends that message in the response.

Returns:

  • (IO)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end

#content_typeString

Content type as specified in the responseContentType in the request.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end

#input_modeString

Indicates whether the input mode to the operation was text or speech.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end

#input_transcriptString

The text used to process the request.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.

The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end

#interpretationsString

A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end

#messagesString

A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end

#request_attributesString

The attributes sent in the request.

The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end

#session_idString

The identifier of the session in use.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end

#session_stateString

Represents the current state of the dialog between the user and the bot.

Use this to determine the progress of the conversation and what the next action might be.

The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1590

class RecognizeUtteranceResponse < Struct.new(
  :input_mode,
  :content_type,
  :messages,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :input_transcript,
  :audio_stream)
  SENSITIVE = []
  include Aws::Structure
end