aws-sdk-bedrockagentruntime 1.36.0 → 1.38.0

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

@@ -224,7 +224,7 @@ module Aws::BedrockAgentRuntime
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgentActionGroup AWS API Documentation
@@ -581,6 +581,20 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Settings for a model called with InvokeAgent.
+    #
+    # @!attribute [rw] performance_config
+    #   The performance configuration for the model.
+    #   @return [Types::PerformanceConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/BedrockModelConfigurations AWS API Documentation
+    #
+    class BedrockModelConfigurations < Struct.new(
+      :performance_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains configurations for an Amazon Bedrock reranker model.
     #
     # @!attribute [rw] model_configuration
@@ -906,12 +920,17 @@ module Aws::BedrockAgentRuntime
     #   The unique identifier of the memory.
     #   @return [String]
     #
+    # @!attribute [rw] session_id
+    #   The unique session identifier of the memory.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DeleteAgentMemoryRequest AWS API Documentation
     #
     class DeleteAgentMemoryRequest < Struct.new(
       :agent_alias_id,
       :agent_id,
-      :memory_id)
+      :memory_id,
+      :session_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -986,6 +1005,10 @@ module Aws::BedrockAgentRuntime
     #   to generate responses while using an external source.
     #   @return [Types::InferenceConfig]
     #
+    # @!attribute [rw] performance_config
+    #   The latency configuration for the model.
+    #   @return [Types::PerformanceConfiguration]
+    #
     # @!attribute [rw] prompt_template
     #   Contain the textPromptTemplate string for the external source
     #   wrapper object.
@@ -997,6 +1020,7 @@ module Aws::BedrockAgentRuntime
       :additional_model_request_fields,
       :guardrail_configuration,
       :inference_config,
+      :performance_config,
       :prompt_template)
       SENSITIVE = []
       include Aws::Structure
@@ -1735,6 +1759,58 @@ module Aws::BedrockAgentRuntime
       class Unknown < FunctionSchema; end
     end
 
+    # @!attribute [rw] query_generation_input
+    #   Specifies information about a natural language query to transform
+    #   into SQL.
+    #   @return [Types::QueryGenerationInput]
+    #
+    # @!attribute [rw] transformation_configuration
+    #   Specifies configurations for transforming the natural language query
+    #   into SQL.
+    #   @return [Types::TransformationConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GenerateQueryRequest AWS API Documentation
+    #
+    class GenerateQueryRequest < Struct.new(
+      :query_generation_input,
+      :transformation_configuration)
+      SENSITIVE = [:query_generation_input]
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] queries
+    #   A list of objects, each of which defines a generated query that can
+    #   correspond to the natural language queries.
+    #   @return [Array<Types::GeneratedQuery>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GenerateQueryResponse AWS API Documentation
+    #
+    class GenerateQueryResponse < Struct.new(
+      :queries)
+      SENSITIVE = [:queries]
+      include Aws::Structure
+    end
+
+    # Contains information about a query generated for a natural language
+    # query.
+    #
+    # @!attribute [rw] sql
+    #   An SQL query that corresponds to the natural language query.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   The type of transformed query.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GeneratedQuery AWS API Documentation
+    #
+    class GeneratedQuery < Struct.new(
+      :sql,
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains metadata about a part of the generated response that is
     # accompanied by a citation.
     #
@@ -1792,6 +1868,10 @@ module Aws::BedrockAgentRuntime
     #   to generate responses while using a knowledge base as a source.
     #   @return [Types::InferenceConfig]
     #
+    # @!attribute [rw] performance_config
+    #   The latency configuration for the model.
+    #   @return [Types::PerformanceConfiguration]
+    #
     # @!attribute [rw] prompt_template
     #   Contains the template for the prompt that's sent to the model for
     #   response generation. Generation prompts must include the
@@ -1809,6 +1889,7 @@ module Aws::BedrockAgentRuntime
       :additional_model_request_fields,
       :guardrail_configuration,
       :inference_config,
+      :performance_config,
       :prompt_template)
       SENSITIVE = []
       include Aws::Structure
@@ -2397,6 +2478,20 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Settings for a model called with InvokeInlineAgent.
+    #
+    # @!attribute [rw] performance_config
+    #   The latency configuration for the model.
+    #   @return [Types::PerformanceConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InlineBedrockModelConfigurations AWS API Documentation
+    #
+    class InlineBedrockModelConfigurations < Struct.new(
+      :performance_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains parameters that specify various attributes that persist
     # across a session or prompt. You can define session state attributes as
     # key-value pairs when writing a [Lambda function][1] for an action
@@ -2655,6 +2750,10 @@ module Aws::BedrockAgentRuntime
     #   The unique identifier of the agent to use.
     #   @return [String]
     #
+    # @!attribute [rw] bedrock_model_configurations
+    #   Model performance settings for the request.
+    #   @return [Types::BedrockModelConfigurations]
+    #
     # @!attribute [rw] enable_trace
     #   Specifies whether to turn on the trace or not to track the agent's
     #   reasoning process. For more information, see [Trace enablement][1].
@@ -2706,6 +2805,11 @@ module Aws::BedrockAgentRuntime
     #
     # @!attribute [rw] streaming_configurations
     #   Specifies the configurations for streaming.
+    #
+    #   <note markdown="1"> To use agent streaming, you need permissions to perform the
+    #   `bedrock:InvokeModelWithResponseStream` action.
+    #
+    #    </note>
     #   @return [Types::StreamingConfigurations]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeAgentRequest AWS API Documentation
@@ -2713,6 +2817,7 @@ module Aws::BedrockAgentRuntime
     class InvokeAgentRequest < Struct.new(
       :agent_alias_id,
       :agent_id,
+      :bedrock_model_configurations,
       :enable_trace,
       :end_session,
       :input_text,
@@ -2777,13 +2882,18 @@ module Aws::BedrockAgentRuntime
     #   the flow.
     #   @return [Array<Types::FlowInput>]
     #
+    # @!attribute [rw] model_performance_configuration
+    #   Model performance settings for the request.
+    #   @return [Types::ModelPerformanceConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeFlowRequest AWS API Documentation
     #
     class InvokeFlowRequest < Struct.new(
       :enable_trace,
       :flow_alias_identifier,
       :flow_identifier,
-      :inputs)
+      :inputs,
+      :model_performance_configuration)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2806,6 +2916,10 @@ module Aws::BedrockAgentRuntime
     #   the inline agent needs to carry out.
     #   @return [Array<Types::AgentActionGroup>]
     #
+    # @!attribute [rw] bedrock_model_configurations
+    #   Model settings for the request.
+    #   @return [Types::InlineBedrockModelConfigurations]
+    #
     # @!attribute [rw] customer_encryption_key_arn
     #   The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to
     #   use to encrypt your inline agent.
@@ -2901,6 +3015,7 @@ module Aws::BedrockAgentRuntime
     #
     class InvokeInlineAgentRequest < Struct.new(
       :action_groups,
+      :bedrock_model_configurations,
       :customer_encryption_key_arn,
       :enable_trace,
       :end_session,
@@ -3106,7 +3221,7 @@ module Aws::BedrockAgentRuntime
     # [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.
+    #   Contains information about the content of the chunk.
     #   @return [Types::RetrievalResultContent]
     #
     # @!attribute [rw] location
@@ -3477,6 +3592,41 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # The model specified in the request is not ready to serve inference
+    # requests. The AWS SDK will automatically retry the operation up to 5
+    # times. For information about configuring automatic retries, see [Retry
+    # behavior][1] in the *AWS SDKs and Tools* reference guide.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ModelNotReadyException AWS API Documentation
+    #
+    class ModelNotReadyException < Struct.new(
+      :message,
+      :event_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The performance configuration for a model called with InvokeFlow.
+    #
+    # @!attribute [rw] performance_config
+    #   The latency configuration for the model.
+    #   @return [Types::PerformanceConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ModelPerformanceConfiguration AWS API Documentation
+    #
+    class ModelPerformanceConfiguration < Struct.new(
+      :performance_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains the result or output of an action group or knowledge base, or
     # the response to the user.
     #
@@ -3626,6 +3776,10 @@ module Aws::BedrockAgentRuntime
     #   to generate responses while using a knowledge base as a source.
     #   @return [Types::InferenceConfig]
     #
+    # @!attribute [rw] performance_config
+    #   The latency configuration for the model.
+    #   @return [Types::PerformanceConfiguration]
+    #
     # @!attribute [rw] prompt_template
     #   Contains the template for the prompt that's sent to the model.
     #   Orchestration prompts must include the `$conversation_history$` and
@@ -3647,6 +3801,7 @@ module Aws::BedrockAgentRuntime
     class OrchestrationConfiguration < Struct.new(
       :additional_model_request_fields,
       :inference_config,
+      :performance_config,
       :prompt_template,
       :query_transformation_configuration)
       SENSITIVE = []
@@ -3838,6 +3993,20 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Performance settings for a model.
+    #
+    # @!attribute [rw] latency
+    #   To use a latency-optimized version of the model, set to `optimized`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/PerformanceConfiguration AWS API Documentation
+    #
+    class PerformanceConfiguration < Struct.new(
+      :latency)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The foundation model output from the post-processing step.
     #
     # @!attribute [rw] metadata
@@ -4196,6 +4365,26 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains information about a natural language query to transform into
+    # SQL.
+    #
+    # @!attribute [rw] text
+    #   The text of the query.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   The type of the query.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/QueryGenerationInput AWS API Documentation
+    #
+    class QueryGenerationInput < Struct.new(
+      :text,
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # To split up the prompt and retrieve multiple sources, set the
     # transformation type to `QUERY_DECOMPOSITION`.
     #
@@ -4713,7 +4902,9 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
-    # Contains the cited text from the data source.
+    # Contains information about a chunk of text from a data source in the
+    # knowledge base. If the result is from a structured data source, the
+    # cell in the database and the type of the value is also identified.
     #
     # This data type is used in the following API operations:
     #
@@ -4729,14 +4920,57 @@ module Aws::BedrockAgentRuntime
     # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
     # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax
     #
+    # @!attribute [rw] byte_content
+    #   A data URI with base64-encoded content from the data source. The URI
+    #   is in the following format: returned in the following format:
+    #   `data:image/jpeg;base64,${base64-encoded string}`.
+    #   @return [String]
+    #
+    # @!attribute [rw] row
+    #   Specifies information about the rows with the cells to return in
+    #   retrieval.
+    #   @return [Array<Types::RetrievalResultContentColumn>]
+    #
     # @!attribute [rw] text
     #   The cited text from the data source.
     #   @return [String]
     #
+    # @!attribute [rw] type
+    #   The type of content in the retrieval result.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultContent AWS API Documentation
     #
     class RetrievalResultContent < Struct.new(
-      :text)
+      :byte_content,
+      :row,
+      :text,
+      :type)
+      SENSITIVE = [:row]
+      include Aws::Structure
+    end
+
+    # Contains information about a column with a cell to return in
+    # retrieval.
+    #
+    # @!attribute [rw] column_name
+    #   The name of the column.
+    #   @return [String]
+    #
+    # @!attribute [rw] column_value
+    #   The value in the column.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   The data type of the value.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultContentColumn AWS API Documentation
+    #
+    class RetrievalResultContentColumn < Struct.new(
+      :column_name,
+      :column_value,
+      :type)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4756,6 +4990,20 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # The location of a result in Amazon Kendra.
+    #
+    # @!attribute [rw] uri
+    #   The document's uri.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultKendraDocumentLocation AWS API Documentation
+    #
+    class RetrievalResultKendraDocumentLocation < Struct.new(
+      :uri)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information about the data source location.
     #
     # This data type is used in the following API operations:
@@ -4764,7 +5012,7 @@ module Aws::BedrockAgentRuntime
     #
     # * [RetrieveAndGenerate response][2] – in the `location` field
     #
-    # * [InvokeAgent response][3] – in the `locatino` field
+    # * [InvokeAgent response][3] – in the `location` field
     #
     #
     #
@@ -4780,6 +5028,10 @@ module Aws::BedrockAgentRuntime
     #   Specifies the location of a document in a custom data source.
     #   @return [Types::RetrievalResultCustomDocumentLocation]
     #
+    # @!attribute [rw] kendra_document_location
+    #   The location of a document in Amazon Kendra.
+    #   @return [Types::RetrievalResultKendraDocumentLocation]
+    #
     # @!attribute [rw] s3_location
     #   The S3 data source location.
     #   @return [Types::RetrievalResultS3Location]
@@ -4792,6 +5044,11 @@ module Aws::BedrockAgentRuntime
     #   The SharePoint data source location.
     #   @return [Types::RetrievalResultSharePointLocation]
     #
+    # @!attribute [rw] sql_location
+    #   Specifies information about the SQL query used to retrieve the
+    #   result.
+    #   @return [Types::RetrievalResultSqlLocation]
+    #
     # @!attribute [rw] type
     #   The type of data source location.
     #   @return [String]
@@ -4805,9 +5062,11 @@ module Aws::BedrockAgentRuntime
     class RetrievalResultLocation < Struct.new(
       :confluence_location,
       :custom_document_location,
+      :kendra_document_location,
       :s3_location,
       :salesforce_location,
       :share_point_location,
+      :sql_location,
       :type,
       :web_location)
       SENSITIVE = []
@@ -4870,6 +5129,20 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains information about the SQL query used to retrieve the result.
+    #
+    # @!attribute [rw] query
+    #   The SQL query used to retrieve the result.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultSqlLocation AWS API Documentation
+    #
+    class RetrievalResultSqlLocation < Struct.new(
+      :query)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The web URL/URLs data source location.
     #
     # @!attribute [rw] url
@@ -5659,6 +5932,40 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains configurations for transforming text to SQL.
+    #
+    # @!attribute [rw] knowledge_base_configuration
+    #   Specifies configurations for a knowledge base to use in
+    #   transformation.
+    #   @return [Types::TextToSqlKnowledgeBaseConfiguration]
+    #
+    # @!attribute [rw] type
+    #   The type of resource to use in transformation.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/TextToSqlConfiguration AWS API Documentation
+    #
+    class TextToSqlConfiguration < Struct.new(
+      :knowledge_base_configuration,
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains configurations for a knowledge base to use in transformation.
+    #
+    # @!attribute [rw] knowledge_base_arn
+    #   The ARN of the knowledge base
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/TextToSqlKnowledgeBaseConfiguration AWS API Documentation
+    #
+    class TextToSqlKnowledgeBaseConfiguration < Struct.new(
+      :knowledge_base_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The number of requests exceeds the limit. Resubmit your request later.
     #
     # @!attribute [rw] message
@@ -5803,6 +6110,26 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains configurations for transforming the natural language query
+    # into SQL.
+    #
+    # @!attribute [rw] mode
+    #   The mode of the transformation.
+    #   @return [String]
+    #
+    # @!attribute [rw] text_to_sql_configuration
+    #   Specifies configurations for transforming text to SQL.
+    #   @return [Types::TextToSqlConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/TransformationConfiguration AWS API Documentation
+    #
+    class TransformationConfiguration < Struct.new(
+      :mode,
+      :text_to_sql_configuration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information of the usage of the foundation model.
     #
     # @!attribute [rw] input_tokens
@@ -6004,6 +6331,7 @@ module Aws::BedrockAgentRuntime
           :dependency_failed_exception,
           :files,
           :internal_server_exception,
+          :model_not_ready_exception,
           :resource_not_found_exception,
           :return_control,
           :service_quota_exceeded_exception,

data/lib/aws-sdk-bedrockagentruntime.rb

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