BedrockRuntime module#
Index > BedrockRuntime
Auto-generated documentation for BedrockRuntime type annotations stubs module mypy-boto3-bedrock-runtime.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and BedrockRuntime
.
From PyPI with pip#
Install boto3-stubs
for BedrockRuntime
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[bedrock-runtime]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[bedrock-runtime]'
# standalone installation
python -m pip install mypy-boto3-bedrock-runtime
How to uninstall#
python -m pip uninstall -y mypy-boto3-bedrock-runtime
Usage#
Code samples can be found in Examples.
BedrockRuntimeClient#
Type annotations and code completion for boto3.client("bedrock-runtime")
as BedrockRuntimeClient
boto3 documentation
# BedrockRuntimeClient usage example
from boto3.session import Session
from mypy_boto3_bedrock_runtime.client import BedrockRuntimeClient
def get_client() -> BedrockRuntimeClient:
return Session().client("bedrock-runtime")
Literals#
Type annotations for literals used in methods and schema.
# ConversationRoleType usage example
from mypy_boto3_bedrock_runtime.literals import ConversationRoleType
def get_value() -> ConversationRoleType:
return "assistant"
- ConversationRoleType
- DocumentFormatType
- GuardrailActionType
- GuardrailContentFilterConfidenceType
- GuardrailContentFilterStrengthType
- GuardrailContentFilterTypeType
- GuardrailContentPolicyActionType
- GuardrailContentQualifierType
- GuardrailContentSourceType
- GuardrailContextualGroundingFilterTypeType
- GuardrailContextualGroundingPolicyActionType
- GuardrailConverseContentQualifierType
- GuardrailManagedWordTypeType
- GuardrailPiiEntityTypeType
- GuardrailSensitiveInformationPolicyActionType
- GuardrailStreamProcessingModeType
- GuardrailTopicPolicyActionType
- GuardrailTopicTypeType
- GuardrailTraceType
- GuardrailWordPolicyActionType
- ImageFormatType
- StopReasonType
- ToolResultStatusType
- TraceType
- BedrockRuntimeServiceName
- ServiceName
- ResourceServiceName
Type definitions#
Type annotations for type definitions used in methods and schema.
- GuardrailOutputContentTypeDef
- GuardrailUsageTypeDef
- ResponseMetadataTypeDef
- BlobTypeDef
- ToolUseBlockDeltaTypeDef
- ToolUseBlockOutputTypeDef
- ToolUseBlockStartTypeDef
- ContentBlockStopEventTypeDef
- ConverseMetricsTypeDef
- GuardrailConfigurationTypeDef
- InferenceConfigurationTypeDef
- PromptVariableValuesTypeDef
- TokenUsageTypeDef
- ConverseStreamMetricsTypeDef
- InternalServerExceptionTypeDef
- MessageStartEventTypeDef
- MessageStopEventTypeDef
- ModelStreamErrorExceptionTypeDef
- ServiceUnavailableExceptionTypeDef
- ThrottlingExceptionTypeDef
- ValidationExceptionTypeDef
- GuardrailStreamConfigurationTypeDef
- DocumentSourceOutputTypeDef
- GuardrailTextBlockTypeDef
- GuardrailContentFilterTypeDef
- GuardrailContextualGroundingFilterTypeDef
- GuardrailConverseTextBlockOutputTypeDef
- GuardrailConverseTextBlockTypeDef
- GuardrailTextCharactersCoverageTypeDef
- GuardrailCustomWordTypeDef
- GuardrailManagedWordTypeDef
- GuardrailPiiEntityFilterTypeDef
- GuardrailRegexFilterTypeDef
- GuardrailTopicTypeDef
- ImageSourceOutputTypeDef
- ModelTimeoutExceptionTypeDef
- PayloadPartTypeDef
- SpecificToolChoiceTypeDef
- ToolInputSchemaTypeDef
- ToolUseBlockTypeDef
- InvokeModelResponseTypeDef
- DocumentSourceTypeDef
- ImageSourceTypeDef
- InvokeModelRequestRequestTypeDef
- InvokeModelWithResponseStreamRequestRequestTypeDef
- ContentBlockDeltaTypeDef
- ContentBlockStartTypeDef
- DocumentBlockOutputTypeDef
- GuardrailContentBlockTypeDef
- GuardrailContentPolicyAssessmentTypeDef
- GuardrailContextualGroundingPolicyAssessmentTypeDef
- GuardrailConverseContentBlockOutputTypeDef
- GuardrailConverseTextBlockUnionTypeDef
- GuardrailCoverageTypeDef
- GuardrailWordPolicyAssessmentTypeDef
- GuardrailSensitiveInformationPolicyAssessmentTypeDef
- GuardrailTopicPolicyAssessmentTypeDef
- ImageBlockOutputTypeDef
- ResponseStreamTypeDef
- ToolChoiceTypeDef
- ToolSpecificationTypeDef
- ToolUseBlockUnionTypeDef
- DocumentSourceUnionTypeDef
- ImageSourceUnionTypeDef
- ContentBlockDeltaEventTypeDef
- ContentBlockStartEventTypeDef
- ApplyGuardrailRequestRequestTypeDef
- GuardrailConverseContentBlockTypeDef
- GuardrailInvocationMetricsTypeDef
- ToolResultContentBlockOutputTypeDef
- InvokeModelWithResponseStreamResponseTypeDef
- ToolTypeDef
- DocumentBlockTypeDef
- ImageBlockTypeDef
- GuardrailConverseContentBlockUnionTypeDef
- GuardrailAssessmentTypeDef
- ToolResultBlockOutputTypeDef
- ToolConfigurationTypeDef
- DocumentBlockUnionTypeDef
- ImageBlockUnionTypeDef
- SystemContentBlockTypeDef
- ApplyGuardrailResponseTypeDef
- GuardrailTraceAssessmentTypeDef
- ContentBlockOutputTypeDef
- ToolResultContentBlockTypeDef
- ConverseStreamTraceTypeDef
- ConverseTraceTypeDef
- MessageOutputTypeDef
- ToolResultContentBlockUnionTypeDef
- ConverseStreamMetadataEventTypeDef
- ConverseOutputTypeDef
- ToolResultBlockTypeDef
- ConverseStreamOutputTypeDef
- ConverseResponseTypeDef
- ToolResultBlockUnionTypeDef
- ConverseStreamResponseTypeDef
- ContentBlockTypeDef
- ContentBlockUnionTypeDef
- MessageTypeDef
- ConverseStreamRequestRequestTypeDef
- MessageUnionTypeDef
- ConverseRequestRequestTypeDef