aws-sdk-bedrockruntime 1.63.0 → 1.67.0

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

@@ -43,6 +43,46 @@ module Aws::BedrockRuntime
     #
     class AnyToolChoice < Aws::EmptyStructure; end
 
+    # Details about the specific guardrail that was applied during this
+    # assessment, including its identifier, version, ARN, origin, and
+    # ownership information.
+    #
+    # @!attribute [rw] guardrail_id
+    #   The unique ID of the guardrail that was applied.
+    #   @return [String]
+    #
+    # @!attribute [rw] guardrail_version
+    #   The version of the guardrail that was applied.
+    #   @return [String]
+    #
+    # @!attribute [rw] guardrail_arn
+    #   The ARN of the guardrail that was applied.
+    #   @return [String]
+    #
+    # @!attribute [rw] guardrail_origin
+    #   The origin of how the guardrail was applied. This can be either
+    #   requested at the API level or enforced at the account or
+    #   organization level as a default guardrail.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] guardrail_ownership
+    #   The ownership type of the guardrail, indicating whether it is owned
+    #   by the requesting account or is a cross-account guardrail shared
+    #   from another AWS account.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/AppliedGuardrailDetails AWS API Documentation
+    #
+    class AppliedGuardrailDetails < Struct.new(
+      :guardrail_id,
+      :guardrail_version,
+      :guardrail_arn,
+      :guardrail_origin,
+      :guardrail_ownership)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] guardrail_identifier
     #   The guardrail identifier used in the request to apply the guardrail.
     #   @return [String]
@@ -292,6 +332,11 @@ module Aws::BedrockRuntime
     #   The title or identifier of the source document being cited.
     #   @return [String]
     #
+    # @!attribute [rw] source
+    #   The source from the original search result that provided the cited
+    #   content.
+    #   @return [String]
+    #
     # @!attribute [rw] source_content
     #   The specific content from the source document that was referenced or
     #   cited in the generated response.
@@ -307,6 +352,7 @@ module Aws::BedrockRuntime
     #
     class Citation < Struct.new(
       :title,
+      :source,
       :source_content,
       :location)
       SENSITIVE = []
@@ -367,6 +413,12 @@ module Aws::BedrockRuntime
     #   logical chunks.
     #   @return [Types::DocumentChunkLocation]
     #
+    # @!attribute [rw] search_result_location
+    #   The search result location where the cited content is found,
+    #   including the search result index and block positions within the
+    #   content array.
+    #   @return [Types::SearchResultLocation]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationLocation AWS API Documentation
     #
     class CitationLocation < Struct.new(
@@ -374,6 +426,7 @@ module Aws::BedrockRuntime
       :document_char,
       :document_page,
       :document_chunk,
+      :search_result_location,
       :unknown)
       SENSITIVE = []
       include Aws::Structure
@@ -383,6 +436,7 @@ module Aws::BedrockRuntime
       class DocumentChar < CitationLocation; end
       class DocumentPage < CitationLocation; end
       class DocumentChunk < CitationLocation; end
+      class SearchResultLocation < CitationLocation; end
       class Unknown < CitationLocation; end
     end
 
@@ -478,6 +532,11 @@ module Aws::BedrockRuntime
     #   The title or identifier of the source document being cited.
     #   @return [String]
     #
+    # @!attribute [rw] source
+    #   The source from the original search result that provided the cited
+    #   content.
+    #   @return [String]
+    #
     # @!attribute [rw] source_content
     #   The specific content from the source document that was referenced or
     #   cited in the generated response.
@@ -494,6 +553,7 @@ module Aws::BedrockRuntime
     #
     class CitationsDelta < Struct.new(
       :title,
+      :source,
       :source_content,
       :location)
       SENSITIVE = []
@@ -578,6 +638,10 @@ module Aws::BedrockRuntime
     #   and source documents.
     #   @return [Types::CitationsContentBlock]
     #
+    # @!attribute [rw] search_result
+    #   Search result to include in the message.
+    #   @return [Types::SearchResultBlock]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ContentBlock AWS API Documentation
     #
     class ContentBlock < Struct.new(
@@ -591,6 +655,7 @@ module Aws::BedrockRuntime
       :cache_point,
       :reasoning_content,
       :citations_content,
+      :search_result,
       :unknown)
       SENSITIVE = [:reasoning_content]
       include Aws::Structure
@@ -606,6 +671,7 @@ module Aws::BedrockRuntime
       class CachePoint < ContentBlock; end
       class ReasoningContent < ContentBlock; end
       class CitationsContent < ContentBlock; end
+      class SearchResult < ContentBlock; end
       class Unknown < ContentBlock; end
     end
 
@@ -906,6 +972,11 @@ module Aws::BedrockRuntime
     #   Model performance settings for the request.
     #   @return [Types::PerformanceConfiguration]
     #
+    # @!attribute [rw] service_tier
+    #   Specifies the processing tier configuration used for serving the
+    #   request.
+    #   @return [Types::ServiceTier]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseRequest AWS API Documentation
     #
     class ConverseRequest < Struct.new(
@@ -919,7 +990,8 @@ module Aws::BedrockRuntime
       :prompt_variables,
       :additional_model_response_field_paths,
       :request_metadata,
-      :performance_config)
+      :performance_config,
+      :service_tier)
       SENSITIVE = [:prompt_variables, :request_metadata]
       include Aws::Structure
     end
@@ -955,6 +1027,11 @@ module Aws::BedrockRuntime
     #   Model performance settings for the request.
     #   @return [Types::PerformanceConfiguration]
     #
+    # @!attribute [rw] service_tier
+    #   Specifies the processing tier configuration used for serving the
+    #   request.
+    #   @return [Types::ServiceTier]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseResponse AWS API Documentation
     #
     class ConverseResponse < Struct.new(
@@ -964,7 +1041,8 @@ module Aws::BedrockRuntime
       :metrics,
       :additional_model_response_fields,
       :trace,
-      :performance_config)
+      :performance_config,
+      :service_tier)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -993,6 +1071,11 @@ module Aws::BedrockRuntime
     #   event.
     #   @return [Types::PerformanceConfiguration]
     #
+    # @!attribute [rw] service_tier
+    #   Specifies the processing tier configuration used for serving the
+    #   request.
+    #   @return [Types::ServiceTier]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseStreamMetadataEvent AWS API Documentation
     #
     class ConverseStreamMetadataEvent < Struct.new(
@@ -1000,6 +1083,7 @@ module Aws::BedrockRuntime
       :metrics,
       :trace,
       :performance_config,
+      :service_tier,
       :event_type)
       SENSITIVE = []
       include Aws::Structure
@@ -1143,6 +1227,11 @@ module Aws::BedrockRuntime
     #   Model performance settings for the request.
     #   @return [Types::PerformanceConfiguration]
     #
+    # @!attribute [rw] service_tier
+    #   Specifies the processing tier configuration used for serving the
+    #   request.
+    #   @return [Types::ServiceTier]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseStreamRequest AWS API Documentation
     #
     class ConverseStreamRequest < Struct.new(
@@ -1156,7 +1245,8 @@ module Aws::BedrockRuntime
       :prompt_variables,
       :additional_model_response_field_paths,
       :request_metadata,
-      :performance_config)
+      :performance_config,
+      :service_tier)
       SENSITIVE = [:prompt_variables, :request_metadata]
       include Aws::Structure
     end
@@ -1213,11 +1303,25 @@ module Aws::BedrockRuntime
     #   provided.
     #   @return [Array<Types::SystemContentBlock>]
     #
+    # @!attribute [rw] tool_config
+    #   The toolConfig of Converse input request to count tokens for.
+    #   Configuration information for the tools that the model can use when
+    #   generating a response.
+    #   @return [Types::ToolConfiguration]
+    #
+    # @!attribute [rw] additional_model_request_fields
+    #   The additionalModelRequestFields of Converse input request to count
+    #   tokens for. Use this field when you want to pass additional
+    #   parameters that the model supports.
+    #   @return [Hash,Array,String,Numeric,Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseTokensRequest AWS API Documentation
     #
     class ConverseTokensRequest < Struct.new(
       :messages,
-      :system)
+      :system,
+      :tool_config,
+      :additional_model_request_fields)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1631,6 +1735,12 @@ module Aws::BedrockRuntime
     #   The invocation metrics for the guardrail assessment.
     #   @return [Types::GuardrailInvocationMetrics]
     #
+    # @!attribute [rw] applied_guardrail_details
+    #   Details about the specific guardrail that was applied during this
+    #   assessment, including its identifier, version, ARN, origin, and
+    #   ownership information.
+    #   @return [Types::AppliedGuardrailDetails]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/GuardrailAssessment AWS API Documentation
     #
     class GuardrailAssessment < Struct.new(
@@ -1640,7 +1750,8 @@ module Aws::BedrockRuntime
       :sensitive_information_policy,
       :contextual_grounding_policy,
       :automated_reasoning_policy,
-      :invocation_metrics)
+      :invocation_metrics,
+      :applied_guardrail_details)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3047,6 +3158,10 @@ module Aws::BedrockRuntime
     #   Model performance settings for the request.
     #   @return [String]
     #
+    # @!attribute [rw] service_tier
+    #   Specifies the processing tier type used for serving the request.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelRequest AWS API Documentation
     #
     class InvokeModelRequest < Struct.new(
@@ -3057,7 +3172,8 @@ module Aws::BedrockRuntime
       :trace,
       :guardrail_identifier,
       :guardrail_version,
-      :performance_config_latency)
+      :performance_config_latency,
+      :service_tier)
       SENSITIVE = [:body]
       include Aws::Structure
     end
@@ -3081,12 +3197,17 @@ module Aws::BedrockRuntime
     #   Model performance settings for the request.
     #   @return [String]
     #
+    # @!attribute [rw] service_tier
+    #   Specifies the processing tier type used for serving the request.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelResponse AWS API Documentation
     #
     class InvokeModelResponse < Struct.new(
       :body,
       :content_type,
-      :performance_config_latency)
+      :performance_config_latency,
+      :service_tier)
       SENSITIVE = [:body]
       include Aws::Structure
     end
@@ -3246,6 +3367,10 @@ module Aws::BedrockRuntime
     #   Model performance settings for the request.
     #   @return [String]
     #
+    # @!attribute [rw] service_tier
+    #   Specifies the processing tier type used for serving the request.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelWithResponseStreamRequest AWS API Documentation
     #
     class InvokeModelWithResponseStreamRequest < Struct.new(
@@ -3256,7 +3381,8 @@ module Aws::BedrockRuntime
       :trace,
       :guardrail_identifier,
       :guardrail_version,
-      :performance_config_latency)
+      :performance_config_latency,
+      :service_tier)
       SENSITIVE = [:body]
       include Aws::Structure
     end
@@ -3279,12 +3405,17 @@ module Aws::BedrockRuntime
     #   Model performance settings for the request.
     #   @return [String]
     #
+    # @!attribute [rw] service_tier
+    #   Specifies the processing tier type used for serving the request.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelWithResponseStreamResponse AWS API Documentation
     #
     class InvokeModelWithResponseStreamResponse < Struct.new(
       :body,
       :content_type,
-      :performance_config_latency)
+      :performance_config_latency,
+      :service_tier)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3708,6 +3839,84 @@ module Aws::BedrockRuntime
       include Aws::Structure
     end
 
+    # A search result block that enables natural citations with proper
+    # source attribution for retrieved content.
+    #
+    # <note markdown="1"> This field is only supported by Anthropic Claude Opus 4.1, Opus 4,
+    # Sonnet 4.5, Sonnet 4, Sonnet 3.7, and 3.5 Haiku models.
+    #
+    #  </note>
+    #
+    # @!attribute [rw] source
+    #   The source URL or identifier for the content.
+    #   @return [String]
+    #
+    # @!attribute [rw] title
+    #   A descriptive title for the search result.
+    #   @return [String]
+    #
+    # @!attribute [rw] content
+    #   An array of search result content block.
+    #   @return [Array<Types::SearchResultContentBlock>]
+    #
+    # @!attribute [rw] citations
+    #   Configuration setting for citations
+    #   @return [Types::CitationsConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/SearchResultBlock AWS API Documentation
+    #
+    class SearchResultBlock < Struct.new(
+      :source,
+      :title,
+      :content,
+      :citations)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A block within a search result that contains the content.
+    #
+    # @!attribute [rw] text
+    #   The actual text content
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/SearchResultContentBlock AWS API Documentation
+    #
+    class SearchResultContentBlock < Struct.new(
+      :text)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Specifies a search result location within the content array, providing
+    # positioning information for cited content using search result index
+    # and block positions.
+    #
+    # @!attribute [rw] search_result_index
+    #   The index of the search result content block where the cited content
+    #   is found.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] start
+    #   The starting position in the content array where the cited content
+    #   begins.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end
+    #   The ending position in the content array where the cited content
+    #   ends.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/SearchResultLocation AWS API Documentation
+    #
+    class SearchResultLocation < Struct.new(
+      :search_result_index,
+      :start,
+      :end)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Your request exceeds the service quota for your account. You can view
     # your quotas at [Viewing service quotas][1]. You can resubmit your
     # request later.
@@ -3727,6 +3936,21 @@ module Aws::BedrockRuntime
       include Aws::Structure
     end
 
+    # Specifies the processing tier configuration used for serving the
+    # request.
+    #
+    # @!attribute [rw] type
+    #   Specifies the processing tier type used for serving the request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ServiceTier AWS API Documentation
+    #
+    class ServiceTier < Struct.new(
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The service isn't currently available. For troubleshooting this
     # error, see [ServiceUnavailable][1] in the Amazon Bedrock User Guide
     #
@@ -4219,6 +4443,10 @@ module Aws::BedrockRuntime
     #   A tool result that is video.
     #   @return [Types::VideoBlock]
     #
+    # @!attribute [rw] search_result
+    #   A tool result that is a search result.
+    #   @return [Types::SearchResultBlock]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolResultContentBlock AWS API Documentation
     #
     class ToolResultContentBlock < Struct.new(
@@ -4227,6 +4455,7 @@ module Aws::BedrockRuntime
       :image,
       :document,
       :video,
+      :search_result,
       :unknown)
       SENSITIVE = []
       include Aws::Structure
@@ -4237,6 +4466,7 @@ module Aws::BedrockRuntime
       class Image < ToolResultContentBlock; end
       class Document < ToolResultContentBlock; end
       class Video < ToolResultContentBlock; end
+      class SearchResult < ToolResultContentBlock; end
       class Unknown < ToolResultContentBlock; end
     end
 

data/lib/aws-sdk-bedrockruntime.rb

@@ -27,6 +27,22 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:bedrockruntime)
 #
 # See {Client} for more information.
 #
+# # Async Client
+#
+# The {AsyncClient} class provides one asynchronous method for each API operation.
+# Operation methods each accept a hash of request parameters and return an async
+# response. For streaming operations, you can signal input events and register
+# output event callbacks before waiting on the response.
+#
+#     bedrock_runtime = Aws::BedrockRuntime::AsyncClient.new
+#     resp = bedrock_runtime.apply_guardrail(
+#       # params and input stream
+#      ) do |output_stream|
+#       # register callbacks for events
+#     end
+#
+# See {AsyncClient} for more information.
+#
 # # Errors
 #
 # Errors returned from Amazon Bedrock Runtime are defined in the
@@ -57,7 +73,7 @@ module Aws::BedrockRuntime
   autoload :AsyncClient, 'aws-sdk-bedrockruntime/async_client'
   autoload :EventStreams, 'aws-sdk-bedrockruntime/event_streams'
 
-  GEM_VERSION = '1.63.0'
+  GEM_VERSION = '1.67.0'
 
 end