Class: Aws::LexRuntimeV2::Types::SessionState
- Inherits:
-
Struct
- Object
- Struct
- Aws::LexRuntimeV2::Types::SessionState
- Defined in:
- gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb
Overview
When making an API call, you may pass SessionState data as a hash:
{
dialog_action: {
type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
slot_to_elicit: "NonEmptyString",
slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
},
intent: {
name: "NonEmptyString", # required
slots: {
"NonEmptyString" => {
value: {
original_value: "NonEmptyString",
interpreted_value: "NonEmptyString", # required
resolved_values: ["NonEmptyString"],
},
shape: "Scalar", # accepts Scalar, List
values: [
{
# recursive Slot
},
],
},
},
state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting, FulfillmentInProgress
confirmation_state: "Confirmed", # accepts Confirmed, Denied, None
},
active_contexts: [
{
name: "ActiveContextName", # required
time_to_live: { # required
time_to_live_in_seconds: 1, # required
turns_to_live: 1, # required
},
context_attributes: { # required
"ParameterName" => "Text",
},
},
],
session_attributes: {
"NonEmptyString" => "String",
},
originating_request_id: "NonEmptyString",
runtime_hints: {
slot_hints: {
"Name" => {
"Name" => {
runtime_hint_values: [ # required
{
phrase: "RuntimeHintPhrase", # required
},
],
},
},
},
},
}
The state of the user's session with Amazon Lex V2.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#active_contexts ⇒ Array<Types::ActiveContext>
One or more contexts that indicate to Amazon Lex V2 the context of a request.
-
#dialog_action ⇒ Types::DialogAction
The next step that Amazon Lex V2 should take in the conversation with a user.
-
#intent ⇒ Types::Intent
The active intent that Amazon Lex V2 is processing.
-
#originating_request_id ⇒ String
A unique identifier for a specific request.
-
#runtime_hints ⇒ Types::RuntimeHints
Hints for phrases that a customer is likely to use for a slot.
-
#session_attributes ⇒ Hash<String,String>
Map of key/value pairs representing session-specific context information.
Instance Attribute Details
#active_contexts ⇒ Array<Types::ActiveContext>
One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 |
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1921 class SessionState < Struct.new( :dialog_action, :intent, :active_contexts, :session_attributes, :originating_request_id, :runtime_hints) SENSITIVE = [] include Aws::Structure end |
#dialog_action ⇒ Types::DialogAction
The next step that Amazon Lex V2 should take in the conversation with a user.
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 |
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1921 class SessionState < Struct.new( :dialog_action, :intent, :active_contexts, :session_attributes, :originating_request_id, :runtime_hints) SENSITIVE = [] include Aws::Structure end |
#intent ⇒ Types::Intent
The active intent that Amazon Lex V2 is processing.
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 |
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1921 class SessionState < Struct.new( :dialog_action, :intent, :active_contexts, :session_attributes, :originating_request_id, :runtime_hints) SENSITIVE = [] include Aws::Structure end |
#originating_request_id ⇒ String
A unique identifier for a specific request.
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 |
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1921 class SessionState < Struct.new( :dialog_action, :intent, :active_contexts, :session_attributes, :originating_request_id, :runtime_hints) SENSITIVE = [] include Aws::Structure end |
#runtime_hints ⇒ Types::RuntimeHints
Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 |
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1921 class SessionState < Struct.new( :dialog_action, :intent, :active_contexts, :session_attributes, :originating_request_id, :runtime_hints) SENSITIVE = [] include Aws::Structure end |
#session_attributes ⇒ Hash<String,String>
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 |
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1921 class SessionState < Struct.new( :dialog_action, :intent, :active_contexts, :session_attributes, :originating_request_id, :runtime_hints) SENSITIVE = [] include Aws::Structure end |