aws-sdk-bedrockagentruntime 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0456f26043768c8a899bebf3fe9e02f7f5ee664c2543ad1ab5ae243d97d00040
-  data.tar.gz: 8e3b743740e6dba682763df127ede599c8a13d1c298984daeee302c59a9935b0
+  metadata.gz: 9a5c8f9ada774c7b6b0f076b035f69819f5b0d0c04912808fda03f994b242e96
+  data.tar.gz: 9142d0bc53700130ddda7545064b22ae00b04e60057c0643add3f5cfa1cb59c5
 SHA512:
-  metadata.gz: c01cf4655c0cbb656e2245f6253c761a656feec75ed4872ea78bd66c8f9b363c34ced4d77d28202b238b0f459c584cc29078de74cdc76ad31868bec447c884ba
-  data.tar.gz: 1a6a16f958c93536a30eb437c21d5b590d92c7f129edcc31c0d1fd6d74ef6c37e606c5816213ac64446e7cec62ff759f00b239f2eee87a89bd867fd0017cf275
+  metadata.gz: 5e5d6f501e8d9cc30c2310099696aebf003fbc3e9d2d228276643178ea15f29c819537d5942a6f63e66bfc5e7656b62a81f2fca55e114422476a91af7d22ad96
+  data.tar.gz: 54e0b35d92200a5b96f66ab97b14ebe698f5ff7aa4f0ed0334522b28dad7451b0270f632a4e2f75bf97c4849b8da4a3ae0ca43dbb6ca5b4d4b52ac3cb97c3461

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.32.0 (2024-11-20)
+------------------
+
+* Feature - Releasing new Prompt Optimization to enhance your prompts for improved performance
+
 1.31.0 (2024-11-08)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.31.0
+1.32.0

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

@@ -1248,7 +1248,7 @@ module Aws::BedrockAgentRuntime
     # Invokes an alias of a flow to run the inputs that you specify and
     # return the output of each node as a stream. If there's an error, the
     # error is returned. For more information, see [Test a flow in Amazon
-    # Bedrock][1] in the Amazon Bedrock User Guide.
+    # Bedrock][1] in the [Amazon Bedrock User Guide][2].
     #
     # <note markdown="1"> The CLI doesn't support streaming operations in Amazon Bedrock,
     # including `InvokeFlow`.
@@ -1258,6 +1258,7 @@ module Aws::BedrockAgentRuntime
     #
     #
     # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
     #
     # @option params [Boolean] :enable_trace
     #   Specifies whether to return the trace for the flow or not. Traces
@@ -1566,6 +1567,242 @@ module Aws::BedrockAgentRuntime
       req.send_request(options, &block)
     end
 
+    # Optimizes a prompt for the task that you specify. For more
+    # information, see [Optimize a prompt][1] in the [Amazon Bedrock User
+    # Guide][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-optimize.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
+    #
+    # @option params [required, Types::InputPrompt] :input
+    #   Contains the prompt to optimize.
+    #
+    # @option params [required, String] :target_model_id
+    #   The unique identifier of the model that you want to optimize the
+    #   prompt for.
+    #
+    # @return [Types::OptimizePromptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::OptimizePromptResponse#optimized_prompt #optimized_prompt} => Types::OptimizedPromptStream
+    #
+    # @example EventStream Operation Example
+    #
+    #   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 #optimize_prompt
+    #   with callbacks. Callbacks can be registered for specific events or for all
+    #   events, including error events.
+    #
+    #   Callbacks can be passed into the `:event_stream_handler` option or within a
+    #   block statement attached to the #optimize_prompt call directly. Hybrid
+    #   pattern of both is also supported.
+    #
+    #   `:event_stream_handler` option takes in either a Proc object or
+    #   Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object.
+    #
+    #   Usage pattern a): Callbacks with a block attached to #optimize_prompt
+    #     Example for registering callbacks for all event types and an error event
+    #
+    #     client.optimize_prompt( # params input# ) do |stream|
+    #       stream.on_error_event do |event|
+    #         # catch unmodeled error event in the stream
+    #         raise event
+    #         # => Aws::Errors::EventError
+    #         # event.event_type => :error
+    #         # event.error_code => String
+    #         # event.error_message => String
+    #       end
+    #
+    #       stream.on_event do |event|
+    #         # process all events arrive
+    #         puts event.event_type
+    #         ...
+    #       end
+    #
+    #     end
+    #
+    #   Usage pattern b): Pass in `:event_stream_handler` for #optimize_prompt
+    #
+    #     1) Create a Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object
+    #     Example for registering callbacks with specific events
+    #
+    #       handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
+    #       handler.on_access_denied_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
+    #       end
+    #       handler.on_analyze_prompt_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
+    #       end
+    #       handler.on_bad_gateway_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::badGatewayException
+    #       end
+    #       handler.on_dependency_failed_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
+    #       end
+    #       handler.on_internal_server_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::internalServerException
+    #       end
+    #       handler.on_optimized_prompt_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
+    #       end
+    #       handler.on_throttling_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::throttlingException
+    #       end
+    #       handler.on_validation_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::validationException
+    #       end
+    #
+    #     client.optimize_prompt( # params input #, event_stream_handler: handler)
+    #
+    #     2) Use a Ruby Proc object
+    #     Example for registering callbacks with specific events
+    #
+    #     handler = Proc.new do |stream|
+    #       stream.on_access_denied_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
+    #       end
+    #       stream.on_analyze_prompt_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
+    #       end
+    #       stream.on_bad_gateway_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::badGatewayException
+    #       end
+    #       stream.on_dependency_failed_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
+    #       end
+    #       stream.on_internal_server_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::internalServerException
+    #       end
+    #       stream.on_optimized_prompt_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
+    #       end
+    #       stream.on_throttling_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::throttlingException
+    #       end
+    #       stream.on_validation_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::validationException
+    #       end
+    #     end
+    #
+    #     client.optimize_prompt( # params input #, event_stream_handler: handler)
+    #
+    #   Usage pattern c): Hybrid pattern of a) and b)
+    #
+    #       handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
+    #       handler.on_access_denied_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
+    #       end
+    #       handler.on_analyze_prompt_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
+    #       end
+    #       handler.on_bad_gateway_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::badGatewayException
+    #       end
+    #       handler.on_dependency_failed_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
+    #       end
+    #       handler.on_internal_server_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::internalServerException
+    #       end
+    #       handler.on_optimized_prompt_event_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
+    #       end
+    #       handler.on_throttling_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::throttlingException
+    #       end
+    #       handler.on_validation_exception_event do |event|
+    #         event # => Aws::BedrockAgentRuntime::Types::validationException
+    #       end
+    #
+    #     client.optimize_prompt( # params input #, event_stream_handler: handler) do |stream|
+    #       stream.on_error_event do |event|
+    #         # catch unmodeled error event in the stream
+    #         raise event
+    #         # => Aws::Errors::EventError
+    #         # event.event_type => :error
+    #         # event.error_code => String
+    #         # event.error_message => String
+    #       end
+    #     end
+    #
+    #   You can also iterate through events after the response complete.
+    #
+    #   Events are available at resp.optimized_prompt # => Enumerator
+    #   For parameter input example, please refer to following request syntax
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.optimize_prompt({
+    #     input: { # required
+    #       text_prompt: {
+    #         text: "TextPromptTextString", # required
+    #       },
+    #     },
+    #     target_model_id: "OptimizePromptRequestTargetModelIdString", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   All events are available at resp.optimized_prompt:
+    #   resp.optimized_prompt #=> Enumerator
+    #   resp.optimized_prompt.event_types #=> [:access_denied_exception, :analyze_prompt_event, :bad_gateway_exception, :dependency_failed_exception, :internal_server_exception, :optimized_prompt_event, :throttling_exception, :validation_exception]
+    #
+    #   For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
+    #   event.message #=> String
+    #
+    #   For :analyze_prompt_event event available at #on_analyze_prompt_event_event callback and response eventstream enumerator:
+    #   event.message #=> String
+    #
+    #   For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
+    #   event.message #=> String
+    #   event.resource_name #=> String
+    #
+    #   For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
+    #   event.message #=> String
+    #   event.resource_name #=> String
+    #
+    #   For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
+    #   event.message #=> String
+    #
+    #   For :optimized_prompt_event event available at #on_optimized_prompt_event_event callback and response eventstream enumerator:
+    #   event.optimized_prompt.text_prompt.text #=> String
+    #
+    #   For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
+    #   event.message #=> String
+    #
+    #   For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
+    #   event.message #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OptimizePrompt AWS API Documentation
+    #
+    # @overload optimize_prompt(params = {})
+    # @param [Hash] params ({})
+    def optimize_prompt(params = {}, options = {}, &block)
+      params = params.dup
+      event_stream_handler = case handler = params.delete(:event_stream_handler)
+        when EventStreams::OptimizedPromptStream then handler
+        when Proc then EventStreams::OptimizedPromptStream.new.tap(&handler)
+        when nil then EventStreams::OptimizedPromptStream.new
+        else
+          msg = "expected :event_stream_handler to be a block or "\
+                "instance of Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream"\
+                ", got `#{handler.inspect}` instead"
+          raise ArgumentError, msg
+        end
+
+      yield(event_stream_handler) if block_given?
+
+      req = build_request(:optimize_prompt, params)
+
+      req.context[:event_stream_handler] = event_stream_handler
+      req.handlers.add(Aws::Binary::DecodeHandler, priority: 95)
+
+      req.send_request(options, &block)
+    end
+
     # Queries a knowledge base and retrieves information from it.
     #
     # @option params [required, String] :knowledge_base_id
@@ -1954,7 +2191,7 @@ module Aws::BedrockAgentRuntime
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-bedrockagentruntime'
-      context[:gem_version] = '1.31.0'
+      context[:gem_version] = '1.32.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -26,6 +26,7 @@ module Aws::BedrockAgentRuntime
     AgentAliasId = Shapes::StringShape.new(name: 'AgentAliasId')
     AgentId = Shapes::StringShape.new(name: 'AgentId')
     AgentVersion = Shapes::StringShape.new(name: 'AgentVersion')
+    AnalyzePromptEvent = Shapes::StructureShape.new(name: 'AnalyzePromptEvent')
     ApiContentMap = Shapes::MapShape.new(name: 'ApiContentMap')
     ApiInvocationInput = Shapes::StructureShape.new(name: 'ApiInvocationInput')
     ApiParameter = Shapes::StructureShape.new(name: 'ApiParameter')
@@ -145,6 +146,7 @@ module Aws::BedrockAgentRuntime
     InferenceConfiguration = Shapes::StructureShape.new(name: 'InferenceConfiguration')
     InputFile = Shapes::StructureShape.new(name: 'InputFile')
     InputFiles = Shapes::ListShape.new(name: 'InputFiles')
+    InputPrompt = Shapes::UnionShape.new(name: 'InputPrompt')
     InputText = Shapes::StringShape.new(name: 'InputText')
     Integer = Shapes::IntegerShape.new(name: 'Integer')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
@@ -191,6 +193,12 @@ module Aws::BedrockAgentRuntime
     NodeType = Shapes::StringShape.new(name: 'NodeType')
     NonBlankString = Shapes::StringShape.new(name: 'NonBlankString')
     Observation = Shapes::StructureShape.new(name: 'Observation')
+    OptimizePromptRequest = Shapes::StructureShape.new(name: 'OptimizePromptRequest')
+    OptimizePromptRequestTargetModelIdString = Shapes::StringShape.new(name: 'OptimizePromptRequestTargetModelIdString')
+    OptimizePromptResponse = Shapes::StructureShape.new(name: 'OptimizePromptResponse')
+    OptimizedPrompt = Shapes::UnionShape.new(name: 'OptimizedPrompt')
+    OptimizedPromptEvent = Shapes::StructureShape.new(name: 'OptimizedPromptEvent')
+    OptimizedPromptStream = Shapes::StructureShape.new(name: 'OptimizedPromptStream')
     OrchestrationConfiguration = Shapes::StructureShape.new(name: 'OrchestrationConfiguration')
     OrchestrationModelInvocationOutput = Shapes::StructureShape.new(name: 'OrchestrationModelInvocationOutput')
     OrchestrationTrace = Shapes::UnionShape.new(name: 'OrchestrationTrace')
@@ -270,7 +278,9 @@ module Aws::BedrockAgentRuntime
     SummaryText = Shapes::StringShape.new(name: 'SummaryText')
     Temperature = Shapes::FloatShape.new(name: 'Temperature')
     TextInferenceConfig = Shapes::StructureShape.new(name: 'TextInferenceConfig')
+    TextPrompt = Shapes::StructureShape.new(name: 'TextPrompt')
     TextPromptTemplate = Shapes::StringShape.new(name: 'TextPromptTemplate')
+    TextPromptTextString = Shapes::StringShape.new(name: 'TextPromptTextString')
     TextResponsePart = Shapes::StructureShape.new(name: 'TextResponsePart')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
     TopK = Shapes::IntegerShape.new(name: 'TopK')
@@ -303,6 +313,9 @@ module Aws::BedrockAgentRuntime
     AdditionalModelRequestFields.key = Shapes::ShapeRef.new(shape: AdditionalModelRequestFieldsKey)
     AdditionalModelRequestFields.value = Shapes::ShapeRef.new(shape: AdditionalModelRequestFieldsValue)
 
+    AnalyzePromptEvent.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message"))
+    AnalyzePromptEvent.struct_class = Types::AnalyzePromptEvent
+
     ApiContentMap.key = Shapes::ShapeRef.new(shape: String)
     ApiContentMap.value = Shapes::ShapeRef.new(shape: PropertyParameters)
 
@@ -654,6 +667,12 @@ module Aws::BedrockAgentRuntime
 
     InputFiles.member = Shapes::ShapeRef.new(shape: InputFile)
 
+    InputPrompt.add_member(:text_prompt, Shapes::ShapeRef.new(shape: TextPrompt, location_name: "textPrompt"))
+    InputPrompt.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    InputPrompt.add_member_subclass(:text_prompt, Types::InputPrompt::TextPrompt)
+    InputPrompt.add_member_subclass(:unknown, Types::InputPrompt::Unknown)
+    InputPrompt.struct_class = Types::InputPrompt
+
     InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
     InternalServerException.struct_class = Types::InternalServerException
 
@@ -786,6 +805,34 @@ module Aws::BedrockAgentRuntime
     Observation.add_member(:type, Shapes::ShapeRef.new(shape: Type, location_name: "type"))
     Observation.struct_class = Types::Observation
 
+    OptimizePromptRequest.add_member(:input, Shapes::ShapeRef.new(shape: InputPrompt, required: true, location_name: "input"))
+    OptimizePromptRequest.add_member(:target_model_id, Shapes::ShapeRef.new(shape: OptimizePromptRequestTargetModelIdString, required: true, location_name: "targetModelId"))
+    OptimizePromptRequest.struct_class = Types::OptimizePromptRequest
+
+    OptimizePromptResponse.add_member(:optimized_prompt, Shapes::ShapeRef.new(shape: OptimizedPromptStream, required: true, eventstream: true, location_name: "optimizedPrompt"))
+    OptimizePromptResponse.struct_class = Types::OptimizePromptResponse
+    OptimizePromptResponse[:payload] = :optimized_prompt
+    OptimizePromptResponse[:payload_member] = OptimizePromptResponse.member(:optimized_prompt)
+
+    OptimizedPrompt.add_member(:text_prompt, Shapes::ShapeRef.new(shape: TextPrompt, location_name: "textPrompt"))
+    OptimizedPrompt.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    OptimizedPrompt.add_member_subclass(:text_prompt, Types::OptimizedPrompt::TextPrompt)
+    OptimizedPrompt.add_member_subclass(:unknown, Types::OptimizedPrompt::Unknown)
+    OptimizedPrompt.struct_class = Types::OptimizedPrompt
+
+    OptimizedPromptEvent.add_member(:optimized_prompt, Shapes::ShapeRef.new(shape: OptimizedPrompt, location_name: "optimizedPrompt"))
+    OptimizedPromptEvent.struct_class = Types::OptimizedPromptEvent
+
+    OptimizedPromptStream.add_member(:access_denied_exception, Shapes::ShapeRef.new(shape: AccessDeniedException, location_name: "accessDeniedException"))
+    OptimizedPromptStream.add_member(:analyze_prompt_event, Shapes::ShapeRef.new(shape: AnalyzePromptEvent, event: true, location_name: "analyzePromptEvent"))
+    OptimizedPromptStream.add_member(:bad_gateway_exception, Shapes::ShapeRef.new(shape: BadGatewayException, location_name: "badGatewayException"))
+    OptimizedPromptStream.add_member(:dependency_failed_exception, Shapes::ShapeRef.new(shape: DependencyFailedException, location_name: "dependencyFailedException"))
+    OptimizedPromptStream.add_member(:internal_server_exception, Shapes::ShapeRef.new(shape: InternalServerException, location_name: "internalServerException"))
+    OptimizedPromptStream.add_member(:optimized_prompt_event, Shapes::ShapeRef.new(shape: OptimizedPromptEvent, event: true, location_name: "optimizedPromptEvent"))
+    OptimizedPromptStream.add_member(:throttling_exception, Shapes::ShapeRef.new(shape: ThrottlingException, location_name: "throttlingException"))
+    OptimizedPromptStream.add_member(:validation_exception, Shapes::ShapeRef.new(shape: ValidationException, location_name: "validationException"))
+    OptimizedPromptStream.struct_class = Types::OptimizedPromptStream
+
     OrchestrationConfiguration.add_member(:additional_model_request_fields, Shapes::ShapeRef.new(shape: AdditionalModelRequestFields, location_name: "additionalModelRequestFields"))
     OrchestrationConfiguration.add_member(:inference_config, Shapes::ShapeRef.new(shape: InferenceConfig, location_name: "inferenceConfig"))
     OrchestrationConfiguration.add_member(:prompt_template, Shapes::ShapeRef.new(shape: PromptTemplate, location_name: "promptTemplate"))
@@ -1057,6 +1104,9 @@ module Aws::BedrockAgentRuntime
     TextInferenceConfig.add_member(:top_p, Shapes::ShapeRef.new(shape: TopP, location_name: "topP"))
     TextInferenceConfig.struct_class = Types::TextInferenceConfig
 
+    TextPrompt.add_member(:text, Shapes::ShapeRef.new(shape: TextPromptTextString, required: true, location_name: "text"))
+    TextPrompt.struct_class = Types::TextPrompt
+
     TextResponsePart.add_member(:span, Shapes::ShapeRef.new(shape: Span, location_name: "span"))
     TextResponsePart.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "text"))
     TextResponsePart.struct_class = Types::TextResponsePart
@@ -1186,6 +1236,20 @@ module Aws::BedrockAgentRuntime
         o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
       end)
 
+      api.add_operation(:optimize_prompt, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "OptimizePrompt"
+        o.http_method = "POST"
+        o.http_request_uri = "/optimize-prompt"
+        o.input = Shapes::ShapeRef.new(shape: OptimizePromptRequest)
+        o.output = Shapes::ShapeRef.new(shape: OptimizePromptResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: DependencyFailedException)
+        o.errors << Shapes::ShapeRef.new(shape: BadGatewayException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+      end)
+
       api.add_operation(:retrieve, Seahorse::Model::Operation.new.tap do |o|
         o.name = "Retrieve"
         o.http_method = "POST"

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

@@ -192,6 +192,75 @@ module Aws::BedrockAgentRuntime
       attr_reader :event_emitter
 
     end
+    class OptimizedPromptStream
+
+      def initialize
+        @event_emitter = Aws::EventEmitter.new
+      end
+
+      def on_access_denied_exception_event(&block)
+        @event_emitter.on(:access_denied_exception, block) if block_given?
+      end
+
+      def on_analyze_prompt_event_event(&block)
+        @event_emitter.on(:analyze_prompt_event, block) if block_given?
+      end
+
+      def on_bad_gateway_exception_event(&block)
+        @event_emitter.on(:bad_gateway_exception, block) if block_given?
+      end
+
+      def on_dependency_failed_exception_event(&block)
+        @event_emitter.on(:dependency_failed_exception, block) if block_given?
+      end
+
+      def on_internal_server_exception_event(&block)
+        @event_emitter.on(:internal_server_exception, block) if block_given?
+      end
+
+      def on_optimized_prompt_event_event(&block)
+        @event_emitter.on(:optimized_prompt_event, block) if block_given?
+      end
+
+      def on_throttling_exception_event(&block)
+        @event_emitter.on(:throttling_exception, block) if block_given?
+      end
+
+      def on_validation_exception_event(&block)
+        @event_emitter.on(:validation_exception, block) if block_given?
+      end
+
+      def on_error_event(&block)
+        @event_emitter.on(:error, block) if block_given?
+      end
+
+      def on_initial_response_event(&block)
+        @event_emitter.on(:initial_response, block) if block_given?
+      end
+
+      def on_unknown_event(&block)
+        @event_emitter.on(:unknown_event, block) if block_given?
+      end
+
+      def on_event(&block)
+        on_access_denied_exception_event(&block)
+        on_analyze_prompt_event_event(&block)
+        on_bad_gateway_exception_event(&block)
+        on_dependency_failed_exception_event(&block)
+        on_internal_server_exception_event(&block)
+        on_optimized_prompt_event_event(&block)
+        on_throttling_exception_event(&block)
+        on_validation_exception_event(&block)
+        on_error_event(&block)
+        on_initial_response_event(&block)
+        on_unknown_event(&block)
+      end
+
+      # @api private
+      # @return Aws::EventEmitter
+      attr_reader :event_emitter
+
+    end
 
   end
 end

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

@@ -27,11 +27,12 @@ module Aws::BedrockAgentRuntime
 
     # Contains information about the action group being invoked. For more
     # information about the possible structures, see the InvocationInput tab
-    # in [OrchestrationTrace][1] in the Amazon Bedrock User Guide.
+    # in [OrchestrationTrace][1] in the [Amazon Bedrock User Guide][2].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
     #
     # @!attribute [rw] action_group_name
     #   The name of the action group.
@@ -102,6 +103,22 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # An event in which the prompt was analyzed in preparation for
+    # optimization.
+    #
+    # @!attribute [rw] message
+    #   A message describing the analysis of the prompt.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AnalyzePromptEvent AWS API Documentation
+    #
+    class AnalyzePromptEvent < Struct.new(
+      :message,
+      :event_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information about the API operation that the agent predicts
     # should be called.
     #
@@ -1769,6 +1786,27 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains information about the prompt to optimize.
+    #
+    # @note InputPrompt is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @!attribute [rw] text_prompt
+    #   Contains information about the text prompt to optimize.
+    #   @return [Types::TextPrompt]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InputPrompt AWS API Documentation
+    #
+    class InputPrompt < Struct.new(
+      :text_prompt,
+      :unknown)
+      SENSITIVE = [:text_prompt]
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class TextPrompt < InputPrompt; end
+      class Unknown < InputPrompt; end
+    end
+
     # An internal server error occurred. Retry your request.
     #
     # @!attribute [rw] message
@@ -2527,6 +2565,73 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # @!attribute [rw] input
+    #   Contains the prompt to optimize.
+    #   @return [Types::InputPrompt]
+    #
+    # @!attribute [rw] target_model_id
+    #   The unique identifier of the model that you want to optimize the
+    #   prompt for.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OptimizePromptRequest AWS API Documentation
+    #
+    class OptimizePromptRequest < Struct.new(
+      :input,
+      :target_model_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] optimized_prompt
+    #   The prompt after being optimized for the task.
+    #   @return [Types::OptimizedPromptStream]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OptimizePromptResponse AWS API Documentation
+    #
+    class OptimizePromptResponse < Struct.new(
+      :optimized_prompt)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains information about the optimized prompt.
+    #
+    # @note OptimizedPrompt is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OptimizedPrompt corresponding to the set member.
+    #
+    # @!attribute [rw] text_prompt
+    #   Contains information about the text in the prompt that was
+    #   optimized.
+    #   @return [Types::TextPrompt]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OptimizedPrompt AWS API Documentation
+    #
+    class OptimizedPrompt < Struct.new(
+      :text_prompt,
+      :unknown)
+      SENSITIVE = [:text_prompt]
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class TextPrompt < OptimizedPrompt; end
+      class Unknown < OptimizedPrompt; end
+    end
+
+    # An event in which the prompt was optimized.
+    #
+    # @!attribute [rw] optimized_prompt
+    #   Contains information about the optimized prompt.
+    #   @return [Types::OptimizedPrompt]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OptimizedPromptEvent AWS API Documentation
+    #
+    class OptimizedPromptEvent < Struct.new(
+      :optimized_prompt,
+      :event_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Settings for how the model processes the prompt prior to retrieval and
     # generation.
     #
@@ -3949,6 +4054,20 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains information about the text prompt to optimize.
+    #
+    # @!attribute [rw] text
+    #   The text in the text prompt to optimize.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/TextPrompt AWS API Documentation
+    #
+    class TextPrompt < Struct.new(
+      :text)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains the part of the generated text that contains a citation,
     # alongside where it begins and ends.
     #
@@ -4166,6 +4285,30 @@ module Aws::BedrockAgentRuntime
 
     end
 
+    # The stream containing events in the prompt optimization process.
+    #
+    # EventStream is an Enumerator of Events.
+    #  #event_types #=> Array, returns all modeled event types in the stream
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OptimizedPromptStream AWS API Documentation
+    #
+    class OptimizedPromptStream < Enumerator
+
+      def event_types
+        [
+          :access_denied_exception,
+          :analyze_prompt_event,
+          :bad_gateway_exception,
+          :dependency_failed_exception,
+          :internal_server_exception,
+          :optimized_prompt_event,
+          :throttling_exception,
+          :validation_exception
+        ]
+      end
+
+    end
+
     # The response from invoking the agent and associated citations and
     # trace information.
     #

data/lib/aws-sdk-bedrockagentruntime.rb

@@ -55,7 +55,7 @@ module Aws::BedrockAgentRuntime
   autoload :Endpoints, 'aws-sdk-bedrockagentruntime/endpoints'
   autoload :EventStreams, 'aws-sdk-bedrockagentruntime/event_streams'
 
-  GEM_VERSION = '1.31.0'
+  GEM_VERSION = '1.32.0'
 
 end
 

data/sig/client.rbs

@@ -265,6 +265,21 @@ module Aws
                        ) ?{ (*untyped) -> void } -> _InvokeFlowResponseSuccess
                      | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _InvokeFlowResponseSuccess
 
+      interface _OptimizePromptResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::OptimizePromptResponse]
+        def optimized_prompt: () -> Types::OptimizedPromptStream
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgentRuntime/Client.html#optimize_prompt-instance_method
+      def optimize_prompt: (
+                             input: {
+                               text_prompt: {
+                                 text: ::String
+                               }?
+                             },
+                             target_model_id: ::String
+                           ) ?{ (*untyped) -> void } -> _OptimizePromptResponseSuccess
+                         | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _OptimizePromptResponseSuccess
+
       interface _RetrieveResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::RetrieveResponse]
         def next_token: () -> ::String

data/sig/types.rbs

@@ -31,6 +31,12 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: [:text]
     end
 
+    class AnalyzePromptEvent
+      attr_accessor message: ::String
+      attr_accessor event_type: untyped
+      SENSITIVE: []
+    end
+
     class ApiInvocationInput
       attr_accessor action_group: ::String
       attr_accessor action_invocation_type: ("RESULT" | "USER_CONFIRMATION" | "USER_CONFIRMATION_AND_RESULT")
@@ -475,6 +481,17 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: []
     end
 
+    class InputPrompt
+      attr_accessor text_prompt: Types::TextPrompt
+      attr_accessor unknown: untyped
+      SENSITIVE: [:text_prompt]
+
+      class TextPrompt < InputPrompt
+      end
+      class Unknown < InputPrompt
+      end
+    end
+
     class InternalServerException
       attr_accessor message: ::String
       attr_accessor event_type: untyped
@@ -649,6 +666,34 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: [:reprompt_response]
     end
 
+    class OptimizePromptRequest
+      attr_accessor input: Types::InputPrompt
+      attr_accessor target_model_id: ::String
+      SENSITIVE: []
+    end
+
+    class OptimizePromptResponse
+      attr_accessor optimized_prompt: Types::OptimizedPromptStream
+      SENSITIVE: []
+    end
+
+    class OptimizedPrompt
+      attr_accessor text_prompt: Types::TextPrompt
+      attr_accessor unknown: untyped
+      SENSITIVE: [:text_prompt]
+
+      class TextPrompt < OptimizedPrompt
+      end
+      class Unknown < OptimizedPrompt
+      end
+    end
+
+    class OptimizedPromptEvent
+      attr_accessor optimized_prompt: Types::OptimizedPrompt
+      attr_accessor event_type: untyped
+      SENSITIVE: []
+    end
+
     class OrchestrationConfiguration
       attr_accessor additional_model_request_fields: ::Hash[::String, untyped]
       attr_accessor inference_config: Types::InferenceConfig
@@ -999,6 +1044,11 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: []
     end
 
+    class TextPrompt
+      attr_accessor text: ::String
+      SENSITIVE: []
+    end
+
     class TextResponsePart
       attr_accessor span: Types::Span
       attr_accessor text: ::String
@@ -1060,6 +1110,10 @@ module Aws::BedrockAgentRuntime
       def event_types: () -> [:access_denied_exception, :bad_gateway_exception, :conflict_exception, :dependency_failed_exception, :flow_completion_event, :flow_output_event, :flow_trace_event, :internal_server_exception, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
     end
 
+    class OptimizedPromptStream < Enumerator[untyped, untyped]
+      def event_types: () -> [:access_denied_exception, :analyze_prompt_event, :bad_gateway_exception, :dependency_failed_exception, :internal_server_exception, :optimized_prompt_event, :throttling_exception, :validation_exception]
+    end
+
     class ResponseStream < Enumerator[untyped, untyped]
       def event_types: () -> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :files, :internal_server_exception, :resource_not_found_exception, :return_control, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockagentruntime
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.32.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core