class Aws::LexRuntimeV2::Client
See {#initialize} for a full list of supported configuration options.
the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
For details on configuring region and credentials see
)
# …
credentials: credentials,
region: region_name,
client = Aws::LexRuntimeV2::Client.new(
An API client for LexRuntimeV2. To construct a client, you need to configure a ‘:region` and `:credentials`.
def build_request(operation_name, params = {})
- Api: - private
Parameters:
-
params({}) --
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.70.0' Seahorse::Client::Request.new(handlers, context) end
def delete_session(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_session(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/DeleteSession - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DeleteSessionResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:session_id(required, String) -- -
:locale_id(required, String) -- -
:bot_alias_id(required, String) -- -
:bot_id(required, String) --
def delete_session(params = {}, options = {}) req = build_request(:delete_session, params) req.send_request(options) end
def errors_module
- Api: - private
def errors_module Errors end
def get_session(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
get_session(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/GetSession - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::GetSessionResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:session_id(required, String) -- -
:locale_id(required, String) -- -
:bot_alias_id(required, String) -- -
:bot_id(required, String) --
def get_session(params = {}, options = {}) req = build_request(:get_session, params) req.send_request(options) end
def initialize(*args)
(**options)-
:ssl_verify_peer(Boolean) -- -
:ssl_timeout(Float) -- -
:ssl_key(OpenSSL::PKey) -- -
:ssl_cert(OpenSSL::X509::Certificate) -- -
:ssl_ca_store(String) -- -
:ssl_ca_directory(String) -- -
:ssl_ca_bundle(String) -- -
:raise_response_errors(Boolean) -- -
:on_chunk_sent(Proc) -- -
:on_chunk_received(Proc) -- -
:http_wire_trace(Boolean) -- -
:http_read_timeout(Float) -- -
:http_proxy(URI::HTTP, String) -- -
:http_open_timeout(Float) -- -
:http_idle_timeout(Float) -- -
:http_continue_timeout(Float) -- -
:endpoint_provider(Aws::LexRuntimeV2::EndpointProvider) -- -
:validate_params(Boolean) -- -
:use_fips_endpoint(Boolean) -- -
:use_dualstack_endpoint(Boolean) -- -
:token_provider(Aws::TokenProvider) -- -
:telemetry_provider(Aws::Telemetry::TelemetryProviderBase) -- -
:stub_responses(Boolean) -- -
:sigv4a_signing_region_set(Array) -- -
:session_token(String) -- -
:secret_access_key(String) -- -
:sdk_ua_app_id(String) -- -
:retry_mode(String) -- -
:retry_max_delay(Integer) -- -
:retry_limit(Integer) -- -
:retry_jitter(Symbol) -- -
:retry_base_delay(Float) -- -
:retry_backoff(Proc) -- -
:response_checksum_validation(String) -- -
:request_min_compression_size_bytes(Integer) -- -
:request_checksum_calculation(String) -- -
:profile(String) -- -
:output_event_stream_handler(Proc) -- -
:max_attempts(Integer) -- -
:logger(Logger) -- -
:log_level(Symbol) -- -
:log_formatter(Aws::Log::Formatter) -- -
:input_event_stream_handler(Proc) -- -
:ignore_configured_endpoint_urls(Boolean) -- -
:event_stream_handler(Proc) -- -
:endpoint_discovery(Boolean) -- -
:endpoint_cache_poll_interval(Integer) -- -
:endpoint_cache_max_threads(Integer) -- -
:endpoint_cache_max_entries(Integer) -- -
:endpoint(String, URI::HTTPS, URI::HTTP) -- -
:disable_request_compression(Boolean) -- -
:disable_host_prefix_injection(Boolean) -- -
:defaults_mode(String) -- -
:correct_clock_skew(Boolean) -- -
:convert_params(Boolean) -- -
:client_side_monitoring_publisher(Aws::ClientSideMonitoring::Publisher) -- -
:client_side_monitoring_port(Integer) -- -
:client_side_monitoring_host(String) -- -
:client_side_monitoring_client_id(String) -- -
:client_side_monitoring(Boolean) -- -
:auth_scheme_preference(Array) -- -
:adaptive_retry_wait_to_fill(Boolean) -- -
:active_endpoint_cache(Boolean) -- -
:account_id(String) -- -
:access_key_id(String) -- -
:region(required, String) -- -
:credentials(required, Aws::CredentialProvider) -- -
:plugins(Array) --
Other tags:
- See: https://www.awsarchitectureblog.com/2015/03/backoff.html -
Parameters:
-
options(Hash) --
Overloads:
-
initialize(options)
def initialize(*args) super end
def put_session(params = {}, options = {}, &block)
-
params(Hash) -- ({})
Overloads:
-
put_session(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/PutSession - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::PutSessionResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:response_content_type(String) -- -
:request_attributes(Hash) -- -
:session_state(required, Types::SessionState) -- -
:messages(Array) -- -
:session_id(required, String) -- -
:locale_id(required, String) -- -
:bot_alias_id(required, String) -- -
:bot_id(required, String) --
def put_session(params = {}, options = {}, &block) req = build_request(:put_session, params) req.send_request(options, &block) end
def recognize_text(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
recognize_text(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RecognizeText - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::RecognizeTextResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:request_attributes(Hash) -- -
:session_state(Types::SessionState) -- -
:text(required, String) -- -
:session_id(required, String) -- -
:locale_id(required, String) -- -
:bot_alias_id(required, String) -- -
:bot_id(required, String) --
def recognize_text(params = {}, options = {}) req = build_request(:recognize_text, params) req.send_request(options) end
def recognize_utterance(params = {}, options = {}, &block)
-
params(Hash) -- ({})
Overloads:
-
recognize_utterance(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RecognizeUtterance - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::RecognizeUtteranceResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:input_stream(String, IO) -- -
:response_content_type(String) -- -
:request_content_type(required, String) -- -
:request_attributes(String) -- -
:session_state(String) -- -
:session_id(required, String) -- -
:locale_id(required, String) -- -
:bot_alias_id(required, String) -- -
:bot_id(required, String) --
def recognize_utterance(params = {}, options = {}, &block) req = build_request(:recognize_utterance, params) req.send_request(options, &block) end
def waiter_names
Other tags:
- Api: - private
def waiter_names [] end