# Packages
Package bedrockruntimeiface provides an interface to enable mocking the Amazon Bedrock Runtime service client for testing your code.
# Functions
ConversationRole_Values returns all elements of the ConversationRole enum.
DocumentFormat_Values returns all elements of the DocumentFormat enum.
GuardrailAction_Values returns all elements of the GuardrailAction enum.
GuardrailContentFilterConfidence_Values returns all elements of the GuardrailContentFilterConfidence enum.
GuardrailContentFilterType_Values returns all elements of the GuardrailContentFilterType enum.
GuardrailContentPolicyAction_Values returns all elements of the GuardrailContentPolicyAction enum.
GuardrailContentQualifier_Values returns all elements of the GuardrailContentQualifier enum.
GuardrailContentSource_Values returns all elements of the GuardrailContentSource enum.
GuardrailContextualGroundingFilterType_Values returns all elements of the GuardrailContextualGroundingFilterType enum.
GuardrailContextualGroundingPolicyAction_Values returns all elements of the GuardrailContextualGroundingPolicyAction enum.
GuardrailConverseContentQualifier_Values returns all elements of the GuardrailConverseContentQualifier enum.
GuardrailManagedWordType_Values returns all elements of the GuardrailManagedWordType enum.
GuardrailPiiEntityType_Values returns all elements of the GuardrailPiiEntityType enum.
GuardrailSensitiveInformationPolicyAction_Values returns all elements of the GuardrailSensitiveInformationPolicyAction enum.
GuardrailStreamProcessingMode_Values returns all elements of the GuardrailStreamProcessingMode enum.
GuardrailTopicPolicyAction_Values returns all elements of the GuardrailTopicPolicyAction enum.
GuardrailTopicType_Values returns all elements of the GuardrailTopicType enum.
GuardrailTrace_Values returns all elements of the GuardrailTrace enum.
GuardrailWordPolicyAction_Values returns all elements of the GuardrailWordPolicyAction enum.
ImageFormat_Values returns all elements of the ImageFormat enum.
New creates a new instance of the BedrockRuntime client with a session.
NewConverseStreamEventStream initializes an ConverseStreamEventStream.
NewInvokeModelWithResponseStreamEventStream initializes an InvokeModelWithResponseStreamEventStream.
StopReason_Values returns all elements of the StopReason enum.
ToolResultStatus_Values returns all elements of the ToolResultStatus enum.
Trace_Values returns all elements of the Trace enum.
# Constants
ConversationRoleAssistant is a ConversationRole enum value.
ConversationRoleUser is a ConversationRole enum value.
DocumentFormatCsv is a DocumentFormat enum value.
DocumentFormatDoc is a DocumentFormat enum value.
DocumentFormatDocx is a DocumentFormat enum value.
DocumentFormatHtml is a DocumentFormat enum value.
DocumentFormatMd is a DocumentFormat enum value.
DocumentFormatPdf is a DocumentFormat enum value.
DocumentFormatTxt is a DocumentFormat enum value.
DocumentFormatXls is a DocumentFormat enum value.
DocumentFormatXlsx is a DocumentFormat enum value.
ID to lookup a service endpoint with.
ErrCodeAccessDeniedException for service response error code "AccessDeniedException".
ErrCodeInternalServerException for service response error code "InternalServerException".
ErrCodeModelErrorException for service response error code "ModelErrorException".
ErrCodeModelNotReadyException for service response error code "ModelNotReadyException".
ErrCodeModelStreamErrorException for service response error code "ModelStreamErrorException".
ErrCodeModelTimeoutException for service response error code "ModelTimeoutException".
ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".
ErrCodeServiceQuotaExceededException for service response error code "ServiceQuotaExceededException".
ErrCodeServiceUnavailableException for service response error code "ServiceUnavailableException".
ErrCodeThrottlingException for service response error code "ThrottlingException".
ErrCodeValidationException for service response error code "ValidationException".
GuardrailActionGuardrailIntervened is a GuardrailAction enum value.
GuardrailActionNone is a GuardrailAction enum value.
GuardrailContentFilterConfidenceHigh is a GuardrailContentFilterConfidence enum value.
GuardrailContentFilterConfidenceLow is a GuardrailContentFilterConfidence enum value.
GuardrailContentFilterConfidenceMedium is a GuardrailContentFilterConfidence enum value.
GuardrailContentFilterConfidenceNone is a GuardrailContentFilterConfidence enum value.
GuardrailContentFilterTypeHate is a GuardrailContentFilterType enum value.
GuardrailContentFilterTypeInsults is a GuardrailContentFilterType enum value.
GuardrailContentFilterTypeMisconduct is a GuardrailContentFilterType enum value.
GuardrailContentFilterTypePromptAttack is a GuardrailContentFilterType enum value.
GuardrailContentFilterTypeSexual is a GuardrailContentFilterType enum value.
GuardrailContentFilterTypeViolence is a GuardrailContentFilterType enum value.
GuardrailContentPolicyActionBlocked is a GuardrailContentPolicyAction enum value.
GuardrailContentQualifierGroundingSource is a GuardrailContentQualifier enum value.
GuardrailContentQualifierGuardContent is a GuardrailContentQualifier enum value.
GuardrailContentQualifierQuery is a GuardrailContentQualifier enum value.
GuardrailContentSourceInput is a GuardrailContentSource enum value.
GuardrailContentSourceOutput is a GuardrailContentSource enum value.
GuardrailContextualGroundingFilterTypeGrounding is a GuardrailContextualGroundingFilterType enum value.
GuardrailContextualGroundingFilterTypeRelevance is a GuardrailContextualGroundingFilterType enum value.
GuardrailContextualGroundingPolicyActionBlocked is a GuardrailContextualGroundingPolicyAction enum value.
GuardrailContextualGroundingPolicyActionNone is a GuardrailContextualGroundingPolicyAction enum value.
GuardrailConverseContentQualifierGroundingSource is a GuardrailConverseContentQualifier enum value.
GuardrailConverseContentQualifierGuardContent is a GuardrailConverseContentQualifier enum value.
GuardrailConverseContentQualifierQuery is a GuardrailConverseContentQualifier enum value.
GuardrailManagedWordTypeProfanity is a GuardrailManagedWordType enum value.
GuardrailPiiEntityTypeAddress is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeAge is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeAwsAccessKey is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeAwsSecretKey is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeCaHealthNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeCaSocialInsuranceNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeCreditDebitCardCvv is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeCreditDebitCardExpiry is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeCreditDebitCardNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeDriverId is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeEmail is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeInternationalBankAccountNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeIpAddress is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeLicensePlate is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeMacAddress is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeName is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypePassword is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypePhone is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypePin is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeSwiftCode is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUkNationalHealthServiceNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUkNationalInsuranceNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUrl is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUsBankAccountNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUsBankRoutingNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUsername is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUsPassportNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeUsSocialSecurityNumber is a GuardrailPiiEntityType enum value.
GuardrailPiiEntityTypeVehicleIdentificationNumber is a GuardrailPiiEntityType enum value.
GuardrailSensitiveInformationPolicyActionAnonymized is a GuardrailSensitiveInformationPolicyAction enum value.
GuardrailSensitiveInformationPolicyActionBlocked is a GuardrailSensitiveInformationPolicyAction enum value.
GuardrailStreamProcessingModeAsync is a GuardrailStreamProcessingMode enum value.
GuardrailStreamProcessingModeSync is a GuardrailStreamProcessingMode enum value.
GuardrailTopicPolicyActionBlocked is a GuardrailTopicPolicyAction enum value.
GuardrailTopicTypeDeny is a GuardrailTopicType enum value.
GuardrailTraceDisabled is a GuardrailTrace enum value.
GuardrailTraceEnabled is a GuardrailTrace enum value.
GuardrailWordPolicyActionBlocked is a GuardrailWordPolicyAction enum value.
ImageFormatGif is a ImageFormat enum value.
ImageFormatJpeg is a ImageFormat enum value.
ImageFormatPng is a ImageFormat enum value.
ImageFormatWebp is a ImageFormat enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
StopReasonContentFiltered is a StopReason enum value.
StopReasonEndTurn is a StopReason enum value.
StopReasonGuardrailIntervened is a StopReason enum value.
StopReasonMaxTokens is a StopReason enum value.
StopReasonStopSequence is a StopReason enum value.
StopReasonToolUse is a StopReason enum value.
ToolResultStatusError is a ToolResultStatus enum value.
ToolResultStatusSuccess is a ToolResultStatus enum value.
TraceDisabled is a Trace enum value.
TraceEnabled is a Trace enum value.
# Structs
The request is denied because of missing access permissions.
The model must request at least one tool (no text is generated).
The Model automatically decides if a tool should be called or whether to generate text instead.
BedrockRuntime provides the API operation methods for making requests to Amazon Bedrock Runtime.
A block of content for a message that you pass to, or receive from, a model with the Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations.
A bock of content in a streaming response.
The content block delta event.
Content block start information.
Content block start event.
A content block stop event.
Metrics for a call to Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
The output from a call to Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
ConverseStreamEventStream provides the event stream handling for the ConverseStream.
A conversation stream metadata event.
Metrics for the stream.
ConverseStreamOutput_UnknownEvent provides a failsafe event for the ConverseStreamOutput_ group of events when an unknown event is received.
The trace object in a response from ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
The trace object in a response from Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
A document to include in a message.
Contains the content of a document.
A behavior assessment of the guardrail policies used in a call to the Converse API.
Configuration information for a guardrail that you use with the Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation.
The content block to be evaluated by the guardrail.
The content filter for a guardrail.
An assessment of a content policy for a guardrail.
The details for the guardrails contextual grounding filter.
The policy assessment details for the guardrails contextual grounding filter.
A content block for selective guarding with the Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations.
A text block that contains text that you want to assess with a guardrail.
A custom word configured in a guardrail.
A managed word configured in a guardrail.
The output content produced by the guardrail.
A Personally Identifiable Information (PII) entity configured in a guardrail.
A Regex filter configured in a guardrail.
The assessment for aPersonally Identifiable Information (PII) policy.
Configuration information for a guardrail that you use with the ConverseStream action.
The text block to be evaluated by the guardrail.
Information about a topic guardrail.
A behavior assessment of a topic policy.
A Top level guardrail trace object.
The details on the use of the guardrail.
The word policy assessment.
Image content for a message.
The source for an image.
Base inference parameters to pass to a model in a call to Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
An internal server error occurred.
InvokeModelWithResponseStreamEventStream provides the event stream handling for the InvokeModelWithResponseStream.
A message input, or returned from, a call to Converse (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or ConverseStream (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
The start of a message.
The stop event for a message.
The request failed due to an error while processing the model.
The model specified in the request is not ready to serve inference requests.
An error occurred while streaming the response.
The request took too long to process.
Payload content included in the response.
The specified resource ARN was not found.
ResponseStreamUnknownEvent provides a failsafe event for the ResponseStream group of events when an unknown event is received.
Your request exceeds the service quota for your account.
The service isn't currently available.
The model must request a specific tool.
A system content block.
Your request was throttled because of service-wide limitations.
The tokens used in a message API inference call.
Information about a tool that you can use with the Converse API.
Determines which tools the model should request in a call to Converse or ConverseStream.
Configuration information for the tools that you pass to a model.
The schema for the tool.
A tool result block that contains the results for a tool request that the model previously made.
The tool result content block.
The specification for the tool.
The delta for a tool use block.
The start of a tool use block.
Input validation failed.
# Interfaces
ConverseStreamOutput_Event groups together all EventStream events writes for ConverseStreamOutput_.
ConverseStreamOutput_Reader provides the interface for reading to the stream.
ResponseStreamEvent groups together all EventStream events writes for ResponseStream.
ResponseStreamReader provides the interface for reading to the stream.