aws-sdk-bedrockruntime 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcfc4e7f6c78a73858c124ab8a49a9da445cdeadeaacdc30890d114afdf0de17
-  data.tar.gz: 0ed57e3a23ea6695dcfcefc2b9009c3f02e97130585b67629eae8b0847b1902c
+  metadata.gz: f743e35a23c1b5da7f2f760eef26a9db4f6b4eb24e9487f0196138617e57c837
+  data.tar.gz: 1c5b8ca501e869cc08952699f11747f48e20f2f1164c3f106514d708773c59ef
 SHA512:
-  metadata.gz: e7002669b089efcc7abf2e81047f1afa2c5ef506bc13286660a3114042fe56d3a9aa9c033295416d23161254e7a22c52e58365c7cb7fc4861b871e51b15d6979
-  data.tar.gz: b66b1426d1cb3e1887d9bba00efe11fabc3c7e23dc285686d1455e8b60c3530783385ce899cf40eb8c10498c1742192f993b9c6b1ef83f6e65af44a35c5c22fb
+  metadata.gz: d78201650cc1ce6ac6c105b019fb07c966732c56329f34513e128af99fd12e27b4f0a29f0fb5c4e2d1ddc35314288f1376d4645de865d440bfaf2541bbb525ed
+  data.tar.gz: 4d330688343a70c240dd6729cf2ac635676e42fb85c0ad63dee52934d4ca3833fea6eedb090c7d60a992b470b1b14ea6c3f03f1973813bb6ec8131aed6e9d652

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.31.0 (2024-11-07)
+------------------
+
+* Feature - Add Prompt management support to Bedrock runtime APIs: Converse, ConverseStream, InvokeModel, InvokeModelWithStreamingResponse
+
 1.30.0 (2024-11-06)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.30.0
+1.31.0

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

@@ -568,6 +568,21 @@ module Aws::BedrockRuntime
     # Amazon Bedrock doesn't store any text, images, or documents that you
     # provide as content. The data is only used to generate the response.
     #
+    # You can submit a prompt by including it in the `messages` field,
+    # specifying the `modelId` of a foundation model or inference profile to
+    # run inference on it, and including any other fields that are relevant
+    # to your use case.
+    #
+    # You can also submit a prompt from Prompt management by specifying the
+    # ARN of the prompt version and including a map of variables to values
+    # in the `promptVariables` field. You can append more messages to the
+    # prompt by using the `messages` field. If you use a prompt from Prompt
+    # management, you can't include the following fields in the request:
+    # `additionalModelRequestFields`, `inferenceConfig`, `system`, or
+    # `toolConfig`. Instead, these fields must be defined through Prompt
+    # management. For more information, see [Use a prompt from Prompt
+    # management][1].
+    #
     # For information about the Converse API, see *Use the Converse API* in
     # the *Amazon Bedrock User Guide*. To use a guardrail, see *Use a
     # guardrail with the Converse API* in the *Amazon Bedrock User Guide*.
@@ -580,10 +595,13 @@ module Aws::BedrockRuntime
     # This operation requires permission for the `bedrock:InvokeModel`
     # action.
     #
-    # @option params [required, String] :model_id
-    #   The identifier for the model that you want to call.
     #
-    #   The `modelId` to provide depends on the type of model or throughput
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html
+    #
+    # @option params [required, String] :model_id
+    #   Specifies the model or throughput with which to run inference, or the
+    #   prompt resource to use in inference. The value depends on the resource
     #   that you use:
     #
     #   * If you use a base model, specify the model ID or its ARN. For a list
@@ -604,6 +622,9 @@ module Aws::BedrockRuntime
     #     more information, see [Use a custom model in Amazon Bedrock][4] in
     #     the Amazon Bedrock User Guide.
     #
+    #   * To include a prompt that was defined in Prompt management, specify
+    #     the ARN of the prompt version to use.
+    #
     #   The Converse API doesn't support [imported models][5].
     #
     #
@@ -614,17 +635,19 @@ module Aws::BedrockRuntime
     #   [4]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html
     #   [5]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html
     #
-    # @option params [required, Array<Types::Message>] :messages
+    # @option params [Array<Types::Message>] :messages
     #   The messages that you want to send to the model.
     #
     # @option params [Array<Types::SystemContentBlock>] :system
-    #   A system prompt to pass to the model.
+    #   A prompt that provides instructions or context to the model about the
+    #   task it should perform, or the persona it should adopt during the
+    #   conversation.
     #
     # @option params [Types::InferenceConfiguration] :inference_config
-    #   Inference parameters to pass to the model. `Converse` supports a base
-    #   set of inference parameters. If you need to pass additional parameters
-    #   that the model supports, use the `additionalModelRequestFields`
-    #   request field.
+    #   Inference parameters to pass to the model. `Converse` and
+    #   `ConverseStream` support a base set of inference parameters. If you
+    #   need to pass additional parameters that the model supports, use the
+    #   `additionalModelRequestFields` request field.
     #
     # @option params [Types::ToolConfiguration] :tool_config
     #   Configuration information for the tools that the model can use when
@@ -637,13 +660,17 @@ module Aws::BedrockRuntime
     #
     # @option params [Types::GuardrailConfiguration] :guardrail_config
     #   Configuration information for a guardrail that you want to use in the
-    #   request.
+    #   request. If you include `guardContent` blocks in the `content` field
+    #   in the `messages` field, the guardrail operates only on those
+    #   messages. If you include no `guardContent` blocks, the guardrail
+    #   operates on all messages in the request body and in any included
+    #   prompt resource.
     #
     # @option params [Hash,Array,String,Numeric,Boolean] :additional_model_request_fields
     #   Additional inference parameters that the model supports, beyond the
-    #   base set of inference parameters that `Converse` supports in the
-    #   `inferenceConfig` field. For more information, see [Model
-    #   parameters][1].
+    #   base set of inference parameters that `Converse` and `ConverseStream`
+    #   support in the `inferenceConfig` field. For more information, see
+    #   [Model parameters][1].
     #
     #   Document type used to carry open content
     #   (Hash,Array,String,Numeric,Boolean). A document type value is
@@ -654,21 +681,27 @@ module Aws::BedrockRuntime
     #
     #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
     #
+    # @option params [Hash<String,Types::PromptVariableValues>] :prompt_variables
+    #   Contains a map of variables in a prompt from Prompt management to
+    #   objects containing the values to fill in for them when running model
+    #   invocation. This field is ignored if you don't specify a prompt
+    #   resource in the `modelId` field.
+    #
     # @option params [Array<String>] :additional_model_response_field_paths
     #   Additional model parameters field paths to return in the response.
-    #   `Converse` returns the requested fields as a JSON Pointer object in
-    #   the `additionalModelResponseFields` field. The following is example
-    #   JSON for `additionalModelResponseFieldPaths`.
+    #   `Converse` and `ConverseStream` return the requested fields as a JSON
+    #   Pointer object in the `additionalModelResponseFields` field. The
+    #   following is example JSON for `additionalModelResponseFieldPaths`.
     #
     #   `[ "/stop_sequence" ]`
     #
     #   For information about the JSON Pointer syntax, see the [Internet
     #   Engineering Task Force (IETF)][1] documentation.
     #
-    #   `Converse` rejects an empty JSON Pointer or incorrectly structured
-    #   JSON Pointer with a `400` error code. if the JSON Pointer is valid,
-    #   but the requested field is not in the model response, it is ignored by
-    #   `Converse`.
+    #   `Converse` and `ConverseStream` reject an empty JSON Pointer or
+    #   incorrectly structured JSON Pointer with a `400` error code. if the
+    #   JSON Pointer is valid, but the requested field is not in the model
+    #   response, it is ignored by `Converse`.
     #
     #
     #
@@ -687,7 +720,7 @@ module Aws::BedrockRuntime
     #
     #   resp = client.converse({
     #     model_id: "ConversationalModelId", # required
-    #     messages: [ # required
+    #     messages: [
     #       {
     #         role: "user", # required, accepts user, assistant
     #         content: [ # required
@@ -793,6 +826,11 @@ module Aws::BedrockRuntime
     #     },
     #     additional_model_request_fields: {
     #     },
+    #     prompt_variables: {
+    #       "String" => {
+    #         text: "String",
+    #       },
+    #     },
     #     additional_model_response_field_paths: ["ConverseRequestAdditionalModelResponseFieldPathsListMemberString"],
     #   })
     #
@@ -937,6 +975,21 @@ module Aws::BedrockRuntime
     # Amazon Bedrock doesn't store any text, images, or documents that you
     # provide as content. The data is only used to generate the response.
     #
+    # You can submit a prompt by including it in the `messages` field,
+    # specifying the `modelId` of a foundation model or inference profile to
+    # run inference on it, and including any other fields that are relevant
+    # to your use case.
+    #
+    # You can also submit a prompt from Prompt management by specifying the
+    # ARN of the prompt version and including a map of variables to values
+    # in the `promptVariables` field. You can append more messages to the
+    # prompt by using the `messages` field. If you use a prompt from Prompt
+    # management, you can't include the following fields in the request:
+    # `additionalModelRequestFields`, `inferenceConfig`, `system`, or
+    # `toolConfig`. Instead, these fields must be defined through Prompt
+    # management. For more information, see [Use a prompt from Prompt
+    # management][2].
+    #
     # For information about the Converse API, see *Use the Converse API* in
     # the *Amazon Bedrock User Guide*. To use a guardrail, see *Use a
     # guardrail with the Converse API* in the *Amazon Bedrock User Guide*.
@@ -952,11 +1005,11 @@ module Aws::BedrockRuntime
     #
     #
     # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html
     #
     # @option params [required, String] :model_id
-    #   The ID for the model.
-    #
-    #   The `modelId` to provide depends on the type of model or throughput
+    #   Specifies the model or throughput with which to run inference, or the
+    #   prompt resource to use in inference. The value depends on the resource
     #   that you use:
     #
     #   * If you use a base model, specify the model ID or its ARN. For a list
@@ -977,6 +1030,9 @@ module Aws::BedrockRuntime
     #     more information, see [Use a custom model in Amazon Bedrock][4] in
     #     the Amazon Bedrock User Guide.
     #
+    #   * To include a prompt that was defined in Prompt management, specify
+    #     the ARN of the prompt version to use.
+    #
     #   The Converse API doesn't support [imported models][5].
     #
     #
@@ -987,16 +1043,18 @@ module Aws::BedrockRuntime
     #   [4]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html
     #   [5]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html
     #
-    # @option params [required, Array<Types::Message>] :messages
+    # @option params [Array<Types::Message>] :messages
     #   The messages that you want to send to the model.
     #
     # @option params [Array<Types::SystemContentBlock>] :system
-    #   A system prompt to send to the model.
+    #   A prompt that provides instructions or context to the model about the
+    #   task it should perform, or the persona it should adopt during the
+    #   conversation.
     #
     # @option params [Types::InferenceConfiguration] :inference_config
-    #   Inference parameters to pass to the model. `ConverseStream` supports a
-    #   base set of inference parameters. If you need to pass additional
-    #   parameters that the model supports, use the
+    #   Inference parameters to pass to the model. `Converse` and
+    #   `ConverseStream` support a base set of inference parameters. If you
+    #   need to pass additional parameters that the model supports, use the
     #   `additionalModelRequestFields` request field.
     #
     # @option params [Types::ToolConfiguration] :tool_config
@@ -1009,33 +1067,48 @@ module Aws::BedrockRuntime
     #
     # @option params [Types::GuardrailStreamConfiguration] :guardrail_config
     #   Configuration information for a guardrail that you want to use in the
-    #   request.
+    #   request. If you include `guardContent` blocks in the `content` field
+    #   in the `messages` field, the guardrail operates only on those
+    #   messages. If you include no `guardContent` blocks, the guardrail
+    #   operates on all messages in the request body and in any included
+    #   prompt resource.
     #
     # @option params [Hash,Array,String,Numeric,Boolean] :additional_model_request_fields
     #   Additional inference parameters that the model supports, beyond the
-    #   base set of inference parameters that `ConverseStream` supports in the
-    #   `inferenceConfig` field.
+    #   base set of inference parameters that `Converse` and `ConverseStream`
+    #   support in the `inferenceConfig` field. For more information, see
+    #   [Model parameters][1].
     #
     #   Document type used to carry open content
     #   (Hash,Array,String,Numeric,Boolean). A document type value is
     #   serialized using the same format as its surroundings and requires no
     #   additional encoding or escaping.
     #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
+    #
+    # @option params [Hash<String,Types::PromptVariableValues>] :prompt_variables
+    #   Contains a map of variables in a prompt from Prompt management to
+    #   objects containing the values to fill in for them when running model
+    #   invocation. This field is ignored if you don't specify a prompt
+    #   resource in the `modelId` field.
+    #
     # @option params [Array<String>] :additional_model_response_field_paths
     #   Additional model parameters field paths to return in the response.
-    #   `ConverseStream` returns the requested fields as a JSON Pointer object
-    #   in the `additionalModelResponseFields` field. The following is example
-    #   JSON for `additionalModelResponseFieldPaths`.
+    #   `Converse` and `ConverseStream` return the requested fields as a JSON
+    #   Pointer object in the `additionalModelResponseFields` field. The
+    #   following is example JSON for `additionalModelResponseFieldPaths`.
     #
     #   `[ "/stop_sequence" ]`
     #
     #   For information about the JSON Pointer syntax, see the [Internet
     #   Engineering Task Force (IETF)][1] documentation.
     #
-    #   `ConverseStream` rejects an empty JSON Pointer or incorrectly
-    #   structured JSON Pointer with a `400` error code. if the JSON Pointer
-    #   is valid, but the requested field is not in the model response, it is
-    #   ignored by `ConverseStream`.
+    #   `Converse` and `ConverseStream` reject an empty JSON Pointer or
+    #   incorrectly structured JSON Pointer with a `400` error code. if the
+    #   JSON Pointer is valid, but the requested field is not in the model
+    #   response, it is ignored by `Converse`.
     #
     #
     #
@@ -1222,7 +1295,7 @@ module Aws::BedrockRuntime
     #
     #   resp = client.converse_stream({
     #     model_id: "ConversationalModelId", # required
-    #     messages: [ # required
+    #     messages: [
     #       {
     #         role: "user", # required, accepts user, assistant
     #         content: [ # required
@@ -1329,6 +1402,11 @@ module Aws::BedrockRuntime
     #     },
     #     additional_model_request_fields: {
     #     },
+    #     prompt_variables: {
+    #       "String" => {
+    #         text: "String",
+    #       },
+    #     },
     #     additional_model_response_field_paths: ["ConverseStreamRequestAdditionalModelResponseFieldPathsListMemberString"],
     #   })
     #
@@ -1500,7 +1578,7 @@ module Aws::BedrockRuntime
     # This operation requires permission for the `bedrock:InvokeModel`
     # action.
     #
-    # @option params [required, String, StringIO, File] :body
+    # @option params [String, StringIO, File] :body
     #   The prompt and inference parameters in the format specified in the
     #   `contentType` in the header. You must provide the body in JSON format.
     #   To see the format and content of the request and response bodies for
@@ -1581,7 +1659,7 @@ module Aws::BedrockRuntime
     # @example Request syntax with placeholder values
     #
     #   resp = client.invoke_model({
-    #     body: "data", # required
+    #     body: "data",
     #     content_type: "MimeType",
     #     accept: "MimeType",
     #     model_id: "InvokeModelIdentifier", # required
@@ -1626,7 +1704,7 @@ module Aws::BedrockRuntime
     #
     # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html
     #
-    # @option params [required, String, StringIO, File] :body
+    # @option params [String, StringIO, File] :body
     #   The prompt and inference parameters in the format specified in the
     #   `contentType` in the header. You must provide the body in JSON format.
     #   To see the format and content of the request and response bodies for
@@ -1844,7 +1922,7 @@ module Aws::BedrockRuntime
     # @example Request syntax with placeholder values
     #
     #   resp = client.invoke_model_with_response_stream({
-    #     body: "data", # required
+    #     body: "data",
     #     content_type: "MimeType",
     #     accept: "MimeType",
     #     model_id: "InvokeModelIdentifier", # required
@@ -1929,7 +2007,7 @@ module Aws::BedrockRuntime
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-bedrockruntime'
-      context[:gem_version] = '1.30.0'
+      context[:gem_version] = '1.31.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -150,6 +150,8 @@ module Aws::BedrockRuntime
     NonNegativeInteger = Shapes::IntegerShape.new(name: 'NonNegativeInteger')
     PartBody = Shapes::BlobShape.new(name: 'PartBody')
     PayloadPart = Shapes::StructureShape.new(name: 'PayloadPart')
+    PromptVariableMap = Shapes::MapShape.new(name: 'PromptVariableMap')
+    PromptVariableValues = Shapes::UnionShape.new(name: 'PromptVariableValues')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     ResponseStream = Shapes::StructureShape.new(name: 'ResponseStream')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
@@ -258,12 +260,13 @@ module Aws::BedrockRuntime
     ConverseOutput.struct_class = Types::ConverseOutput
 
     ConverseRequest.add_member(:model_id, Shapes::ShapeRef.new(shape: ConversationalModelId, required: true, location: "uri", location_name: "modelId"))
-    ConverseRequest.add_member(:messages, Shapes::ShapeRef.new(shape: Messages, required: true, location_name: "messages"))
+    ConverseRequest.add_member(:messages, Shapes::ShapeRef.new(shape: Messages, location_name: "messages"))
     ConverseRequest.add_member(:system, Shapes::ShapeRef.new(shape: SystemContentBlocks, location_name: "system"))
     ConverseRequest.add_member(:inference_config, Shapes::ShapeRef.new(shape: InferenceConfiguration, location_name: "inferenceConfig"))
     ConverseRequest.add_member(:tool_config, Shapes::ShapeRef.new(shape: ToolConfiguration, location_name: "toolConfig"))
     ConverseRequest.add_member(:guardrail_config, Shapes::ShapeRef.new(shape: GuardrailConfiguration, location_name: "guardrailConfig"))
     ConverseRequest.add_member(:additional_model_request_fields, Shapes::ShapeRef.new(shape: Document, location_name: "additionalModelRequestFields"))
+    ConverseRequest.add_member(:prompt_variables, Shapes::ShapeRef.new(shape: PromptVariableMap, location_name: "promptVariables"))
     ConverseRequest.add_member(:additional_model_response_field_paths, Shapes::ShapeRef.new(shape: ConverseRequestAdditionalModelResponseFieldPathsList, location_name: "additionalModelResponseFieldPaths"))
     ConverseRequest.struct_class = Types::ConverseRequest
 
@@ -299,12 +302,13 @@ module Aws::BedrockRuntime
     ConverseStreamOutput.struct_class = Types::ConverseStreamOutput
 
     ConverseStreamRequest.add_member(:model_id, Shapes::ShapeRef.new(shape: ConversationalModelId, required: true, location: "uri", location_name: "modelId"))
-    ConverseStreamRequest.add_member(:messages, Shapes::ShapeRef.new(shape: Messages, required: true, location_name: "messages"))
+    ConverseStreamRequest.add_member(:messages, Shapes::ShapeRef.new(shape: Messages, location_name: "messages"))
     ConverseStreamRequest.add_member(:system, Shapes::ShapeRef.new(shape: SystemContentBlocks, location_name: "system"))
     ConverseStreamRequest.add_member(:inference_config, Shapes::ShapeRef.new(shape: InferenceConfiguration, location_name: "inferenceConfig"))
     ConverseStreamRequest.add_member(:tool_config, Shapes::ShapeRef.new(shape: ToolConfiguration, location_name: "toolConfig"))
     ConverseStreamRequest.add_member(:guardrail_config, Shapes::ShapeRef.new(shape: GuardrailStreamConfiguration, location_name: "guardrailConfig"))
     ConverseStreamRequest.add_member(:additional_model_request_fields, Shapes::ShapeRef.new(shape: Document, location_name: "additionalModelRequestFields"))
+    ConverseStreamRequest.add_member(:prompt_variables, Shapes::ShapeRef.new(shape: PromptVariableMap, location_name: "promptVariables"))
     ConverseStreamRequest.add_member(:additional_model_response_field_paths, Shapes::ShapeRef.new(shape: ConverseStreamRequestAdditionalModelResponseFieldPathsList, location_name: "additionalModelResponseFieldPaths"))
     ConverseStreamRequest.struct_class = Types::ConverseStreamRequest
 
@@ -504,7 +508,7 @@ module Aws::BedrockRuntime
     InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
     InternalServerException.struct_class = Types::InternalServerException
 
-    InvokeModelRequest.add_member(:body, Shapes::ShapeRef.new(shape: Body, required: true, location_name: "body"))
+    InvokeModelRequest.add_member(:body, Shapes::ShapeRef.new(shape: Body, location_name: "body"))
     InvokeModelRequest.add_member(:content_type, Shapes::ShapeRef.new(shape: MimeType, location: "header", location_name: "Content-Type"))
     InvokeModelRequest.add_member(:accept, Shapes::ShapeRef.new(shape: MimeType, location: "header", location_name: "Accept"))
     InvokeModelRequest.add_member(:model_id, Shapes::ShapeRef.new(shape: InvokeModelIdentifier, required: true, location: "uri", location_name: "modelId"))
@@ -521,7 +525,7 @@ module Aws::BedrockRuntime
     InvokeModelResponse[:payload] = :body
     InvokeModelResponse[:payload_member] = InvokeModelResponse.member(:body)
 
-    InvokeModelWithResponseStreamRequest.add_member(:body, Shapes::ShapeRef.new(shape: Body, required: true, location_name: "body"))
+    InvokeModelWithResponseStreamRequest.add_member(:body, Shapes::ShapeRef.new(shape: Body, location_name: "body"))
     InvokeModelWithResponseStreamRequest.add_member(:content_type, Shapes::ShapeRef.new(shape: MimeType, location: "header", location_name: "Content-Type"))
     InvokeModelWithResponseStreamRequest.add_member(:accept, Shapes::ShapeRef.new(shape: MimeType, location: "header", location_name: "X-Amzn-Bedrock-Accept"))
     InvokeModelWithResponseStreamRequest.add_member(:model_id, Shapes::ShapeRef.new(shape: InvokeModelIdentifier, required: true, location: "uri", location_name: "modelId"))
@@ -572,6 +576,15 @@ module Aws::BedrockRuntime
     PayloadPart.add_member(:bytes, Shapes::ShapeRef.new(shape: PartBody, location_name: "bytes"))
     PayloadPart.struct_class = Types::PayloadPart
 
+    PromptVariableMap.key = Shapes::ShapeRef.new(shape: String)
+    PromptVariableMap.value = Shapes::ShapeRef.new(shape: PromptVariableValues)
+
+    PromptVariableValues.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "text"))
+    PromptVariableValues.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    PromptVariableValues.add_member_subclass(:text, Types::PromptVariableValues::Text)
+    PromptVariableValues.add_member_subclass(:unknown, Types::PromptVariableValues::Unknown)
+    PromptVariableValues.struct_class = Types::PromptVariableValues
+
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 

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

@@ -315,10 +315,9 @@ module Aws::BedrockRuntime
     end
 
     # @!attribute [rw] model_id
-    #   The identifier for the model that you want to call.
-    #
-    #   The `modelId` to provide depends on the type of model or throughput
-    #   that you use:
+    #   Specifies the model or throughput with which to run inference, or
+    #   the prompt resource to use in inference. The value depends on the
+    #   resource that you use:
     #
     #   * If you use a base model, specify the model ID or its ARN. For a
     #     list of model IDs for base models, see [Amazon Bedrock base model
@@ -338,6 +337,9 @@ module Aws::BedrockRuntime
     #     For more information, see [Use a custom model in Amazon
     #     Bedrock][4] in the Amazon Bedrock User Guide.
     #
+    #   * To include a prompt that was defined in Prompt management, specify
+    #     the ARN of the prompt version to use.
+    #
     #   The Converse API doesn't support [imported models][5].
     #
     #
@@ -354,13 +356,15 @@ module Aws::BedrockRuntime
     #   @return [Array<Types::Message>]
     #
     # @!attribute [rw] system
-    #   A system prompt to pass to the model.
+    #   A prompt that provides instructions or context to the model about
+    #   the task it should perform, or the persona it should adopt during
+    #   the conversation.
     #   @return [Array<Types::SystemContentBlock>]
     #
     # @!attribute [rw] inference_config
-    #   Inference parameters to pass to the model. `Converse` supports a
-    #   base set of inference parameters. If you need to pass additional
-    #   parameters that the model supports, use the
+    #   Inference parameters to pass to the model. `Converse` and
+    #   `ConverseStream` support a base set of inference parameters. If you
+    #   need to pass additional parameters that the model supports, use the
     #   `additionalModelRequestFields` request field.
     #   @return [Types::InferenceConfiguration]
     #
@@ -376,35 +380,47 @@ module Aws::BedrockRuntime
     #
     # @!attribute [rw] guardrail_config
     #   Configuration information for a guardrail that you want to use in
-    #   the request.
+    #   the request. If you include `guardContent` blocks in the `content`
+    #   field in the `messages` field, the guardrail operates only on those
+    #   messages. If you include no `guardContent` blocks, the guardrail
+    #   operates on all messages in the request body and in any included
+    #   prompt resource.
     #   @return [Types::GuardrailConfiguration]
     #
     # @!attribute [rw] additional_model_request_fields
     #   Additional inference parameters that the model supports, beyond the
-    #   base set of inference parameters that `Converse` supports in the
-    #   `inferenceConfig` field. For more information, see [Model
-    #   parameters][1].
+    #   base set of inference parameters that `Converse` and
+    #   `ConverseStream` support in the `inferenceConfig` field. For more
+    #   information, see [Model parameters][1].
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
     #   @return [Hash,Array,String,Numeric,Boolean]
     #
+    # @!attribute [rw] prompt_variables
+    #   Contains a map of variables in a prompt from Prompt management to
+    #   objects containing the values to fill in for them when running model
+    #   invocation. This field is ignored if you don't specify a prompt
+    #   resource in the `modelId` field.
+    #   @return [Hash<String,Types::PromptVariableValues>]
+    #
     # @!attribute [rw] additional_model_response_field_paths
     #   Additional model parameters field paths to return in the response.
-    #   `Converse` returns the requested fields as a JSON Pointer object in
-    #   the `additionalModelResponseFields` field. The following is example
-    #   JSON for `additionalModelResponseFieldPaths`.
+    #   `Converse` and `ConverseStream` return the requested fields as a
+    #   JSON Pointer object in the `additionalModelResponseFields` field.
+    #   The following is example JSON for
+    #   `additionalModelResponseFieldPaths`.
     #
     #   `[ "/stop_sequence" ]`
     #
     #   For information about the JSON Pointer syntax, see the [Internet
     #   Engineering Task Force (IETF)][1] documentation.
     #
-    #   `Converse` rejects an empty JSON Pointer or incorrectly structured
-    #   JSON Pointer with a `400` error code. if the JSON Pointer is valid,
-    #   but the requested field is not in the model response, it is ignored
-    #   by `Converse`.
+    #   `Converse` and `ConverseStream` reject an empty JSON Pointer or
+    #   incorrectly structured JSON Pointer with a `400` error code. if the
+    #   JSON Pointer is valid, but the requested field is not in the model
+    #   response, it is ignored by `Converse`.
     #
     #
     #
@@ -421,8 +437,9 @@ module Aws::BedrockRuntime
       :tool_config,
       :guardrail_config,
       :additional_model_request_fields,
+      :prompt_variables,
       :additional_model_response_field_paths)
-      SENSITIVE = []
+      SENSITIVE = [:prompt_variables]
       include Aws::Structure
     end
 
@@ -511,10 +528,9 @@ module Aws::BedrockRuntime
     end
 
     # @!attribute [rw] model_id
-    #   The ID for the model.
-    #
-    #   The `modelId` to provide depends on the type of model or throughput
-    #   that you use:
+    #   Specifies the model or throughput with which to run inference, or
+    #   the prompt resource to use in inference. The value depends on the
+    #   resource that you use:
     #
     #   * If you use a base model, specify the model ID or its ARN. For a
     #     list of model IDs for base models, see [Amazon Bedrock base model
@@ -534,6 +550,9 @@ module Aws::BedrockRuntime
     #     For more information, see [Use a custom model in Amazon
     #     Bedrock][4] in the Amazon Bedrock User Guide.
     #
+    #   * To include a prompt that was defined in Prompt management, specify
+    #     the ARN of the prompt version to use.
+    #
     #   The Converse API doesn't support [imported models][5].
     #
     #
@@ -550,13 +569,15 @@ module Aws::BedrockRuntime
     #   @return [Array<Types::Message>]
     #
     # @!attribute [rw] system
-    #   A system prompt to send to the model.
+    #   A prompt that provides instructions or context to the model about
+    #   the task it should perform, or the persona it should adopt during
+    #   the conversation.
     #   @return [Array<Types::SystemContentBlock>]
     #
     # @!attribute [rw] inference_config
-    #   Inference parameters to pass to the model. `ConverseStream` supports
-    #   a base set of inference parameters. If you need to pass additional
-    #   parameters that the model supports, use the
+    #   Inference parameters to pass to the model. `Converse` and
+    #   `ConverseStream` support a base set of inference parameters. If you
+    #   need to pass additional parameters that the model supports, use the
     #   `additionalModelRequestFields` request field.
     #   @return [Types::InferenceConfiguration]
     #
@@ -571,30 +592,47 @@ module Aws::BedrockRuntime
     #
     # @!attribute [rw] guardrail_config
     #   Configuration information for a guardrail that you want to use in
-    #   the request.
+    #   the request. If you include `guardContent` blocks in the `content`
+    #   field in the `messages` field, the guardrail operates only on those
+    #   messages. If you include no `guardContent` blocks, the guardrail
+    #   operates on all messages in the request body and in any included
+    #   prompt resource.
     #   @return [Types::GuardrailStreamConfiguration]
     #
     # @!attribute [rw] additional_model_request_fields
     #   Additional inference parameters that the model supports, beyond the
-    #   base set of inference parameters that `ConverseStream` supports in
-    #   the `inferenceConfig` field.
+    #   base set of inference parameters that `Converse` and
+    #   `ConverseStream` support in the `inferenceConfig` field. For more
+    #   information, see [Model parameters][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
     #   @return [Hash,Array,String,Numeric,Boolean]
     #
+    # @!attribute [rw] prompt_variables
+    #   Contains a map of variables in a prompt from Prompt management to
+    #   objects containing the values to fill in for them when running model
+    #   invocation. This field is ignored if you don't specify a prompt
+    #   resource in the `modelId` field.
+    #   @return [Hash<String,Types::PromptVariableValues>]
+    #
     # @!attribute [rw] additional_model_response_field_paths
     #   Additional model parameters field paths to return in the response.
-    #   `ConverseStream` returns the requested fields as a JSON Pointer
-    #   object in the `additionalModelResponseFields` field. The following
-    #   is example JSON for `additionalModelResponseFieldPaths`.
+    #   `Converse` and `ConverseStream` return the requested fields as a
+    #   JSON Pointer object in the `additionalModelResponseFields` field.
+    #   The following is example JSON for
+    #   `additionalModelResponseFieldPaths`.
     #
     #   `[ "/stop_sequence" ]`
     #
     #   For information about the JSON Pointer syntax, see the [Internet
     #   Engineering Task Force (IETF)][1] documentation.
     #
-    #   `ConverseStream` rejects an empty JSON Pointer or incorrectly
-    #   structured JSON Pointer with a `400` error code. if the JSON Pointer
-    #   is valid, but the requested field is not in the model response, it
-    #   is ignored by `ConverseStream`.
+    #   `Converse` and `ConverseStream` reject an empty JSON Pointer or
+    #   incorrectly structured JSON Pointer with a `400` error code. if the
+    #   JSON Pointer is valid, but the requested field is not in the model
+    #   response, it is ignored by `Converse`.
     #
     #
     #
@@ -611,8 +649,9 @@ module Aws::BedrockRuntime
       :tool_config,
       :guardrail_config,
       :additional_model_request_fields,
+      :prompt_variables,
       :additional_model_response_field_paths)
-      SENSITIVE = []
+      SENSITIVE = [:prompt_variables]
       include Aws::Structure
     end
 
@@ -1854,6 +1893,34 @@ module Aws::BedrockRuntime
       include Aws::Structure
     end
 
+    # Contains a map of variables in a prompt from Prompt management to an
+    # object containing the values to fill in for them when running model
+    # invocation. For more information, see [How Prompt management
+    # works][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-how.html
+    #
+    # @note PromptVariableValues is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @!attribute [rw] text
+    #   The text value that the variable maps to.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/PromptVariableValues AWS API Documentation
+    #
+    class PromptVariableValues < Struct.new(
+      :text,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Text < PromptVariableValues; end
+      class Unknown < PromptVariableValues; end
+    end
+
     # The specified resource ARN was not found. Check the ARN and try your
     # request again.
     #

data/lib/aws-sdk-bedrockruntime.rb

@@ -56,7 +56,7 @@ module Aws::BedrockRuntime
   autoload :Endpoints, 'aws-sdk-bedrockruntime/endpoints'
   autoload :EventStreams, 'aws-sdk-bedrockruntime/event_streams'
 
-  GEM_VERSION = '1.30.0'
+  GEM_VERSION = '1.31.0'
 
 end
 

data/sig/client.rbs

@@ -114,7 +114,7 @@ module Aws
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockRuntime/Client.html#converse-instance_method
       def converse: (
                       model_id: ::String,
-                      messages: Array[
+                      ?messages: Array[
                         {
                           role: ("user" | "assistant"),
                           content: Array[
@@ -220,6 +220,9 @@ module Aws
                       },
                       ?additional_model_request_fields: {
                       },
+                      ?prompt_variables: Hash[::String, {
+                          text: ::String?
+                        }],
                       ?additional_model_response_field_paths: Array[::String]
                     ) -> _ConverseResponseSuccess
                   | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConverseResponseSuccess
@@ -231,7 +234,7 @@ module Aws
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockRuntime/Client.html#converse_stream-instance_method
       def converse_stream: (
                              model_id: ::String,
-                             messages: Array[
+                             ?messages: Array[
                                {
                                  role: ("user" | "assistant"),
                                  content: Array[
@@ -338,6 +341,9 @@ module Aws
                              },
                              ?additional_model_request_fields: {
                              },
+                             ?prompt_variables: Hash[::String, {
+                                 text: ::String?
+                               }],
                              ?additional_model_response_field_paths: Array[::String]
                            ) ?{ (*untyped) -> void } -> _ConverseStreamResponseSuccess
                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _ConverseStreamResponseSuccess
@@ -349,7 +355,7 @@ module Aws
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockRuntime/Client.html#invoke_model-instance_method
       def invoke_model: (
-                          body: ::String,
+                          ?body: ::String,
                           ?content_type: ::String,
                           ?accept: ::String,
                           model_id: ::String,
@@ -366,7 +372,7 @@ module Aws
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockRuntime/Client.html#invoke_model_with_response_stream-instance_method
       def invoke_model_with_response_stream: (
-                                               body: ::String,
+                                               ?body: ::String,
                                                ?content_type: ::String,
                                                ?accept: ::String,
                                                model_id: ::String,

data/sig/types.rbs

@@ -131,8 +131,9 @@ module Aws::BedrockRuntime
       attr_accessor tool_config: Types::ToolConfiguration
       attr_accessor guardrail_config: Types::GuardrailConfiguration
       attr_accessor additional_model_request_fields: untyped
+      attr_accessor prompt_variables: ::Hash[::String, Types::PromptVariableValues]
       attr_accessor additional_model_response_field_paths: ::Array[::String]
-      SENSITIVE: []
+      SENSITIVE: [:prompt_variables]
     end
 
     class ConverseResponse
@@ -166,8 +167,9 @@ module Aws::BedrockRuntime
       attr_accessor tool_config: Types::ToolConfiguration
       attr_accessor guardrail_config: Types::GuardrailStreamConfiguration
       attr_accessor additional_model_request_fields: untyped
+      attr_accessor prompt_variables: ::Hash[::String, Types::PromptVariableValues]
       attr_accessor additional_model_response_field_paths: ::Array[::String]
-      SENSITIVE: []
+      SENSITIVE: [:prompt_variables]
     end
 
     class ConverseStreamResponse
@@ -496,6 +498,17 @@ module Aws::BedrockRuntime
       SENSITIVE: [:bytes]
     end
 
+    class PromptVariableValues
+      attr_accessor text: ::String
+      attr_accessor unknown: untyped
+      SENSITIVE: []
+
+      class Text < PromptVariableValues
+      end
+      class Unknown < PromptVariableValues
+      end
+    end
+
     class ResourceNotFoundException
       attr_accessor message: ::String
       SENSITIVE: []

metadata

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