aws-sdk-bedrockruntime 1.72.0 → 1.73.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 301bb5aa68305df5bc9e951a0ed54fb5b93bb5fe0e4a7019125276c33ab399d5
-  data.tar.gz: 84bedbd592678e39f2ad442c83a3816108c6cc9505de0328af5951135d7fde00
+  metadata.gz: c954e566176ffe4a5115d952631cc095d293077a32c450c87ef0e3878de327b0
+  data.tar.gz: b07886b2813cbe2495823f3b9d7566beea3a259c91bf5a63b95889410ff6d53b
 SHA512:
-  metadata.gz: 26686c725ac9f5f0360f32a26504909aa8c74f48e1a0744c8d521621e952a5d4863832706ac47a067862d8f1603da277b6ee4e1a9bc52ff17368e4be956fc77e
-  data.tar.gz: 7107117ecb4207154e038099bc89f1bd64df9529ddd4e27433f1e9e64a6ffca1cf967105da2e3b2e4ff980e6e9bbf7fe8be83f8328d8966425a721f9e4b893b4
+  metadata.gz: 29e837287df6da304eec950765ce7560356073c1d3f4b524194964ebf8cd7838b808fcffa10981d7c37e460a2a95869c06a0eacc803ecd2e3998323363645faf
+  data.tar.gz: df49c34aaec9871bf6c5b09f5324cde2d29a7ff23a52d2d0c335e29b9919f660f472268302d4613196b6e46cdbe356d2111b3fe813c4bdb241a4ea0f9aac056f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.73.0 (2026-02-04)
+------------------
+
+* Feature - Added support for structured outputs to Converse and ConverseStream APIs.
+
 1.72.0 (2026-01-20)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.72.0
+1.73.0

data/lib/aws-sdk-bedrockruntime/async_client.rb

@@ -621,7 +621,7 @@ module Aws::BedrockRuntime
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-bedrockruntime'
-      context[:gem_version] = '1.72.0'
+      context[:gem_version] = '1.73.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -924,6 +924,9 @@ module Aws::BedrockRuntime
     #   Specifies the processing tier configuration used for serving the
     #   request.
     #
+    # @option params [Types::OutputConfig] :output_config
+    #   Output configuration for a model response.
+    #
     # @return [Types::ConverseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ConverseResponse#output #output} => Types::ConverseOutput
@@ -1197,6 +1200,7 @@ module Aws::BedrockRuntime
     #               json: {
     #               },
     #             },
+    #             strict: false,
     #           },
     #           system_tool: {
     #             name: "ToolName", # required
@@ -1239,6 +1243,18 @@ module Aws::BedrockRuntime
     #     service_tier: {
     #       type: "priority", # required, accepts priority, default, flex, reserved
     #     },
+    #     output_config: {
+    #       text_format: {
+    #         type: "json_schema", # required, accepts json_schema
+    #         structure: { # required
+    #           json_schema: {
+    #             schema: "String", # required
+    #             name: "String",
+    #             description: "String",
+    #           },
+    #         },
+    #       },
+    #     },
     #   })
     #
     # @example Response structure
@@ -1884,6 +1900,9 @@ module Aws::BedrockRuntime
     #   Specifies the processing tier configuration used for serving the
     #   request.
     #
+    # @option params [Types::OutputConfig] :output_config
+    #   Output configuration for a model response.
+    #
     # @return [Types::ConverseStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ConverseStreamResponse#stream #stream} => Types::ConverseStreamOutput
@@ -2329,6 +2348,7 @@ module Aws::BedrockRuntime
     #               json: {
     #               },
     #             },
+    #             strict: false,
     #           },
     #           system_tool: {
     #             name: "ToolName", # required
@@ -2372,6 +2392,18 @@ module Aws::BedrockRuntime
     #     service_tier: {
     #       type: "priority", # required, accepts priority, default, flex, reserved
     #     },
+    #     output_config: {
+    #       text_format: {
+    #         type: "json_schema", # required, accepts json_schema
+    #         structure: { # required
+    #           json_schema: {
+    #             schema: "String", # required
+    #             name: "String",
+    #             description: "String",
+    #           },
+    #         },
+    #       },
+    #     },
     #   })
     #
     # @example Response structure
@@ -3144,6 +3176,7 @@ module Aws::BedrockRuntime
     #                   json: {
     #                   },
     #                 },
+    #                 strict: false,
     #               },
     #               system_tool: {
     #                 name: "ToolName", # required
@@ -3893,7 +3926,7 @@ module Aws::BedrockRuntime
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-bedrockruntime'
-      context[:gem_version] = '1.72.0'
+      context[:gem_version] = '1.73.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -253,6 +253,7 @@ module Aws::BedrockRuntime
     InvokeModelWithResponseStreamRequest = Shapes::StructureShape.new(name: 'InvokeModelWithResponseStreamRequest')
     InvokeModelWithResponseStreamResponse = Shapes::StructureShape.new(name: 'InvokeModelWithResponseStreamResponse')
     InvokedModelId = Shapes::StringShape.new(name: 'InvokedModelId')
+    JsonSchemaDefinition = Shapes::StructureShape.new(name: 'JsonSchemaDefinition')
     KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
     ListAsyncInvokesRequest = Shapes::StructureShape.new(name: 'ListAsyncInvokesRequest')
     ListAsyncInvokesResponse = Shapes::StructureShape.new(name: 'ListAsyncInvokesResponse')
@@ -272,6 +273,10 @@ module Aws::BedrockRuntime
     NonBlankString = Shapes::StringShape.new(name: 'NonBlankString')
     NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
     NonNegativeInteger = Shapes::IntegerShape.new(name: 'NonNegativeInteger')
+    OutputConfig = Shapes::StructureShape.new(name: 'OutputConfig')
+    OutputFormat = Shapes::StructureShape.new(name: 'OutputFormat')
+    OutputFormatStructure = Shapes::UnionShape.new(name: 'OutputFormatStructure')
+    OutputFormatType = Shapes::StringShape.new(name: 'OutputFormatType')
     PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
     PartBody = Shapes::BlobShape.new(name: 'PartBody')
     PayloadPart = Shapes::StructureShape.new(name: 'PayloadPart')
@@ -582,6 +587,7 @@ module Aws::BedrockRuntime
     ConverseRequest.add_member(:request_metadata, Shapes::ShapeRef.new(shape: RequestMetadata, location_name: "requestMetadata"))
     ConverseRequest.add_member(:performance_config, Shapes::ShapeRef.new(shape: PerformanceConfiguration, location_name: "performanceConfig"))
     ConverseRequest.add_member(:service_tier, Shapes::ShapeRef.new(shape: ServiceTier, location_name: "serviceTier"))
+    ConverseRequest.add_member(:output_config, Shapes::ShapeRef.new(shape: OutputConfig, location_name: "outputConfig"))
     ConverseRequest.struct_class = Types::ConverseRequest
 
     ConverseRequestAdditionalModelResponseFieldPathsList.member = Shapes::ShapeRef.new(shape: ConverseRequestAdditionalModelResponseFieldPathsListMemberString)
@@ -631,6 +637,7 @@ module Aws::BedrockRuntime
     ConverseStreamRequest.add_member(:request_metadata, Shapes::ShapeRef.new(shape: RequestMetadata, location_name: "requestMetadata"))
     ConverseStreamRequest.add_member(:performance_config, Shapes::ShapeRef.new(shape: PerformanceConfiguration, location_name: "performanceConfig"))
     ConverseStreamRequest.add_member(:service_tier, Shapes::ShapeRef.new(shape: ServiceTier, location_name: "serviceTier"))
+    ConverseStreamRequest.add_member(:output_config, Shapes::ShapeRef.new(shape: OutputConfig, location_name: "outputConfig"))
     ConverseStreamRequest.struct_class = Types::ConverseStreamRequest
 
     ConverseStreamRequestAdditionalModelResponseFieldPathsList.member = Shapes::ShapeRef.new(shape: ConverseStreamRequestAdditionalModelResponseFieldPathsListMemberString)
@@ -1116,6 +1123,11 @@ module Aws::BedrockRuntime
     InvokeModelWithResponseStreamResponse[:payload] = :body
     InvokeModelWithResponseStreamResponse[:payload_member] = InvokeModelWithResponseStreamResponse.member(:body)
 
+    JsonSchemaDefinition.add_member(:schema, Shapes::ShapeRef.new(shape: String, required: true, location_name: "schema"))
+    JsonSchemaDefinition.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
+    JsonSchemaDefinition.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description"))
+    JsonSchemaDefinition.struct_class = Types::JsonSchemaDefinition
+
     ListAsyncInvokesRequest.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location: "querystring", location_name: "submitTimeAfter"))
     ListAsyncInvokesRequest.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location: "querystring", location_name: "submitTimeBefore"))
     ListAsyncInvokesRequest.add_member(:status_equals, Shapes::ShapeRef.new(shape: AsyncInvokeStatus, location: "querystring", location_name: "statusEquals"))
@@ -1160,6 +1172,19 @@ module Aws::BedrockRuntime
     ModelTimeoutException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
     ModelTimeoutException.struct_class = Types::ModelTimeoutException
 
+    OutputConfig.add_member(:text_format, Shapes::ShapeRef.new(shape: OutputFormat, location_name: "textFormat"))
+    OutputConfig.struct_class = Types::OutputConfig
+
+    OutputFormat.add_member(:type, Shapes::ShapeRef.new(shape: OutputFormatType, required: true, location_name: "type"))
+    OutputFormat.add_member(:structure, Shapes::ShapeRef.new(shape: OutputFormatStructure, required: true, location_name: "structure"))
+    OutputFormat.struct_class = Types::OutputFormat
+
+    OutputFormatStructure.add_member(:json_schema, Shapes::ShapeRef.new(shape: JsonSchemaDefinition, location_name: "jsonSchema"))
+    OutputFormatStructure.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    OutputFormatStructure.add_member_subclass(:json_schema, Types::OutputFormatStructure::JsonSchema)
+    OutputFormatStructure.add_member_subclass(:unknown, Types::OutputFormatStructure::Unknown)
+    OutputFormatStructure.struct_class = Types::OutputFormatStructure
+
     PayloadPart.add_member(:bytes, Shapes::ShapeRef.new(shape: PartBody, location_name: "bytes"))
     PayloadPart.struct_class = Types::PayloadPart
 
@@ -1363,6 +1388,7 @@ module Aws::BedrockRuntime
     ToolSpecification.add_member(:name, Shapes::ShapeRef.new(shape: ToolName, required: true, location_name: "name"))
     ToolSpecification.add_member(:description, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "description"))
     ToolSpecification.add_member(:input_schema, Shapes::ShapeRef.new(shape: ToolInputSchema, required: true, location_name: "inputSchema"))
+    ToolSpecification.add_member(:strict, Shapes::ShapeRef.new(shape: Boolean, location_name: "strict"))
     ToolSpecification.struct_class = Types::ToolSpecification
 
     ToolUseBlock.add_member(:tool_use_id, Shapes::ShapeRef.new(shape: ToolUseId, required: true, location_name: "toolUseId"))

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

@@ -1086,6 +1086,10 @@ module Aws::BedrockRuntime
     #   request.
     #   @return [Types::ServiceTier]
     #
+    # @!attribute [rw] output_config
+    #   Output configuration for a model response.
+    #   @return [Types::OutputConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseRequest AWS API Documentation
     #
     class ConverseRequest < Struct.new(
@@ -1100,7 +1104,8 @@ module Aws::BedrockRuntime
       :additional_model_response_field_paths,
       :request_metadata,
       :performance_config,
-      :service_tier)
+      :service_tier,
+      :output_config)
       SENSITIVE = [:prompt_variables, :request_metadata]
       include Aws::Structure
     end
@@ -1341,6 +1346,10 @@ module Aws::BedrockRuntime
     #   request.
     #   @return [Types::ServiceTier]
     #
+    # @!attribute [rw] output_config
+    #   Output configuration for a model response.
+    #   @return [Types::OutputConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseStreamRequest AWS API Documentation
     #
     class ConverseStreamRequest < Struct.new(
@@ -1355,7 +1364,8 @@ module Aws::BedrockRuntime
       :additional_model_response_field_paths,
       :request_metadata,
       :performance_config,
-      :service_tier)
+      :service_tier,
+      :output_config)
       SENSITIVE = [:prompt_variables, :request_metadata]
       include Aws::Structure
     end
@@ -3586,6 +3596,35 @@ module Aws::BedrockRuntime
       include Aws::Structure
     end
 
+    # JSON schema structured output format options.
+    #
+    # @!attribute [rw] schema
+    #   The JSON schema to constrain the model's output. For more
+    #   information, see [JSON Schema Reference][1].
+    #
+    #
+    #
+    #   [1]: https://json-schema.org/understanding-json-schema/reference
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the JSON schema.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   A description of the JSON schema.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/JsonSchemaDefinition AWS API Documentation
+    #
+    class JsonSchemaDefinition < Struct.new(
+      :schema,
+      :name,
+      :description)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] submit_time_after
     #   Include invocations submitted after this time.
     #   @return [Time]
@@ -3801,6 +3840,66 @@ module Aws::BedrockRuntime
       include Aws::Structure
     end
 
+    # Output configuration for a model response in a call to [Converse][1]
+    # or [ConverseStream][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html
+    #
+    # @!attribute [rw] text_format
+    #   Structured output parameters to control the model's text response.
+    #   @return [Types::OutputFormat]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/OutputConfig AWS API Documentation
+    #
+    class OutputConfig < Struct.new(
+      :text_format)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Structured output parameters to control the model's response.
+    #
+    # @!attribute [rw] type
+    #   The type of structured output format.
+    #   @return [String]
+    #
+    # @!attribute [rw] structure
+    #   The structure that the model's output must adhere to.
+    #   @return [Types::OutputFormatStructure]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/OutputFormat AWS API Documentation
+    #
+    class OutputFormat < Struct.new(
+      :type,
+      :structure)
+      SENSITIVE = [:structure]
+      include Aws::Structure
+    end
+
+    # The structure that the model's output must adhere to.
+    #
+    # @note OutputFormatStructure is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @!attribute [rw] json_schema
+    #   A JSON schema structure that the model's output must adhere to.
+    #   @return [Types::JsonSchemaDefinition]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/OutputFormatStructure AWS API Documentation
+    #
+    class OutputFormatStructure < Struct.new(
+      :json_schema,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class JsonSchema < OutputFormatStructure; end
+      class Unknown < OutputFormatStructure; end
+    end
+
     # Payload content included in the response.
     #
     # @!attribute [rw] bytes
@@ -4672,12 +4771,18 @@ module Aws::BedrockRuntime
     #   The input schema for the tool in JSON format.
     #   @return [Types::ToolInputSchema]
     #
+    # @!attribute [rw] strict
+    #   Flag to enable structured output enforcement on a tool usage
+    #   response.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolSpecification AWS API Documentation
     #
     class ToolSpecification < Struct.new(
       :name,
       :description,
-      :input_schema)
+      :input_schema,
+      :strict)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-bedrockruntime.rb

@@ -73,7 +73,7 @@ module Aws::BedrockRuntime
   autoload :AsyncClient, 'aws-sdk-bedrockruntime/async_client'
   autoload :EventStreams, 'aws-sdk-bedrockruntime/event_streams'
 
-  GEM_VERSION = '1.72.0'
+  GEM_VERSION = '1.73.0'
 
 end
 

data/sig/client.rbs

@@ -384,7 +384,8 @@ module Aws
                               input_schema: {
                                 json: {
                                 }?
-                              }
+                              },
+                              strict: bool?
                             }?,
                             system_tool: {
                               name: ::String
@@ -422,6 +423,18 @@ module Aws
                       },
                       ?service_tier: {
                         type: ("priority" | "default" | "flex" | "reserved")
+                      },
+                      ?output_config: {
+                        text_format: {
+                          type: ("json_schema"),
+                          structure: {
+                            json_schema: {
+                              schema: ::String,
+                              name: ::String?,
+                              description: ::String?
+                            }?
+                          }
+                        }?
                       }
                     ) -> _ConverseResponseSuccess
                   | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConverseResponseSuccess
@@ -690,7 +703,8 @@ module Aws
                                      input_schema: {
                                        json: {
                                        }?
-                                     }
+                                     },
+                                     strict: bool?
                                    }?,
                                    system_tool: {
                                      name: ::String
@@ -729,6 +743,18 @@ module Aws
                              },
                              ?service_tier: {
                                type: ("priority" | "default" | "flex" | "reserved")
+                             },
+                             ?output_config: {
+                               text_format: {
+                                 type: ("json_schema"),
+                                 structure: {
+                                   json_schema: {
+                                     schema: ::String,
+                                     name: ::String?,
+                                     description: ::String?
+                                   }?
+                                 }
+                               }?
                              }
                            ) ?{ (*untyped) -> void } -> _ConverseStreamResponseSuccess
                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _ConverseStreamResponseSuccess
@@ -996,7 +1022,8 @@ module Aws
                                       input_schema: {
                                         json: {
                                         }?
-                                      }
+                                      },
+                                      strict: bool?
                                     }?,
                                     system_tool: {
                                       name: ::String

data/sig/types.rbs

@@ -341,6 +341,7 @@ module Aws::BedrockRuntime
       attr_accessor request_metadata: ::Hash[::String, ::String]
       attr_accessor performance_config: Types::PerformanceConfiguration
       attr_accessor service_tier: Types::ServiceTier
+      attr_accessor output_config: Types::OutputConfig
       SENSITIVE: [:prompt_variables, :request_metadata]
     end
 
@@ -384,6 +385,7 @@ module Aws::BedrockRuntime
       attr_accessor request_metadata: ::Hash[::String, ::String]
       attr_accessor performance_config: Types::PerformanceConfiguration
       attr_accessor service_tier: Types::ServiceTier
+      attr_accessor output_config: Types::OutputConfig
       SENSITIVE: [:prompt_variables, :request_metadata]
     end
 
@@ -981,6 +983,13 @@ module Aws::BedrockRuntime
       SENSITIVE: []
     end
 
+    class JsonSchemaDefinition
+      attr_accessor schema: ::String
+      attr_accessor name: ::String
+      attr_accessor description: ::String
+      SENSITIVE: []
+    end
+
     class ListAsyncInvokesRequest
       attr_accessor submit_time_after: ::Time
       attr_accessor submit_time_before: ::Time
@@ -1043,6 +1052,28 @@ module Aws::BedrockRuntime
       SENSITIVE: []
     end
 
+    class OutputConfig
+      attr_accessor text_format: Types::OutputFormat
+      SENSITIVE: []
+    end
+
+    class OutputFormat
+      attr_accessor type: ("json_schema")
+      attr_accessor structure: Types::OutputFormatStructure
+      SENSITIVE: [:structure]
+    end
+
+    class OutputFormatStructure
+      attr_accessor json_schema: Types::JsonSchemaDefinition
+      attr_accessor unknown: untyped
+      SENSITIVE: []
+
+      class JsonSchema < OutputFormatStructure
+      end
+      class Unknown < OutputFormatStructure
+      end
+    end
+
     class PayloadPart
       attr_accessor bytes: ::String
       attr_accessor event_type: untyped
@@ -1327,6 +1358,7 @@ module Aws::BedrockRuntime
       attr_accessor name: ::String
       attr_accessor description: ::String
       attr_accessor input_schema: Types::ToolInputSchema
+      attr_accessor strict: bool
       SENSITIVE: []
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockruntime
 version: !ruby/object:Gem::Version
-  version: 1.72.0
+  version: 1.73.0
 platform: ruby
 authors:
 - Amazon Web Services