aws-sdk-bedrockagentruntime 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24e10fc42b8ea0b4e35d44ca0c691949feaab6fe28ebe2a12c290ea005730c27
-  data.tar.gz: 7239ae58b7fc4a5343de154490f9c81eb7011fdd9a1be9472fc64575f6b4f803
+  metadata.gz: 3a7807ae877e929d1ebf772ede849e026038aef63d4cab849617d61b17ca4ab2
+  data.tar.gz: 65456ef078ed1cf91f3f6bb9771417e2a8754a9112f73f40a967c8e2d931a04c
 SHA512:
-  metadata.gz: 3f4d8ef61cdf0882cea1ab50df77212c91dda6f4a9457ad6632702c328f21fa20c1ff2dcff52544e935f747bb7b973c65f68ee40d77c63342c14f079599be7d7
-  data.tar.gz: 7b77085b8fe83e0f72e6276a82403b2a891515a51c3f2957860d516cb4b9657ea8be881250cda8abe01cd5417ef783b2ee499b8a84484bf72ca3f82f2e483ae6
+  metadata.gz: c87fb48cd5dca38d6bc19cab8ffd706e48d38b824eb5fab4bcada125e8c03de0b2bf8e9fa2952390d2b3a52b5f9691a9c4ef1dbfd41750f7841d9ae1af99b0b7
+  data.tar.gz: 5c541812632089ec05e6323e2297a14795fd4964742bd7fab30c5ca2d365828c62c9babe1460cbcd9d0aa866364692cf21fafdc191e81fcad22b5362b8672258

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.7.0 (2024-04-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.6.0 (2024-04-23)
+------------------
+
+* Feature - This release introduces zero-setup file upload support for the RetrieveAndGenerate API. This allows you to chat with your data without setting up a Knowledge Base.
+
 1.5.0 (2024-03-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.7.0

data/lib/aws-sdk-bedrockagentruntime/client.rb

@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
 require 'aws-sdk-core/plugins/response_paging.rb'
 require 'aws-sdk-core/plugins/stub_responses.rb'
 require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/invocation_id.rb'
 require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -73,6 +74,7 @@ module Aws::BedrockAgentRuntime
     add_plugin(Aws::Plugins::ResponsePaging)
     add_plugin(Aws::Plugins::StubResponses)
     add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::InvocationId)
     add_plugin(Aws::Plugins::JsonvalueConverter)
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -198,10 +200,17 @@ module Aws::BedrockAgentRuntime
     #     When set to 'true' the request body will not be compressed
     #     for supported operations.
     #
-    #   @option options [String] :endpoint
-    #     The client endpoint is normally constructed from the `:region`
-    #     option. You should only configure an `:endpoint` when connecting
-    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
+    #   @option options [String, URI::HTTPS, URI::HTTP] :endpoint
+    #     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'
+    #
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -348,50 +357,65 @@ module Aws::BedrockAgentRuntime
     #   @option options [Aws::BedrockAgentRuntime::EndpointProvider] :endpoint_provider
     #     The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::BedrockAgentRuntime::EndpointParameters`
     #
-    #   @option options [URI::HTTP,String] :http_proxy A proxy to send
-    #     requests through.  Formatted like 'http://proxy.com:123'.
-    #
-    #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before raising a
-    #     `Timeout::Error`.
-    #
-    #   @option options [Float] :http_read_timeout (60) The default
-    #     number of seconds to wait for response data.  This value can
-    #     safely be set per-request on the session.
-    #
-    #   @option options [Float] :http_idle_timeout (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.
-    #
-    #   @option options [Float] :http_continue_timeout (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.
-    #
-    #   @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
-    #     in seconds.
+    #   @option options [Float] :http_continue_timeout (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.
+    #
+    #   @option options [Float] :http_idle_timeout (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.
+    #
+    #   @option options [Float] :http_open_timeout (15)
+    #     The default number of seconds to wait for response data.
+    #     This value can safely be set per-request on the session.
+    #
+    #   @option options [URI::HTTP,String] :http_proxy
+    #     A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
+    #
+    #   @option options [Float] :http_read_timeout (60)
+    #     The default number of seconds to wait for response data.
+    #     This value can safely be set per-request on the session.
+    #
+    #   @option options [Boolean] :http_wire_trace (false)
+    #     When `true`,  HTTP debug output will be sent to the `:logger`.
+    #
+    #   @option options [Proc] :on_chunk_received
+    #     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`).
+    #
+    #   @option options [Proc] :on_chunk_sent
+    #     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.
+    #
+    #   @option options [Boolean] :raise_response_errors (true)
+    #     When `true`, response errors are raised.
+    #
+    #   @option options [String] :ssl_ca_bundle
+    #     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.
+    #
+    #   @option options [String] :ssl_ca_directory
+    #     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.
     #
-    #   @option options [Boolean] :http_wire_trace (false) When `true`,
-    #     HTTP debug output will be sent to the `:logger`.
+    #   @option options [String] :ssl_ca_store
+    #     Sets the X509::Store to verify peer certificate.
     #
-    #   @option options [Boolean] :ssl_verify_peer (true) When `true`,
-    #     SSL peer certificates are verified when establishing a
-    #     connection.
+    #   @option options [Float] :ssl_timeout
+    #     Sets the SSL timeout in seconds
     #
-    #   @option options [String] :ssl_ca_bundle 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.
-    #
-    #   @option options [String] :ssl_ca_directory 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.
+    #   @option options [Boolean] :ssl_verify_peer (true)
+    #     When `true`, SSL peer certificates are verified when establishing a connection.
     #
     def initialize(*args)
       super
@@ -399,7 +423,8 @@ module Aws::BedrockAgentRuntime
 
     # @!group API Operations
 
-    # Sends a prompt for the agent to process and respond to.
+    # Sends a prompt for the agent to process and respond to. Use return
+    # control event type for function calling.
     #
     # <note markdown="1"> The CLI doesn't support `InvokeAgent`.
     #
@@ -416,8 +441,10 @@ module Aws::BedrockAgentRuntime
     #
     # * End a conversation by setting `endSession` to `true`.
     #
-    # * Include attributes for the session or prompt in the `sessionState`
-    #   object.
+    # * In the `sessionState` object, you can include attributes for the
+    #   session or prompt or parameters returned from the action group.
+    #
+    # * Use return control event type for function calling.
     #
     # The response is returned in the `bytes` field of the `chunk` object.
     #
@@ -450,7 +477,7 @@ module Aws::BedrockAgentRuntime
     # @option params [Boolean] :end_session
     #   Specifies whether to end the session with the agent or not.
     #
-    # @option params [required, String] :input_text
+    # @option params [String] :input_text
     #   The prompt text to send the agent.
     #
     # @option params [required, String] :session_id
@@ -473,22 +500,22 @@ module Aws::BedrockAgentRuntime
     #
     # @example EventStream Operation Example
     #
-    #   You can process event once it arrives immediately, or wait until
-    #   full response complete and iterate through eventstream enumerator.
+    #   You can process the event once it arrives immediately, or wait until the
+    #   full response is complete and iterate through the eventstream enumerator.
     #
     #   To interact with event immediately, you need to register #invoke_agent
-    #   with callbacks, callbacks can be register for specifc events or for all events,
-    #   callback for errors in the event stream is also available for register.
+    #   with callbacks. Callbacks can be registered for specific events or for all
+    #   events, including error events.
     #
-    #   Callbacks can be passed in by `:event_stream_handler` option or within block
-    #   statement attached to #invoke_agent call directly. Hybrid pattern of both
-    #   is also supported.
+    #   Callbacks can be passed into the `:event_stream_handler` option or within a
+    #   block statement attached to the #invoke_agent call directly. Hybrid
+    #   pattern of both is also supported.
     #
-    #   `:event_stream_handler` option takes in either Proc object or
+    #   `:event_stream_handler` option takes in either a Proc object or
     #   Aws::BedrockAgentRuntime::EventStreams::ResponseStream object.
     #
-    #   Usage pattern a): callbacks with a block attached to #invoke_agent
-    #     Example for registering callbacks for all event types and error event
+    #   Usage pattern a): Callbacks with a block attached to #invoke_agent
+    #     Example for registering callbacks for all event types and an error event
     #
     #     client.invoke_agent( # params input# ) do |stream|
     #       stream.on_error_event do |event|
@@ -508,9 +535,9 @@ module Aws::BedrockAgentRuntime
     #
     #     end
     #
-    #   Usage pattern b): pass in `:event_stream_handler` for #invoke_agent
+    #   Usage pattern b): Pass in `:event_stream_handler` for #invoke_agent
     #
-    #     1) create a Aws::BedrockAgentRuntime::EventStreams::ResponseStream object
+    #     1) Create a Aws::BedrockAgentRuntime::EventStreams::ResponseStream object
     #     Example for registering callbacks with specific events
     #
     #       handler = Aws::BedrockAgentRuntime::EventStreams::ResponseStream.new
@@ -535,6 +562,9 @@ module Aws::BedrockAgentRuntime
     #       handler.on_resource_not_found_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
     #       end
+    #       handler.on_return_control_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::returnControl
+    #       end
     #       handler.on_service_quota_exceeded_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
     #       end
@@ -550,7 +580,7 @@ module Aws::BedrockAgentRuntime
     #
     #     client.invoke_agent( # params input #, event_stream_handler: handler)
     #
-    #     2) use a Ruby Proc object
+    #     2) Use a Ruby Proc object
     #     Example for registering callbacks with specific events
     #
     #     handler = Proc.new do |stream|
@@ -575,6 +605,9 @@ module Aws::BedrockAgentRuntime
     #       stream.on_resource_not_found_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
     #       end
+    #       stream.on_return_control_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::returnControl
+    #       end
     #       stream.on_service_quota_exceeded_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
     #       end
@@ -591,7 +624,7 @@ module Aws::BedrockAgentRuntime
     #
     #     client.invoke_agent( # params input #, event_stream_handler: handler)
     #
-    #   Usage pattern c): hybird pattern of a) and b)
+    #   Usage pattern c): Hybrid pattern of a) and b)
     #
     #       handler = Aws::BedrockAgentRuntime::EventStreams::ResponseStream.new
     #       handler.on_access_denied_exception_event do |event|
@@ -615,6 +648,9 @@ module Aws::BedrockAgentRuntime
     #       handler.on_resource_not_found_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
     #       end
+    #       handler.on_return_control_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::returnControl
+    #       end
     #       handler.on_service_quota_exceeded_exception_event do |event|
     #         event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
     #       end
@@ -639,8 +675,7 @@ module Aws::BedrockAgentRuntime
     #       end
     #     end
     #
-    #   Besides above usage patterns for process events when they arrive immediately, you can also
-    #   iterate through events after response complete.
+    #   You can also iterate through events after the response complete.
     #
     #   Events are available at resp.completion # => Enumerator
     #   For parameter input example, please refer to following request syntax
@@ -652,12 +687,39 @@ module Aws::BedrockAgentRuntime
     #     agent_id: "AgentId", # required
     #     enable_trace: false,
     #     end_session: false,
-    #     input_text: "InputText", # required
+    #     input_text: "InputText",
     #     session_id: "SessionId", # required
     #     session_state: {
+    #       invocation_id: "String",
     #       prompt_session_attributes: {
     #         "String" => "String",
     #       },
+    #       return_control_invocation_results: [
+    #         {
+    #           api_result: {
+    #             action_group: "String", # required
+    #             api_path: "ApiPath",
+    #             http_method: "String",
+    #             http_status_code: 1,
+    #             response_body: {
+    #               "String" => {
+    #                 body: "String",
+    #               },
+    #             },
+    #             response_state: "FAILURE", # accepts FAILURE, REPROMPT
+    #           },
+    #           function_result: {
+    #             action_group: "String", # required
+    #             function: "String",
+    #             response_body: {
+    #               "String" => {
+    #                 body: "String",
+    #               },
+    #             },
+    #             response_state: "FAILURE", # accepts FAILURE, REPROMPT
+    #           },
+    #         },
+    #       ],
     #       session_attributes: {
     #         "String" => "String",
     #       },
@@ -668,7 +730,7 @@ module Aws::BedrockAgentRuntime
     #
     #   All events are available at resp.completion:
     #   resp.completion #=> Enumerator
-    #   resp.completion.event_types #=> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :internal_server_exception, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
+    #   resp.completion.event_types #=> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :internal_server_exception, :resource_not_found_exception, :return_control, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
     #
     #   For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
     #   event.message #=> String
@@ -702,6 +764,28 @@ module Aws::BedrockAgentRuntime
     #   For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
     #   event.message #=> String
     #
+    #   For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
+    #   event.invocation_id #=> String
+    #   event.invocation_inputs #=> Array
+    #   event.invocation_inputs[0].api_invocation_input.action_group #=> String
+    #   event.invocation_inputs[0].api_invocation_input.api_path #=> String
+    #   event.invocation_inputs[0].api_invocation_input.http_method #=> String
+    #   event.invocation_inputs[0].api_invocation_input.parameters #=> Array
+    #   event.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
+    #   event.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
+    #   event.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
+    #   event.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
+    #   event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
+    #   event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
+    #   event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
+    #   event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
+    #   event.invocation_inputs[0].function_invocation_input.action_group #=> String
+    #   event.invocation_inputs[0].function_invocation_input.function #=> String
+    #   event.invocation_inputs[0].function_invocation_input.parameters #=> Array
+    #   event.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
+    #   event.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
+    #   event.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
+    #
     #   For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
     #   event.message #=> String
     #
@@ -711,11 +795,13 @@ module Aws::BedrockAgentRuntime
     #   For :trace event available at #on_trace_event callback and response eventstream enumerator:
     #   event.agent_alias_id #=> String
     #   event.agent_id #=> String
+    #   event.agent_version #=> String
     #   event.session_id #=> String
     #   event.trace.failure_trace.failure_reason #=> String
     #   event.trace.failure_trace.trace_id #=> String
     #   event.trace.orchestration_trace.invocation_input.action_group_invocation_input.action_group_name #=> String
     #   event.trace.orchestration_trace.invocation_input.action_group_invocation_input.api_path #=> String
+    #   event.trace.orchestration_trace.invocation_input.action_group_invocation_input.function #=> String
     #   event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters #=> Array
     #   event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters[0].name #=> String
     #   event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters[0].type #=> String
@@ -973,6 +1059,27 @@ module Aws::BedrockAgentRuntime
     #       text: "RetrieveAndGenerateInputTextString", # required
     #     },
     #     retrieve_and_generate_configuration: {
+    #       external_sources_configuration: {
+    #         generation_configuration: {
+    #           prompt_template: {
+    #             text_prompt_template: "TextPromptTemplate",
+    #           },
+    #         },
+    #         model_arn: "BedrockModelArn", # required
+    #         sources: [ # required
+    #           {
+    #             byte_content: {
+    #               content_type: "ContentType", # required
+    #               data: "data", # required
+    #               identifier: "Identifier", # required
+    #             },
+    #             s3_location: {
+    #               uri: "S3Uri", # required
+    #             },
+    #             source_type: "S3", # required, accepts S3, BYTE_CONTENT
+    #           },
+    #         ],
+    #       },
     #       knowledge_base_configuration: {
     #         generation_configuration: {
     #           prompt_template: {
@@ -1045,7 +1152,7 @@ module Aws::BedrockAgentRuntime
     #           },
     #         },
     #       },
-    #       type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE
+    #       type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE, EXTERNAL_SOURCES
     #     },
     #     session_configuration: {
     #       kms_key_arn: "KmsKeyArn", # required
@@ -1089,7 +1196,7 @@ module Aws::BedrockAgentRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-bedrockagentruntime'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.7.0'
       Seahorse::Client::Request.new(handlers, context)
     end