Class: Aws::LexRuntimeV2::Types::RecognizeTextRequest

Inherits:

Struct

• Object
• Struct
• Aws::LexRuntimeV2::Types::RecognizeTextRequest

Defined in:

gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:text]

Instance Attribute Summary

• #bot_alias_id ⇒ String

  The alias identifier in use for the bot that processes the request.

• #bot_id ⇒ String

  The identifier of the bot that processes the request.

• #locale_id ⇒ String

  The locale where the session is in use.

• #request_attributes ⇒ Hash<String,String>

  Request-specific information passed between the client application and Amazon Lex V2.

• #session_id ⇒ String

  The identifier of the user session that is having the conversation.

• #session_state ⇒ Types::SessionState

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

• #text ⇒ String

  The text that the user entered.

Instance Attribute Details

#bot_alias_id ⇒ String

The alias identifier in use for the bot that processes the request.

Returns:

• (String)

# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1023

class RecognizeTextRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :text,
  :session_state,
  :request_attributes)
  SENSITIVE = [:text]
  include Aws::Structure
end

#bot_id ⇒ String

The identifier of the bot that processes the request.

Returns:

• (String)

# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1023

class RecognizeTextRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :text,
  :session_state,
  :request_attributes)
  SENSITIVE = [:text]
  include Aws::Structure
end

#locale_id ⇒ String

The locale where the session is in use.

Returns:

• (String)

# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1023

class RecognizeTextRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :text,
  :session_state,
  :request_attributes)
  SENSITIVE = [:text]
  include Aws::Structure
end

#request_attributes ⇒ Hash<String,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 with the prefix x-amz-lex:.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1023

class RecognizeTextRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :text,
  :session_state,
  :request_attributes)
  SENSITIVE = [:text]
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the user session that is having the conversation.

Returns:

• (String)

# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1023

class RecognizeTextRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :text,
  :session_state,
  :request_attributes)
  SENSITIVE = [:text]
  include Aws::Structure
end

#session_state ⇒ Types::SessionState

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

Returns:

• (Types::SessionState)

# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1023

class RecognizeTextRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :text,
  :session_state,
  :request_attributes)
  SENSITIVE = [:text]
  include Aws::Structure
end

#text ⇒ String

The text that the user entered. Amazon Lex V2 interprets this text.

Returns:

• (String)

# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1023

class RecognizeTextRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :text,
  :session_state,
  :request_attributes)
  SENSITIVE = [:text]
  include Aws::Structure
end