aws-sdk-bedrockagent 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2721f4d09bda31c0e5fd576ad591a4c03c7dd552599898c95e7106f0e5be2f4
-  data.tar.gz: e46f96d2bb853db13d431793e62427fcf7f3dadb7383526439ed4a5e6b676918
+  metadata.gz: 5823b0a385ecf5bfd8da8fc673945bc5dd80ee73a0cdbb0b1aa4d78731dc7a5e
+  data.tar.gz: 2e51b4755fa3b3f3b26118d447937d7112adc873d516c53aefed044d40d0c1b3
 SHA512:
-  metadata.gz: 18c06c3e2e50c238eabc210d540fe7507d4260b78f097ce77adeca4850faa5f4ce7b4c2c85fd8a89010070cb1a64a4f534ca0a4c5c4a98e9f31dd3afb6835097
-  data.tar.gz: 35c0d06522f4da9beb693df413cd207794366907bbeefb5fe319cfb36f805c66e34e7f846a685662ee2406410f5f6efa3a817dd012d21c512c58a42928afd94a
+  metadata.gz: 7347d5bbc975e31c11a7646765f79b6e4389b1e187ec6f20ecddcbdfdb3769b288345a20ea5ab2565584e0e8d36047e51e02023c2353a529f3c3c604a921e81b
+  data.tar.gz: ff50a8193fe7643af64d785996b3678a20c9a57efbfbab9502d1f66f0573c2995f97a8832c3f1b91e04ccab4aa398e004176a78128fa20a251f4e29e38c7be9a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.22.0 (2024-09-04)
+------------------
+
+* Feature - Add support for user metadata inside PromptVariant.
+
 1.21.0 (2024-09-03)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.21.0
+1.22.0

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

@@ -523,10 +523,14 @@ module Aws::BedrockAgent
     #   to use advanced prompts, include a `promptOverrideConfiguration`
     #   object. For more information, see [Advanced prompts][2].
     #
-    # * If you agent fails to be created, the response returns a list of
+    # * If your agent fails to be created, the response returns a list of
     #   `failureReasons` alongside a list of `recommendedActions` for you to
     #   troubleshoot.
     #
+    # * The agent instructions will not be honored if your agent has only
+    #   one knowledge base, uses default prompts, has no action group, and
+    #   user input is disabled.
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-configure-memory.html
@@ -2017,6 +2021,12 @@ module Aws::BedrockAgent
     #             top_p: 1.0,
     #           },
     #         },
+    #         metadata: [
+    #           {
+    #             key: "PromptMetadataKey", # required
+    #             value: "PromptMetadataValue", # required
+    #           },
+    #         ],
     #         model_id: "PromptModelIdentifier",
     #         name: "PromptVariantName", # required
     #         template_configuration: {
@@ -2051,6 +2061,9 @@ module Aws::BedrockAgent
     #   resp.variants[0].inference_configuration.text.temperature #=> Float
     #   resp.variants[0].inference_configuration.text.top_k #=> Integer
     #   resp.variants[0].inference_configuration.text.top_p #=> Float
+    #   resp.variants[0].metadata #=> Array
+    #   resp.variants[0].metadata[0].key #=> String
+    #   resp.variants[0].metadata[0].value #=> String
     #   resp.variants[0].model_id #=> String
     #   resp.variants[0].name #=> String
     #   resp.variants[0].template_configuration.text.input_variables #=> Array
@@ -2145,6 +2158,9 @@ module Aws::BedrockAgent
     #   resp.variants[0].inference_configuration.text.temperature #=> Float
     #   resp.variants[0].inference_configuration.text.top_k #=> Integer
     #   resp.variants[0].inference_configuration.text.top_p #=> Float
+    #   resp.variants[0].metadata #=> Array
+    #   resp.variants[0].metadata[0].key #=> String
+    #   resp.variants[0].metadata[0].value #=> String
     #   resp.variants[0].model_id #=> String
     #   resp.variants[0].name #=> String
     #   resp.variants[0].template_configuration.text.input_variables #=> Array
@@ -3391,6 +3407,9 @@ module Aws::BedrockAgent
     #   resp.variants[0].inference_configuration.text.temperature #=> Float
     #   resp.variants[0].inference_configuration.text.top_k #=> Integer
     #   resp.variants[0].inference_configuration.text.top_p #=> Float
+    #   resp.variants[0].metadata #=> Array
+    #   resp.variants[0].metadata[0].key #=> String
+    #   resp.variants[0].metadata[0].value #=> String
     #   resp.variants[0].model_id #=> String
     #   resp.variants[0].name #=> String
     #   resp.variants[0].template_configuration.text.input_variables #=> Array
@@ -5566,6 +5585,12 @@ module Aws::BedrockAgent
     #             top_p: 1.0,
     #           },
     #         },
+    #         metadata: [
+    #           {
+    #             key: "PromptMetadataKey", # required
+    #             value: "PromptMetadataValue", # required
+    #           },
+    #         ],
     #         model_id: "PromptModelIdentifier",
     #         name: "PromptVariantName", # required
     #         template_configuration: {
@@ -5600,6 +5625,9 @@ module Aws::BedrockAgent
     #   resp.variants[0].inference_configuration.text.temperature #=> Float
     #   resp.variants[0].inference_configuration.text.top_k #=> Integer
     #   resp.variants[0].inference_configuration.text.top_p #=> Float
+    #   resp.variants[0].metadata #=> Array
+    #   resp.variants[0].metadata[0].key #=> String
+    #   resp.variants[0].metadata[0].value #=> String
     #   resp.variants[0].model_id #=> String
     #   resp.variants[0].name #=> String
     #   resp.variants[0].template_configuration.text.input_variables #=> Array
@@ -5635,7 +5663,7 @@ module Aws::BedrockAgent
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-bedrockagent'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.22.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -337,6 +337,10 @@ module Aws::BedrockAgent
     PromptInputVariable = Shapes::StructureShape.new(name: 'PromptInputVariable')
     PromptInputVariableName = Shapes::StringShape.new(name: 'PromptInputVariableName')
     PromptInputVariablesList = Shapes::ListShape.new(name: 'PromptInputVariablesList')
+    PromptMetadataEntry = Shapes::StructureShape.new(name: 'PromptMetadataEntry')
+    PromptMetadataKey = Shapes::StringShape.new(name: 'PromptMetadataKey')
+    PromptMetadataList = Shapes::ListShape.new(name: 'PromptMetadataList')
+    PromptMetadataValue = Shapes::StringShape.new(name: 'PromptMetadataValue')
     PromptModelIdentifier = Shapes::StringShape.new(name: 'PromptModelIdentifier')
     PromptModelInferenceConfiguration = Shapes::StructureShape.new(name: 'PromptModelInferenceConfiguration')
     PromptName = Shapes::StringShape.new(name: 'PromptName')
@@ -1589,6 +1593,12 @@ module Aws::BedrockAgent
 
     PromptInputVariablesList.member = Shapes::ShapeRef.new(shape: PromptInputVariable)
 
+    PromptMetadataEntry.add_member(:key, Shapes::ShapeRef.new(shape: PromptMetadataKey, required: true, location_name: "key"))
+    PromptMetadataEntry.add_member(:value, Shapes::ShapeRef.new(shape: PromptMetadataValue, required: true, location_name: "value"))
+    PromptMetadataEntry.struct_class = Types::PromptMetadataEntry
+
+    PromptMetadataList.member = Shapes::ShapeRef.new(shape: PromptMetadataEntry)
+
     PromptModelInferenceConfiguration.add_member(:max_tokens, Shapes::ShapeRef.new(shape: MaximumLength, location_name: "maxTokens"))
     PromptModelInferenceConfiguration.add_member(:stop_sequences, Shapes::ShapeRef.new(shape: StopSequences, location_name: "stopSequences"))
     PromptModelInferenceConfiguration.add_member(:temperature, Shapes::ShapeRef.new(shape: Temperature, location_name: "temperature"))
@@ -1618,6 +1628,7 @@ module Aws::BedrockAgent
     PromptTemplateConfiguration.struct_class = Types::PromptTemplateConfiguration
 
     PromptVariant.add_member(:inference_configuration, Shapes::ShapeRef.new(shape: PromptInferenceConfiguration, location_name: "inferenceConfiguration"))
+    PromptVariant.add_member(:metadata, Shapes::ShapeRef.new(shape: PromptMetadataList, location_name: "metadata"))
     PromptVariant.add_member(:model_id, Shapes::ShapeRef.new(shape: PromptModelIdentifier, location_name: "modelId"))
     PromptVariant.add_member(:name, Shapes::ShapeRef.new(shape: PromptVariantName, required: true, location_name: "name"))
     PromptVariant.add_member(:template_configuration, Shapes::ShapeRef.new(shape: PromptTemplateConfiguration, location_name: "templateConfiguration"))

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

@@ -5545,8 +5545,13 @@ module Aws::BedrockAgent
     #
     # * Anthropic Claude 3 Haiku - `anthropic.claude-3-haiku-20240307-v1:0`
     #
-    # You can get the ARN of a model with the action. Standard model usage
-    # charges apply for the foundation model parsing strategy.
+    # You can get the ARN of a model with the [ListFoundationModels][1]
+    # action. Standard model usage charges apply for the foundation model
+    # parsing strategy.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListFoundationModels.html
     #
     # @!attribute [rw] bedrock_foundation_model_configuration
     #   Settings for a foundation model used to parse documents for a data
@@ -5982,6 +5987,31 @@ module Aws::BedrockAgent
       include Aws::Structure
     end
 
+    # Contains a key-value pair that defines a metadata tag and value to
+    # attach to a prompt variant. For more information, see [Create a prompt
+    # using Prompt management][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html
+    #
+    # @!attribute [rw] key
+    #   The key of a metadata tag for a prompt variant.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The value of a metadata tag for a prompt variant.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptMetadataEntry AWS API Documentation
+    #
+    class PromptMetadataEntry < Struct.new(
+      :key,
+      :value)
+      SENSITIVE = [:key, :value]
+      include Aws::Structure
+    end
+
     # Contains inference configurations related to model inference for a
     # prompt. For more information, see [Inference parameters][1].
     #
@@ -6153,6 +6183,16 @@ module Aws::BedrockAgent
     #   Contains inference configurations for the prompt variant.
     #   @return [Types::PromptInferenceConfiguration]
     #
+    # @!attribute [rw] metadata
+    #   An array of objects, each containing a key-value pair that defines a
+    #   metadata tag and value to attach to a prompt variant. For more
+    #   information, see [Create a prompt using Prompt management][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html
+    #   @return [Array<Types::PromptMetadataEntry>]
+    #
     # @!attribute [rw] model_id
     #   The unique identifier of the model with which to run inference on
     #   the prompt.
@@ -6174,11 +6214,12 @@ module Aws::BedrockAgent
     #
     class PromptVariant < Struct.new(
       :inference_configuration,
+      :metadata,
       :model_id,
       :name,
       :template_configuration,
       :template_type)
-      SENSITIVE = []
+      SENSITIVE = [:metadata]
       include Aws::Structure
     end
 

data/lib/aws-sdk-bedrockagent.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-bedrockagent/customizations'
 # @!group service
 module Aws::BedrockAgent
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.22.0'
 
 end

data/sig/client.rbs

@@ -652,6 +652,12 @@ module Aws
                                    top_p: ::Float?
                                  }?
                                }?,
+                               metadata: Array[
+                                 {
+                                   key: ::String,
+                                   value: ::String
+                                 },
+                               ]?,
                                model_id: ::String?,
                                name: ::String,
                                template_configuration: {
@@ -1779,6 +1785,12 @@ module Aws
                                    top_p: ::Float?
                                  }?
                                }?,
+                               metadata: Array[
+                                 {
+                                   key: ::String,
+                                   value: ::String
+                                 },
+                               ]?,
                                model_id: ::String?,
                                name: ::String,
                                template_configuration: {

data/sig/types.rbs

@@ -1475,6 +1475,12 @@ module Aws::BedrockAgent
       SENSITIVE: []
     end
 
+    class PromptMetadataEntry
+      attr_accessor key: ::String
+      attr_accessor value: ::String
+      SENSITIVE: [:key, :value]
+    end
+
     class PromptModelInferenceConfiguration
       attr_accessor max_tokens: ::Integer
       attr_accessor stop_sequences: ::Array[::String]
@@ -1514,11 +1520,12 @@ module Aws::BedrockAgent
 
     class PromptVariant
       attr_accessor inference_configuration: Types::PromptInferenceConfiguration
+      attr_accessor metadata: ::Array[Types::PromptMetadataEntry]
       attr_accessor model_id: ::String
       attr_accessor name: ::String
       attr_accessor template_configuration: Types::PromptTemplateConfiguration
       attr_accessor template_type: ("TEXT")
-      SENSITIVE: []
+      SENSITIVE: [:metadata]
     end
 
     class RdsConfiguration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockagent
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-03 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core