Type definitions#
Index > BedrockRuntime > Type definitions
Auto-generated documentation for BedrockRuntime type annotations stubs module mypy-boto3-bedrock-runtime.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
MessageUnionTypeDef#
# MessageUnionTypeDef definition
MessageUnionTypeDef = Union[
MessageTypeDef, # (1)
MessageOutputTypeDef, # (2)
]
- See MessageTypeDef
- See MessageOutputTypeDef
GuardrailOutputContentTypeDef#
# GuardrailOutputContentTypeDef definition
class GuardrailOutputContentTypeDef(TypedDict):
text: NotRequired[str],
GuardrailUsageTypeDef#
# GuardrailUsageTypeDef definition
class GuardrailUsageTypeDef(TypedDict):
topicPolicyUnits: int,
contentPolicyUnits: int,
wordPolicyUnits: int,
sensitiveInformationPolicyUnits: int,
sensitiveInformationPolicyFreeUnits: int,
contextualGroundingPolicyUnits: int,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
ToolUseBlockDeltaTypeDef#
# ToolUseBlockDeltaTypeDef definition
class ToolUseBlockDeltaTypeDef(TypedDict):
input: str,
ToolUseBlockOutputTypeDef#
# ToolUseBlockOutputTypeDef definition
class ToolUseBlockOutputTypeDef(TypedDict):
toolUseId: str,
name: str,
input: Dict[str, Any],
ToolUseBlockStartTypeDef#
# ToolUseBlockStartTypeDef definition
class ToolUseBlockStartTypeDef(TypedDict):
toolUseId: str,
name: str,
ContentBlockStopEventTypeDef#
# ContentBlockStopEventTypeDef definition
class ContentBlockStopEventTypeDef(TypedDict):
contentBlockIndex: int,
ToolUseBlockTypeDef#
# ToolUseBlockTypeDef definition
class ToolUseBlockTypeDef(TypedDict):
toolUseId: str,
name: str,
input: Mapping[str, Any],
ConverseMetricsTypeDef#
# ConverseMetricsTypeDef definition
class ConverseMetricsTypeDef(TypedDict):
latencyMs: int,
GuardrailConfigurationTypeDef#
# GuardrailConfigurationTypeDef definition
class GuardrailConfigurationTypeDef(TypedDict):
guardrailIdentifier: str,
guardrailVersion: str,
trace: NotRequired[GuardrailTraceType], # (1)
InferenceConfigurationTypeDef#
# InferenceConfigurationTypeDef definition
class InferenceConfigurationTypeDef(TypedDict):
maxTokens: NotRequired[int],
temperature: NotRequired[float],
topP: NotRequired[float],
stopSequences: NotRequired[Sequence[str]],
TokenUsageTypeDef#
# TokenUsageTypeDef definition
class TokenUsageTypeDef(TypedDict):
inputTokens: int,
outputTokens: int,
totalTokens: int,
ConverseStreamMetricsTypeDef#
# ConverseStreamMetricsTypeDef definition
class ConverseStreamMetricsTypeDef(TypedDict):
latencyMs: int,
InternalServerExceptionTypeDef#
# InternalServerExceptionTypeDef definition
class InternalServerExceptionTypeDef(TypedDict):
message: NotRequired[str],
MessageStartEventTypeDef#
# MessageStartEventTypeDef definition
class MessageStartEventTypeDef(TypedDict):
role: ConversationRoleType, # (1)
MessageStopEventTypeDef#
# MessageStopEventTypeDef definition
class MessageStopEventTypeDef(TypedDict):
stopReason: StopReasonType, # (1)
additionalModelResponseFields: NotRequired[Dict[str, Any]],
- See StopReasonType
ModelStreamErrorExceptionTypeDef#
# ModelStreamErrorExceptionTypeDef definition
class ModelStreamErrorExceptionTypeDef(TypedDict):
message: NotRequired[str],
originalStatusCode: NotRequired[int],
originalMessage: NotRequired[str],
ServiceUnavailableExceptionTypeDef#
# ServiceUnavailableExceptionTypeDef definition
class ServiceUnavailableExceptionTypeDef(TypedDict):
message: NotRequired[str],
ThrottlingExceptionTypeDef#
# ThrottlingExceptionTypeDef definition
class ThrottlingExceptionTypeDef(TypedDict):
message: NotRequired[str],
ValidationExceptionTypeDef#
# ValidationExceptionTypeDef definition
class ValidationExceptionTypeDef(TypedDict):
message: NotRequired[str],
GuardrailStreamConfigurationTypeDef#
# GuardrailStreamConfigurationTypeDef definition
class GuardrailStreamConfigurationTypeDef(TypedDict):
guardrailIdentifier: str,
guardrailVersion: str,
trace: NotRequired[GuardrailTraceType], # (1)
streamProcessingMode: NotRequired[GuardrailStreamProcessingModeType], # (2)
DocumentSourceOutputTypeDef#
# DocumentSourceOutputTypeDef definition
class DocumentSourceOutputTypeDef(TypedDict):
bytes: NotRequired[bytes],
GuardrailTextBlockTypeDef#
# GuardrailTextBlockTypeDef definition
class GuardrailTextBlockTypeDef(TypedDict):
text: str,
qualifiers: NotRequired[Sequence[GuardrailContentQualifierType]], # (1)
GuardrailContentFilterTypeDef#
# GuardrailContentFilterTypeDef definition
class GuardrailContentFilterTypeDef(TypedDict):
type: GuardrailContentFilterTypeType, # (1)
confidence: GuardrailContentFilterConfidenceType, # (2)
action: GuardrailContentPolicyActionType, # (3)
- See GuardrailContentFilterTypeType
- See GuardrailContentFilterConfidenceType
- See GuardrailContentPolicyActionType
GuardrailContextualGroundingFilterTypeDef#
# GuardrailContextualGroundingFilterTypeDef definition
class GuardrailContextualGroundingFilterTypeDef(TypedDict):
type: GuardrailContextualGroundingFilterTypeType, # (1)
threshold: float,
score: float,
action: GuardrailContextualGroundingPolicyActionType, # (2)
GuardrailConverseTextBlockOutputTypeDef#
# GuardrailConverseTextBlockOutputTypeDef definition
class GuardrailConverseTextBlockOutputTypeDef(TypedDict):
text: str,
qualifiers: NotRequired[List[GuardrailConverseContentQualifierType]], # (1)
GuardrailConverseTextBlockTypeDef#
# GuardrailConverseTextBlockTypeDef definition
class GuardrailConverseTextBlockTypeDef(TypedDict):
text: str,
qualifiers: NotRequired[Sequence[GuardrailConverseContentQualifierType]], # (1)
GuardrailCustomWordTypeDef#
# GuardrailCustomWordTypeDef definition
class GuardrailCustomWordTypeDef(TypedDict):
match: str,
action: GuardrailWordPolicyActionType, # (1)
GuardrailManagedWordTypeDef#
# GuardrailManagedWordTypeDef definition
class GuardrailManagedWordTypeDef(TypedDict):
match: str,
type: GuardrailManagedWordTypeType, # (1)
action: GuardrailWordPolicyActionType, # (2)
GuardrailPiiEntityFilterTypeDef#
# GuardrailPiiEntityFilterTypeDef definition
class GuardrailPiiEntityFilterTypeDef(TypedDict):
match: str,
type: GuardrailPiiEntityTypeType, # (1)
action: GuardrailSensitiveInformationPolicyActionType, # (2)
GuardrailRegexFilterTypeDef#
# GuardrailRegexFilterTypeDef definition
class GuardrailRegexFilterTypeDef(TypedDict):
action: GuardrailSensitiveInformationPolicyActionType, # (1)
name: NotRequired[str],
match: NotRequired[str],
regex: NotRequired[str],
GuardrailTopicTypeDef#
# GuardrailTopicTypeDef definition
class GuardrailTopicTypeDef(TypedDict):
name: str,
type: GuardrailTopicTypeType, # (1)
action: GuardrailTopicPolicyActionType, # (2)
ImageSourceOutputTypeDef#
# ImageSourceOutputTypeDef definition
class ImageSourceOutputTypeDef(TypedDict):
bytes: NotRequired[bytes],
ModelTimeoutExceptionTypeDef#
# ModelTimeoutExceptionTypeDef definition
class ModelTimeoutExceptionTypeDef(TypedDict):
message: NotRequired[str],
PayloadPartTypeDef#
# PayloadPartTypeDef definition
class PayloadPartTypeDef(TypedDict):
bytes: NotRequired[bytes],
SpecificToolChoiceTypeDef#
# SpecificToolChoiceTypeDef definition
class SpecificToolChoiceTypeDef(TypedDict):
name: str,
ToolInputSchemaTypeDef#
# ToolInputSchemaTypeDef definition
class ToolInputSchemaTypeDef(TypedDict):
json: NotRequired[Mapping[str, Any]],
InvokeModelResponseTypeDef#
# InvokeModelResponseTypeDef definition
class InvokeModelResponseTypeDef(TypedDict):
body: StreamingBody,
contentType: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DocumentSourceTypeDef#
# DocumentSourceTypeDef definition
class DocumentSourceTypeDef(TypedDict):
bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
ImageSourceTypeDef#
# ImageSourceTypeDef definition
class ImageSourceTypeDef(TypedDict):
bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
InvokeModelRequestRequestTypeDef#
# InvokeModelRequestRequestTypeDef definition
class InvokeModelRequestRequestTypeDef(TypedDict):
body: Union[str, bytes, IO[Any], StreamingBody],
modelId: str,
contentType: NotRequired[str],
accept: NotRequired[str],
trace: NotRequired[TraceType], # (1)
guardrailIdentifier: NotRequired[str],
guardrailVersion: NotRequired[str],
- See TraceType
InvokeModelWithResponseStreamRequestRequestTypeDef#
# InvokeModelWithResponseStreamRequestRequestTypeDef definition
class InvokeModelWithResponseStreamRequestRequestTypeDef(TypedDict):
body: Union[str, bytes, IO[Any], StreamingBody],
modelId: str,
contentType: NotRequired[str],
accept: NotRequired[str],
trace: NotRequired[TraceType], # (1)
guardrailIdentifier: NotRequired[str],
guardrailVersion: NotRequired[str],
- See TraceType
ContentBlockDeltaTypeDef#
# ContentBlockDeltaTypeDef definition
class ContentBlockDeltaTypeDef(TypedDict):
text: NotRequired[str],
toolUse: NotRequired[ToolUseBlockDeltaTypeDef], # (1)
ContentBlockStartTypeDef#
# ContentBlockStartTypeDef definition
class ContentBlockStartTypeDef(TypedDict):
toolUse: NotRequired[ToolUseBlockStartTypeDef], # (1)
DocumentBlockOutputTypeDef#
# DocumentBlockOutputTypeDef definition
class DocumentBlockOutputTypeDef(TypedDict):
format: DocumentFormatType, # (1)
name: str,
source: DocumentSourceOutputTypeDef, # (2)
GuardrailContentBlockTypeDef#
# GuardrailContentBlockTypeDef definition
class GuardrailContentBlockTypeDef(TypedDict):
text: NotRequired[GuardrailTextBlockTypeDef], # (1)
GuardrailContentPolicyAssessmentTypeDef#
# GuardrailContentPolicyAssessmentTypeDef definition
class GuardrailContentPolicyAssessmentTypeDef(TypedDict):
filters: List[GuardrailContentFilterTypeDef], # (1)
GuardrailContextualGroundingPolicyAssessmentTypeDef#
# GuardrailContextualGroundingPolicyAssessmentTypeDef definition
class GuardrailContextualGroundingPolicyAssessmentTypeDef(TypedDict):
filters: NotRequired[List[GuardrailContextualGroundingFilterTypeDef]], # (1)
GuardrailConverseContentBlockOutputTypeDef#
# GuardrailConverseContentBlockOutputTypeDef definition
class GuardrailConverseContentBlockOutputTypeDef(TypedDict):
text: NotRequired[GuardrailConverseTextBlockOutputTypeDef], # (1)
GuardrailConverseContentBlockTypeDef#
# GuardrailConverseContentBlockTypeDef definition
class GuardrailConverseContentBlockTypeDef(TypedDict):
text: NotRequired[GuardrailConverseTextBlockTypeDef], # (1)
GuardrailWordPolicyAssessmentTypeDef#
# GuardrailWordPolicyAssessmentTypeDef definition
class GuardrailWordPolicyAssessmentTypeDef(TypedDict):
customWords: List[GuardrailCustomWordTypeDef], # (1)
managedWordLists: List[GuardrailManagedWordTypeDef], # (2)
GuardrailSensitiveInformationPolicyAssessmentTypeDef#
# GuardrailSensitiveInformationPolicyAssessmentTypeDef definition
class GuardrailSensitiveInformationPolicyAssessmentTypeDef(TypedDict):
piiEntities: List[GuardrailPiiEntityFilterTypeDef], # (1)
regexes: List[GuardrailRegexFilterTypeDef], # (2)
GuardrailTopicPolicyAssessmentTypeDef#
# GuardrailTopicPolicyAssessmentTypeDef definition
class GuardrailTopicPolicyAssessmentTypeDef(TypedDict):
topics: List[GuardrailTopicTypeDef], # (1)
ImageBlockOutputTypeDef#
# ImageBlockOutputTypeDef definition
class ImageBlockOutputTypeDef(TypedDict):
format: ImageFormatType, # (1)
source: ImageSourceOutputTypeDef, # (2)
ResponseStreamTypeDef#
# ResponseStreamTypeDef definition
class ResponseStreamTypeDef(TypedDict):
chunk: NotRequired[PayloadPartTypeDef], # (1)
internalServerException: NotRequired[InternalServerExceptionTypeDef], # (2)
modelStreamErrorException: NotRequired[ModelStreamErrorExceptionTypeDef], # (3)
validationException: NotRequired[ValidationExceptionTypeDef], # (4)
throttlingException: NotRequired[ThrottlingExceptionTypeDef], # (5)
modelTimeoutException: NotRequired[ModelTimeoutExceptionTypeDef], # (6)
serviceUnavailableException: NotRequired[ServiceUnavailableExceptionTypeDef], # (7)
- See PayloadPartTypeDef
- See InternalServerExceptionTypeDef
- See ModelStreamErrorExceptionTypeDef
- See ValidationExceptionTypeDef
- See ThrottlingExceptionTypeDef
- See ModelTimeoutExceptionTypeDef
- See ServiceUnavailableExceptionTypeDef
ToolChoiceTypeDef#
# ToolChoiceTypeDef definition
class ToolChoiceTypeDef(TypedDict):
auto: NotRequired[Mapping[str, Any]],
any: NotRequired[Mapping[str, Any]],
tool: NotRequired[SpecificToolChoiceTypeDef], # (1)
ToolSpecificationTypeDef#
# ToolSpecificationTypeDef definition
class ToolSpecificationTypeDef(TypedDict):
name: str,
inputSchema: ToolInputSchemaTypeDef, # (1)
description: NotRequired[str],
DocumentBlockTypeDef#
# DocumentBlockTypeDef definition
class DocumentBlockTypeDef(TypedDict):
format: DocumentFormatType, # (1)
name: str,
source: DocumentSourceTypeDef, # (2)
ImageBlockTypeDef#
# ImageBlockTypeDef definition
class ImageBlockTypeDef(TypedDict):
format: ImageFormatType, # (1)
source: ImageSourceTypeDef, # (2)
- See ImageFormatType
- See ImageSourceTypeDef
ContentBlockDeltaEventTypeDef#
# ContentBlockDeltaEventTypeDef definition
class ContentBlockDeltaEventTypeDef(TypedDict):
delta: ContentBlockDeltaTypeDef, # (1)
contentBlockIndex: int,
ContentBlockStartEventTypeDef#
# ContentBlockStartEventTypeDef definition
class ContentBlockStartEventTypeDef(TypedDict):
start: ContentBlockStartTypeDef, # (1)
contentBlockIndex: int,
ApplyGuardrailRequestRequestTypeDef#
# ApplyGuardrailRequestRequestTypeDef definition
class ApplyGuardrailRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
guardrailVersion: str,
source: GuardrailContentSourceType, # (1)
content: Sequence[GuardrailContentBlockTypeDef], # (2)
SystemContentBlockTypeDef#
# SystemContentBlockTypeDef definition
class SystemContentBlockTypeDef(TypedDict):
text: NotRequired[str],
guardContent: NotRequired[GuardrailConverseContentBlockTypeDef], # (1)
GuardrailAssessmentTypeDef#
# GuardrailAssessmentTypeDef definition
class GuardrailAssessmentTypeDef(TypedDict):
topicPolicy: NotRequired[GuardrailTopicPolicyAssessmentTypeDef], # (1)
contentPolicy: NotRequired[GuardrailContentPolicyAssessmentTypeDef], # (2)
wordPolicy: NotRequired[GuardrailWordPolicyAssessmentTypeDef], # (3)
sensitiveInformationPolicy: NotRequired[GuardrailSensitiveInformationPolicyAssessmentTypeDef], # (4)
contextualGroundingPolicy: NotRequired[GuardrailContextualGroundingPolicyAssessmentTypeDef], # (5)
- See GuardrailTopicPolicyAssessmentTypeDef
- See GuardrailContentPolicyAssessmentTypeDef
- See GuardrailWordPolicyAssessmentTypeDef
- See GuardrailSensitiveInformationPolicyAssessmentTypeDef
- See GuardrailContextualGroundingPolicyAssessmentTypeDef
ToolResultContentBlockOutputTypeDef#
# ToolResultContentBlockOutputTypeDef definition
class ToolResultContentBlockOutputTypeDef(TypedDict):
json: NotRequired[Dict[str, Any]],
text: NotRequired[str],
image: NotRequired[ImageBlockOutputTypeDef], # (1)
document: NotRequired[DocumentBlockOutputTypeDef], # (2)
InvokeModelWithResponseStreamResponseTypeDef#
# InvokeModelWithResponseStreamResponseTypeDef definition
class InvokeModelWithResponseStreamResponseTypeDef(TypedDict):
body: EventStream[ResponseStreamTypeDef], # (1)
contentType: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ToolTypeDef#
# ToolTypeDef definition
class ToolTypeDef(TypedDict):
toolSpec: NotRequired[ToolSpecificationTypeDef], # (1)
ToolResultContentBlockTypeDef#
# ToolResultContentBlockTypeDef definition
class ToolResultContentBlockTypeDef(TypedDict):
json: NotRequired[Mapping[str, Any]],
text: NotRequired[str],
image: NotRequired[ImageBlockTypeDef], # (1)
document: NotRequired[DocumentBlockTypeDef], # (2)
ApplyGuardrailResponseTypeDef#
# ApplyGuardrailResponseTypeDef definition
class ApplyGuardrailResponseTypeDef(TypedDict):
usage: GuardrailUsageTypeDef, # (1)
action: GuardrailActionType, # (2)
outputs: List[GuardrailOutputContentTypeDef], # (3)
assessments: List[GuardrailAssessmentTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See GuardrailUsageTypeDef
- See GuardrailActionType
- See GuardrailOutputContentTypeDef
- See GuardrailAssessmentTypeDef
- See ResponseMetadataTypeDef
GuardrailTraceAssessmentTypeDef#
# GuardrailTraceAssessmentTypeDef definition
class GuardrailTraceAssessmentTypeDef(TypedDict):
modelOutput: NotRequired[List[str]],
inputAssessment: NotRequired[Dict[str, GuardrailAssessmentTypeDef]], # (1)
outputAssessments: NotRequired[Dict[str, List[GuardrailAssessmentTypeDef]]], # (2)
ToolResultBlockOutputTypeDef#
# ToolResultBlockOutputTypeDef definition
class ToolResultBlockOutputTypeDef(TypedDict):
toolUseId: str,
content: List[ToolResultContentBlockOutputTypeDef], # (1)
status: NotRequired[ToolResultStatusType], # (2)
ToolConfigurationTypeDef#
# ToolConfigurationTypeDef definition
class ToolConfigurationTypeDef(TypedDict):
tools: Sequence[ToolTypeDef], # (1)
toolChoice: NotRequired[ToolChoiceTypeDef], # (2)
- See ToolTypeDef
- See ToolChoiceTypeDef
ToolResultBlockTypeDef#
# ToolResultBlockTypeDef definition
class ToolResultBlockTypeDef(TypedDict):
toolUseId: str,
content: Sequence[ToolResultContentBlockTypeDef], # (1)
status: NotRequired[ToolResultStatusType], # (2)
ConverseStreamTraceTypeDef#
# ConverseStreamTraceTypeDef definition
class ConverseStreamTraceTypeDef(TypedDict):
guardrail: NotRequired[GuardrailTraceAssessmentTypeDef], # (1)
ConverseTraceTypeDef#
# ConverseTraceTypeDef definition
class ConverseTraceTypeDef(TypedDict):
guardrail: NotRequired[GuardrailTraceAssessmentTypeDef], # (1)
ContentBlockOutputTypeDef#
# ContentBlockOutputTypeDef definition
class ContentBlockOutputTypeDef(TypedDict):
text: NotRequired[str],
image: NotRequired[ImageBlockOutputTypeDef], # (1)
document: NotRequired[DocumentBlockOutputTypeDef], # (2)
toolUse: NotRequired[ToolUseBlockOutputTypeDef], # (3)
toolResult: NotRequired[ToolResultBlockOutputTypeDef], # (4)
guardContent: NotRequired[GuardrailConverseContentBlockOutputTypeDef], # (5)
- See ImageBlockOutputTypeDef
- See DocumentBlockOutputTypeDef
- See ToolUseBlockOutputTypeDef
- See ToolResultBlockOutputTypeDef
- See GuardrailConverseContentBlockOutputTypeDef
ContentBlockTypeDef#
# ContentBlockTypeDef definition
class ContentBlockTypeDef(TypedDict):
text: NotRequired[str],
image: NotRequired[ImageBlockTypeDef], # (1)
document: NotRequired[DocumentBlockTypeDef], # (2)
toolUse: NotRequired[ToolUseBlockTypeDef], # (3)
toolResult: NotRequired[ToolResultBlockTypeDef], # (4)
guardContent: NotRequired[GuardrailConverseContentBlockTypeDef], # (5)
- See ImageBlockTypeDef
- See DocumentBlockTypeDef
- See ToolUseBlockTypeDef
- See ToolResultBlockTypeDef
- See GuardrailConverseContentBlockTypeDef
ConverseStreamMetadataEventTypeDef#
# ConverseStreamMetadataEventTypeDef definition
class ConverseStreamMetadataEventTypeDef(TypedDict):
usage: TokenUsageTypeDef, # (1)
metrics: ConverseStreamMetricsTypeDef, # (2)
trace: NotRequired[ConverseStreamTraceTypeDef], # (3)
MessageOutputTypeDef#
# MessageOutputTypeDef definition
class MessageOutputTypeDef(TypedDict):
role: ConversationRoleType, # (1)
content: List[ContentBlockOutputTypeDef], # (2)
MessageTypeDef#
# MessageTypeDef definition
class MessageTypeDef(TypedDict):
role: ConversationRoleType, # (1)
content: Sequence[ContentBlockTypeDef], # (2)
ConverseStreamOutputTypeDef#
# ConverseStreamOutputTypeDef definition
class ConverseStreamOutputTypeDef(TypedDict):
messageStart: NotRequired[MessageStartEventTypeDef], # (1)
contentBlockStart: NotRequired[ContentBlockStartEventTypeDef], # (2)
contentBlockDelta: NotRequired[ContentBlockDeltaEventTypeDef], # (3)
contentBlockStop: NotRequired[ContentBlockStopEventTypeDef], # (4)
messageStop: NotRequired[MessageStopEventTypeDef], # (5)
metadata: NotRequired[ConverseStreamMetadataEventTypeDef], # (6)
internalServerException: NotRequired[InternalServerExceptionTypeDef], # (7)
modelStreamErrorException: NotRequired[ModelStreamErrorExceptionTypeDef], # (8)
validationException: NotRequired[ValidationExceptionTypeDef], # (9)
throttlingException: NotRequired[ThrottlingExceptionTypeDef], # (10)
serviceUnavailableException: NotRequired[ServiceUnavailableExceptionTypeDef], # (11)
- See MessageStartEventTypeDef
- See ContentBlockStartEventTypeDef
- See ContentBlockDeltaEventTypeDef
- See ContentBlockStopEventTypeDef
- See MessageStopEventTypeDef
- See ConverseStreamMetadataEventTypeDef
- See InternalServerExceptionTypeDef
- See ModelStreamErrorExceptionTypeDef
- See ValidationExceptionTypeDef
- See ThrottlingExceptionTypeDef
- See ServiceUnavailableExceptionTypeDef
ConverseOutputTypeDef#
# ConverseOutputTypeDef definition
class ConverseOutputTypeDef(TypedDict):
message: NotRequired[MessageOutputTypeDef], # (1)
ConverseStreamResponseTypeDef#
# ConverseStreamResponseTypeDef definition
class ConverseStreamResponseTypeDef(TypedDict):
stream: EventStream[ConverseStreamOutputTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConverseResponseTypeDef#
# ConverseResponseTypeDef definition
class ConverseResponseTypeDef(TypedDict):
output: ConverseOutputTypeDef, # (1)
stopReason: StopReasonType, # (2)
usage: TokenUsageTypeDef, # (3)
metrics: ConverseMetricsTypeDef, # (4)
additionalModelResponseFields: Dict[str, Any],
trace: ConverseTraceTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See ConverseOutputTypeDef
- See StopReasonType
- See TokenUsageTypeDef
- See ConverseMetricsTypeDef
- See ConverseTraceTypeDef
- See ResponseMetadataTypeDef
ConverseRequestRequestTypeDef#
# ConverseRequestRequestTypeDef definition
class ConverseRequestRequestTypeDef(TypedDict):
modelId: str,
messages: Sequence[Union[MessageTypeDef, MessageOutputTypeDef]], # (1)
system: NotRequired[Sequence[SystemContentBlockTypeDef]], # (2)
inferenceConfig: NotRequired[InferenceConfigurationTypeDef], # (3)
toolConfig: NotRequired[ToolConfigurationTypeDef], # (4)
guardrailConfig: NotRequired[GuardrailConfigurationTypeDef], # (5)
additionalModelRequestFields: NotRequired[Mapping[str, Any]],
additionalModelResponseFieldPaths: NotRequired[Sequence[str]],
- See MessageTypeDef MessageOutputTypeDef
- See SystemContentBlockTypeDef
- See InferenceConfigurationTypeDef
- See ToolConfigurationTypeDef
- See GuardrailConfigurationTypeDef
ConverseStreamRequestRequestTypeDef#
# ConverseStreamRequestRequestTypeDef definition
class ConverseStreamRequestRequestTypeDef(TypedDict):
modelId: str,
messages: Sequence[Union[MessageTypeDef, MessageOutputTypeDef]], # (1)
system: NotRequired[Sequence[SystemContentBlockTypeDef]], # (2)
inferenceConfig: NotRequired[InferenceConfigurationTypeDef], # (3)
toolConfig: NotRequired[ToolConfigurationTypeDef], # (4)
guardrailConfig: NotRequired[GuardrailStreamConfigurationTypeDef], # (5)
additionalModelRequestFields: NotRequired[Mapping[str, Any]],
additionalModelResponseFieldPaths: NotRequired[Sequence[str]],