class Aws::LexRuntimeV2::Types::RecognizeTextRequest
@note When making an API call, you may pass RecognizeTextRequest
data as a hash: { bot_id: "BotIdentifier", # required bot_alias_id: "BotAliasIdentifier", # required locale_id: "LocaleId", # required session_id: "SessionId", # required text: "Text", # required session_state: { dialog_action: { type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot slot_to_elicit: "NonEmptyString", }, 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 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", }, request_attributes: { "NonEmptyString" => "String", }, }
@!attribute [rw] bot_id
The identifier of the bot that processes the request. @return [String]
@!attribute [rw] bot_alias_id
The alias identifier in use for the bot that processes the request. @return [String]
@!attribute [rw] locale_id
The locale where the session is in use. @return [String]
@!attribute [rw] session_id
The identifier of the user session that is having the conversation. @return [String]
@!attribute [rw] text
The text that the user entered. Amazon Lex V2 interprets this text. @return [String]
@!attribute [rw] session_state
The current state of the dialog between the user and the bot. @return [Types::SessionState]
@!attribute [rw] request_attributes
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:`. @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RecognizeTextRequest AWS API Documentation
Constants
- SENSITIVE