types-boto3-bedrock-runtime 1.40.62__py3-none-any.whl → 1.41.0__py3-none-any.whl

types_boto3_bedrock_runtime/type_defs.py

@@ -17,6 +17,7 @@ Usage::
 from __future__ import annotations
 
 import sys
+from collections.abc import Mapping, Sequence
 from datetime import datetime
 from typing import IO, Any, Union
 
@@ -49,19 +50,15 @@ from .literals import (
     GuardrailWordPolicyActionType,
     ImageFormatType,
     PerformanceConfigLatencyType,
+    ServiceTierTypeType,
     SortOrderType,
     StopReasonType,
     ToolResultStatusType,
+    ToolUseTypeType,
     TraceType,
     VideoFormatType,
 )
 
-if sys.version_info >= (3, 9):
-    from builtins import dict as Dict
-    from builtins import list as List
-    from collections.abc import Mapping, Sequence
-else:
-    from typing import Dict, List, Mapping, Sequence
 if sys.version_info >= (3, 12):
     from typing import Literal, NotRequired, TypedDict
 else:
@@ -217,6 +214,12 @@ __all__ = (
     "ResponseMetadataTypeDef",
     "ResponseStreamTypeDef",
     "S3LocationTypeDef",
+    "SearchResultBlockOutputTypeDef",
+    "SearchResultBlockTypeDef",
+    "SearchResultBlockUnionTypeDef",
+    "SearchResultContentBlockTypeDef",
+    "SearchResultLocationTypeDef",
+    "ServiceTierTypeDef",
     "ServiceUnavailableExceptionTypeDef",
     "SpecificToolChoiceTypeDef",
     "StartAsyncInvokeRequestTypeDef",
@@ -275,7 +278,7 @@ class GuardrailUsageTypeDef(TypedDict):
 class ResponseMetadataTypeDef(TypedDict):
     RequestId: str
     HTTPStatusCode: int
-    HTTPHeaders: Dict[str, str]
+    HTTPHeaders: dict[str, str]
     RetryAttempts: int
     HostId: NotRequired[str]
 
@@ -323,6 +326,12 @@ class DocumentPageLocationTypeDef(TypedDict):
     end: NotRequired[int]
 
 
+class SearchResultLocationTypeDef(TypedDict):
+    searchResultIndex: NotRequired[int]
+    start: NotRequired[int]
+    end: NotRequired[int]
+
+
 class WebLocationTypeDef(TypedDict):
     url: NotRequired[str]
     domain: NotRequired[str]
@@ -361,8 +370,8 @@ ToolUseBlockOutputTypeDef = TypedDict(
     {
         "toolUseId": str,
         "name": str,
-        "input": Dict[str, Any],
-        "type": NotRequired[Literal["server_tool_use"]],
+        "input": dict[str, Any],
+        "type": NotRequired[ToolUseTypeType],
     },
 )
 ToolResultBlockStartTypeDef = TypedDict(
@@ -378,7 +387,7 @@ ToolUseBlockStartTypeDef = TypedDict(
     {
         "toolUseId": str,
         "name": str,
-        "type": NotRequired[Literal["server_tool_use"]],
+        "type": NotRequired[ToolUseTypeType],
     },
 )
 
@@ -412,6 +421,14 @@ class PromptVariableValuesTypeDef(TypedDict):
     text: NotRequired[str]
 
 
+ServiceTierTypeDef = TypedDict(
+    "ServiceTierTypeDef",
+    {
+        "type": ServiceTierTypeType,
+    },
+)
+
+
 class TokenUsageTypeDef(TypedDict):
     inputTokens: int
     outputTokens: int
@@ -434,7 +451,7 @@ class MessageStartEventTypeDef(TypedDict):
 
 class MessageStopEventTypeDef(TypedDict):
     stopReason: StopReasonType
-    additionalModelResponseFields: NotRequired[Dict[str, Any]]
+    additionalModelResponseFields: NotRequired[dict[str, Any]]
 
 
 class ModelStreamErrorExceptionTypeDef(TypedDict):
@@ -522,7 +539,7 @@ GuardrailContextualGroundingFilterTypeDef = TypedDict(
 
 class GuardrailConverseTextBlockOutputTypeDef(TypedDict):
     text: str
-    qualifiers: NotRequired[List[GuardrailConverseContentQualifierType]]
+    qualifiers: NotRequired[list[GuardrailConverseContentQualifierType]]
 
 
 GuardrailConverseImageSourceOutputTypeDef = TypedDict(
@@ -617,6 +634,10 @@ class ReasoningTextBlockTypeDef(TypedDict):
     signature: NotRequired[str]
 
 
+class SearchResultContentBlockTypeDef(TypedDict):
+    text: str
+
+
 class SpecificToolChoiceTypeDef(TypedDict):
     name: str
 
@@ -640,7 +661,7 @@ ToolUseBlockTypeDef = TypedDict(
         "toolUseId": str,
         "name": str,
         "input": Mapping[str, Any],
-        "type": NotRequired[Literal["server_tool_use"]],
+        "type": NotRequired[ToolUseTypeType],
     },
 )
 
@@ -654,6 +675,7 @@ class InvokeModelResponseTypeDef(TypedDict):
     body: StreamingBody
     contentType: str
     performanceConfigLatency: PerformanceConfigLatencyType
+    serviceTier: ServiceTierTypeType
     ResponseMetadata: ResponseMetadataTypeDef
 
 
@@ -695,6 +717,7 @@ class InvokeModelRequestTypeDef(TypedDict):
     guardrailIdentifier: NotRequired[str]
     guardrailVersion: NotRequired[str]
     performanceConfigLatency: NotRequired[PerformanceConfigLatencyType]
+    serviceTier: NotRequired[ServiceTierTypeType]
 
 
 class InvokeModelTokensRequestTypeDef(TypedDict):
@@ -710,6 +733,7 @@ class InvokeModelWithResponseStreamRequestTypeDef(TypedDict):
     guardrailIdentifier: NotRequired[str]
     guardrailVersion: NotRequired[str]
     performanceConfigLatency: NotRequired[PerformanceConfigLatencyType]
+    serviceTier: NotRequired[ServiceTierTypeType]
 
 
 class CitationLocationTypeDef(TypedDict):
@@ -717,6 +741,7 @@ class CitationLocationTypeDef(TypedDict):
     documentChar: NotRequired[DocumentCharLocationTypeDef]
     documentPage: NotRequired[DocumentPageLocationTypeDef]
     documentChunk: NotRequired[DocumentChunkLocationTypeDef]
+    searchResultLocation: NotRequired[SearchResultLocationTypeDef]
 
 
 class ContentBlockStartTypeDef(TypedDict):
@@ -730,7 +755,7 @@ DocumentSourceOutputTypeDef = TypedDict(
         "bytes": NotRequired[bytes],
         "s3Location": NotRequired[S3LocationTypeDef],
         "text": NotRequired[str],
-        "content": NotRequired[List[DocumentContentBlockTypeDef]],
+        "content": NotRequired[list[DocumentContentBlockTypeDef]],
     },
 )
 DocumentSourceTypeDef = TypedDict(
@@ -774,30 +799,30 @@ GuardrailAutomatedReasoningLogicWarningTypeDef = TypedDict(
     "GuardrailAutomatedReasoningLogicWarningTypeDef",
     {
         "type": NotRequired[GuardrailAutomatedReasoningLogicWarningTypeType],
-        "premises": NotRequired[List[GuardrailAutomatedReasoningStatementTypeDef]],
-        "claims": NotRequired[List[GuardrailAutomatedReasoningStatementTypeDef]],
+        "premises": NotRequired[list[GuardrailAutomatedReasoningStatementTypeDef]],
+        "claims": NotRequired[list[GuardrailAutomatedReasoningStatementTypeDef]],
     },
 )
 
 
 class GuardrailAutomatedReasoningScenarioTypeDef(TypedDict):
-    statements: NotRequired[List[GuardrailAutomatedReasoningStatementTypeDef]]
+    statements: NotRequired[list[GuardrailAutomatedReasoningStatementTypeDef]]
 
 
 class GuardrailAutomatedReasoningTranslationTypeDef(TypedDict):
-    premises: NotRequired[List[GuardrailAutomatedReasoningStatementTypeDef]]
-    claims: NotRequired[List[GuardrailAutomatedReasoningStatementTypeDef]]
-    untranslatedPremises: NotRequired[List[GuardrailAutomatedReasoningInputTextReferenceTypeDef]]
-    untranslatedClaims: NotRequired[List[GuardrailAutomatedReasoningInputTextReferenceTypeDef]]
+    premises: NotRequired[list[GuardrailAutomatedReasoningStatementTypeDef]]
+    claims: NotRequired[list[GuardrailAutomatedReasoningStatementTypeDef]]
+    untranslatedPremises: NotRequired[list[GuardrailAutomatedReasoningInputTextReferenceTypeDef]]
+    untranslatedClaims: NotRequired[list[GuardrailAutomatedReasoningInputTextReferenceTypeDef]]
     confidence: NotRequired[float]
 
 
 class GuardrailContentPolicyAssessmentTypeDef(TypedDict):
-    filters: List[GuardrailContentFilterTypeDef]
+    filters: list[GuardrailContentFilterTypeDef]
 
 
 class GuardrailContextualGroundingPolicyAssessmentTypeDef(TypedDict):
-    filters: NotRequired[List[GuardrailContextualGroundingFilterTypeDef]]
+    filters: NotRequired[list[GuardrailContextualGroundingFilterTypeDef]]
 
 
 GuardrailConverseImageBlockOutputTypeDef = TypedDict(
@@ -818,17 +843,17 @@ class GuardrailCoverageTypeDef(TypedDict):
 
 
 class GuardrailWordPolicyAssessmentTypeDef(TypedDict):
-    customWords: List[GuardrailCustomWordTypeDef]
-    managedWordLists: List[GuardrailManagedWordTypeDef]
+    customWords: list[GuardrailCustomWordTypeDef]
+    managedWordLists: list[GuardrailManagedWordTypeDef]
 
 
 class GuardrailSensitiveInformationPolicyAssessmentTypeDef(TypedDict):
-    piiEntities: List[GuardrailPiiEntityFilterTypeDef]
-    regexes: List[GuardrailRegexFilterTypeDef]
+    piiEntities: list[GuardrailPiiEntityFilterTypeDef]
+    regexes: list[GuardrailRegexFilterTypeDef]
 
 
 class GuardrailTopicPolicyAssessmentTypeDef(TypedDict):
-    topics: List[GuardrailTopicTypeDef]
+    topics: list[GuardrailTopicTypeDef]
 
 
 class InvokeModelWithBidirectionalStreamOutputTypeDef(TypedDict):
@@ -880,6 +905,20 @@ class ReasoningContentBlockTypeDef(TypedDict):
     redactedContent: NotRequired[BlobTypeDef]
 
 
+class SearchResultBlockOutputTypeDef(TypedDict):
+    source: str
+    title: str
+    content: list[SearchResultContentBlockTypeDef]
+    citations: NotRequired[CitationsConfigTypeDef]
+
+
+class SearchResultBlockTypeDef(TypedDict):
+    source: str
+    title: str
+    content: Sequence[SearchResultContentBlockTypeDef]
+    citations: NotRequired[CitationsConfigTypeDef]
+
+
 ToolChoiceTypeDef = TypedDict(
     "ToolChoiceTypeDef",
     {
@@ -950,19 +989,22 @@ GuardrailImageBlockTypeDef = TypedDict(
 
 class CitationOutputTypeDef(TypedDict):
     title: NotRequired[str]
-    sourceContent: NotRequired[List[CitationSourceContentTypeDef]]
+    source: NotRequired[str]
+    sourceContent: NotRequired[list[CitationSourceContentTypeDef]]
     location: NotRequired[CitationLocationTypeDef]
 
 
 class CitationTypeDef(TypedDict):
     title: NotRequired[str]
+    source: NotRequired[str]
     sourceContent: NotRequired[Sequence[CitationSourceContentTypeDef]]
     location: NotRequired[CitationLocationTypeDef]
 
 
 class CitationsDeltaTypeDef(TypedDict):
     title: NotRequired[str]
-    sourceContent: NotRequired[List[CitationSourceContentDeltaTypeDef]]
+    source: NotRequired[str]
+    sourceContent: NotRequired[list[CitationSourceContentDeltaTypeDef]]
     location: NotRequired[CitationLocationTypeDef]
 
 
@@ -1002,13 +1044,13 @@ VideoSourceUnionTypeDef = Union[VideoSourceTypeDef, VideoSourceOutputTypeDef]
 
 class GuardrailAutomatedReasoningImpossibleFindingTypeDef(TypedDict):
     translation: NotRequired[GuardrailAutomatedReasoningTranslationTypeDef]
-    contradictingRules: NotRequired[List[GuardrailAutomatedReasoningRuleTypeDef]]
+    contradictingRules: NotRequired[list[GuardrailAutomatedReasoningRuleTypeDef]]
     logicWarning: NotRequired[GuardrailAutomatedReasoningLogicWarningTypeDef]
 
 
 class GuardrailAutomatedReasoningInvalidFindingTypeDef(TypedDict):
     translation: NotRequired[GuardrailAutomatedReasoningTranslationTypeDef]
-    contradictingRules: NotRequired[List[GuardrailAutomatedReasoningRuleTypeDef]]
+    contradictingRules: NotRequired[list[GuardrailAutomatedReasoningRuleTypeDef]]
     logicWarning: NotRequired[GuardrailAutomatedReasoningLogicWarningTypeDef]
 
 
@@ -1020,13 +1062,13 @@ class GuardrailAutomatedReasoningSatisfiableFindingTypeDef(TypedDict):
 
 
 class GuardrailAutomatedReasoningTranslationOptionTypeDef(TypedDict):
-    translations: NotRequired[List[GuardrailAutomatedReasoningTranslationTypeDef]]
+    translations: NotRequired[list[GuardrailAutomatedReasoningTranslationTypeDef]]
 
 
 class GuardrailAutomatedReasoningValidFindingTypeDef(TypedDict):
     translation: NotRequired[GuardrailAutomatedReasoningTranslationTypeDef]
     claimsTrueScenario: NotRequired[GuardrailAutomatedReasoningScenarioTypeDef]
-    supportingRules: NotRequired[List[GuardrailAutomatedReasoningRuleTypeDef]]
+    supportingRules: NotRequired[list[GuardrailAutomatedReasoningRuleTypeDef]]
     logicWarning: NotRequired[GuardrailAutomatedReasoningLogicWarningTypeDef]
 
 
@@ -1050,12 +1092,14 @@ class InvokeModelWithResponseStreamResponseTypeDef(TypedDict):
     body: EventStream[ResponseStreamTypeDef]
     contentType: str
     performanceConfigLatency: PerformanceConfigLatencyType
+    serviceTier: ServiceTierTypeType
     ResponseMetadata: ResponseMetadataTypeDef
 
 
 ReasoningContentBlockUnionTypeDef = Union[
     ReasoningContentBlockTypeDef, ReasoningContentBlockOutputTypeDef
 ]
+SearchResultBlockUnionTypeDef = Union[SearchResultBlockTypeDef, SearchResultBlockOutputTypeDef]
 
 
 class ToolTypeDef(TypedDict):
@@ -1065,7 +1109,7 @@ class ToolTypeDef(TypedDict):
 
 
 class ListAsyncInvokesResponseTypeDef(TypedDict):
-    asyncInvokeSummaries: List[AsyncInvokeSummaryTypeDef]
+    asyncInvokeSummaries: list[AsyncInvokeSummaryTypeDef]
     ResponseMetadata: ResponseMetadataTypeDef
     nextToken: NotRequired[str]
 
@@ -1090,8 +1134,8 @@ class GuardrailContentBlockTypeDef(TypedDict):
 
 
 class CitationsContentBlockOutputTypeDef(TypedDict):
-    content: NotRequired[List[CitationGeneratedContentTypeDef]]
-    citations: NotRequired[List[CitationOutputTypeDef]]
+    content: NotRequired[list[CitationGeneratedContentTypeDef]]
+    citations: NotRequired[list[CitationOutputTypeDef]]
 
 
 CitationUnionTypeDef = Union[CitationTypeDef, CitationOutputTypeDef]
@@ -1100,7 +1144,7 @@ CitationUnionTypeDef = Union[CitationTypeDef, CitationOutputTypeDef]
 class ContentBlockDeltaTypeDef(TypedDict):
     text: NotRequired[str]
     toolUse: NotRequired[ToolUseBlockDeltaTypeDef]
-    toolResult: NotRequired[List[ToolResultBlockDeltaTypeDef]]
+    toolResult: NotRequired[list[ToolResultBlockDeltaTypeDef]]
     reasoningContent: NotRequired[ReasoningContentBlockDeltaTypeDef]
     citation: NotRequired[CitationsDeltaTypeDef]
 
@@ -1125,11 +1169,12 @@ ImageBlockTypeDef = TypedDict(
 
 
 class ToolResultContentBlockOutputTypeDef(TypedDict):
-    json: NotRequired[Dict[str, Any]]
+    json: NotRequired[dict[str, Any]]
     text: NotRequired[str]
     image: NotRequired[ImageBlockOutputTypeDef]
     document: NotRequired[DocumentBlockOutputTypeDef]
     video: NotRequired[VideoBlockOutputTypeDef]
+    searchResult: NotRequired[SearchResultBlockOutputTypeDef]
 
 
 VideoBlockTypeDef = TypedDict(
@@ -1142,8 +1187,8 @@ VideoBlockTypeDef = TypedDict(
 
 
 class GuardrailAutomatedReasoningTranslationAmbiguousFindingTypeDef(TypedDict):
-    options: NotRequired[List[GuardrailAutomatedReasoningTranslationOptionTypeDef]]
-    differenceScenarios: NotRequired[List[GuardrailAutomatedReasoningScenarioTypeDef]]
+    options: NotRequired[list[GuardrailAutomatedReasoningTranslationOptionTypeDef]]
+    differenceScenarios: NotRequired[list[GuardrailAutomatedReasoningScenarioTypeDef]]
 
 
 class ToolConfigurationTypeDef(TypedDict):
@@ -1180,7 +1225,7 @@ ToolResultBlockOutputTypeDef = TypedDict(
     "ToolResultBlockOutputTypeDef",
     {
         "toolUseId": str,
-        "content": List[ToolResultContentBlockOutputTypeDef],
+        "content": list[ToolResultContentBlockOutputTypeDef],
         "status": NotRequired[ToolResultStatusType],
         "type": NotRequired[str],
     },
@@ -1194,8 +1239,8 @@ class GuardrailAutomatedReasoningFindingTypeDef(TypedDict):
     satisfiable: NotRequired[GuardrailAutomatedReasoningSatisfiableFindingTypeDef]
     impossible: NotRequired[GuardrailAutomatedReasoningImpossibleFindingTypeDef]
     translationAmbiguous: NotRequired[GuardrailAutomatedReasoningTranslationAmbiguousFindingTypeDef]
-    tooComplex: NotRequired[Dict[str, Any]]
-    noTranslations: NotRequired[Dict[str, Any]]
+    tooComplex: NotRequired[dict[str, Any]]
+    noTranslations: NotRequired[dict[str, Any]]
 
 
 class GuardrailConverseContentBlockTypeDef(TypedDict):
@@ -1219,6 +1264,7 @@ class ContentBlockOutputTypeDef(TypedDict):
     cachePoint: NotRequired[CachePointBlockTypeDef]
     reasoningContent: NotRequired[ReasoningContentBlockOutputTypeDef]
     citationsContent: NotRequired[CitationsContentBlockOutputTypeDef]
+    searchResult: NotRequired[SearchResultBlockOutputTypeDef]
 
 
 class ToolResultContentBlockTypeDef(TypedDict):
@@ -1227,10 +1273,11 @@ class ToolResultContentBlockTypeDef(TypedDict):
     image: NotRequired[ImageBlockUnionTypeDef]
     document: NotRequired[DocumentBlockUnionTypeDef]
     video: NotRequired[VideoBlockUnionTypeDef]
+    searchResult: NotRequired[SearchResultBlockUnionTypeDef]
 
 
 class GuardrailAutomatedReasoningPolicyAssessmentTypeDef(TypedDict):
-    findings: NotRequired[List[GuardrailAutomatedReasoningFindingTypeDef]]
+    findings: NotRequired[list[GuardrailAutomatedReasoningFindingTypeDef]]
 
 
 GuardrailConverseContentBlockUnionTypeDef = Union[
@@ -1240,7 +1287,7 @@ GuardrailConverseContentBlockUnionTypeDef = Union[
 
 class MessageOutputTypeDef(TypedDict):
     role: ConversationRoleType
-    content: List[ContentBlockOutputTypeDef]
+    content: list[ContentBlockOutputTypeDef]
 
 
 ToolResultContentBlockUnionTypeDef = Union[
@@ -1283,16 +1330,16 @@ class ApplyGuardrailResponseTypeDef(TypedDict):
     usage: GuardrailUsageTypeDef
     action: GuardrailActionType
     actionReason: str
-    outputs: List[GuardrailOutputContentTypeDef]
-    assessments: List[GuardrailAssessmentTypeDef]
+    outputs: list[GuardrailOutputContentTypeDef]
+    assessments: list[GuardrailAssessmentTypeDef]
     guardrailCoverage: GuardrailCoverageTypeDef
     ResponseMetadata: ResponseMetadataTypeDef
 
 
 class GuardrailTraceAssessmentTypeDef(TypedDict):
-    modelOutput: NotRequired[List[str]]
-    inputAssessment: NotRequired[Dict[str, GuardrailAssessmentTypeDef]]
-    outputAssessments: NotRequired[Dict[str, List[GuardrailAssessmentTypeDef]]]
+    modelOutput: NotRequired[list[str]]
+    inputAssessment: NotRequired[dict[str, GuardrailAssessmentTypeDef]]
+    outputAssessments: NotRequired[dict[str, list[GuardrailAssessmentTypeDef]]]
     actionReason: NotRequired[str]
 
 
@@ -1320,6 +1367,7 @@ class ContentBlockTypeDef(TypedDict):
     cachePoint: NotRequired[CachePointBlockTypeDef]
     reasoningContent: NotRequired[ReasoningContentBlockUnionTypeDef]
     citationsContent: NotRequired[CitationsContentBlockUnionTypeDef]
+    searchResult: NotRequired[SearchResultBlockUnionTypeDef]
 
 
 class ConverseStreamMetadataEventTypeDef(TypedDict):
@@ -1327,6 +1375,7 @@ class ConverseStreamMetadataEventTypeDef(TypedDict):
     metrics: ConverseStreamMetricsTypeDef
     trace: NotRequired[ConverseStreamTraceTypeDef]
     performanceConfig: NotRequired[PerformanceConfigurationTypeDef]
+    serviceTier: NotRequired[ServiceTierTypeDef]
 
 
 class ConverseResponseTypeDef(TypedDict):
@@ -1334,9 +1383,10 @@ class ConverseResponseTypeDef(TypedDict):
     stopReason: StopReasonType
     usage: TokenUsageTypeDef
     metrics: ConverseMetricsTypeDef
-    additionalModelResponseFields: Dict[str, Any]
+    additionalModelResponseFields: dict[str, Any]
     trace: ConverseTraceTypeDef
     performanceConfig: PerformanceConfigurationTypeDef
+    serviceTier: ServiceTierTypeDef
     ResponseMetadata: ResponseMetadataTypeDef
 
 
@@ -1382,6 +1432,7 @@ class ConverseRequestTypeDef(TypedDict):
     additionalModelResponseFieldPaths: NotRequired[Sequence[str]]
     requestMetadata: NotRequired[Mapping[str, str]]
     performanceConfig: NotRequired[PerformanceConfigurationTypeDef]
+    serviceTier: NotRequired[ServiceTierTypeDef]
 
 
 class ConverseStreamRequestTypeDef(TypedDict):
@@ -1396,11 +1447,14 @@ class ConverseStreamRequestTypeDef(TypedDict):
     additionalModelResponseFieldPaths: NotRequired[Sequence[str]]
     requestMetadata: NotRequired[Mapping[str, str]]
     performanceConfig: NotRequired[PerformanceConfigurationTypeDef]
+    serviceTier: NotRequired[ServiceTierTypeDef]
 
 
 class ConverseTokensRequestTypeDef(TypedDict):
     messages: NotRequired[Sequence[MessageUnionTypeDef]]
     system: NotRequired[Sequence[SystemContentBlockTypeDef]]
+    toolConfig: NotRequired[ToolConfigurationTypeDef]
+    additionalModelRequestFields: NotRequired[Mapping[str, Any]]
 
 
 class CountTokensInputTypeDef(TypedDict):