Class: Aws::LexRuntimeV2::Client

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

Overview

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

client = Aws::LexRuntimeV2::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 used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or 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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :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 —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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.

  • :event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :ignore_configured_endpoint_urls (Boolean) —

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

  • :input_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it can be used for sending events for the event stream.

  • :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.

  • :output_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

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

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or 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::LexRuntimeV2::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::LexRuntimeV2::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.



484
485
486
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 484

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. 



1276
1277
1278
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 1276

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. 



1279
1280
1281
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 1279

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: {}) 


1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 1249

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::LexRuntimeV2')
  )
  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-lexruntimev2'
  context[:gem_version] = '1.62.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

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

You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.

You don’t need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.

If you specify a bot or alias ID that doesn’t exist, you receive a ‘BadRequestException.`

If the locale doesn’t exist in the bot, or if the locale hasn’t been enables for the alias, you receive a ‘BadRequestException`.

Examples:

Request syntax with placeholder values


resp = client.delete_session({
  bot_id: "BotIdentifier", # required
  bot_alias_id: "BotAliasIdentifier", # required
  locale_id: "LocaleId", # required
  session_id: "SessionId", # required
})

Response structure


resp.bot_id #=> String
resp.bot_alias_id #=> String
resp.locale_id #=> String
resp.session_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :bot_id (required, String) —

    The identifier of the bot that contains the session data.

  • :bot_alias_id (required, String) —

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

  • :locale_id (required, String) —

    The locale where the session is in use.

  • :session_id (required, String) —

    The identifier of the session to delete.

Returns:

See Also:



547
548
549
550
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 547

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.

For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.

If the bot, alias, or session identifier doesn’t exist, Amazon Lex V2 returns a ‘BadRequestException`. If the locale doesn’t exist or is not enabled for the alias, you receive a ‘BadRequestException`.

Examples:

Request syntax with placeholder values


resp = client.get_session({
  bot_id: "BotIdentifier", # required
  bot_alias_id: "BotAliasIdentifier", # required
  locale_id: "LocaleId", # required
  session_id: "SessionId", # required
})

Response structure


resp.session_id #=> String
resp.messages #=> Array
resp.messages[0].content #=> String
resp.messages[0].content_type #=> String, one of "CustomPayload", "ImageResponseCard", "PlainText", "SSML"
resp.messages[0].image_response_card.title #=> String
resp.messages[0].image_response_card.subtitle #=> String
resp.messages[0].image_response_card.image_url #=> String
resp.messages[0].image_response_card.buttons #=> Array
resp.messages[0].image_response_card.buttons[0].text #=> String
resp.messages[0].image_response_card.buttons[0].value #=> String
resp.interpretations #=> Array
resp.interpretations[0].nlu_confidence.score #=> Float
resp.interpretations[0].sentiment_response.sentiment #=> String, one of "MIXED", "NEGATIVE", "NEUTRAL", "POSITIVE"
resp.interpretations[0].sentiment_response.sentiment_score.positive #=> Float
resp.interpretations[0].sentiment_response.sentiment_score.negative #=> Float
resp.interpretations[0].sentiment_response.sentiment_score.neutral #=> Float
resp.interpretations[0].sentiment_response.sentiment_score.mixed #=> Float
resp.interpretations[0].intent.name #=> String
resp.interpretations[0].intent.slots #=> Hash
resp.interpretations[0].intent.slots["NonEmptyString"].value.original_value #=> String
resp.interpretations[0].intent.slots["NonEmptyString"].value.interpreted_value #=> String
resp.interpretations[0].intent.slots["NonEmptyString"].value.resolved_values #=> Array
resp.interpretations[0].intent.slots["NonEmptyString"].value.resolved_values[0] #=> String
resp.interpretations[0].intent.slots["NonEmptyString"].shape #=> String, one of "Scalar", "List", "Composite"
resp.interpretations[0].intent.slots["NonEmptyString"].values #=> Array
resp.interpretations[0].intent.slots["NonEmptyString"].values[0] #=> Types::Slot
resp.interpretations[0].intent.slots["NonEmptyString"].sub_slots #=> Types::Slots
resp.interpretations[0].intent.state #=> String, one of "Failed", "Fulfilled", "InProgress", "ReadyForFulfillment", "Waiting", "FulfillmentInProgress"
resp.interpretations[0].intent.confirmation_state #=> String, one of "Confirmed", "Denied", "None"
resp.interpretations[0].interpretation_source #=> String, one of "Bedrock", "Lex"
resp.session_state.dialog_action.type #=> String, one of "Close", "ConfirmIntent", "Delegate", "ElicitIntent", "ElicitSlot", "None"
resp.session_state.dialog_action.slot_to_elicit #=> String
resp.session_state.dialog_action.slot_elicitation_style #=> String, one of "Default", "SpellByLetter", "SpellByWord"
resp.session_state.dialog_action.sub_slot_to_elicit.name #=> String
resp.session_state.dialog_action.sub_slot_to_elicit.sub_slot_to_elicit #=> Types::ElicitSubSlot
resp.session_state.intent.name #=> String
resp.session_state.intent.slots #=> Hash
resp.session_state.intent.slots["NonEmptyString"].value.original_value #=> String
resp.session_state.intent.slots["NonEmptyString"].value.interpreted_value #=> String
resp.session_state.intent.slots["NonEmptyString"].value.resolved_values #=> Array
resp.session_state.intent.slots["NonEmptyString"].value.resolved_values[0] #=> String
resp.session_state.intent.slots["NonEmptyString"].shape #=> String, one of "Scalar", "List", "Composite"
resp.session_state.intent.slots["NonEmptyString"].values #=> Array
resp.session_state.intent.slots["NonEmptyString"].values[0] #=> Types::Slot
resp.session_state.intent.slots["NonEmptyString"].sub_slots #=> Types::Slots
resp.session_state.intent.state #=> String, one of "Failed", "Fulfilled", "InProgress", "ReadyForFulfillment", "Waiting", "FulfillmentInProgress"
resp.session_state.intent.confirmation_state #=> String, one of "Confirmed", "Denied", "None"
resp.session_state.active_contexts #=> Array
resp.session_state.active_contexts[0].name #=> String
resp.session_state.active_contexts[0].time_to_live.time_to_live_in_seconds #=> Integer
resp.session_state.active_contexts[0].time_to_live.turns_to_live #=> Integer
resp.session_state.active_contexts[0].context_attributes #=> Hash
resp.session_state.active_contexts[0].context_attributes["ParameterName"] #=> String
resp.session_state.session_attributes #=> Hash
resp.session_state.session_attributes["NonEmptyString"] #=> String
resp.session_state.originating_request_id #=> String
resp.session_state.runtime_hints.slot_hints #=> Hash
resp.session_state.runtime_hints.slot_hints["Name"] #=> Hash
resp.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values #=> Array
resp.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values[0].phrase #=> String
resp.session_state.runtime_hints.slot_hints["Name"]["Name"].sub_slot_hints #=> Types::SlotHintsSlotMap

Parameters:

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

    ({})

Options Hash (params):

  • :bot_id (required, String) —

    The identifier of the bot that contains the session data.

  • :bot_alias_id (required, String) —

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

  • :locale_id (required, String) —

    The locale where the session is in use.

  • :session_id (required, String) —

    The identifier of the session to return.

Returns:

See Also:



658
659
660
661
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 658

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

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

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

Examples:

Request syntax with placeholder values


resp = client.put_session({
  bot_id: "BotIdentifier", # required
  bot_alias_id: "BotAliasIdentifier", # required
  locale_id: "LocaleId", # required
  session_id: "SessionId", # required
  messages: [
    {
      content: "Text",
      content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
      image_response_card: {
        title: "AttachmentTitle", # required
        subtitle: "AttachmentTitle",
        image_url: "AttachmentUrl",
        buttons: [
          {
            text: "ButtonText", # required
            value: "ButtonValue", # required
          },
        ],
      },
    },
  ],
  session_state: { # required
    dialog_action: {
      type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
      slot_to_elicit: "NonEmptyString",
      slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
      sub_slot_to_elicit: {
        name: "NonEmptyString", # required
        sub_slot_to_elicit: {
          # recursive ElicitSubSlot
        },
      },
    },
    intent: {
      name: "NonEmptyString", # required
      slots: {
        "NonEmptyString" => {
          value: {
            original_value: "NonEmptyString",
            interpreted_value: "NonEmptyString", # required
            resolved_values: ["NonEmptyString"],
          },
          shape: "Scalar", # accepts Scalar, List, Composite
          values: [
            {
              # recursive Slot
            },
          ],
          sub_slots: {
            # recursive Slots
          },
        },
      },
      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: [
              {
                phrase: "RuntimeHintPhrase", # required
              },
            ],
            sub_slot_hints: {
              # recursive SlotHintsSlotMap
            },
          },
        },
      },
    },
  },
  request_attributes: {
    "NonEmptyString" => "String",
  },
  response_content_type: "NonEmptyString",
})

Response structure


resp.content_type #=> String
resp.messages #=> String
resp.session_state #=> String
resp.request_attributes #=> String
resp.session_id #=> String
resp.audio_stream #=> IO

Parameters:

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

    ({})

Options Hash (params):

  • :bot_id (required, String) —

    The identifier of the bot that receives the session data.

  • :bot_alias_id (required, String) —

    The alias identifier of the bot that receives the session data.

  • :locale_id (required, String) —

    The locale where the session is in use.

  • :session_id (required, String) —

    The identifier of the session that receives the session data.

  • :messages (Array<Types::Message>) —

    A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

  • :session_state (required, Types::SessionState) —

    Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

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

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

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

  • :response_content_type (String) —

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

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

    ^

Returns:

See Also:



825
826
827
828
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 825

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

#recognize_text(params = {}) ⇒ Types::RecognizeTextResponse

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

In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see [PostFulfillmentStatusSpecification].

  • **Success message** - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

  • **Failed message** - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

  • **Timeout message** - If you don’t configure a timeout message and a timeout, and the Lambda function doesn’t return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see [Completion message].

[1]: docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html [2]: docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html

Examples:

Request syntax with placeholder values


resp = client.recognize_text({
  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, None
      slot_to_elicit: "NonEmptyString",
      slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
      sub_slot_to_elicit: {
        name: "NonEmptyString", # required
        sub_slot_to_elicit: {
          # recursive ElicitSubSlot
        },
      },
    },
    intent: {
      name: "NonEmptyString", # required
      slots: {
        "NonEmptyString" => {
          value: {
            original_value: "NonEmptyString",
            interpreted_value: "NonEmptyString", # required
            resolved_values: ["NonEmptyString"],
          },
          shape: "Scalar", # accepts Scalar, List, Composite
          values: [
            {
              # recursive Slot
            },
          ],
          sub_slots: {
            # recursive Slots
          },
        },
      },
      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: [
              {
                phrase: "RuntimeHintPhrase", # required
              },
            ],
            sub_slot_hints: {
              # recursive SlotHintsSlotMap
            },
          },
        },
      },
    },
  },
  request_attributes: {
    "NonEmptyString" => "String",
  },
})

Response structure


resp.messages #=> Array
resp.messages[0].content #=> String
resp.messages[0].content_type #=> String, one of "CustomPayload", "ImageResponseCard", "PlainText", "SSML"
resp.messages[0].image_response_card.title #=> String
resp.messages[0].image_response_card.subtitle #=> String
resp.messages[0].image_response_card.image_url #=> String
resp.messages[0].image_response_card.buttons #=> Array
resp.messages[0].image_response_card.buttons[0].text #=> String
resp.messages[0].image_response_card.buttons[0].value #=> String
resp.session_state.dialog_action.type #=> String, one of "Close", "ConfirmIntent", "Delegate", "ElicitIntent", "ElicitSlot", "None"
resp.session_state.dialog_action.slot_to_elicit #=> String
resp.session_state.dialog_action.slot_elicitation_style #=> String, one of "Default", "SpellByLetter", "SpellByWord"
resp.session_state.dialog_action.sub_slot_to_elicit.name #=> String
resp.session_state.dialog_action.sub_slot_to_elicit.sub_slot_to_elicit #=> Types::ElicitSubSlot
resp.session_state.intent.name #=> String
resp.session_state.intent.slots #=> Hash
resp.session_state.intent.slots["NonEmptyString"].value.original_value #=> String
resp.session_state.intent.slots["NonEmptyString"].value.interpreted_value #=> String
resp.session_state.intent.slots["NonEmptyString"].value.resolved_values #=> Array
resp.session_state.intent.slots["NonEmptyString"].value.resolved_values[0] #=> String
resp.session_state.intent.slots["NonEmptyString"].shape #=> String, one of "Scalar", "List", "Composite"
resp.session_state.intent.slots["NonEmptyString"].values #=> Array
resp.session_state.intent.slots["NonEmptyString"].values[0] #=> Types::Slot
resp.session_state.intent.slots["NonEmptyString"].sub_slots #=> Types::Slots
resp.session_state.intent.state #=> String, one of "Failed", "Fulfilled", "InProgress", "ReadyForFulfillment", "Waiting", "FulfillmentInProgress"
resp.session_state.intent.confirmation_state #=> String, one of "Confirmed", "Denied", "None"
resp.session_state.active_contexts #=> Array
resp.session_state.active_contexts[0].name #=> String
resp.session_state.active_contexts[0].time_to_live.time_to_live_in_seconds #=> Integer
resp.session_state.active_contexts[0].time_to_live.turns_to_live #=> Integer
resp.session_state.active_contexts[0].context_attributes #=> Hash
resp.session_state.active_contexts[0].context_attributes["ParameterName"] #=> String
resp.session_state.session_attributes #=> Hash
resp.session_state.session_attributes["NonEmptyString"] #=> String
resp.session_state.originating_request_id #=> String
resp.session_state.runtime_hints.slot_hints #=> Hash
resp.session_state.runtime_hints.slot_hints["Name"] #=> Hash
resp.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values #=> Array
resp.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values[0].phrase #=> String
resp.session_state.runtime_hints.slot_hints["Name"]["Name"].sub_slot_hints #=> Types::SlotHintsSlotMap
resp.interpretations #=> Array
resp.interpretations[0].nlu_confidence.score #=> Float
resp.interpretations[0].sentiment_response.sentiment #=> String, one of "MIXED", "NEGATIVE", "NEUTRAL", "POSITIVE"
resp.interpretations[0].sentiment_response.sentiment_score.positive #=> Float
resp.interpretations[0].sentiment_response.sentiment_score.negative #=> Float
resp.interpretations[0].sentiment_response.sentiment_score.neutral #=> Float
resp.interpretations[0].sentiment_response.sentiment_score.mixed #=> Float
resp.interpretations[0].intent.name #=> String
resp.interpretations[0].intent.slots #=> Hash
resp.interpretations[0].intent.slots["NonEmptyString"].value.original_value #=> String
resp.interpretations[0].intent.slots["NonEmptyString"].value.interpreted_value #=> String
resp.interpretations[0].intent.slots["NonEmptyString"].value.resolved_values #=> Array
resp.interpretations[0].intent.slots["NonEmptyString"].value.resolved_values[0] #=> String
resp.interpretations[0].intent.slots["NonEmptyString"].shape #=> String, one of "Scalar", "List", "Composite"
resp.interpretations[0].intent.slots["NonEmptyString"].values #=> Array
resp.interpretations[0].intent.slots["NonEmptyString"].values[0] #=> Types::Slot
resp.interpretations[0].intent.slots["NonEmptyString"].sub_slots #=> Types::Slots
resp.interpretations[0].intent.state #=> String, one of "Failed", "Fulfilled", "InProgress", "ReadyForFulfillment", "Waiting", "FulfillmentInProgress"
resp.interpretations[0].intent.confirmation_state #=> String, one of "Confirmed", "Denied", "None"
resp.interpretations[0].interpretation_source #=> String, one of "Bedrock", "Lex"
resp.request_attributes #=> Hash
resp.request_attributes["NonEmptyString"] #=> String
resp.session_id #=> String
resp.recognized_bot_member.bot_id #=> String
resp.recognized_bot_member.bot_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :bot_id (required, String) —

    The identifier of the bot that processes the request.

  • :bot_alias_id (required, String) —

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

  • :locale_id (required, String) —

    The locale where the session is in use.

  • :session_id (required, String) —

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

  • :text (required, String) —

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

  • :session_state (Types::SessionState) —

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

  • :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:

See Also:



1049
1050
1051
1052
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 1049

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

#recognize_utterance(params = {}) ⇒ Types::RecognizeUtteranceResponse

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

The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.

  • requestAttributes

  • sessionState

The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.

  • inputTranscript

  • interpretations

  • messages

  • requestAttributes

  • sessionState

The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see [PostFulfillmentStatusSpecification].

  • **Success message** - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

  • **Failed message** - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

  • **Timeout message** - If you don’t configure a timeout message and a timeout, and the Lambda function doesn’t return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see [Completion message].

[1]: docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html [2]: docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html

Examples:

Request syntax with placeholder values


resp = client.recognize_utterance({
  bot_id: "BotIdentifier", # required
  bot_alias_id: "BotAliasIdentifier", # required
  locale_id: "LocaleId", # required
  session_id: "SessionId", # required
  session_state: "SensitiveNonEmptyString",
  request_attributes: "SensitiveNonEmptyString",
  request_content_type: "NonEmptyString", # required
  response_content_type: "NonEmptyString",
  input_stream: "data",
})

Response structure


resp.input_mode #=> String
resp.content_type #=> String
resp.messages #=> String
resp.interpretations #=> String
resp.session_state #=> String
resp.request_attributes #=> String
resp.session_id #=> String
resp.input_transcript #=> String
resp.audio_stream #=> IO
resp.recognized_bot_member #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :bot_id (required, String) —

    The identifier of the bot that should receive the request.

  • :bot_alias_id (required, String) —

    The alias identifier in use for the bot that should receive the request.

  • :locale_id (required, String) —

    The locale where the session is in use.

  • :session_id (required, String) —

    The identifier of the session in use.

  • :session_state (String) —

    Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

    The ‘sessionState` field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

  • :request_attributes (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 for prefix ‘x-amz-lex:`.

    The ‘requestAttributes` field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

  • :request_content_type (required, String) —

    Indicates the format for audio input or that the content is text. The header 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

      ^

  • :response_content_type (String) —

    The message that Amazon Lex V2 returns in the response can be either text or speech based on the ‘responseContentType` value.

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

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

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

    • The following are the accepted values:

      • audio/mpeg

      • audio/ogg

      • audio/pcm (16 KHz)

      • audio/* (defaults to mpeg)

      • text/plain; charset=utf-8

  • :input_stream (String, IO) —

    User input in PCM or Opus audio format or text format as described in the ‘requestContentType` parameter.

Returns:

See Also:



1240
1241
1242
1243
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 1240

def recognize_utterance(params = {}, options = {}, &block)
  req = build_request(:recognize_utterance, 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. 


1269
1270
1271
 
# File 'lib/aws-sdk-lexruntimev2/client.rb', line 1269

def waiter_names
  []
end