aws-sdk-bedrock 1.52.0 → 1.54.0

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

@@ -283,6 +283,67 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # @!attribute [rw] model_deployment_name
+    #   The name for the custom model deployment. The name must be unique
+    #   within your Amazon Web Services account and Region.
+    #   @return [String]
+    #
+    # @!attribute [rw] model_arn
+    #   The Amazon Resource Name (ARN) of the custom model to deploy for
+    #   on-demand inference. The custom model must be in the `Active` state.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   A description for the custom model deployment to help you identify
+    #   its purpose.
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   Tags to assign to the custom model deployment. You can use tags to
+    #   organize and track your Amazon Web Services resources for cost
+    #   allocation and management purposes.
+    #   @return [Array<Types::Tag>]
+    #
+    # @!attribute [rw] client_request_token
+    #   A unique, case-sensitive identifier to ensure that the operation
+    #   completes no more than one time. If this token matches a previous
+    #   request, Amazon Bedrock ignores the request, but does not return an
+    #   error. For more information, see [Ensuring idempotency][1].
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-idempotency.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelDeploymentRequest AWS API Documentation
+    #
+    class CreateCustomModelDeploymentRequest < Struct.new(
+      :model_deployment_name,
+      :model_arn,
+      :description,
+      :tags,
+      :client_request_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] custom_model_deployment_arn
+    #   The Amazon Resource Name (ARN) of the custom model deployment. Use
+    #   this ARN as the `modelId` parameter when invoking the model with the
+    #   `InvokeModel` or `Converse` operations.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelDeploymentResponse AWS API Documentation
+    #
+    class CreateCustomModelDeploymentResponse < Struct.new(
+      :custom_model_deployment_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] model_name
     #   A unique name for the custom model.
     #   @return [String]
@@ -1404,6 +1465,55 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Contains summary information about a custom model deployment,
+    # including its ARN, name, status, and associated custom model.
+    #
+    # @!attribute [rw] custom_model_deployment_arn
+    #   The Amazon Resource Name (ARN) of the custom model deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] custom_model_deployment_name
+    #   The name of the custom model deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] model_arn
+    #   The Amazon Resource Name (ARN) of the custom model associated with
+    #   this deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] created_at
+    #   The date and time when the custom model deployment was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] status
+    #   The status of the custom model deployment. Possible values are
+    #   `CREATING`, `ACTIVE`, and `FAILED`.
+    #   @return [String]
+    #
+    # @!attribute [rw] last_updated_at
+    #   The date and time when the custom model deployment was last
+    #   modified.
+    #   @return [Time]
+    #
+    # @!attribute [rw] failure_message
+    #   If the deployment status is `FAILED`, this field contains a message
+    #   describing the failure reason.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomModelDeploymentSummary AWS API Documentation
+    #
+    class CustomModelDeploymentSummary < Struct.new(
+      :custom_model_deployment_arn,
+      :custom_model_deployment_name,
+      :model_arn,
+      :created_at,
+      :status,
+      :last_updated_at,
+      :failure_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Summary information for a custom model.
     #
     # @!attribute [rw] model_arn
@@ -1543,6 +1653,23 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # @!attribute [rw] custom_model_deployment_identifier
+    #   The Amazon Resource Name (ARN) or name of the custom model
+    #   deployment to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelDeploymentRequest AWS API Documentation
+    #
+    class DeleteCustomModelDeploymentRequest < Struct.new(
+      :custom_model_deployment_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelDeploymentResponse AWS API Documentation
+    #
+    class DeleteCustomModelDeploymentResponse < Aws::EmptyStructure; end
+
     # @!attribute [rw] model_identifier
     #   Name of the model to delete.
     #   @return [String]
@@ -2387,6 +2514,24 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Specifies a field to be used during the reranking process in a
+    # Knowledge Base vector search. This structure identifies metadata
+    # fields that should be considered when reordering search results to
+    # improve relevance.
+    #
+    # @!attribute [rw] field_name
+    #   The name of the metadata field to be used during the reranking
+    #   process.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FieldForReranking AWS API Documentation
+    #
+    class FieldForReranking < Struct.new(
+      :field_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies the name of the metadata attribute/field to apply filters.
     # You must match the name of the attribute/field in your data
     # source/document metadata.
@@ -2579,6 +2724,77 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # @!attribute [rw] custom_model_deployment_identifier
+    #   The Amazon Resource Name (ARN) or name of the custom model
+    #   deployment to retrieve information about.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelDeploymentRequest AWS API Documentation
+    #
+    class GetCustomModelDeploymentRequest < Struct.new(
+      :custom_model_deployment_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] custom_model_deployment_arn
+    #   The Amazon Resource Name (ARN) of the custom model deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] model_deployment_name
+    #   The name of the custom model deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] model_arn
+    #   The Amazon Resource Name (ARN) of the custom model associated with
+    #   this deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] created_at
+    #   The date and time when the custom model deployment was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] status
+    #   The status of the custom model deployment. Possible values are:
+    #
+    #   * `CREATING` - The deployment is being set up and prepared for
+    #     inference.
+    #
+    #   * `ACTIVE` - The deployment is ready and available for inference
+    #     requests.
+    #
+    #   * `FAILED` - The deployment failed to be created or became
+    #     unavailable.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The description of the custom model deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_message
+    #   If the deployment status is `FAILED`, this field contains a message
+    #   describing the failure reason.
+    #   @return [String]
+    #
+    # @!attribute [rw] last_updated_at
+    #   The date and time when the custom model deployment was last updated.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelDeploymentResponse AWS API Documentation
+    #
+    class GetCustomModelDeploymentResponse < Struct.new(
+      :custom_model_deployment_arn,
+      :model_deployment_name,
+      :model_arn,
+      :created_at,
+      :status,
+      :description,
+      :failure_message,
+      :last_updated_at)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] model_identifier
     #   Name or Amazon Resource Name (ARN) of the custom model.
     #   @return [String]
@@ -5535,6 +5751,32 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Configuration for implicit filtering in Knowledge Base vector
+    # searches. Implicit filtering allows you to automatically filter search
+    # results based on metadata attributes without requiring explicit filter
+    # expressions in each query.
+    #
+    # @!attribute [rw] metadata_attributes
+    #   A list of metadata attribute schemas that define the structure and
+    #   properties of metadata fields used for implicit filtering. Each
+    #   attribute defines a key, type, and optional description.
+    #   @return [Array<Types::MetadataAttributeSchema>]
+    #
+    # @!attribute [rw] model_arn
+    #   The Amazon Resource Name (ARN) of the foundation model used for
+    #   implicit filtering. This model processes the query to extract
+    #   relevant filtering criteria.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ImplicitFilterConfiguration AWS API Documentation
+    #
+    class ImplicitFilterConfiguration < Struct.new(
+      :metadata_attributes,
+      :model_arn)
+      SENSITIVE = [:metadata_attributes]
+      include Aws::Structure
+    end
+
     # Information about the imported model.
     #
     # @!attribute [rw] model_arn
@@ -5860,12 +6102,27 @@ module Aws::Bedrock
     #   base data sources before returning results.
     #   @return [Types::RetrievalFilter]
     #
+    # @!attribute [rw] implicit_filter_configuration
+    #   Configuration for implicit filtering in Knowledge Base vector
+    #   searches. This allows the system to automatically apply filters
+    #   based on the query context without requiring explicit filter
+    #   expressions.
+    #   @return [Types::ImplicitFilterConfiguration]
+    #
+    # @!attribute [rw] reranking_configuration
+    #   Configuration for reranking search results in Knowledge Base vector
+    #   searches. Reranking improves search relevance by reordering initial
+    #   vector search results using more sophisticated relevance models.
+    #   @return [Types::VectorSearchRerankingConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
     #
     class KnowledgeBaseVectorSearchConfiguration < Struct.new(
       :number_of_results,
       :override_search_type,
-      :filter)
+      :filter,
+      :implicit_filter_configuration,
+      :reranking_configuration)
       SENSITIVE = [:filter]
       include Aws::Structure
     end
@@ -5884,6 +6141,81 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # @!attribute [rw] created_before
+    #   Filters deployments created before the specified date and time.
+    #   @return [Time]
+    #
+    # @!attribute [rw] created_after
+    #   Filters deployments created after the specified date and time.
+    #   @return [Time]
+    #
+    # @!attribute [rw] name_contains
+    #   Filters deployments whose names contain the specified string.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return in a single call.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of results. Use this token to retrieve
+    #   additional results when the response is truncated.
+    #   @return [String]
+    #
+    # @!attribute [rw] sort_by
+    #   The field to sort the results by. The only supported value is
+    #   `CreationTime`.
+    #   @return [String]
+    #
+    # @!attribute [rw] sort_order
+    #   The sort order for the results. Valid values are `Ascending` and
+    #   `Descending`. Default is `Descending`.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_equals
+    #   Filters deployments by status. Valid values are `CREATING`,
+    #   `ACTIVE`, and `FAILED`.
+    #   @return [String]
+    #
+    # @!attribute [rw] model_arn_equals
+    #   Filters deployments by the Amazon Resource Name (ARN) of the
+    #   associated custom model.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelDeploymentsRequest AWS API Documentation
+    #
+    class ListCustomModelDeploymentsRequest < Struct.new(
+      :created_before,
+      :created_after,
+      :name_contains,
+      :max_results,
+      :next_token,
+      :sort_by,
+      :sort_order,
+      :status_equals,
+      :model_arn_equals)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   The token for the next set of results. This value is null when there
+    #   are no more results to return.
+    #   @return [String]
+    #
+    # @!attribute [rw] model_deployment_summaries
+    #   A list of custom model deployment summaries.
+    #   @return [Array<Types::CustomModelDeploymentSummary>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelDeploymentsResponse AWS API Documentation
+    #
+    class ListCustomModelDeploymentsResponse < Struct.new(
+      :next_token,
+      :model_deployment_summaries)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] creation_time_before
     #   Return custom models created before the specified time.
     #   @return [Time]
@@ -7020,6 +7352,62 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Defines the schema for a metadata attribute used in Knowledge Base
+    # vector searches. Metadata attributes provide additional context for
+    # documents and can be used for filtering and reranking search results.
+    #
+    # @!attribute [rw] key
+    #   The unique identifier for the metadata attribute. This key is used
+    #   to reference the attribute in filter expressions and reranking
+    #   configurations.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   The data type of the metadata attribute. The type determines how the
+    #   attribute can be used in filter expressions and reranking.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   An optional description of the metadata attribute that provides
+    #   additional context about its purpose and usage.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/MetadataAttributeSchema AWS API Documentation
+    #
+    class MetadataAttributeSchema < Struct.new(
+      :key,
+      :type,
+      :description)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Configuration for how metadata should be used during the reranking
+    # process in Knowledge Base vector searches. This determines which
+    # metadata fields are included or excluded when reordering search
+    # results.
+    #
+    # @!attribute [rw] selection_mode
+    #   The mode for selecting which metadata fields to include in the
+    #   reranking process. Valid values are ALL (use all available metadata
+    #   fields) or SELECTIVE (use only specified fields).
+    #   @return [String]
+    #
+    # @!attribute [rw] selective_mode_configuration
+    #   Configuration for selective mode, which allows you to explicitly
+    #   include or exclude specific metadata fields during reranking. This
+    #   is only used when selectionMode is set to SELECTIVE.
+    #   @return [Types::RerankingMetadataSelectiveModeConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/MetadataConfigurationForReranking AWS API Documentation
+    #
+    class MetadataConfigurationForReranking < Struct.new(
+      :selection_mode,
+      :selective_mode_configuration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains details about each model copy job.
     #
     # This data type is used in the following API operations:
@@ -7986,6 +8374,43 @@ module Aws::Bedrock
       class Unknown < RequestMetadataFilters; end
     end
 
+    # Configuration for selectively including or excluding metadata fields
+    # during the reranking process. This allows you to control which
+    # metadata attributes are considered when reordering search results.
+    #
+    # @note RerankingMetadataSelectiveModeConfiguration is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note RerankingMetadataSelectiveModeConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RerankingMetadataSelectiveModeConfiguration corresponding to the set member.
+    #
+    # @!attribute [rw] fields_to_include
+    #   A list of metadata field names to explicitly include in the
+    #   reranking process. Only these fields will be considered when
+    #   reordering search results. This parameter cannot be used together
+    #   with fieldsToExclude.
+    #   @return [Array<Types::FieldForReranking>]
+    #
+    # @!attribute [rw] fields_to_exclude
+    #   A list of metadata field names to explicitly exclude from the
+    #   reranking process. All metadata fields except these will be
+    #   considered when reordering search results. This parameter cannot be
+    #   used together with fieldsToInclude.
+    #   @return [Array<Types::FieldForReranking>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/RerankingMetadataSelectiveModeConfiguration AWS API Documentation
+    #
+    class RerankingMetadataSelectiveModeConfiguration < Struct.new(
+      :fields_to_include,
+      :fields_to_exclude,
+      :unknown)
+      SENSITIVE = [:fields_to_include, :fields_to_exclude]
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
+      class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
+      class Unknown < RerankingMetadataSelectiveModeConfiguration; end
+    end
+
     # The specified resource Amazon Resource Name (ARN) was not found. Check
     # the Amazon Resource Name (ARN) and try your request again.
     #
@@ -8978,6 +9403,90 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Configuration for using Amazon Bedrock foundation models to rerank
+    # Knowledge Base vector search results. This enables more sophisticated
+    # relevance ranking using large language models.
+    #
+    # @!attribute [rw] model_configuration
+    #   Configuration for the Amazon Bedrock foundation model used for
+    #   reranking. This includes the model ARN and any additional request
+    #   fields required by the model.
+    #   @return [Types::VectorSearchBedrockRerankingModelConfiguration]
+    #
+    # @!attribute [rw] number_of_reranked_results
+    #   The maximum number of results to rerank. This limits how many of the
+    #   initial vector search results will be processed by the reranking
+    #   model. A smaller number improves performance but may exclude
+    #   potentially relevant results.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] metadata_configuration
+    #   Configuration for how document metadata should be used during the
+    #   reranking process. This determines which metadata fields are
+    #   included when reordering search results.
+    #   @return [Types::MetadataConfigurationForReranking]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchBedrockRerankingConfiguration AWS API Documentation
+    #
+    class VectorSearchBedrockRerankingConfiguration < Struct.new(
+      :model_configuration,
+      :number_of_reranked_results,
+      :metadata_configuration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Configuration for the Amazon Bedrock foundation model used for
+    # reranking vector search results. This specifies which model to use and
+    # any additional parameters required by the model.
+    #
+    # @!attribute [rw] model_arn
+    #   The Amazon Resource Name (ARN) of the foundation model to use for
+    #   reranking. This model processes the query and search results to
+    #   determine a more relevant ordering.
+    #   @return [String]
+    #
+    # @!attribute [rw] additional_model_request_fields
+    #   A list of additional fields to include in the model request during
+    #   reranking. These fields provide extra context or configuration
+    #   options specific to the selected foundation model.
+    #   @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchBedrockRerankingModelConfiguration AWS API Documentation
+    #
+    class VectorSearchBedrockRerankingModelConfiguration < Struct.new(
+      :model_arn,
+      :additional_model_request_fields)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Configuration for reranking vector search results to improve
+    # relevance. Reranking applies additional relevance models to reorder
+    # the initial vector search results based on more sophisticated
+    # criteria.
+    #
+    # @!attribute [rw] type
+    #   The type of reranking to apply to vector search results. Currently,
+    #   the only supported value is BEDROCK, which uses Amazon Bedrock
+    #   foundation models for reranking.
+    #   @return [String]
+    #
+    # @!attribute [rw] bedrock_reranking_configuration
+    #   Configuration for using Amazon Bedrock foundation models to rerank
+    #   search results. This is required when the reranking type is set to
+    #   BEDROCK.
+    #   @return [Types::VectorSearchBedrockRerankingConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchRerankingConfiguration AWS API Documentation
+    #
+    class VectorSearchRerankingConfiguration < Struct.new(
+      :type,
+      :bedrock_reranking_configuration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The configuration of a virtual private cloud (VPC). For more
     # information, see [Protect your data using Amazon Virtual Private Cloud
     # and Amazon Web Services PrivateLink][1].

data/lib/aws-sdk-bedrock.rb

@@ -55,7 +55,7 @@ module Aws::Bedrock
   autoload :EndpointProvider, 'aws-sdk-bedrock/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-bedrock/endpoints'
 
-  GEM_VERSION = '1.52.0'
+  GEM_VERSION = '1.54.0'
 
 end