aws-sdk-bedrockagentruntime 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12cf1b84a20e0969d3e184e5b93f9455474446b7e54b938b72fb071fb458f26b
-  data.tar.gz: 8aff379d2148dcf2554d477750d148e0dfdb42f42aa85e6e50cce3347f76bc4b
+  metadata.gz: 8cc803bf4f889db4885d44233100f88828fc7cfb99149a1a2ac536104e28e629
+  data.tar.gz: 99eb1b4a9fbc673091079294ec6a5c69db1ea6c59ece19b623ed9f1dce14a0a2
 SHA512:
-  metadata.gz: 94b70ee38eeab8f9df78cfcef7f8ec0de55e22da72660b37846584294b27b68412491d79464a0ec1c69b6fa0332c110efc4b32315ecba769a47c14d00bd396cd
-  data.tar.gz: d6ba32ed95ac5aaeaac0a6f87d64bd27a5719e905101cf4741c570d8c175396b2102b58325901241a08918c37a197beef563e8fd8cd0f0907717de48cd348fbb
+  metadata.gz: cd0d0b58178239d1ef2eed238b570d86a4a2b5f260cd5e3c21a2957f4299b1ef6bc92119691d1581c035765009d068396d2fed6a93838910f52bdda6c55b9017
+  data.tar.gz: 8d9f09594ad68bcd0f79990e9ade1524719349ddde8c5e89370fa058e44f4bea7fe274aff63d3c646b034abb3089a0eda266444d522b5981d6025e5367f9f400

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.4.0 (2024-03-26)
+------------------
+
+* Feature - This release adds support to customize prompts sent through the RetrieveAndGenerate API in Agents for Amazon Bedrock.
+
 1.3.0 (2024-03-08)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

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

@@ -459,6 +459,11 @@ module Aws::BedrockAgentRuntime
     #
     # @option params [Types::SessionState] :session_state
     #   Contains parameters that specify various attributes of the session.
+    #   For more information, see [Control session context][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
     #
     # @return [Types::InvokeAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -822,10 +827,15 @@ module Aws::BedrockAgentRuntime
     #   another request to retrieve the next batch of results.
     #
     # @option params [Types::KnowledgeBaseRetrievalConfiguration] :retrieval_configuration
-    #   Contains details about how the results should be returned.
+    #   Contains configurations for the knowledge base query and retrieval
+    #   process. For more information, see [Query configurations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
     #
     # @option params [required, Types::KnowledgeBaseQuery] :retrieval_query
-    #   The query to send the knowledge base.
+    #   Contains the query to send the knowledge base.
     #
     # @return [Types::RetrieveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -872,22 +882,16 @@ module Aws::BedrockAgentRuntime
     # retrieved results. The response cites up to five sources but only
     # selects the ones that are relevant to the query.
     #
-    # <note markdown="1"> The `numberOfResults` field is currently unsupported for
-    # `RetrieveAndGenerate`. Don't include it in the
-    # [vectorSearchConfiguration][1] object.
-    #
-    #  </note>
+    # @option params [required, Types::RetrieveAndGenerateInput] :input
+    #   Contains the query to be made to the knowledge base.
     #
+    # @option params [Types::RetrieveAndGenerateConfiguration] :retrieve_and_generate_configuration
+    #   Contains configurations for the knowledge base query and retrieval
+    #   process. For more information, see [Query configurations][1].
     #
     #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_KnowledgeBaseVectorSearchConfiguration.html
     #
-    # @option params [required, Types::RetrieveAndGenerateInput] :input
-    #   Contains the query made to the knowledge base.
-    #
-    # @option params [Types::RetrieveAndGenerateConfiguration] :retrieve_and_generate_configuration
-    #   Contains details about the resource being queried and the foundation
-    #   model used for generation.
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
     #
     # @option params [Types::RetrieveAndGenerateSessionConfiguration] :session_configuration
     #   Contains details about the session with the knowledge base.
@@ -910,6 +914,11 @@ module Aws::BedrockAgentRuntime
     #     },
     #     retrieve_and_generate_configuration: {
     #       knowledge_base_configuration: {
+    #         generation_configuration: {
+    #           prompt_template: {
+    #             text_prompt_template: "TextPromptTemplate",
+    #           },
+    #         },
     #         knowledge_base_id: "KnowledgeBaseId", # required
     #         model_arn: "BedrockModelArn", # required
     #         retrieval_configuration: {
@@ -962,7 +971,7 @@ module Aws::BedrockAgentRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-bedrockagentruntime'
-      context[:gem_version] = '1.3.0'
+      context[:gem_version] = '1.4.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -37,6 +37,7 @@ module Aws::BedrockAgentRuntime
     FinalResponse = Shapes::StructureShape.new(name: 'FinalResponse')
     FinalResponseString = Shapes::StringShape.new(name: 'FinalResponseString')
     GeneratedResponsePart = Shapes::StructureShape.new(name: 'GeneratedResponsePart')
+    GenerationConfiguration = Shapes::StructureShape.new(name: 'GenerationConfiguration')
     InferenceConfiguration = Shapes::StructureShape.new(name: 'InferenceConfiguration')
     InputText = Shapes::StringShape.new(name: 'InputText')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
@@ -77,6 +78,7 @@ module Aws::BedrockAgentRuntime
     PreProcessingParsedResponse = Shapes::StructureShape.new(name: 'PreProcessingParsedResponse')
     PreProcessingTrace = Shapes::UnionShape.new(name: 'PreProcessingTrace')
     PromptSessionAttributesMap = Shapes::MapShape.new(name: 'PromptSessionAttributesMap')
+    PromptTemplate = Shapes::StructureShape.new(name: 'PromptTemplate')
     PromptText = Shapes::StringShape.new(name: 'PromptText')
     PromptType = Shapes::StringShape.new(name: 'PromptType')
     Rationale = Shapes::StructureShape.new(name: 'Rationale')
@@ -113,6 +115,7 @@ module Aws::BedrockAgentRuntime
     StopSequences = Shapes::ListShape.new(name: 'StopSequences')
     String = Shapes::StringShape.new(name: 'String')
     Temperature = Shapes::FloatShape.new(name: 'Temperature')
+    TextPromptTemplate = Shapes::StringShape.new(name: 'TextPromptTemplate')
     TextResponsePart = Shapes::StructureShape.new(name: 'TextResponsePart')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
     TopK = Shapes::IntegerShape.new(name: 'TopK')
@@ -171,6 +174,9 @@ module Aws::BedrockAgentRuntime
     GeneratedResponsePart.add_member(:text_response_part, Shapes::ShapeRef.new(shape: TextResponsePart, location_name: "textResponsePart"))
     GeneratedResponsePart.struct_class = Types::GeneratedResponsePart
 
+    GenerationConfiguration.add_member(:prompt_template, Shapes::ShapeRef.new(shape: PromptTemplate, location_name: "promptTemplate"))
+    GenerationConfiguration.struct_class = Types::GenerationConfiguration
+
     InferenceConfiguration.add_member(:maximum_length, Shapes::ShapeRef.new(shape: MaximumLength, location_name: "maximumLength"))
     InferenceConfiguration.add_member(:stop_sequences, Shapes::ShapeRef.new(shape: StopSequences, location_name: "stopSequences"))
     InferenceConfiguration.add_member(:temperature, Shapes::ShapeRef.new(shape: Temperature, location_name: "temperature"))
@@ -223,6 +229,7 @@ module Aws::BedrockAgentRuntime
 
     KnowledgeBaseRetrievalResults.member = Shapes::ShapeRef.new(shape: KnowledgeBaseRetrievalResult)
 
+    KnowledgeBaseRetrieveAndGenerateConfiguration.add_member(:generation_configuration, Shapes::ShapeRef.new(shape: GenerationConfiguration, location_name: "generationConfiguration"))
     KnowledgeBaseRetrieveAndGenerateConfiguration.add_member(:knowledge_base_id, Shapes::ShapeRef.new(shape: KnowledgeBaseId, required: true, location_name: "knowledgeBaseId"))
     KnowledgeBaseRetrieveAndGenerateConfiguration.add_member(:model_arn, Shapes::ShapeRef.new(shape: BedrockModelArn, required: true, location_name: "modelArn"))
     KnowledgeBaseRetrieveAndGenerateConfiguration.add_member(:retrieval_configuration, Shapes::ShapeRef.new(shape: KnowledgeBaseRetrievalConfiguration, location_name: "retrievalConfiguration"))
@@ -306,6 +313,9 @@ module Aws::BedrockAgentRuntime
     PromptSessionAttributesMap.key = Shapes::ShapeRef.new(shape: String)
     PromptSessionAttributesMap.value = Shapes::ShapeRef.new(shape: String)
 
+    PromptTemplate.add_member(:text_prompt_template, Shapes::ShapeRef.new(shape: TextPromptTemplate, location_name: "textPromptTemplate"))
+    PromptTemplate.struct_class = Types::PromptTemplate
+
     Rationale.add_member(:text, Shapes::ShapeRef.new(shape: RationaleString, location_name: "text"))
     Rationale.add_member(:trace_id, Shapes::ShapeRef.new(shape: TraceId, location_name: "traceId"))
     Rationale.struct_class = Types::Rationale

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

@@ -115,6 +115,17 @@ module Aws::BedrockAgentRuntime
     # on a source in the knowledge base, alongside information about the
     # source.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve response][1] – in the `citations` field
+    #
+    # * [RetrieveAndGenerate response][2] – in the `citations` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    #
     # @!attribute [rw] generated_response_part
     #   Contains the generated response and metadata
     #   @return [Types::GeneratedResponsePart]
@@ -205,6 +216,18 @@ module Aws::BedrockAgentRuntime
     # Contains metadata about a part of the generated response that is
     # accompanied by a citation.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve response][1] – in the `generatedResponsePart` field
+    #
+    # * [RetrieveAndGenerate response][2] – in the `generatedResponsePart`
+    #   field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    #
     # @!attribute [rw] text_response_part
     #   Contains metadata about a textual part of the generated response
     #   that is accompanied by a citation.
@@ -218,6 +241,32 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains configurations for response generation based on the knowledge
+    # base query results.
+    #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate request][1]
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
+    # @!attribute [rw] prompt_template
+    #   Contains the template for the prompt that's sent to the model for
+    #   response generation.
+    #   @return [Types::PromptTemplate]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GenerationConfiguration AWS API Documentation
+    #
+    class GenerationConfiguration < Struct.new(
+      :prompt_template)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifications about the inference parameters that were provided
     # alongside the prompt. These are specified in the
     # [PromptOverrideConfiguration][1] object that was set when the agent
@@ -353,6 +402,11 @@ module Aws::BedrockAgentRuntime
     #
     # @!attribute [rw] session_state
     #   Contains parameters that specify various attributes of the session.
+    #   For more information, see [Control session context][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
     #   @return [Types::SessionState]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeAgentRequest AWS API Documentation
@@ -429,6 +483,16 @@ module Aws::BedrockAgentRuntime
 
     # Contains the query made to the knowledge base.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve request][1] – in the `retrievalQuery` field
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
+    #
     # @!attribute [rw] text
     #   The text of the query made to the knowledge base.
     #   @return [String]
@@ -441,22 +505,29 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
-    # Contains details about how the results should be returned.
+    # Contains configurations for the knowledge base query and retrieval
+    # process. For more information, see [Query configurations][1].
     #
     # This data type is used in the following API operations:
     #
-    # * [Retrieve request body][1]
+    # * [Retrieve request][2] – in the `retrievalConfiguration` field
     #
-    # * [RetrieveAndGenerate request body][2]
+    # * [RetrieveAndGenerate request][3] – in the `retrievalConfiguration`
+    #   field
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
-    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
+    # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
     #
     # @!attribute [rw] vector_search_configuration
     #   Contains details about how the results from the vector search should
-    #   be returned.
+    #   be returned. For more information, see [Query configurations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
     #   @return [Types::KnowledgeBaseVectorSearchConfiguration]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrievalConfiguration AWS API Documentation
@@ -469,6 +540,16 @@ module Aws::BedrockAgentRuntime
 
     # Details about a result from querying the knowledge base.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve response][1] – in the `retrievalResults` field
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
+    #
     # @!attribute [rw] content
     #   Contains a chunk of text from a data source in the knowledge base.
     #   @return [Types::RetrievalResultContent]
@@ -493,6 +574,23 @@ module Aws::BedrockAgentRuntime
 
     # Contains details about the resource being queried.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve request][1] – in the `knowledgeBaseConfiguration` field
+    #
+    # * [RetrieveAndGenerate request][2] – in the
+    #   `knowledgeBaseConfiguration` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
+    # @!attribute [rw] generation_configuration
+    #   Contains configurations for response generation based on the
+    #   knowwledge base query results.
+    #   @return [Types::GenerationConfiguration]
+    #
     # @!attribute [rw] knowledge_base_id
     #   The unique identifier of the knowledge base that is queried and the
     #   foundation model used for generation.
@@ -510,6 +608,7 @@ module Aws::BedrockAgentRuntime
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrieveAndGenerateConfiguration AWS API Documentation
     #
     class KnowledgeBaseRetrieveAndGenerateConfiguration < Struct.new(
+      :generation_configuration,
       :knowledge_base_id,
       :model_arn,
       :retrieval_configuration)
@@ -517,16 +616,24 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
-    # Configurations for how to carry out the search.
+    # Configurations for how to perform the search query and return results.
+    # For more information, see [Query configurations][1].
     #
-    # @!attribute [rw] number_of_results
-    #   The number of results to return.
+    # This data type is used in the following API operations:
     #
-    #   <note markdown="1"> The `numberOfResults` field is currently unsupported for
-    #   `RetrieveAndGenerate`. Don't include it in this field if you are
-    #   sending a `RetrieveAndGenerate` request.
+    # * [Retrieve request][2] – in the `vectorSearchConfiguration` field
     #
-    #    </note>
+    # * [RetrieveAndGenerate request][3] – in the
+    #   `vectorSearchConfiguration` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
+    # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
+    # @!attribute [rw] number_of_results
+    #   The number of source chunks to retrieve.
     #   @return [Integer]
     #
     # @!attribute [rw] override_search_type
@@ -943,6 +1050,48 @@ module Aws::BedrockAgentRuntime
       class Unknown < PreProcessingTrace; end
     end
 
+    # Contains the template for the prompt that's sent to the model for
+    # response generation. For more information, see [Knowledge base prompt
+    # templates][1].
+    #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate request][2]
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
+    # @!attribute [rw] text_prompt_template
+    #   The template for the prompt that's sent to the model for response
+    #   generation. You can include prompt placeholders, which become
+    #   replaced before the prompt is sent to the model to provide
+    #   instructions and context to the model. In addition, you can include
+    #   XML tags to delineate meaningful sections of the prompt template.
+    #
+    #   For more information, see the following resources:
+    #
+    #   * [Knowledge base prompt templates][1]
+    #
+    #   * [Use XML tags with Anthropic Claude models][2]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt
+    #   [2]: https://docs.anthropic.com/claude/docs/use-xml-tags
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/PromptTemplate AWS API Documentation
+    #
+    class PromptTemplate < Struct.new(
+      :text_prompt_template)
+      SENSITIVE = [:text_prompt_template]
+      include Aws::Structure
+    end
+
     # Contains the reasoning, based on the input, that the agent uses to
     # justify carrying out an action group or getting information from a
     # knowledge base.
@@ -1014,6 +1163,19 @@ module Aws::BedrockAgentRuntime
 
     # Contains the cited text from the data source.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve response][1] – in the `content` field
+    #
+    # * [RetrieveAndGenerate response][2] – in the `content` field
+    #
+    # * [Retrieve response][1] – in the `content` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    #
     # @!attribute [rw] text
     #   The cited text from the data source.
     #   @return [String]
@@ -1028,6 +1190,19 @@ module Aws::BedrockAgentRuntime
 
     # Contains information about the location of the data source.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve response][1] – in the `location` field
+    #
+    # * [RetrieveAndGenerate response][2] – in the `location` field
+    #
+    # * [Retrieve response][1] – in the `locatino` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    #
     # @!attribute [rw] s3_location
     #   Contains the S3 location of the data source.
     #   @return [Types::RetrievalResultS3Location]
@@ -1047,6 +1222,19 @@ module Aws::BedrockAgentRuntime
 
     # Contains the S3 location of the data source.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve response][1] – in the `s3Location` field
+    #
+    # * [RetrieveAndGenerate response][2] – in the `s3Location` field
+    #
+    # * [Retrieve response][1] – in the `s3Location` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    #
     # @!attribute [rw] uri
     #   The S3 URI of the data source.
     #   @return [String]
@@ -1061,6 +1249,17 @@ module Aws::BedrockAgentRuntime
 
     # Contains details about the resource being queried.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate request][1] – in the
+    #   `retrieveAndGenerateConfiguration` field
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
     # @!attribute [rw] knowledge_base_configuration
     #   Contains details about the resource being queried.
     #   @return [Types::KnowledgeBaseRetrieveAndGenerateConfiguration]
@@ -1080,6 +1279,16 @@ module Aws::BedrockAgentRuntime
 
     # Contains the query made to the knowledge base.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate request][1] – in the `input` field
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
     # @!attribute [rw] text
     #   The query made to the knowledge base.
     #   @return [String]
@@ -1094,6 +1303,16 @@ module Aws::BedrockAgentRuntime
 
     # Contains the response generated from querying the knowledge base.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate response][1] – in the `output` field
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    #
     # @!attribute [rw] text
     #   The response generated from querying the knowledge base.
     #   @return [String]
@@ -1107,12 +1326,16 @@ module Aws::BedrockAgentRuntime
     end
 
     # @!attribute [rw] input
-    #   Contains the query made to the knowledge base.
+    #   Contains the query to be made to the knowledge base.
     #   @return [Types::RetrieveAndGenerateInput]
     #
     # @!attribute [rw] retrieve_and_generate_configuration
-    #   Contains details about the resource being queried and the foundation
-    #   model used for generation.
+    #   Contains configurations for the knowledge base query and retrieval
+    #   process. For more information, see [Query configurations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
     #   @return [Types::RetrieveAndGenerateConfiguration]
     #
     # @!attribute [rw] session_configuration
@@ -1162,6 +1385,17 @@ module Aws::BedrockAgentRuntime
 
     # Contains configuration about the session with the knowledge base.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate request][1] – in the `sessionConfiguration`
+    #   field
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
     # @!attribute [rw] kms_key_arn
     #   The ARN of the KMS key encrypting the session.
     #   @return [String]
@@ -1185,11 +1419,16 @@ module Aws::BedrockAgentRuntime
     #   @return [String]
     #
     # @!attribute [rw] retrieval_configuration
-    #   Contains details about how the results should be returned.
+    #   Contains configurations for the knowledge base query and retrieval
+    #   process. For more information, see [Query configurations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
     #   @return [Types::KnowledgeBaseRetrievalConfiguration]
     #
     # @!attribute [rw] retrieval_query
-    #   The query to send the knowledge base.
+    #   Contains the query to send the knowledge base.
     #   @return [Types::KnowledgeBaseQuery]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveRequest AWS API Documentation
@@ -1222,7 +1461,19 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
-    # Contains metadata about a sources cited for the generated response.
+    # Contains metadata about a source cited for the generated response.
+    #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate response][1] – in the `retrievedReferences`
+    #   field
+    #
+    # * [Retrieve response][2] – in the `retrievedReferences` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
     #
     # @!attribute [rw] content
     #   Contains the cited text from the data source.
@@ -1262,13 +1513,13 @@ module Aws::BedrockAgentRuntime
     # group or pass them when making an [InvokeAgent][2] request. Use
     # session state attributes to control and provide conversational context
     # for your agent and to help customize your agent's behavior. For more
-    # information, see [Session context][3].
+    # information, see [Control session context][3].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html
     # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
-    # [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/sessionstate.html
+    # [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
     #
     # @!attribute [rw] prompt_session_attributes
     #   Contains attributes that persist across a prompt and the values of
@@ -1299,6 +1550,17 @@ module Aws::BedrockAgentRuntime
     # Contains information about where the text with a citation begins and
     # ends in the generated output.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate response][1] – in the `span` field
+    #
+    # * [Retrieve response][2] – in the `span` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
+    #
     # @!attribute [rw] end
     #   Where the text with a citation ends in the generated output.
     #   @return [Integer]
@@ -1319,6 +1581,17 @@ module Aws::BedrockAgentRuntime
     # Contains the part of the generated text that contains a citation,
     # alongside where it begins and ends.
     #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate response][1] – in the `textResponsePart` field
+    #
+    # * [Retrieve response][2] – in the `textResponsePart` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax
+    #
     # @!attribute [rw] span
     #   Contains information about where the text with a citation begins and
     #   ends in the generated output.

data/lib/aws-sdk-bedrockagentruntime.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-bedrockagentruntime/event_streams'
 # @!group service
 module Aws::BedrockAgentRuntime
 
-  GEM_VERSION = '1.3.0'
+  GEM_VERSION = '1.4.0'
 
 end

data/sig/client.rbs

@@ -130,6 +130,11 @@ module Aws
                                    },
                                    ?retrieve_and_generate_configuration: {
                                      knowledge_base_configuration: {
+                                       generation_configuration: {
+                                         prompt_template: {
+                                           text_prompt_template: ::String?
+                                         }?
+                                       }?,
                                        knowledge_base_id: ::String,
                                        model_arn: ::String,
                                        retrieval_configuration: {

data/sig/types.rbs

@@ -75,6 +75,11 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: [:text_response_part]
     end
 
+    class GenerationConfiguration
+      attr_accessor prompt_template: Types::PromptTemplate
+      SENSITIVE: []
+    end
+
     class InferenceConfiguration
       attr_accessor maximum_length: ::Integer
       attr_accessor stop_sequences: ::Array[::String]
@@ -145,6 +150,7 @@ module Aws::BedrockAgentRuntime
     end
 
     class KnowledgeBaseRetrieveAndGenerateConfiguration
+      attr_accessor generation_configuration: Types::GenerationConfiguration
       attr_accessor knowledge_base_id: ::String
       attr_accessor model_arn: ::String
       attr_accessor retrieval_configuration: Types::KnowledgeBaseRetrievalConfiguration
@@ -263,6 +269,11 @@ module Aws::BedrockAgentRuntime
       end
     end
 
+    class PromptTemplate
+      attr_accessor text_prompt_template: ::String
+      SENSITIVE: [:text_prompt_template]
+    end
+
     class Rationale
       attr_accessor text: ::String
       attr_accessor trace_id: ::String

metadata

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