types-boto3-full 1.38.46__py3-none-any.whl → 1.39.0__py3-none-any.whl

types_boto3_bedrock/literals.py

@@ -25,6 +25,7 @@ else:
 __all__ = (
     "AgreementStatusType",
     "ApplicationTypeType",
+    "AttributeTypeType",
     "AuthorizationStatusType",
     "BedrockServiceName",
     "CommitmentDurationType",
@@ -83,6 +84,7 @@ __all__ = (
     "QueryTransformationTypeType",
     "RegionAvailabilityType",
     "RegionName",
+    "RerankingMetadataSelectionModeType",
     "ResourceServiceName",
     "RetrieveAndGenerateTypeType",
     "S3InputFormatType",
@@ -93,11 +95,13 @@ __all__ = (
     "SortModelsByType",
     "SortOrderType",
     "StatusType",
+    "VectorSearchRerankingConfigurationTypeType",
 )
 
 
 AgreementStatusType = Literal["AVAILABLE", "ERROR", "NOT_AVAILABLE", "PENDING"]
 ApplicationTypeType = Literal["ModelEvaluation", "RagEvaluation"]
+AttributeTypeType = Literal["BOOLEAN", "NUMBER", "STRING", "STRING_LIST"]
 AuthorizationStatusType = Literal["AUTHORIZED", "NOT_AUTHORIZED"]
 CommitmentDurationType = Literal["OneMonth", "SixMonths"]
 CustomizationTypeType = Literal["CONTINUED_PRE_TRAINING", "DISTILLATION", "FINE_TUNING", "IMPORTED"]
@@ -206,6 +210,7 @@ PromptRouterTypeType = Literal["custom", "default"]
 ProvisionedModelStatusType = Literal["Creating", "Failed", "InService", "Updating"]
 QueryTransformationTypeType = Literal["QUERY_DECOMPOSITION"]
 RegionAvailabilityType = Literal["AVAILABLE", "NOT_AVAILABLE"]
+RerankingMetadataSelectionModeType = Literal["ALL", "SELECTIVE"]
 RetrieveAndGenerateTypeType = Literal["EXTERNAL_SOURCES", "KNOWLEDGE_BASE"]
 S3InputFormatType = Literal["JSONL"]
 SearchTypeType = Literal["HYBRID", "SEMANTIC"]
@@ -214,6 +219,7 @@ SortJobsByType = Literal["CreationTime"]
 SortModelsByType = Literal["CreationTime"]
 SortOrderType = Literal["Ascending", "Descending"]
 StatusType = Literal["INCOMPATIBLE_ENDPOINT", "REGISTERED"]
+VectorSearchRerankingConfigurationTypeType = Literal["BEDROCK_RERANKING_MODEL"]
 BedrockServiceName = Literal["bedrock"]
 ServiceName = Literal[
     "accessanalyzer",

types_boto3_bedrock/literals.pyi

@@ -24,6 +24,7 @@ else:
 __all__ = (
     "AgreementStatusType",
     "ApplicationTypeType",
+    "AttributeTypeType",
     "AuthorizationStatusType",
     "BedrockServiceName",
     "CommitmentDurationType",
@@ -82,6 +83,7 @@ __all__ = (
     "QueryTransformationTypeType",
     "RegionAvailabilityType",
     "RegionName",
+    "RerankingMetadataSelectionModeType",
     "ResourceServiceName",
     "RetrieveAndGenerateTypeType",
     "S3InputFormatType",
@@ -92,10 +94,12 @@ __all__ = (
     "SortModelsByType",
     "SortOrderType",
     "StatusType",
+    "VectorSearchRerankingConfigurationTypeType",
 )
 
 AgreementStatusType = Literal["AVAILABLE", "ERROR", "NOT_AVAILABLE", "PENDING"]
 ApplicationTypeType = Literal["ModelEvaluation", "RagEvaluation"]
+AttributeTypeType = Literal["BOOLEAN", "NUMBER", "STRING", "STRING_LIST"]
 AuthorizationStatusType = Literal["AUTHORIZED", "NOT_AUTHORIZED"]
 CommitmentDurationType = Literal["OneMonth", "SixMonths"]
 CustomizationTypeType = Literal["CONTINUED_PRE_TRAINING", "DISTILLATION", "FINE_TUNING", "IMPORTED"]
@@ -204,6 +208,7 @@ PromptRouterTypeType = Literal["custom", "default"]
 ProvisionedModelStatusType = Literal["Creating", "Failed", "InService", "Updating"]
 QueryTransformationTypeType = Literal["QUERY_DECOMPOSITION"]
 RegionAvailabilityType = Literal["AVAILABLE", "NOT_AVAILABLE"]
+RerankingMetadataSelectionModeType = Literal["ALL", "SELECTIVE"]
 RetrieveAndGenerateTypeType = Literal["EXTERNAL_SOURCES", "KNOWLEDGE_BASE"]
 S3InputFormatType = Literal["JSONL"]
 SearchTypeType = Literal["HYBRID", "SEMANTIC"]
@@ -212,6 +217,7 @@ SortJobsByType = Literal["CreationTime"]
 SortModelsByType = Literal["CreationTime"]
 SortOrderType = Literal["Ascending", "Descending"]
 StatusType = Literal["INCOMPATIBLE_ENDPOINT", "REGISTERED"]
+VectorSearchRerankingConfigurationTypeType = Literal["BEDROCK_RERANKING_MODEL"]
 BedrockServiceName = Literal["bedrock"]
 ServiceName = Literal[
     "accessanalyzer",

types_boto3_bedrock/type_defs.py

@@ -25,6 +25,7 @@ from botocore.response import StreamingBody
 from .literals import (
     AgreementStatusType,
     ApplicationTypeType,
+    AttributeTypeType,
     AuthorizationStatusType,
     CommitmentDurationType,
     CustomizationTypeType,
@@ -63,6 +64,7 @@ from .literals import (
     PromptRouterTypeType,
     ProvisionedModelStatusType,
     RegionAvailabilityType,
+    RerankingMetadataSelectionModeType,
     RetrieveAndGenerateTypeType,
     SearchTypeType,
     SortOrderType,
@@ -176,6 +178,7 @@ __all__ = (
     "ExternalSourcesGenerationConfigurationTypeDef",
     "ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef",
     "ExternalSourcesRetrieveAndGenerateConfigurationTypeDef",
+    "FieldForRerankingTypeDef",
     "FilterAttributeOutputTypeDef",
     "FilterAttributeTypeDef",
     "FoundationModelDetailsTypeDef",
@@ -249,6 +252,8 @@ __all__ = (
     "HumanEvaluationConfigTypeDef",
     "HumanEvaluationCustomMetricTypeDef",
     "HumanWorkflowConfigTypeDef",
+    "ImplicitFilterConfigurationOutputTypeDef",
+    "ImplicitFilterConfigurationTypeDef",
     "ImportedModelSummaryTypeDef",
     "InferenceProfileModelSourceTypeDef",
     "InferenceProfileModelTypeDef",
@@ -312,6 +317,9 @@ __all__ = (
     "LoggingConfigTypeDef",
     "MarketplaceModelEndpointSummaryTypeDef",
     "MarketplaceModelEndpointTypeDef",
+    "MetadataAttributeSchemaTypeDef",
+    "MetadataConfigurationForRerankingOutputTypeDef",
+    "MetadataConfigurationForRerankingTypeDef",
     "ModelCopyJobSummaryTypeDef",
     "ModelCustomizationJobSummaryTypeDef",
     "ModelDataSourceTypeDef",
@@ -344,6 +352,8 @@ __all__ = (
     "RequestMetadataBaseFiltersTypeDef",
     "RequestMetadataFiltersOutputTypeDef",
     "RequestMetadataFiltersTypeDef",
+    "RerankingMetadataSelectiveModeConfigurationOutputTypeDef",
+    "RerankingMetadataSelectiveModeConfigurationTypeDef",
     "ResponseMetadataTypeDef",
     "RetrievalFilterOutputTypeDef",
     "RetrievalFilterTypeDef",
@@ -387,6 +397,12 @@ __all__ = (
     "ValidatorMetricTypeDef",
     "ValidatorTypeDef",
     "ValidityTermTypeDef",
+    "VectorSearchBedrockRerankingConfigurationOutputTypeDef",
+    "VectorSearchBedrockRerankingConfigurationTypeDef",
+    "VectorSearchBedrockRerankingModelConfigurationOutputTypeDef",
+    "VectorSearchBedrockRerankingModelConfigurationTypeDef",
+    "VectorSearchRerankingConfigurationOutputTypeDef",
+    "VectorSearchRerankingConfigurationTypeDef",
     "VpcConfigOutputTypeDef",
     "VpcConfigTypeDef",
     "VpcConfigUnionTypeDef",
@@ -597,6 +613,10 @@ class PromptTemplateTypeDef(TypedDict):
     textPromptTemplate: NotRequired[str]
 
 
+class FieldForRerankingTypeDef(TypedDict):
+    fieldName: str
+
+
 class FilterAttributeOutputTypeDef(TypedDict):
     key: str
     value: Dict[str, Any]
@@ -877,6 +897,16 @@ class HumanWorkflowConfigTypeDef(TypedDict):
     instructions: NotRequired[str]
 
 
+MetadataAttributeSchemaTypeDef = TypedDict(
+    "MetadataAttributeSchemaTypeDef",
+    {
+        "key": str,
+        "type": AttributeTypeType,
+        "description": str,
+    },
+)
+
+
 class ImportedModelSummaryTypeDef(TypedDict):
     modelArn: str
     modelName: str
@@ -1091,6 +1121,16 @@ class ValidatorTypeDef(TypedDict):
     s3Uri: str
 
 
+class VectorSearchBedrockRerankingModelConfigurationOutputTypeDef(TypedDict):
+    modelArn: str
+    additionalModelRequestFields: NotRequired[Dict[str, Dict[str, Any]]]
+
+
+class VectorSearchBedrockRerankingModelConfigurationTypeDef(TypedDict):
+    modelArn: str
+    additionalModelRequestFields: NotRequired[Mapping[str, Mapping[str, Any]]]
+
+
 class BatchDeleteEvaluationJobResponseTypeDef(TypedDict):
     errors: List[BatchDeleteEvaluationJobErrorTypeDef]
     evaluationJobs: List[BatchDeleteEvaluationJobItemTypeDef]
@@ -1383,6 +1423,16 @@ class ExternalSourceOutputTypeDef(TypedDict):
     byteContent: NotRequired[ByteContentDocOutputTypeDef]
 
 
+class RerankingMetadataSelectiveModeConfigurationOutputTypeDef(TypedDict):
+    fieldsToInclude: NotRequired[List[FieldForRerankingTypeDef]]
+    fieldsToExclude: NotRequired[List[FieldForRerankingTypeDef]]
+
+
+class RerankingMetadataSelectiveModeConfigurationTypeDef(TypedDict):
+    fieldsToInclude: NotRequired[Sequence[FieldForRerankingTypeDef]]
+    fieldsToExclude: NotRequired[Sequence[FieldForRerankingTypeDef]]
+
+
 RetrievalFilterOutputTypeDef = TypedDict(
     "RetrievalFilterOutputTypeDef",
     {
@@ -1548,6 +1598,16 @@ class GuardrailWordPolicyTypeDef(TypedDict):
     managedWordLists: NotRequired[List[GuardrailManagedWordsTypeDef]]
 
 
+class ImplicitFilterConfigurationOutputTypeDef(TypedDict):
+    metadataAttributes: List[MetadataAttributeSchemaTypeDef]
+    modelArn: str
+
+
+class ImplicitFilterConfigurationTypeDef(TypedDict):
+    metadataAttributes: Sequence[MetadataAttributeSchemaTypeDef]
+    modelArn: str
+
+
 class ListImportedModelsResponseTypeDef(TypedDict):
     modelSummaries: List[ImportedModelSummaryTypeDef]
     ResponseMetadata: ResponseMetadataTypeDef
@@ -1914,22 +1974,16 @@ class EvaluationSummaryTypeDef(TypedDict):
     applicationType: NotRequired[ApplicationTypeType]
 
 
-KnowledgeBaseVectorSearchConfigurationOutputTypeDef = TypedDict(
-    "KnowledgeBaseVectorSearchConfigurationOutputTypeDef",
-    {
-        "numberOfResults": NotRequired[int],
-        "overrideSearchType": NotRequired[SearchTypeType],
-        "filter": NotRequired[RetrievalFilterOutputTypeDef],
-    },
-)
-KnowledgeBaseVectorSearchConfigurationTypeDef = TypedDict(
-    "KnowledgeBaseVectorSearchConfigurationTypeDef",
-    {
-        "numberOfResults": NotRequired[int],
-        "overrideSearchType": NotRequired[SearchTypeType],
-        "filter": NotRequired[RetrievalFilterTypeDef],
-    },
-)
+class MetadataConfigurationForRerankingOutputTypeDef(TypedDict):
+    selectionMode: RerankingMetadataSelectionModeType
+    selectiveModeConfiguration: NotRequired[
+        RerankingMetadataSelectiveModeConfigurationOutputTypeDef
+    ]
+
+
+class MetadataConfigurationForRerankingTypeDef(TypedDict):
+    selectionMode: RerankingMetadataSelectionModeType
+    selectiveModeConfiguration: NotRequired[RerankingMetadataSelectiveModeConfigurationTypeDef]
 
 
 class GetFoundationModelResponseTypeDef(TypedDict):
@@ -2221,12 +2275,16 @@ class ListEvaluationJobsResponseTypeDef(TypedDict):
     nextToken: NotRequired[str]
 
 
-class KnowledgeBaseRetrievalConfigurationOutputTypeDef(TypedDict):
-    vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationOutputTypeDef
+class VectorSearchBedrockRerankingConfigurationOutputTypeDef(TypedDict):
+    modelConfiguration: VectorSearchBedrockRerankingModelConfigurationOutputTypeDef
+    numberOfRerankedResults: NotRequired[int]
+    metadataConfiguration: NotRequired[MetadataConfigurationForRerankingOutputTypeDef]
 
 
-class KnowledgeBaseRetrievalConfigurationTypeDef(TypedDict):
-    vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationTypeDef
+class VectorSearchBedrockRerankingConfigurationTypeDef(TypedDict):
+    modelConfiguration: VectorSearchBedrockRerankingModelConfigurationTypeDef
+    numberOfRerankedResults: NotRequired[int]
+    metadataConfiguration: NotRequired[MetadataConfigurationForRerankingTypeDef]
 
 
 class MarketplaceModelEndpointTypeDef(TypedDict):
@@ -2292,30 +2350,24 @@ class ListFoundationModelAgreementOffersResponseTypeDef(TypedDict):
     ResponseMetadata: ResponseMetadataTypeDef
 
 
-class KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef(TypedDict):
-    knowledgeBaseId: str
-    modelArn: str
-    retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationOutputTypeDef]
-    generationConfiguration: NotRequired[GenerationConfigurationOutputTypeDef]
-    orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef]
-
-
-class RetrieveConfigOutputTypeDef(TypedDict):
-    knowledgeBaseId: str
-    knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfigurationOutputTypeDef
-
-
-class KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef(TypedDict):
-    knowledgeBaseId: str
-    modelArn: str
-    retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationTypeDef]
-    generationConfiguration: NotRequired[GenerationConfigurationTypeDef]
-    orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef]
-
-
-class RetrieveConfigTypeDef(TypedDict):
-    knowledgeBaseId: str
-    knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfigurationTypeDef
+VectorSearchRerankingConfigurationOutputTypeDef = TypedDict(
+    "VectorSearchRerankingConfigurationOutputTypeDef",
+    {
+        "type": Literal["BEDROCK_RERANKING_MODEL"],
+        "bedrockRerankingConfiguration": NotRequired[
+            VectorSearchBedrockRerankingConfigurationOutputTypeDef
+        ],
+    },
+)
+VectorSearchRerankingConfigurationTypeDef = TypedDict(
+    "VectorSearchRerankingConfigurationTypeDef",
+    {
+        "type": Literal["BEDROCK_RERANKING_MODEL"],
+        "bedrockRerankingConfiguration": NotRequired[
+            VectorSearchBedrockRerankingConfigurationTypeDef
+        ],
+    },
+)
 
 
 class CreateMarketplaceModelEndpointResponseTypeDef(TypedDict):
@@ -2414,28 +2466,24 @@ class UpdateMarketplaceModelEndpointRequestTypeDef(TypedDict):
     clientRequestToken: NotRequired[str]
 
 
-RetrieveAndGenerateConfigurationOutputTypeDef = TypedDict(
-    "RetrieveAndGenerateConfigurationOutputTypeDef",
+KnowledgeBaseVectorSearchConfigurationOutputTypeDef = TypedDict(
+    "KnowledgeBaseVectorSearchConfigurationOutputTypeDef",
     {
-        "type": RetrieveAndGenerateTypeType,
-        "knowledgeBaseConfiguration": NotRequired[
-            KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef
-        ],
-        "externalSourcesConfiguration": NotRequired[
-            ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef
-        ],
+        "numberOfResults": NotRequired[int],
+        "overrideSearchType": NotRequired[SearchTypeType],
+        "filter": NotRequired[RetrievalFilterOutputTypeDef],
+        "implicitFilterConfiguration": NotRequired[ImplicitFilterConfigurationOutputTypeDef],
+        "rerankingConfiguration": NotRequired[VectorSearchRerankingConfigurationOutputTypeDef],
     },
 )
-RetrieveAndGenerateConfigurationTypeDef = TypedDict(
-    "RetrieveAndGenerateConfigurationTypeDef",
+KnowledgeBaseVectorSearchConfigurationTypeDef = TypedDict(
+    "KnowledgeBaseVectorSearchConfigurationTypeDef",
     {
-        "type": RetrieveAndGenerateTypeType,
-        "knowledgeBaseConfiguration": NotRequired[
-            KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
-        ],
-        "externalSourcesConfiguration": NotRequired[
-            ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
-        ],
+        "numberOfResults": NotRequired[int],
+        "overrideSearchType": NotRequired[SearchTypeType],
+        "filter": NotRequired[RetrievalFilterTypeDef],
+        "implicitFilterConfiguration": NotRequired[ImplicitFilterConfigurationTypeDef],
+        "rerankingConfiguration": NotRequired[VectorSearchRerankingConfigurationTypeDef],
     },
 )
 
@@ -2470,14 +2518,12 @@ class CreateModelCustomizationJobRequestTypeDef(TypedDict):
     customizationConfig: NotRequired[CustomizationConfigTypeDef]
 
 
-class KnowledgeBaseConfigOutputTypeDef(TypedDict):
-    retrieveConfig: NotRequired[RetrieveConfigOutputTypeDef]
-    retrieveAndGenerateConfig: NotRequired[RetrieveAndGenerateConfigurationOutputTypeDef]
+class KnowledgeBaseRetrievalConfigurationOutputTypeDef(TypedDict):
+    vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationOutputTypeDef
 
 
-class KnowledgeBaseConfigTypeDef(TypedDict):
-    retrieveConfig: NotRequired[RetrieveConfigTypeDef]
-    retrieveAndGenerateConfig: NotRequired[RetrieveAndGenerateConfigurationTypeDef]
+class KnowledgeBaseRetrievalConfigurationTypeDef(TypedDict):
+    vectorSearchConfiguration: KnowledgeBaseVectorSearchConfigurationTypeDef
 
 
 class EvaluationConfigOutputTypeDef(TypedDict):
@@ -2490,6 +2536,69 @@ class EvaluationConfigTypeDef(TypedDict):
     human: NotRequired[HumanEvaluationConfigTypeDef]
 
 
+class KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef(TypedDict):
+    knowledgeBaseId: str
+    modelArn: str
+    retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationOutputTypeDef]
+    generationConfiguration: NotRequired[GenerationConfigurationOutputTypeDef]
+    orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef]
+
+
+class RetrieveConfigOutputTypeDef(TypedDict):
+    knowledgeBaseId: str
+    knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfigurationOutputTypeDef
+
+
+class KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef(TypedDict):
+    knowledgeBaseId: str
+    modelArn: str
+    retrievalConfiguration: NotRequired[KnowledgeBaseRetrievalConfigurationTypeDef]
+    generationConfiguration: NotRequired[GenerationConfigurationTypeDef]
+    orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef]
+
+
+class RetrieveConfigTypeDef(TypedDict):
+    knowledgeBaseId: str
+    knowledgeBaseRetrievalConfiguration: KnowledgeBaseRetrievalConfigurationTypeDef
+
+
+EvaluationConfigUnionTypeDef = Union[EvaluationConfigTypeDef, EvaluationConfigOutputTypeDef]
+RetrieveAndGenerateConfigurationOutputTypeDef = TypedDict(
+    "RetrieveAndGenerateConfigurationOutputTypeDef",
+    {
+        "type": RetrieveAndGenerateTypeType,
+        "knowledgeBaseConfiguration": NotRequired[
+            KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef
+        ],
+        "externalSourcesConfiguration": NotRequired[
+            ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef
+        ],
+    },
+)
+RetrieveAndGenerateConfigurationTypeDef = TypedDict(
+    "RetrieveAndGenerateConfigurationTypeDef",
+    {
+        "type": RetrieveAndGenerateTypeType,
+        "knowledgeBaseConfiguration": NotRequired[
+            KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
+        ],
+        "externalSourcesConfiguration": NotRequired[
+            ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
+        ],
+    },
+)
+
+
+class KnowledgeBaseConfigOutputTypeDef(TypedDict):
+    retrieveConfig: NotRequired[RetrieveConfigOutputTypeDef]
+    retrieveAndGenerateConfig: NotRequired[RetrieveAndGenerateConfigurationOutputTypeDef]
+
+
+class KnowledgeBaseConfigTypeDef(TypedDict):
+    retrieveConfig: NotRequired[RetrieveConfigTypeDef]
+    retrieveAndGenerateConfig: NotRequired[RetrieveAndGenerateConfigurationTypeDef]
+
+
 class RAGConfigOutputTypeDef(TypedDict):
     knowledgeBaseConfig: NotRequired[KnowledgeBaseConfigOutputTypeDef]
     precomputedRagSourceConfig: NotRequired[EvaluationPrecomputedRagSourceConfigTypeDef]
@@ -2500,9 +2609,6 @@ class RAGConfigTypeDef(TypedDict):
     precomputedRagSourceConfig: NotRequired[EvaluationPrecomputedRagSourceConfigTypeDef]
 
 
-EvaluationConfigUnionTypeDef = Union[EvaluationConfigTypeDef, EvaluationConfigOutputTypeDef]
-
-
 class EvaluationInferenceConfigOutputTypeDef(TypedDict):
     models: NotRequired[List[EvaluationModelConfigTypeDef]]
     ragConfigs: NotRequired[List[RAGConfigOutputTypeDef]]