Class: Aws::Lex::Types::ActiveContext

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

Overview

Note:

When making an API call, you may pass ActiveContext data as a hash:

{
  name: "ActiveContextName", # required
  time_to_live: { # required
    time_to_live_in_seconds: 1,
    turns_to_live: 1,
  },
  parameters: { # required
    "ParameterName" => "Text",
  },
}

A context is a variable that contains information about the current state of the conversation between a user and Amazon Lex. Context can be set automatically by Amazon Lex when an intent is fulfilled, or it can be set at runtime using the PutContent, PutText, or PutSession operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the context.

Returns:

  • (String)


48
49
50
51
52
53
54
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 48

class ActiveContext < Struct.new(
  :name,
  :time_to_live,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,String>

State variables for the current context. You can use these values as default values for slots in subsequent events.

Returns:

  • (Hash<String,String>)


48
49
50
51
52
53
54
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 48

class ActiveContext < Struct.new(
  :name,
  :time_to_live,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#time_to_liveTypes::ActiveContextTimeToLive

The length of time or number of turns that a context remains active.



48
49
50
51
52
53
54
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 48

class ActiveContext < Struct.new(
  :name,
  :time_to_live,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end