Class: Aws::Lex::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-lex/client.rb

Overview

An API client for Lex. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::Lex::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Lex::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Lex::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



444
445
446
 
# File 'lib/aws-sdk-lex/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1265
1266
1267
 
# File 'lib/aws-sdk-lex/client.rb', line 1265

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1268
1269
1270
 
# File 'lib/aws-sdk-lex/client.rb', line 1268

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/aws-sdk-lex/client.rb', line 1238

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Lex')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-lex'
  context[:gem_version] = '1.73.0'
  Seahorse::Client::Request.new(handlers, context)
end

#delete_session(params = {}) ⇒ Types::DeleteSessionResponse

Removes session information for a specified bot, alias, and user ID.

Examples:

Request syntax with placeholder values


resp = client.delete_session({
  bot_name: "BotName", # required
  bot_alias: "BotAlias", # required
  user_id: "UserId", # required
})

Response structure


resp.bot_name #=> String
resp.bot_alias #=> String
resp.user_id #=> String
resp.session_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bot_name (required, String) —

    The name of the bot that contains the session data.

  • :bot_alias (required, String) —

    The alias in use for the bot that contains the session data.

  • :user_id (required, String) —

    The identifier of the user associated with the session data.

Returns:

See Also:



487
488
489
490
 
# File 'lib/aws-sdk-lex/client.rb', line 487

def delete_session(params = {}, options = {})
  req = build_request(:delete_session, params)
  req.send_request(options)
end

#get_session(params = {}) ⇒ Types::GetSessionResponse

Returns session information for a specified bot, alias, and user ID.

Examples:

Request syntax with placeholder values


resp = client.get_session({
  bot_name: "BotName", # required
  bot_alias: "BotAlias", # required
  user_id: "UserId", # required
  checkpoint_label_filter: "IntentSummaryCheckpointLabel",
})

Response structure


resp.recent_intent_summary_view #=> Array
resp.recent_intent_summary_view[0].intent_name #=> String
resp.recent_intent_summary_view[0].checkpoint_label #=> String
resp.recent_intent_summary_view[0].slots #=> Hash
resp.recent_intent_summary_view[0].slots["String"] #=> String
resp.recent_intent_summary_view[0].confirmation_status #=> String, one of "None", "Confirmed", "Denied"
resp.recent_intent_summary_view[0].dialog_action_type #=> String, one of "ElicitIntent", "ConfirmIntent", "ElicitSlot", "Close", "Delegate"
resp.recent_intent_summary_view[0].fulfillment_state #=> String, one of "Fulfilled", "Failed", "ReadyForFulfillment"
resp.recent_intent_summary_view[0].slot_to_elicit #=> String
resp.session_attributes #=> Hash
resp.session_attributes["String"] #=> String
resp.session_id #=> String
resp.dialog_action.type #=> String, one of "ElicitIntent", "ConfirmIntent", "ElicitSlot", "Close", "Delegate"
resp.dialog_action.intent_name #=> String
resp.dialog_action.slots #=> Hash
resp.dialog_action.slots["String"] #=> String
resp.dialog_action.slot_to_elicit #=> String
resp.dialog_action.fulfillment_state #=> String, one of "Fulfilled", "Failed", "ReadyForFulfillment"
resp.dialog_action.message #=> String
resp.dialog_action.message_format #=> String, one of "PlainText", "CustomPayload", "SSML", "Composite"
resp.active_contexts #=> Array
resp.active_contexts[0].name #=> String
resp.active_contexts[0].time_to_live.time_to_live_in_seconds #=> Integer
resp.active_contexts[0].time_to_live.turns_to_live #=> Integer
resp.active_contexts[0].parameters #=> Hash
resp.active_contexts[0].parameters["ParameterName"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bot_name (required, String) —

    The name of the bot that contains the session data.

  • :bot_alias (required, String) —

    The alias in use for the bot that contains the session data.

  • :user_id (required, String) —

    The ID of the client application user. Amazon Lex uses this to identify a user’s conversation with your bot.

  • :checkpoint_label_filter (String) —

    A string used to filter the intents returned in the ‘recentIntentSummaryView` structure.

    When you specify a filter, only intents with their ‘checkpointLabel` field set to that string are returned.

Returns:

See Also:



561
562
563
564
 
# File 'lib/aws-sdk-lex/client.rb', line 561

def get_session(params = {}, options = {})
  req = build_request(:get_session, params)
  req.send_request(options)
end

#post_content(params = {}) ⇒ Types::PostContentResponse

Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.

The ‘PostContent` operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications.

In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:

  • For a user input “I would like a pizza,” Amazon Lex might return a response with a message eliciting slot data (for example, ‘PizzaSize`): “What size pizza would you like?”.

  • After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: “Order the pizza?”.

  • After the user replies “Yes” to the confirmation prompt, Amazon Lex might return a conclusion statement: “Thank you, your cheese pizza has been ordered.”.

Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the ‘message`, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples:

  • If the message is to elicit slot data, Amazon Lex returns the following context information:

    • ‘x-amz-lex-dialog-state` header set to `ElicitSlot`

    • ‘x-amz-lex-intent-name` header set to the intent name in the current context

    • ‘x-amz-lex-slot-to-elicit` header set to the slot name for which the `message` is eliciting information

    • ‘x-amz-lex-slots` header set to a map of slots configured for the intent with their current values

  • If the message is a confirmation prompt, the ‘x-amz-lex-dialog-state` header is set to `Confirmation` and the `x-amz-lex-slot-to-elicit` header is omitted.

  • If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the ‘x-amz-dialog-state` header is set to `ElicitIntent` and the `x-amz-slot-to-elicit` header is omitted.

In addition, Amazon Lex also returns your application-specific ‘sessionAttributes`. For more information, see [Managing Conversation Context].

[1]: docs.aws.amazon.com/lex/latest/dg/context-mgmt.html

Examples:

Request syntax with placeholder values


resp = client.post_content({
  bot_name: "BotName", # required
  bot_alias: "BotAlias", # required
  user_id: "UserId", # required
  session_attributes: "AttributesString",
  request_attributes: "AttributesString",
  content_type: "HttpContentType", # required
  accept: "Accept",
  input_stream: "data", # required
  active_contexts: "ActiveContextsString",
})

Response structure


resp.content_type #=> String
resp.intent_name #=> String
resp.nlu_intent_confidence #=> String
resp.alternative_intents #=> String
resp.slots #=> String
resp.session_attributes #=> String
resp.sentiment_response #=> String
resp.message #=> String
resp.encoded_message #=> String
resp.message_format #=> String, one of "PlainText", "CustomPayload", "SSML", "Composite"
resp.dialog_state #=> String, one of "ElicitIntent", "ConfirmIntent", "ElicitSlot", "Fulfilled", "ReadyForFulfillment", "Failed"
resp.slot_to_elicit #=> String
resp.input_transcript #=> String
resp.encoded_input_transcript #=> String
resp.audio_stream #=> IO
resp.bot_version #=> String
resp.session_id #=> String
resp.active_contexts #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bot_name (required, String) —

    Name of the Amazon Lex bot.

  • :bot_alias (required, String) —

    Alias of the Amazon Lex bot.

  • :user_id (required, String) —

    The ID of the client application user. Amazon Lex uses this to identify a user’s conversation with your bot. At runtime, each request must contain the ‘userID` field.

    To decide the user ID to use for your application, consider the following factors.

    • The ‘userID` field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

    • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

    • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

    • A user can’t have two independent conversations with two different versions of the same bot. For example, a user can’t have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

  • :session_attributes (String) —

    You pass this value as the ‘x-amz-lex-session-attributes` HTTP header.

    Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the ‘sessionAttributes` and `requestAttributes` headers is limited to 12 KB.

    For more information, see [Setting Session Attributes].

    **SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.**

    [1]: docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs

  • :request_attributes (String) —

    You pass this value as the ‘x-amz-lex-request-attributes` HTTP header.

    Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the ‘requestAttributes` and `sessionAttributes` headers is limited to 12 KB.

    The namespace ‘x-amz-lex:` is reserved for special attributes. Don’t create any request attributes with the prefix ‘x-amz-lex:`.

    For more information, see [Setting Request Attributes].

    **SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.**

    [1]: docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs

  • :content_type (required, String) —

    You pass this value as the ‘Content-Type` HTTP header.

    Indicates the audio format or text. The header value must start with one of the following prefixes:

    • PCM format, audio data must be in little-endian byte order.

      • audio/l16; rate=16000; channels=1

      • audio/x-l16; sample-rate=16000; channel-count=1

      • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

    • Opus format

      • audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4

      ^

    • Text format

      • text/plain; charset=utf-8

      ^

  • :accept (String) —

    You pass this value as the ‘Accept` HTTP header.

    The message Amazon Lex returns in the response can be either text or speech based on the ‘Accept` HTTP header value in the request.

    • If the value is ‘text/plain; charset=utf-8`, Amazon Lex returns text in the response.

    • If the value begins with ‘audio/`, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the `Accept` header). For example, if you specify `audio/mpeg` as the value, Amazon Lex returns speech in the MPEG format.

    • If the value is ‘audio/pcm`, the speech returned is `audio/pcm` in 16-bit, little endian format.

    • The following are the accepted values:

      • audio/mpeg

      • audio/ogg

      • audio/pcm

      • text/plain; charset=utf-8

      • audio/* (defaults to mpeg)

  • :input_stream (required, String, IO) —

    User input in PCM or Opus audio format or text format as described in the ‘Content-Type` HTTP header.

    You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.

  • :active_contexts (String) —

    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

    If you don’t specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

    **SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.**

Returns:

See Also:



839
840
841
842
 
# File 'lib/aws-sdk-lex/client.rb', line 839

def post_content(params = {}, options = {}, &block)
  req = build_request(:post_content, params)
  req.send_request(options, &block)
end

#post_text(params = {}) ⇒ Types::PostTextResponse

Sends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.

In response, Amazon Lex returns the next ‘message` to convey to the user an optional `responseCard` to display. Consider the following example messages:

  • For a user input “I would like a pizza”, Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): “What size pizza would you like?”

  • After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation “Proceed with the pizza order?”.

  • After the user replies to a confirmation prompt with a “yes”, Amazon Lex might return a conclusion statement: “Thank you, your cheese pizza has been ordered.”.

Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a “yes” or “no” user response. In addition to the ‘message`, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the `slotToElicit`, `dialogState`, `intentName`, and `slots` fields in the response. Consider the following examples:

  • If the message is to elicit slot data, Amazon Lex returns the following context information:

    • ‘dialogState` set to ElicitSlot

    • ‘intentName` set to the intent name in the current context

    • ‘slotToElicit` set to the slot name for which the `message` is eliciting information

    • ‘slots` set to a map of slots, configured for the intent, with currently known values

  • If the message is a confirmation prompt, the ‘dialogState` is set to ConfirmIntent and `SlotToElicit` is set to null.

  • If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the ‘dialogState` is set to ElicitIntent and `slotToElicit` is set to null.

In addition, Amazon Lex also returns your application-specific ‘sessionAttributes`. For more information, see [Managing Conversation Context].

[1]: docs.aws.amazon.com/lex/latest/dg/context-mgmt.html

Examples:

Request syntax with placeholder values


resp = client.post_text({
  bot_name: "BotName", # required
  bot_alias: "BotAlias", # required
  user_id: "UserId", # required
  session_attributes: {
    "String" => "String",
  },
  request_attributes: {
    "String" => "String",
  },
  input_text: "Text", # required
  active_contexts: [
    {
      name: "ActiveContextName", # required
      time_to_live: { # required
        time_to_live_in_seconds: 1,
        turns_to_live: 1,
      },
      parameters: { # required
        "ParameterName" => "Text",
      },
    },
  ],
})

Response structure


resp.intent_name #=> String
resp.nlu_intent_confidence.score #=> Float
resp.alternative_intents #=> Array
resp.alternative_intents[0].intent_name #=> String
resp.alternative_intents[0].nlu_intent_confidence.score #=> Float
resp.alternative_intents[0].slots #=> Hash
resp.alternative_intents[0].slots["String"] #=> String
resp.slots #=> Hash
resp.slots["String"] #=> String
resp.session_attributes #=> Hash
resp.session_attributes["String"] #=> String
resp.message #=> String
resp.sentiment_response.sentiment_label #=> String
resp.sentiment_response.sentiment_score #=> String
resp.message_format #=> String, one of "PlainText", "CustomPayload", "SSML", "Composite"
resp.dialog_state #=> String, one of "ElicitIntent", "ConfirmIntent", "ElicitSlot", "Fulfilled", "ReadyForFulfillment", "Failed"
resp.slot_to_elicit #=> String
resp.response_card.version #=> String
resp.response_card.content_type #=> String, one of "application/vnd.amazonaws.card.generic"
resp.response_card.generic_attachments #=> Array
resp.response_card.generic_attachments[0].title #=> String
resp.response_card.generic_attachments[0].sub_title #=> String
resp.response_card.generic_attachments[0].attachment_link_url #=> String
resp.response_card.generic_attachments[0].image_url #=> String
resp.response_card.generic_attachments[0].buttons #=> Array
resp.response_card.generic_attachments[0].buttons[0].text #=> String
resp.response_card.generic_attachments[0].buttons[0].value #=> String
resp.session_id #=> String
resp.bot_version #=> String
resp.active_contexts #=> Array
resp.active_contexts[0].name #=> String
resp.active_contexts[0].time_to_live.time_to_live_in_seconds #=> Integer
resp.active_contexts[0].time_to_live.turns_to_live #=> Integer
resp.active_contexts[0].parameters #=> Hash
resp.active_contexts[0].parameters["ParameterName"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bot_name (required, String) —

    The name of the Amazon Lex bot.

  • :bot_alias (required, String) —

    The alias of the Amazon Lex bot.

  • :user_id (required, String) —

    The ID of the client application user. Amazon Lex uses this to identify a user’s conversation with your bot. At runtime, each request must contain the ‘userID` field.

    To decide the user ID to use for your application, consider the following factors.

    • The ‘userID` field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

    • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

    • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

    • A user can’t have two independent conversations with two different versions of the same bot. For example, a user can’t have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

  • :session_attributes (Hash<String,String>) —

    Application-specific information passed between Amazon Lex and a client application.

    For more information, see [Setting Session Attributes].

    [1]: docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs

  • :request_attributes (Hash<String,String>) —

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

    The namespace ‘x-amz-lex:` is reserved for special attributes. Don’t create any request attributes with the prefix ‘x-amz-lex:`.

    For more information, see [Setting Request Attributes].

    [1]: docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs

  • :input_text (required, String) —

    The text that the user entered (Amazon Lex interprets this text).

  • :active_contexts (Array<Types::ActiveContext>) —

    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

    If you don’t specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Returns:

See Also:



1053
1054
1055
1056
 
# File 'lib/aws-sdk-lex/client.rb', line 1053

def post_text(params = {}, options = {})
  req = build_request(:post_text, params)
  req.send_request(options)
end

#put_session(params = {}) ⇒ Types::PutSessionResponse

Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.

For more information, see [Managing Sessions].

[1]: docs.aws.amazon.com/lex/latest/dg/how-session-api.html

Examples:

Request syntax with placeholder values


resp = client.put_session({
  bot_name: "BotName", # required
  bot_alias: "BotAlias", # required
  user_id: "UserId", # required
  session_attributes: {
    "String" => "String",
  },
  dialog_action: {
    type: "ElicitIntent", # required, accepts ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
    intent_name: "IntentName",
    slots: {
      "String" => "String",
    },
    slot_to_elicit: "String",
    fulfillment_state: "Fulfilled", # accepts Fulfilled, Failed, ReadyForFulfillment
    message: "Text",
    message_format: "PlainText", # accepts PlainText, CustomPayload, SSML, Composite
  },
  recent_intent_summary_view: [
    {
      intent_name: "IntentName",
      checkpoint_label: "IntentSummaryCheckpointLabel",
      slots: {
        "String" => "String",
      },
      confirmation_status: "None", # accepts None, Confirmed, Denied
      dialog_action_type: "ElicitIntent", # required, accepts ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
      fulfillment_state: "Fulfilled", # accepts Fulfilled, Failed, ReadyForFulfillment
      slot_to_elicit: "String",
    },
  ],
  accept: "Accept",
  active_contexts: [
    {
      name: "ActiveContextName", # required
      time_to_live: { # required
        time_to_live_in_seconds: 1,
        turns_to_live: 1,
      },
      parameters: { # required
        "ParameterName" => "Text",
      },
    },
  ],
})

Response structure


resp.content_type #=> String
resp.intent_name #=> String
resp.slots #=> String
resp.session_attributes #=> String
resp.message #=> String
resp.encoded_message #=> String
resp.message_format #=> String, one of "PlainText", "CustomPayload", "SSML", "Composite"
resp.dialog_state #=> String, one of "ElicitIntent", "ConfirmIntent", "ElicitSlot", "Fulfilled", "ReadyForFulfillment", "Failed"
resp.slot_to_elicit #=> String
resp.audio_stream #=> IO
resp.session_id #=> String
resp.active_contexts #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :bot_name (required, String) —

    The name of the bot that contains the session data.

  • :bot_alias (required, String) —

    The alias in use for the bot that contains the session data.

  • :user_id (required, String) —

    The ID of the client application user. Amazon Lex uses this to identify a user’s conversation with your bot.

  • :session_attributes (Hash<String,String>) —

    Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

  • :dialog_action (Types::DialogAction) —

    Sets the next action that the bot should take to fulfill the conversation.

  • :recent_intent_summary_view (Array<Types::IntentSummary>) —

    A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

    An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

    • ‘intentName`

    • slot names

    • ‘slotToElict`

    If you send the ‘recentIntentSummaryView` parameter in a `PutSession` request, the contents of the new summary view replaces the old summary view. For example, if a `GetSession` request returns three intents in the summary view and you call `PutSession` with one intent in the summary view, the next call to `GetSession` will only return one intent.

  • :accept (String) —

    The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

    • If the value is ‘text/plain; charset=utf-8`, Amazon Lex returns text in the response.

    • If the value begins with ‘audio/`, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify `audio/mpeg` as the value, Amazon Lex returns speech in the MPEG format.

    • If the value is ‘audio/pcm`, the speech is returned as `audio/pcm` in 16-bit, little endian format.

    • The following are the accepted values:

      • ‘audio/mpeg`

      • ‘audio/ogg`

      • ‘audio/pcm`

      • ‘audio/*` (defaults to mpeg)

      • ‘text/plain; charset=utf-8`

  • :active_contexts (Array<Types::ActiveContext>) —

    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

    If you don’t specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Returns:

See Also:



1229
1230
1231
1232
 
# File 'lib/aws-sdk-lex/client.rb', line 1229

def put_session(params = {}, options = {}, &block)
  req = build_request(:put_session, params)
  req.send_request(options, &block)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1258
1259
1260
 
# File 'lib/aws-sdk-lex/client.rb', line 1258

def waiter_names
  []
end