# Amazon Bedrock Runtime
<a name="API_Types_Amazon_Bedrock_Runtime"></a>

The following data types are supported by Amazon Bedrock Runtime:
+  [AnyToolChoice](API_runtime_AnyToolChoice.md) 
+  [AppliedGuardrailDetails](API_runtime_AppliedGuardrailDetails.md) 
+  [AsyncInvokeOutputDataConfig](API_runtime_AsyncInvokeOutputDataConfig.md) 
+  [AsyncInvokeS3OutputDataConfig](API_runtime_AsyncInvokeS3OutputDataConfig.md) 
+  [AsyncInvokeSummary](API_runtime_AsyncInvokeSummary.md) 
+  [AudioBlock](API_runtime_AudioBlock.md) 
+  [AudioSource](API_runtime_AudioSource.md) 
+  [AutoToolChoice](API_runtime_AutoToolChoice.md) 
+  [BidirectionalInputPayloadPart](API_runtime_BidirectionalInputPayloadPart.md) 
+  [BidirectionalOutputPayloadPart](API_runtime_BidirectionalOutputPayloadPart.md) 
+  [CacheDetail](API_runtime_CacheDetail.md) 
+  [CachePointBlock](API_runtime_CachePointBlock.md) 
+  [Citation](API_runtime_Citation.md) 
+  [CitationGeneratedContent](API_runtime_CitationGeneratedContent.md) 
+  [CitationLocation](API_runtime_CitationLocation.md) 
+  [CitationsConfig](API_runtime_CitationsConfig.md) 
+  [CitationsContentBlock](API_runtime_CitationsContentBlock.md) 
+  [CitationsDelta](API_runtime_CitationsDelta.md) 
+  [CitationSourceContent](API_runtime_CitationSourceContent.md) 
+  [CitationSourceContentDelta](API_runtime_CitationSourceContentDelta.md) 
+  [ContentBlock](API_runtime_ContentBlock.md) 
+  [ContentBlockDelta](API_runtime_ContentBlockDelta.md) 
+  [ContentBlockDeltaEvent](API_runtime_ContentBlockDeltaEvent.md) 
+  [ContentBlockStart](API_runtime_ContentBlockStart.md) 
+  [ContentBlockStartEvent](API_runtime_ContentBlockStartEvent.md) 
+  [ContentBlockStopEvent](API_runtime_ContentBlockStopEvent.md) 
+  [ConverseMetrics](API_runtime_ConverseMetrics.md) 
+  [ConverseOutput](API_runtime_ConverseOutput.md) 
+  [ConverseStreamMetadataEvent](API_runtime_ConverseStreamMetadataEvent.md) 
+  [ConverseStreamMetrics](API_runtime_ConverseStreamMetrics.md) 
+  [ConverseStreamOutput](API_runtime_ConverseStreamOutput.md) 
+  [ConverseStreamTrace](API_runtime_ConverseStreamTrace.md) 
+  [ConverseTokensRequest](API_runtime_ConverseTokensRequest.md) 
+  [ConverseTrace](API_runtime_ConverseTrace.md) 
+  [CountTokensInput](API_runtime_CountTokensInput.md) 
+  [DocumentBlock](API_runtime_DocumentBlock.md) 
+  [DocumentCharLocation](API_runtime_DocumentCharLocation.md) 
+  [DocumentChunkLocation](API_runtime_DocumentChunkLocation.md) 
+  [DocumentContentBlock](API_runtime_DocumentContentBlock.md) 
+  [DocumentPageLocation](API_runtime_DocumentPageLocation.md) 
+  [DocumentSource](API_runtime_DocumentSource.md) 
+  [ErrorBlock](API_runtime_ErrorBlock.md) 
+  [GuardrailAssessment](API_runtime_GuardrailAssessment.md) 
+  [GuardrailAutomatedReasoningFinding](API_runtime_GuardrailAutomatedReasoningFinding.md) 
+  [GuardrailAutomatedReasoningImpossibleFinding](API_runtime_GuardrailAutomatedReasoningImpossibleFinding.md) 
+  [GuardrailAutomatedReasoningInputTextReference](API_runtime_GuardrailAutomatedReasoningInputTextReference.md) 
+  [GuardrailAutomatedReasoningInvalidFinding](API_runtime_GuardrailAutomatedReasoningInvalidFinding.md) 
+  [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) 
+  [GuardrailAutomatedReasoningNoTranslationsFinding](API_runtime_GuardrailAutomatedReasoningNoTranslationsFinding.md) 
+  [GuardrailAutomatedReasoningPolicyAssessment](API_runtime_GuardrailAutomatedReasoningPolicyAssessment.md) 
+  [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md) 
+  [GuardrailAutomatedReasoningSatisfiableFinding](API_runtime_GuardrailAutomatedReasoningSatisfiableFinding.md) 
+  [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) 
+  [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) 
+  [GuardrailAutomatedReasoningTooComplexFinding](API_runtime_GuardrailAutomatedReasoningTooComplexFinding.md) 
+  [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) 
+  [GuardrailAutomatedReasoningTranslationAmbiguousFinding](API_runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding.md) 
+  [GuardrailAutomatedReasoningTranslationOption](API_runtime_GuardrailAutomatedReasoningTranslationOption.md) 
+  [GuardrailAutomatedReasoningValidFinding](API_runtime_GuardrailAutomatedReasoningValidFinding.md) 
+  [GuardrailConfiguration](API_runtime_GuardrailConfiguration.md) 
+  [GuardrailContentBlock](API_runtime_GuardrailContentBlock.md) 
+  [GuardrailContentFilter](API_runtime_GuardrailContentFilter.md) 
+  [GuardrailContentPolicyAssessment](API_runtime_GuardrailContentPolicyAssessment.md) 
+  [GuardrailContextualGroundingFilter](API_runtime_GuardrailContextualGroundingFilter.md) 
+  [GuardrailContextualGroundingPolicyAssessment](API_runtime_GuardrailContextualGroundingPolicyAssessment.md) 
+  [GuardrailConverseContentBlock](API_runtime_GuardrailConverseContentBlock.md) 
+  [GuardrailConverseImageBlock](API_runtime_GuardrailConverseImageBlock.md) 
+  [GuardrailConverseImageSource](API_runtime_GuardrailConverseImageSource.md) 
+  [GuardrailConverseTextBlock](API_runtime_GuardrailConverseTextBlock.md) 
+  [GuardrailCoverage](API_runtime_GuardrailCoverage.md) 
+  [GuardrailCustomWord](API_runtime_GuardrailCustomWord.md) 
+  [GuardrailImageBlock](API_runtime_GuardrailImageBlock.md) 
+  [GuardrailImageCoverage](API_runtime_GuardrailImageCoverage.md) 
+  [GuardrailImageSource](API_runtime_GuardrailImageSource.md) 
+  [GuardrailInvocationMetrics](API_runtime_GuardrailInvocationMetrics.md) 
+  [GuardrailManagedWord](API_runtime_GuardrailManagedWord.md) 
+  [GuardrailOutputContent](API_runtime_GuardrailOutputContent.md) 
+  [GuardrailPiiEntityFilter](API_runtime_GuardrailPiiEntityFilter.md) 
+  [GuardrailRegexFilter](API_runtime_GuardrailRegexFilter.md) 
+  [GuardrailSensitiveInformationPolicyAssessment](API_runtime_GuardrailSensitiveInformationPolicyAssessment.md) 
+  [GuardrailStreamConfiguration](API_runtime_GuardrailStreamConfiguration.md) 
+  [GuardrailTextBlock](API_runtime_GuardrailTextBlock.md) 
+  [GuardrailTextCharactersCoverage](API_runtime_GuardrailTextCharactersCoverage.md) 
+  [GuardrailTopic](API_runtime_GuardrailTopic.md) 
+  [GuardrailTopicPolicyAssessment](API_runtime_GuardrailTopicPolicyAssessment.md) 
+  [GuardrailTraceAssessment](API_runtime_GuardrailTraceAssessment.md) 
+  [GuardrailUsage](API_runtime_GuardrailUsage.md) 
+  [GuardrailWordPolicyAssessment](API_runtime_GuardrailWordPolicyAssessment.md) 
+  [ImageBlock](API_runtime_ImageBlock.md) 
+  [ImageBlockDelta](API_runtime_ImageBlockDelta.md) 
+  [ImageBlockStart](API_runtime_ImageBlockStart.md) 
+  [ImageSource](API_runtime_ImageSource.md) 
+  [InferenceConfiguration](API_runtime_InferenceConfiguration.md) 
+  [InvokeModelTokensRequest](API_runtime_InvokeModelTokensRequest.md) 
+  [InvokeModelWithBidirectionalStreamInput](API_runtime_InvokeModelWithBidirectionalStreamInput.md) 
+  [InvokeModelWithBidirectionalStreamOutput](API_runtime_InvokeModelWithBidirectionalStreamOutput.md) 
+  [JsonSchemaDefinition](API_runtime_JsonSchemaDefinition.md) 
+  [Message](API_runtime_Message.md) 
+  [MessageStartEvent](API_runtime_MessageStartEvent.md) 
+  [MessageStopEvent](API_runtime_MessageStopEvent.md) 
+  [OutputConfig](API_runtime_OutputConfig.md) 
+  [OutputFormat](API_runtime_OutputFormat.md) 
+  [OutputFormatStructure](API_runtime_OutputFormatStructure.md) 
+  [PayloadPart](API_runtime_PayloadPart.md) 
+  [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) 
+  [PromptRouterTrace](API_runtime_PromptRouterTrace.md) 
+  [PromptVariableValues](API_runtime_PromptVariableValues.md) 
+  [ReasoningContentBlock](API_runtime_ReasoningContentBlock.md) 
+  [ReasoningContentBlockDelta](API_runtime_ReasoningContentBlockDelta.md) 
+  [ReasoningTextBlock](API_runtime_ReasoningTextBlock.md) 
+  [ResponseStream](API_runtime_ResponseStream.md) 
+  [S3Location](API_runtime_S3Location.md) 
+  [SearchResultBlock](API_runtime_SearchResultBlock.md) 
+  [SearchResultContentBlock](API_runtime_SearchResultContentBlock.md) 
+  [SearchResultLocation](API_runtime_SearchResultLocation.md) 
+  [ServiceTier](API_runtime_ServiceTier.md) 
+  [SpecificToolChoice](API_runtime_SpecificToolChoice.md) 
+  [SystemContentBlock](API_runtime_SystemContentBlock.md) 
+  [SystemTool](API_runtime_SystemTool.md) 
+  [Tag](API_runtime_Tag.md) 
+  [TokenUsage](API_runtime_TokenUsage.md) 
+  [Tool](API_runtime_Tool.md) 
+  [ToolChoice](API_runtime_ToolChoice.md) 
+  [ToolConfiguration](API_runtime_ToolConfiguration.md) 
+  [ToolInputSchema](API_runtime_ToolInputSchema.md) 
+  [ToolResultBlock](API_runtime_ToolResultBlock.md) 
+  [ToolResultBlockDelta](API_runtime_ToolResultBlockDelta.md) 
+  [ToolResultBlockStart](API_runtime_ToolResultBlockStart.md) 
+  [ToolResultContentBlock](API_runtime_ToolResultContentBlock.md) 
+  [ToolSpecification](API_runtime_ToolSpecification.md) 
+  [ToolUseBlock](API_runtime_ToolUseBlock.md) 
+  [ToolUseBlockDelta](API_runtime_ToolUseBlockDelta.md) 
+  [ToolUseBlockStart](API_runtime_ToolUseBlockStart.md) 
+  [VideoBlock](API_runtime_VideoBlock.md) 
+  [VideoSource](API_runtime_VideoSource.md) 
+  [WebLocation](API_runtime_WebLocation.md) 

# AnyToolChoice
<a name="API_runtime_AnyToolChoice"></a>

The model must request at least one tool (no text is generated). For example, `{"any" : {}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_AnyToolChoice_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_runtime_AnyToolChoice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AnyToolChoice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AnyToolChoice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AnyToolChoice) 

# AppliedGuardrailDetails
<a name="API_runtime_AppliedGuardrailDetails"></a>

Details about the specific guardrail that was applied during this assessment, including its identifier, version, ARN, origin, and ownership information.

## Contents
<a name="API_runtime_AppliedGuardrailDetails_Contents"></a>

 ** guardrailArn **   <a name="bedrock-Type-runtime_AppliedGuardrailDetails-guardrailArn"></a>
The ARN of the guardrail that was applied.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+)`   
Required: No

 ** guardrailId **   <a name="bedrock-Type-runtime_AppliedGuardrailDetails-guardrailId"></a>
The unique ID of the guardrail that was applied.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `([a-z0-9]+)`   
Required: No

 ** guardrailOrigin **   <a name="bedrock-Type-runtime_AppliedGuardrailDetails-guardrailOrigin"></a>
The origin of how the guardrail was applied. This can be either requested at the API level or enforced at the account or organization level as a default guardrail.  
Type: Array of strings  
Valid Values: `REQUEST | ACCOUNT_ENFORCED | ORGANIZATION_ENFORCED`   
Required: No

 ** guardrailOwnership **   <a name="bedrock-Type-runtime_AppliedGuardrailDetails-guardrailOwnership"></a>
The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account.  
Type: String  
Valid Values: `SELF | CROSS_ACCOUNT`   
Required: No

 ** guardrailVersion **   <a name="bedrock-Type-runtime_AppliedGuardrailDetails-guardrailVersion"></a>
The version of the guardrail that was applied.  
Type: String  
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`   
Required: No

## See Also
<a name="API_runtime_AppliedGuardrailDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AppliedGuardrailDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AppliedGuardrailDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AppliedGuardrailDetails) 

# AsyncInvokeOutputDataConfig
<a name="API_runtime_AsyncInvokeOutputDataConfig"></a>

Asynchronous invocation output data settings.

## Contents
<a name="API_runtime_AsyncInvokeOutputDataConfig_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** s3OutputDataConfig **   <a name="bedrock-Type-runtime_AsyncInvokeOutputDataConfig-s3OutputDataConfig"></a>
A storage location for the output data in an S3 bucket  
Type: [AsyncInvokeS3OutputDataConfig](API_runtime_AsyncInvokeS3OutputDataConfig.md) object  
Required: No

## See Also
<a name="API_runtime_AsyncInvokeOutputDataConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AsyncInvokeOutputDataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AsyncInvokeOutputDataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AsyncInvokeOutputDataConfig) 

# AsyncInvokeS3OutputDataConfig
<a name="API_runtime_AsyncInvokeS3OutputDataConfig"></a>

Asynchronous invocation output data settings.

## Contents
<a name="API_runtime_AsyncInvokeS3OutputDataConfig_Contents"></a>

 ** s3Uri **   <a name="bedrock-Type-runtime_AsyncInvokeS3OutputDataConfig-s3Uri"></a>
An object URI starting with `s3://`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?`   
Required: Yes

 ** bucketOwner **   <a name="bedrock-Type-runtime_AsyncInvokeS3OutputDataConfig-bucketOwner"></a>
If the bucket belongs to another AWS account, specify that account's ID.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** kmsKeyId **   <a name="bedrock-Type-runtime_AsyncInvokeS3OutputDataConfig-kmsKeyId"></a>
A KMS encryption key ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+))`   
Required: No

## See Also
<a name="API_runtime_AsyncInvokeS3OutputDataConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AsyncInvokeS3OutputDataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AsyncInvokeS3OutputDataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AsyncInvokeS3OutputDataConfig) 

# AsyncInvokeSummary
<a name="API_runtime_AsyncInvokeSummary"></a>

A summary of an asynchronous invocation.

## Contents
<a name="API_runtime_AsyncInvokeSummary_Contents"></a>

 ** invocationArn **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-invocationArn"></a>
The invocation's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}`   
Required: Yes

 ** modelArn **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-modelArn"></a>
The invoked model's ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z0-9\-]+:bedrock:[a-z0-9\-]*:[0-9]*:(provisioned-model|foundation-model)/.+`   
Required: Yes

 ** outputDataConfig **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-outputDataConfig"></a>
The invocation's output data settings.  
Type: [AsyncInvokeOutputDataConfig](API_runtime_AsyncInvokeOutputDataConfig.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** submitTime **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-submitTime"></a>
When the invocation was submitted.  
Type: Timestamp  
Required: Yes

 ** clientRequestToken **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-clientRequestToken"></a>
The invocation's idempotency token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[!-~]*`   
Required: No

 ** endTime **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-endTime"></a>
When the invocation ended.  
Type: Timestamp  
Required: No

 ** failureMessage **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-failureMessage"></a>
An error message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** lastModifiedTime **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-lastModifiedTime"></a>
When the invocation was last modified.  
Type: Timestamp  
Required: No

 ** status **   <a name="bedrock-Type-runtime_AsyncInvokeSummary-status"></a>
The invocation's status.  
Type: String  
Valid Values: `InProgress | Completed | Failed`   
Required: No

## See Also
<a name="API_runtime_AsyncInvokeSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AsyncInvokeSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AsyncInvokeSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AsyncInvokeSummary) 

# AudioBlock
<a name="API_runtime_AudioBlock"></a>

An audio content block that contains audio data in various supported formats.

## Contents
<a name="API_runtime_AudioBlock_Contents"></a>

 ** format **   <a name="bedrock-Type-runtime_AudioBlock-format"></a>
The format of the audio data, such as MP3, WAV, FLAC, or other supported audio formats.  
Type: String  
Valid Values: `mp3 | opus | wav | aac | flac | mp4 | ogg | mkv | mka | x-aac | m4a | mpeg | mpga | pcm | webm`   
Required: Yes

 ** source **   <a name="bedrock-Type-runtime_AudioBlock-source"></a>
The source of the audio data, which can be provided as raw bytes or an S3 location.  
Type: [AudioSource](API_runtime_AudioSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** error **   <a name="bedrock-Type-runtime_AudioBlock-error"></a>
Error information if the audio block could not be processed or contains invalid data.  
Type: [ErrorBlock](API_runtime_ErrorBlock.md) object  
Required: No

## See Also
<a name="API_runtime_AudioBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AudioBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AudioBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AudioBlock) 

# AudioSource
<a name="API_runtime_AudioSource"></a>

The source of audio data, which can be provided either as raw bytes or a reference to an S3 location.

## Contents
<a name="API_runtime_AudioSource_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** bytes **   <a name="bedrock-Type-runtime_AudioSource-bytes"></a>
Audio data encoded in base64.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1.  
Required: No

 ** s3Location **   <a name="bedrock-Type-runtime_AudioSource-s3Location"></a>
A reference to audio data stored in an Amazon S3 bucket. To see which models support S3 uploads, see [Supported models and features for Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).  
Type: [S3Location](API_runtime_S3Location.md) object  
Required: No

## See Also
<a name="API_runtime_AudioSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AudioSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AudioSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AudioSource) 

# AutoToolChoice
<a name="API_runtime_AutoToolChoice"></a>

The Model automatically decides if a tool should be called or whether to generate text instead. For example, `{"auto" : {}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide

## Contents
<a name="API_runtime_AutoToolChoice_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_runtime_AutoToolChoice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AutoToolChoice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AutoToolChoice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AutoToolChoice) 

# BidirectionalInputPayloadPart
<a name="API_runtime_BidirectionalInputPayloadPart"></a>

Payload content for the bidirectional input. The input is an audio stream.

## Contents
<a name="API_runtime_BidirectionalInputPayloadPart_Contents"></a>

 ** bytes **   <a name="bedrock-Type-runtime_BidirectionalInputPayloadPart-bytes"></a>
The audio content for the bidirectional input.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 0. Maximum length of 1000000.  
Required: No

## See Also
<a name="API_runtime_BidirectionalInputPayloadPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/BidirectionalInputPayloadPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/BidirectionalInputPayloadPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/BidirectionalInputPayloadPart) 

# BidirectionalOutputPayloadPart
<a name="API_runtime_BidirectionalOutputPayloadPart"></a>

Output from the bidirectional stream. The output is speech and a text transcription.

## Contents
<a name="API_runtime_BidirectionalOutputPayloadPart_Contents"></a>

 ** bytes **   <a name="bedrock-Type-runtime_BidirectionalOutputPayloadPart-bytes"></a>
The speech output of the bidirectional stream.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 0. Maximum length of 1000000.  
Required: No

## See Also
<a name="API_runtime_BidirectionalOutputPayloadPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/BidirectionalOutputPayloadPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/BidirectionalOutputPayloadPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/BidirectionalOutputPayloadPart) 

# CacheDetail
<a name="API_runtime_CacheDetail"></a>

Cache creation metrics for a specific TTL duration

## Contents
<a name="API_runtime_CacheDetail_Contents"></a>

 ** inputTokens **   <a name="bedrock-Type-runtime_CacheDetail-inputTokens"></a>
Number of tokens written to cache with this TTL (cache creation tokens)  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** ttl **   <a name="bedrock-Type-runtime_CacheDetail-ttl"></a>
TTL duration for these cached tokens  
Type: String  
Valid Values: `5m | 1h`   
Required: Yes

## See Also
<a name="API_runtime_CacheDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CacheDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CacheDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CacheDetail) 

# CachePointBlock
<a name="API_runtime_CachePointBlock"></a>

Defines a section of content to be cached for reuse in subsequent API calls.

## Contents
<a name="API_runtime_CachePointBlock_Contents"></a>

 ** type **   <a name="bedrock-Type-runtime_CachePointBlock-type"></a>
Specifies the type of cache point within the CachePointBlock.  
Type: String  
Valid Values: `default`   
Required: Yes

 ** ttl **   <a name="bedrock-Type-runtime_CachePointBlock-ttl"></a>
Optional TTL duration for cache entries. When specified, enables extended TTL caching with the specified duration. When omitted, uses `type` value for caching behavior.  
Type: String  
Valid Values: `5m | 1h`   
Required: No

## See Also
<a name="API_runtime_CachePointBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CachePointBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CachePointBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CachePointBlock) 

# Citation
<a name="API_runtime_Citation"></a>

Contains information about a citation that references a specific source document. Citations provide traceability between the model's generated response and the source documents that informed that response.

## Contents
<a name="API_runtime_Citation_Contents"></a>

 ** location **   <a name="bedrock-Type-runtime_Citation-location"></a>
The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.  
Type: [CitationLocation](API_runtime_CitationLocation.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** source **   <a name="bedrock-Type-runtime_Citation-source"></a>
The source from the original search result that provided the cited content.  
Type: String  
Required: No

 ** sourceContent **   <a name="bedrock-Type-runtime_Citation-sourceContent"></a>
The specific content from the source document that was referenced or cited in the generated response.  
Type: Array of [CitationSourceContent](API_runtime_CitationSourceContent.md) objects  
Required: No

 ** title **   <a name="bedrock-Type-runtime_Citation-title"></a>
The title or identifier of the source document being cited.  
Type: String  
Required: No

## See Also
<a name="API_runtime_Citation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Citation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Citation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Citation) 

# CitationGeneratedContent
<a name="API_runtime_CitationGeneratedContent"></a>

Contains the generated text content that corresponds to or is supported by a citation from a source document.

## Contents
<a name="API_runtime_CitationGeneratedContent_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** text **   <a name="bedrock-Type-runtime_CitationGeneratedContent-text"></a>
The text content that was generated by the model and is supported by the associated citation.  
Type: String  
Required: No

## See Also
<a name="API_runtime_CitationGeneratedContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationGeneratedContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationGeneratedContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationGeneratedContent) 

# CitationLocation
<a name="API_runtime_CitationLocation"></a>

Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

## Contents
<a name="API_runtime_CitationLocation_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** documentChar **   <a name="bedrock-Type-runtime_CitationLocation-documentChar"></a>
The character-level location within the document where the cited content is found.  
Type: [DocumentCharLocation](API_runtime_DocumentCharLocation.md) object  
Required: No

 ** documentChunk **   <a name="bedrock-Type-runtime_CitationLocation-documentChunk"></a>
The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.  
Type: [DocumentChunkLocation](API_runtime_DocumentChunkLocation.md) object  
Required: No

 ** documentPage **   <a name="bedrock-Type-runtime_CitationLocation-documentPage"></a>
The page-level location within the document where the cited content is found.  
Type: [DocumentPageLocation](API_runtime_DocumentPageLocation.md) object  
Required: No

 ** searchResultLocation **   <a name="bedrock-Type-runtime_CitationLocation-searchResultLocation"></a>
The search result location where the cited content is found, including the search result index and block positions within the content array.  
Type: [SearchResultLocation](API_runtime_SearchResultLocation.md) object  
Required: No

 ** web **   <a name="bedrock-Type-runtime_CitationLocation-web"></a>
The web URL that was cited for this reference.  
Type: [WebLocation](API_runtime_WebLocation.md) object  
Required: No

## See Also
<a name="API_runtime_CitationLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationLocation) 

# CitationsConfig
<a name="API_runtime_CitationsConfig"></a>

Configuration settings for enabling and controlling document citations in Converse API responses. When enabled, the model can include citation information that links generated content back to specific source documents.

## Contents
<a name="API_runtime_CitationsConfig_Contents"></a>

 ** enabled **   <a name="bedrock-Type-runtime_CitationsConfig-enabled"></a>
Specifies whether citations from the selected document should be used in the model's response. When set to true, the model can generate citations that reference the source documents used to inform the response.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_runtime_CitationsConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationsConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationsConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationsConfig) 

# CitationsContentBlock
<a name="API_runtime_CitationsContentBlock"></a>

A content block that contains both generated text and associated citation information. This block type is returned when document citations are enabled, providing traceability between the generated content and the source documents that informed the response.

## Contents
<a name="API_runtime_CitationsContentBlock_Contents"></a>

 ** citations **   <a name="bedrock-Type-runtime_CitationsContentBlock-citations"></a>
An array of citations that reference the source documents used to generate the associated content.  
Type: Array of [Citation](API_runtime_Citation.md) objects  
Required: No

 ** content **   <a name="bedrock-Type-runtime_CitationsContentBlock-content"></a>
The generated content that is supported by the associated citations.  
Type: Array of [CitationGeneratedContent](API_runtime_CitationGeneratedContent.md) objects  
Required: No

## See Also
<a name="API_runtime_CitationsContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationsContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationsContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationsContentBlock) 

# CitationsDelta
<a name="API_runtime_CitationsDelta"></a>

Contains incremental updates to citation information during streaming responses. This allows clients to build up citation data progressively as the response is generated.

## Contents
<a name="API_runtime_CitationsDelta_Contents"></a>

 ** location **   <a name="bedrock-Type-runtime_CitationsDelta-location"></a>
Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.  
Type: [CitationLocation](API_runtime_CitationLocation.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** source **   <a name="bedrock-Type-runtime_CitationsDelta-source"></a>
The source from the original search result that provided the cited content.  
Type: String  
Required: No

 ** sourceContent **   <a name="bedrock-Type-runtime_CitationsDelta-sourceContent"></a>
The specific content from the source document that was referenced or cited in the generated response.  
Type: Array of [CitationSourceContentDelta](API_runtime_CitationSourceContentDelta.md) objects  
Required: No

 ** title **   <a name="bedrock-Type-runtime_CitationsDelta-title"></a>
The title or identifier of the source document being cited.  
Type: String  
Required: No

## See Also
<a name="API_runtime_CitationsDelta_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationsDelta) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationsDelta) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationsDelta) 

# CitationSourceContent
<a name="API_runtime_CitationSourceContent"></a>

Contains the actual text content from a source document that is being cited or referenced in the model's response.

## Contents
<a name="API_runtime_CitationSourceContent_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** text **   <a name="bedrock-Type-runtime_CitationSourceContent-text"></a>
The text content from the source document that is being cited.  
Type: String  
Required: No

## See Also
<a name="API_runtime_CitationSourceContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationSourceContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationSourceContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationSourceContent) 

# CitationSourceContentDelta
<a name="API_runtime_CitationSourceContentDelta"></a>

Contains incremental updates to the source content text during streaming responses, allowing clients to build up the cited content progressively.

## Contents
<a name="API_runtime_CitationSourceContentDelta_Contents"></a>

 ** text **   <a name="bedrock-Type-runtime_CitationSourceContentDelta-text"></a>
An incremental update to the text content from the source document that is being cited.  
Type: String  
Required: No

## See Also
<a name="API_runtime_CitationSourceContentDelta_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationSourceContentDelta) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationSourceContentDelta) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationSourceContentDelta) 

# ContentBlock
<a name="API_runtime_ContentBlock"></a>

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.

## Contents
<a name="API_runtime_ContentBlock_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** audio **   <a name="bedrock-Type-runtime_ContentBlock-audio"></a>
An audio content block containing audio data in the conversation.  
Type: [AudioBlock](API_runtime_AudioBlock.md) object  
Required: No

 ** cachePoint **   <a name="bedrock-Type-runtime_ContentBlock-cachePoint"></a>
CachePoint to include in the message.  
Type: [CachePointBlock](API_runtime_CachePointBlock.md) object  
Required: No

 ** citationsContent **   <a name="bedrock-Type-runtime_ContentBlock-citationsContent"></a>
A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.  
Type: [CitationsContentBlock](API_runtime_CitationsContentBlock.md) object  
Required: No

 ** document **   <a name="bedrock-Type-runtime_ContentBlock-document"></a>
A document to include in the message.  
Type: [DocumentBlock](API_runtime_DocumentBlock.md) object  
Required: No

 ** guardContent **   <a name="bedrock-Type-runtime_ContentBlock-guardContent"></a>
Contains the content to assess with the guardrail. If you don't specify `guardContent` in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.  
For more information, see [Use a guardrail with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-use-converse-api.html).  
Type: [GuardrailConverseContentBlock](API_runtime_GuardrailConverseContentBlock.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** image **   <a name="bedrock-Type-runtime_ContentBlock-image"></a>
Image to include in the message.   
This field is only supported by Anthropic Claude 3 models.
Type: [ImageBlock](API_runtime_ImageBlock.md) object  
Required: No

 ** reasoningContent **   <a name="bedrock-Type-runtime_ContentBlock-reasoningContent"></a>
Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.  
Type: [ReasoningContentBlock](API_runtime_ReasoningContentBlock.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** searchResult **   <a name="bedrock-Type-runtime_ContentBlock-searchResult"></a>
Search result to include in the message.  
Type: [SearchResultBlock](API_runtime_SearchResultBlock.md) object  
Required: No

 ** text **   <a name="bedrock-Type-runtime_ContentBlock-text"></a>
Text to include in the message.  
Type: String  
Required: No

 ** toolResult **   <a name="bedrock-Type-runtime_ContentBlock-toolResult"></a>
The result for a tool request that a model makes.  
Type: [ToolResultBlock](API_runtime_ToolResultBlock.md) object  
Required: No

 ** toolUse **   <a name="bedrock-Type-runtime_ContentBlock-toolUse"></a>
Information about a tool use request from a model.  
Type: [ToolUseBlock](API_runtime_ToolUseBlock.md) object  
Required: No

 ** video **   <a name="bedrock-Type-runtime_ContentBlock-video"></a>
Video to include in the message.   
Type: [VideoBlock](API_runtime_VideoBlock.md) object  
Required: No

## See Also
<a name="API_runtime_ContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlock) 

# ContentBlockDelta
<a name="API_runtime_ContentBlockDelta"></a>

A block of content in a streaming response.

## Contents
<a name="API_runtime_ContentBlockDelta_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** citation **   <a name="bedrock-Type-runtime_ContentBlockDelta-citation"></a>
Incremental citation information that is streamed as part of the response generation process.  
Type: [CitationsDelta](API_runtime_CitationsDelta.md) object  
Required: No

 ** image **   <a name="bedrock-Type-runtime_ContentBlockDelta-image"></a>
A streaming delta event containing incremental image data.  
Type: [ImageBlockDelta](API_runtime_ImageBlockDelta.md) object  
Required: No

 ** reasoningContent **   <a name="bedrock-Type-runtime_ContentBlockDelta-reasoningContent"></a>
Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.  
Type: [ReasoningContentBlockDelta](API_runtime_ReasoningContentBlockDelta.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** text **   <a name="bedrock-Type-runtime_ContentBlockDelta-text"></a>
The content text.  
Type: String  
Required: No

 ** toolResult **   <a name="bedrock-Type-runtime_ContentBlockDelta-toolResult"></a>
An incremental update that contains the results from a tool call.  
Type: Array of [ToolResultBlockDelta](API_runtime_ToolResultBlockDelta.md) objects  
Required: No

 ** toolUse **   <a name="bedrock-Type-runtime_ContentBlockDelta-toolUse"></a>
Information about a tool that the model is requesting to use.  
Type: [ToolUseBlockDelta](API_runtime_ToolUseBlockDelta.md) object  
Required: No

## See Also
<a name="API_runtime_ContentBlockDelta_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockDelta) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockDelta) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockDelta) 

# ContentBlockDeltaEvent
<a name="API_runtime_ContentBlockDeltaEvent"></a>

The content block delta event.

## Contents
<a name="API_runtime_ContentBlockDeltaEvent_Contents"></a>

 ** contentBlockIndex **   <a name="bedrock-Type-runtime_ContentBlockDeltaEvent-contentBlockIndex"></a>
The block index for a content block delta event.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** delta **   <a name="bedrock-Type-runtime_ContentBlockDeltaEvent-delta"></a>
The delta for a content block delta event.  
Type: [ContentBlockDelta](API_runtime_ContentBlockDelta.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_runtime_ContentBlockDeltaEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockDeltaEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockDeltaEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockDeltaEvent) 

# ContentBlockStart
<a name="API_runtime_ContentBlockStart"></a>

Content block start information.

## Contents
<a name="API_runtime_ContentBlockStart_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** image **   <a name="bedrock-Type-runtime_ContentBlockStart-image"></a>
The initial event indicating the start of a streaming image block.  
Type: [ImageBlockStart](API_runtime_ImageBlockStart.md) object  
Required: No

 ** toolResult **   <a name="bedrock-Type-runtime_ContentBlockStart-toolResult"></a>
The   
Type: [ToolResultBlockStart](API_runtime_ToolResultBlockStart.md) object  
Required: No

 ** toolUse **   <a name="bedrock-Type-runtime_ContentBlockStart-toolUse"></a>
Information about a tool that the model is requesting to use.  
Type: [ToolUseBlockStart](API_runtime_ToolUseBlockStart.md) object  
Required: No

## See Also
<a name="API_runtime_ContentBlockStart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockStart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockStart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockStart) 

# ContentBlockStartEvent
<a name="API_runtime_ContentBlockStartEvent"></a>

Content block start event.

## Contents
<a name="API_runtime_ContentBlockStartEvent_Contents"></a>

 ** contentBlockIndex **   <a name="bedrock-Type-runtime_ContentBlockStartEvent-contentBlockIndex"></a>
The index for a content block start event.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** start **   <a name="bedrock-Type-runtime_ContentBlockStartEvent-start"></a>
Start information about a content block start event.   
Type: [ContentBlockStart](API_runtime_ContentBlockStart.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_runtime_ContentBlockStartEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockStartEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockStartEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockStartEvent) 

# ContentBlockStopEvent
<a name="API_runtime_ContentBlockStopEvent"></a>

A content block stop event.

## Contents
<a name="API_runtime_ContentBlockStopEvent_Contents"></a>

 ** contentBlockIndex **   <a name="bedrock-Type-runtime_ContentBlockStopEvent-contentBlockIndex"></a>
The index for a content block.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

## See Also
<a name="API_runtime_ContentBlockStopEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockStopEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockStopEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockStopEvent) 

# ConverseMetrics
<a name="API_runtime_ConverseMetrics"></a>

Metrics for a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).

## Contents
<a name="API_runtime_ConverseMetrics_Contents"></a>

 ** latencyMs **   <a name="bedrock-Type-runtime_ConverseMetrics-latencyMs"></a>
The latency of the call to `Converse`, in milliseconds.   
Type: Long  
Required: Yes

## See Also
<a name="API_runtime_ConverseMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseMetrics) 

# ConverseOutput
<a name="API_runtime_ConverseOutput"></a>

The output from a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).

## Contents
<a name="API_runtime_ConverseOutput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** message **   <a name="bedrock-Type-runtime_ConverseOutput-message"></a>
The message that the model generates.  
Type: [Message](API_runtime_Message.md) object  
Required: No

## See Also
<a name="API_runtime_ConverseOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseOutput) 

# ConverseStreamMetadataEvent
<a name="API_runtime_ConverseStreamMetadataEvent"></a>

A conversation stream metadata event.

## Contents
<a name="API_runtime_ConverseStreamMetadataEvent_Contents"></a>

 ** metrics **   <a name="bedrock-Type-runtime_ConverseStreamMetadataEvent-metrics"></a>
The metrics for the conversation stream metadata event.  
Type: [ConverseStreamMetrics](API_runtime_ConverseStreamMetrics.md) object  
Required: Yes

 ** usage **   <a name="bedrock-Type-runtime_ConverseStreamMetadataEvent-usage"></a>
Usage information for the conversation stream event.  
Type: [TokenUsage](API_runtime_TokenUsage.md) object  
Required: Yes

 ** performanceConfig **   <a name="bedrock-Type-runtime_ConverseStreamMetadataEvent-performanceConfig"></a>
Model performance configuration metadata for the conversation stream event.  
Type: [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) object  
Required: No

 ** serviceTier **   <a name="bedrock-Type-runtime_ConverseStreamMetadataEvent-serviceTier"></a>
Specifies the processing tier configuration used for serving the request.  
Type: [ServiceTier](API_runtime_ServiceTier.md) object  
Required: No

 ** trace **   <a name="bedrock-Type-runtime_ConverseStreamMetadataEvent-trace"></a>
The trace object in the response from [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) that contains information about the guardrail behavior.  
Type: [ConverseStreamTrace](API_runtime_ConverseStreamTrace.md) object  
Required: No

## See Also
<a name="API_runtime_ConverseStreamMetadataEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStreamMetadataEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStreamMetadataEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStreamMetadataEvent) 

# ConverseStreamMetrics
<a name="API_runtime_ConverseStreamMetrics"></a>

Metrics for the stream.

## Contents
<a name="API_runtime_ConverseStreamMetrics_Contents"></a>

 ** latencyMs **   <a name="bedrock-Type-runtime_ConverseStreamMetrics-latencyMs"></a>
The latency for the streaming request, in milliseconds.  
Type: Long  
Required: Yes

## See Also
<a name="API_runtime_ConverseStreamMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStreamMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStreamMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStreamMetrics) 

# ConverseStreamOutput
<a name="API_runtime_ConverseStreamOutput"></a>

The messages output stream

## Contents
<a name="API_runtime_ConverseStreamOutput_Contents"></a>

 ** contentBlockDelta **   <a name="bedrock-Type-runtime_ConverseStreamOutput-contentBlockDelta"></a>
The messages output content block delta.  
Type: [ContentBlockDeltaEvent](API_runtime_ContentBlockDeltaEvent.md) object  
Required: No

 ** contentBlockStart **   <a name="bedrock-Type-runtime_ConverseStreamOutput-contentBlockStart"></a>
Start information for a content block.  
Type: [ContentBlockStartEvent](API_runtime_ContentBlockStartEvent.md) object  
Required: No

 ** contentBlockStop **   <a name="bedrock-Type-runtime_ConverseStreamOutput-contentBlockStop"></a>
Stop information for a content block.  
Type: [ContentBlockStopEvent](API_runtime_ContentBlockStopEvent.md) object  
Required: No

 ** internalServerException **   <a name="bedrock-Type-runtime_ConverseStreamOutput-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500  
Required: No

 ** messageStart **   <a name="bedrock-Type-runtime_ConverseStreamOutput-messageStart"></a>
Message start information.  
Type: [MessageStartEvent](API_runtime_MessageStartEvent.md) object  
Required: No

 ** messageStop **   <a name="bedrock-Type-runtime_ConverseStreamOutput-messageStop"></a>
Message stop information.  
Type: [MessageStopEvent](API_runtime_MessageStopEvent.md) object  
Required: No

 ** metadata **   <a name="bedrock-Type-runtime_ConverseStreamOutput-metadata"></a>
Metadata for the converse output stream.  
Type: [ConverseStreamMetadataEvent](API_runtime_ConverseStreamMetadataEvent.md) object  
Required: No

 ** modelStreamErrorException **   <a name="bedrock-Type-runtime_ConverseStreamOutput-modelStreamErrorException"></a>
A streaming error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 424  
Required: No

 ** serviceUnavailableException **   <a name="bedrock-Type-runtime_ConverseStreamOutput-serviceUnavailableException"></a>
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide  
Type: Exception  
HTTP Status Code: 503  
Required: No

 ** throttlingException **   <a name="bedrock-Type-runtime_ConverseStreamOutput-throttlingException"></a>
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide.  
Type: Exception  
HTTP Status Code: 429  
Required: No

 ** validationException **   <a name="bedrock-Type-runtime_ConverseStreamOutput-validationException"></a>
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide.  
Type: Exception  
HTTP Status Code: 400  
Required: No

## See Also
<a name="API_runtime_ConverseStreamOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStreamOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStreamOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStreamOutput) 

# ConverseStreamTrace
<a name="API_runtime_ConverseStreamTrace"></a>

The trace object in a response from [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).

## Contents
<a name="API_runtime_ConverseStreamTrace_Contents"></a>

 ** guardrail **   <a name="bedrock-Type-runtime_ConverseStreamTrace-guardrail"></a>
The guardrail trace object.   
Type: [GuardrailTraceAssessment](API_runtime_GuardrailTraceAssessment.md) object  
Required: No

 ** promptRouter **   <a name="bedrock-Type-runtime_ConverseStreamTrace-promptRouter"></a>
The request's prompt router.  
Type: [PromptRouterTrace](API_runtime_PromptRouterTrace.md) object  
Required: No

## See Also
<a name="API_runtime_ConverseStreamTrace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStreamTrace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStreamTrace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStreamTrace) 

# ConverseTokensRequest
<a name="API_runtime_ConverseTokensRequest"></a>

The inputs from a `Converse` API request for token counting.

This structure mirrors the input format for the `Converse` operation, allowing you to count tokens for conversation-based inference requests.

## Contents
<a name="API_runtime_ConverseTokensRequest_Contents"></a>

 ** additionalModelRequestFields **   <a name="bedrock-Type-runtime_ConverseTokensRequest-additionalModelRequestFields"></a>
The additionalModelRequestFields of Converse input request to count tokens for. Use this field when you want to pass additional parameters that the model supports.  
Type: JSON value  
Required: No

 ** messages **   <a name="bedrock-Type-runtime_ConverseTokensRequest-messages"></a>
An array of messages to count tokens for.  
Type: Array of [Message](API_runtime_Message.md) objects  
Required: No

 ** system **   <a name="bedrock-Type-runtime_ConverseTokensRequest-system"></a>
The system content blocks to count tokens for. System content provides instructions or context to the model about how it should behave or respond. The token count will include any system content provided.  
Type: Array of [SystemContentBlock](API_runtime_SystemContentBlock.md) objects  
Required: No

 ** toolConfig **   <a name="bedrock-Type-runtime_ConverseTokensRequest-toolConfig"></a>
The toolConfig of Converse input request to count tokens for. Configuration information for the tools that the model can use when generating a response.  
Type: [ToolConfiguration](API_runtime_ToolConfiguration.md) object  
Required: No

## See Also
<a name="API_runtime_ConverseTokensRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseTokensRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseTokensRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseTokensRequest) 

# ConverseTrace
<a name="API_runtime_ConverseTrace"></a>

The trace object in a response from [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).

## Contents
<a name="API_runtime_ConverseTrace_Contents"></a>

 ** guardrail **   <a name="bedrock-Type-runtime_ConverseTrace-guardrail"></a>
The guardrail trace object.   
Type: [GuardrailTraceAssessment](API_runtime_GuardrailTraceAssessment.md) object  
Required: No

 ** promptRouter **   <a name="bedrock-Type-runtime_ConverseTrace-promptRouter"></a>
The request's prompt router.  
Type: [PromptRouterTrace](API_runtime_PromptRouterTrace.md) object  
Required: No

## See Also
<a name="API_runtime_ConverseTrace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseTrace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseTrace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseTrace) 

# CountTokensInput
<a name="API_runtime_CountTokensInput"></a>

The input value for token counting. The value should be either an `InvokeModel` or `Converse` request body. 

## Contents
<a name="API_runtime_CountTokensInput_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** converse **   <a name="bedrock-Type-runtime_CountTokensInput-converse"></a>
A `Converse` request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the `Converse` operation.  
Type: [ConverseTokensRequest](API_runtime_ConverseTokensRequest.md) object  
Required: No

 ** invokeModel **   <a name="bedrock-Type-runtime_CountTokensInput-invokeModel"></a>
An `InvokeModel` request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the `InvokeModel` operation.  
Type: [InvokeModelTokensRequest](API_runtime_InvokeModelTokensRequest.md) object  
Required: No

## See Also
<a name="API_runtime_CountTokensInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CountTokensInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CountTokensInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CountTokensInput) 

# DocumentBlock
<a name="API_runtime_DocumentBlock"></a>

A document to include in a message.

## Contents
<a name="API_runtime_DocumentBlock_Contents"></a>

 ** name **   <a name="bedrock-Type-runtime_DocumentBlock-name"></a>
A name for the document. The name can only contain the following characters:  
+ Alphanumeric characters
+ Whitespace characters (no more than one in a row)
+ Hyphens
+ Parentheses
+ Square brackets
This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** source **   <a name="bedrock-Type-runtime_DocumentBlock-source"></a>
Contains the content of the document.  
Type: [DocumentSource](API_runtime_DocumentSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** citations **   <a name="bedrock-Type-runtime_DocumentBlock-citations"></a>
Configuration settings that control how citations should be generated for this specific document.  
Type: [CitationsConfig](API_runtime_CitationsConfig.md) object  
Required: No

 ** context **   <a name="bedrock-Type-runtime_DocumentBlock-context"></a>
Contextual information about how the document should be processed or interpreted by the model when generating citations.  
Type: String  
Required: No

 ** format **   <a name="bedrock-Type-runtime_DocumentBlock-format"></a>
The format of a document, or its extension.  
Type: String  
Valid Values: `pdf | csv | doc | docx | xls | xlsx | html | txt | md`   
Required: No

## See Also
<a name="API_runtime_DocumentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentBlock) 

# DocumentCharLocation
<a name="API_runtime_DocumentCharLocation"></a>

Specifies a character-level location within a document, providing precise positioning information for cited content using start and end character indices.

## Contents
<a name="API_runtime_DocumentCharLocation_Contents"></a>

 ** documentIndex **   <a name="bedrock-Type-runtime_DocumentCharLocation-documentIndex"></a>
The index of the document within the array of documents provided in the request.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** end **   <a name="bedrock-Type-runtime_DocumentCharLocation-end"></a>
The ending character position of the cited content within the document.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** start **   <a name="bedrock-Type-runtime_DocumentCharLocation-start"></a>
The starting character position of the cited content within the document.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_runtime_DocumentCharLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentCharLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentCharLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentCharLocation) 

# DocumentChunkLocation
<a name="API_runtime_DocumentChunkLocation"></a>

Specifies a chunk-level location within a document, providing positioning information for cited content using logical document segments or chunks.

## Contents
<a name="API_runtime_DocumentChunkLocation_Contents"></a>

 ** documentIndex **   <a name="bedrock-Type-runtime_DocumentChunkLocation-documentIndex"></a>
The index of the document within the array of documents provided in the request.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** end **   <a name="bedrock-Type-runtime_DocumentChunkLocation-end"></a>
The ending chunk identifier or index of the cited content within the document.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** start **   <a name="bedrock-Type-runtime_DocumentChunkLocation-start"></a>
The starting chunk identifier or index of the cited content within the document.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_runtime_DocumentChunkLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentChunkLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentChunkLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentChunkLocation) 

# DocumentContentBlock
<a name="API_runtime_DocumentContentBlock"></a>

Contains the actual content of a document that can be processed by the model and potentially cited in the response.

## Contents
<a name="API_runtime_DocumentContentBlock_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** text **   <a name="bedrock-Type-runtime_DocumentContentBlock-text"></a>
The text content of the document.  
Type: String  
Required: No

## See Also
<a name="API_runtime_DocumentContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentContentBlock) 

# DocumentPageLocation
<a name="API_runtime_DocumentPageLocation"></a>

Specifies a page-level location within a document, providing positioning information for cited content using page numbers.

## Contents
<a name="API_runtime_DocumentPageLocation_Contents"></a>

 ** documentIndex **   <a name="bedrock-Type-runtime_DocumentPageLocation-documentIndex"></a>
The index of the document within the array of documents provided in the request.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** end **   <a name="bedrock-Type-runtime_DocumentPageLocation-end"></a>
The ending page number of the cited content within the document.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** start **   <a name="bedrock-Type-runtime_DocumentPageLocation-start"></a>
The starting page number of the cited content within the document.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_runtime_DocumentPageLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentPageLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentPageLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentPageLocation) 

# DocumentSource
<a name="API_runtime_DocumentSource"></a>

Contains the content of a document.

## Contents
<a name="API_runtime_DocumentSource_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** bytes **   <a name="bedrock-Type-runtime_DocumentSource-bytes"></a>
The raw bytes for the document. If you use an AWS SDK, you don't need to encode the bytes in base64.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1.  
Required: No

 ** content **   <a name="bedrock-Type-runtime_DocumentSource-content"></a>
The structured content of the document source, which may include various content blocks such as text, images, or other document elements.  
Type: Array of [DocumentContentBlock](API_runtime_DocumentContentBlock.md) objects  
Required: No

 ** s3Location **   <a name="bedrock-Type-runtime_DocumentSource-s3Location"></a>
The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see [Supported models and features for Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).  
Type: [S3Location](API_runtime_S3Location.md) object  
Required: No

 ** text **   <a name="bedrock-Type-runtime_DocumentSource-text"></a>
The text content of the document source.  
Type: String  
Required: No

## See Also
<a name="API_runtime_DocumentSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentSource) 

# ErrorBlock
<a name="API_runtime_ErrorBlock"></a>

A block containing error information when content processing fails.

## Contents
<a name="API_runtime_ErrorBlock_Contents"></a>

 ** message **   <a name="bedrock-Type-runtime_ErrorBlock-message"></a>
A human-readable error message describing what went wrong during content processing.  
Type: String  
Required: No

## See Also
<a name="API_runtime_ErrorBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ErrorBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ErrorBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ErrorBlock) 

# GuardrailAssessment
<a name="API_runtime_GuardrailAssessment"></a>

A behavior assessment of the guardrail policies used in a call to the Converse API. 

## Contents
<a name="API_runtime_GuardrailAssessment_Contents"></a>

 ** appliedGuardrailDetails **   <a name="bedrock-Type-runtime_GuardrailAssessment-appliedGuardrailDetails"></a>
Details about the specific guardrail that was applied during this assessment, including its identifier, version, ARN, origin, and ownership information.  
Type: [AppliedGuardrailDetails](API_runtime_AppliedGuardrailDetails.md) object  
Required: No

 ** automatedReasoningPolicy **   <a name="bedrock-Type-runtime_GuardrailAssessment-automatedReasoningPolicy"></a>
The automated reasoning policy assessment results, including logical validation findings for the input content.  
Type: [GuardrailAutomatedReasoningPolicyAssessment](API_runtime_GuardrailAutomatedReasoningPolicyAssessment.md) object  
Required: No

 ** contentPolicy **   <a name="bedrock-Type-runtime_GuardrailAssessment-contentPolicy"></a>
The content policy.  
Type: [GuardrailContentPolicyAssessment](API_runtime_GuardrailContentPolicyAssessment.md) object  
Required: No

 ** contextualGroundingPolicy **   <a name="bedrock-Type-runtime_GuardrailAssessment-contextualGroundingPolicy"></a>
The contextual grounding policy used for the guardrail assessment.  
Type: [GuardrailContextualGroundingPolicyAssessment](API_runtime_GuardrailContextualGroundingPolicyAssessment.md) object  
Required: No

 ** invocationMetrics **   <a name="bedrock-Type-runtime_GuardrailAssessment-invocationMetrics"></a>
The invocation metrics for the guardrail assessment.  
Type: [GuardrailInvocationMetrics](API_runtime_GuardrailInvocationMetrics.md) object  
Required: No

 ** sensitiveInformationPolicy **   <a name="bedrock-Type-runtime_GuardrailAssessment-sensitiveInformationPolicy"></a>
The sensitive information policy.  
Type: [GuardrailSensitiveInformationPolicyAssessment](API_runtime_GuardrailSensitiveInformationPolicyAssessment.md) object  
Required: No

 ** topicPolicy **   <a name="bedrock-Type-runtime_GuardrailAssessment-topicPolicy"></a>
The topic policy.  
Type: [GuardrailTopicPolicyAssessment](API_runtime_GuardrailTopicPolicyAssessment.md) object  
Required: No

 ** wordPolicy **   <a name="bedrock-Type-runtime_GuardrailAssessment-wordPolicy"></a>
The word policy.  
Type: [GuardrailWordPolicyAssessment](API_runtime_GuardrailWordPolicyAssessment.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAssessment) 

# GuardrailAutomatedReasoningFinding
<a name="API_runtime_GuardrailAutomatedReasoningFinding"></a>

Represents a logical validation result from automated reasoning policy evaluation. The finding indicates whether claims in the input are logically valid, invalid, satisfiable, impossible, or have other logical issues.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningFinding_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** impossible **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningFinding-impossible"></a>
Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.  
Type: [GuardrailAutomatedReasoningImpossibleFinding](API_runtime_GuardrailAutomatedReasoningImpossibleFinding.md) object  
Required: No

 ** invalid **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningFinding-invalid"></a>
Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.  
Type: [GuardrailAutomatedReasoningInvalidFinding](API_runtime_GuardrailAutomatedReasoningInvalidFinding.md) object  
Required: No

 ** noTranslations **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningFinding-noTranslations"></a>
Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.  
Type: [GuardrailAutomatedReasoningNoTranslationsFinding](API_runtime_GuardrailAutomatedReasoningNoTranslationsFinding.md) object  
Required: No

 ** satisfiable **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningFinding-satisfiable"></a>
Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.  
Type: [GuardrailAutomatedReasoningSatisfiableFinding](API_runtime_GuardrailAutomatedReasoningSatisfiableFinding.md) object  
Required: No

 ** tooComplex **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningFinding-tooComplex"></a>
Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.  
Type: [GuardrailAutomatedReasoningTooComplexFinding](API_runtime_GuardrailAutomatedReasoningTooComplexFinding.md) object  
Required: No

 ** translationAmbiguous **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningFinding-translationAmbiguous"></a>
Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.  
Type: [GuardrailAutomatedReasoningTranslationAmbiguousFinding](API_runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding.md) object  
Required: No

 ** valid **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningFinding-valid"></a>
Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.  
Type: [GuardrailAutomatedReasoningValidFinding](API_runtime_GuardrailAutomatedReasoningValidFinding.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningFinding) 

# GuardrailAutomatedReasoningImpossibleFinding
<a name="API_runtime_GuardrailAutomatedReasoningImpossibleFinding"></a>

Indicates that no valid claims can be made due to logical contradictions in the premises or rules.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningImpossibleFinding_Contents"></a>

 ** contradictingRules **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningImpossibleFinding-contradictingRules"></a>
The automated reasoning policy rules that contradict the claims and/or premises in the input.  
Type: Array of [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md) objects  
Required: No

 ** logicWarning **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningImpossibleFinding-logicWarning"></a>
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.  
Type: [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) object  
Required: No

 ** translation **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningImpossibleFinding-translation"></a>
The logical translation of the input that this finding evaluates.  
Type: [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningImpossibleFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningImpossibleFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningImpossibleFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningImpossibleFinding) 

# GuardrailAutomatedReasoningInputTextReference
<a name="API_runtime_GuardrailAutomatedReasoningInputTextReference"></a>

References a portion of the original input text that corresponds to logical elements.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningInputTextReference_Contents"></a>

 ** text **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningInputTextReference-text"></a>
The specific text from the original input that this reference points to.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningInputTextReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInputTextReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInputTextReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInputTextReference) 

# GuardrailAutomatedReasoningInvalidFinding
<a name="API_runtime_GuardrailAutomatedReasoningInvalidFinding"></a>

Indicates that the claims are logically false and contradictory to the established rules or premises.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningInvalidFinding_Contents"></a>

 ** contradictingRules **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningInvalidFinding-contradictingRules"></a>
The automated reasoning policy rules that contradict the claims in the input.  
Type: Array of [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md) objects  
Required: No

 ** logicWarning **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningInvalidFinding-logicWarning"></a>
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.  
Type: [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) object  
Required: No

 ** translation **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningInvalidFinding-translation"></a>
The logical translation of the input that this finding invalidates.  
Type: [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningInvalidFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInvalidFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInvalidFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInvalidFinding) 

# GuardrailAutomatedReasoningLogicWarning
<a name="API_runtime_GuardrailAutomatedReasoningLogicWarning"></a>

Identifies logical issues in the translated statements that exist independent of any policy rules, such as statements that are always true or always false.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningLogicWarning_Contents"></a>

 ** claims **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningLogicWarning-claims"></a>
The logical statements that are validated while assuming the policy and premises.  
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects  
Required: No

 ** premises **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningLogicWarning-premises"></a>
The logical statements that serve as premises under which the claims are validated.  
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects  
Required: No

 ** type **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningLogicWarning-type"></a>
The category of the detected logical issue, such as statements that are always true or always false.  
Type: String  
Valid Values: `ALWAYS_FALSE | ALWAYS_TRUE`   
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningLogicWarning_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningLogicWarning) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningLogicWarning) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningLogicWarning) 

# GuardrailAutomatedReasoningNoTranslationsFinding
<a name="API_runtime_GuardrailAutomatedReasoningNoTranslationsFinding"></a>

Indicates that no relevant logical information could be extracted from the input for validation.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningNoTranslationsFinding_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningNoTranslationsFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningNoTranslationsFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningNoTranslationsFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningNoTranslationsFinding) 

# GuardrailAutomatedReasoningPolicyAssessment
<a name="API_runtime_GuardrailAutomatedReasoningPolicyAssessment"></a>

Contains the results of automated reasoning policy evaluation, including logical findings about the validity of claims made in the input content.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningPolicyAssessment_Contents"></a>

 ** findings **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningPolicyAssessment-findings"></a>
List of logical validation results produced by evaluating the input content against automated reasoning policies.  
Type: Array of [GuardrailAutomatedReasoningFinding](API_runtime_GuardrailAutomatedReasoningFinding.md) objects  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningPolicyAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningPolicyAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningPolicyAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningPolicyAssessment) 

# GuardrailAutomatedReasoningRule
<a name="API_runtime_GuardrailAutomatedReasoningRule"></a>

References a specific automated reasoning policy rule that was applied during evaluation.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningRule_Contents"></a>

 ** identifier **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningRule-identifier"></a>
The unique identifier of the automated reasoning rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12.  
Pattern: `[a-z0-9]{12}`   
Required: No

 ** policyVersionArn **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningRule-policyVersionArn"></a>
The ARN of the automated reasoning policy version that contains this rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`   
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningRule) 

# GuardrailAutomatedReasoningSatisfiableFinding
<a name="API_runtime_GuardrailAutomatedReasoningSatisfiableFinding"></a>

Indicates that the claims could be either true or false depending on additional assumptions not provided in the input.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningSatisfiableFinding_Contents"></a>

 ** claimsFalseScenario **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningSatisfiableFinding-claimsFalseScenario"></a>
An example scenario demonstrating how the claims could be logically false.  
Type: [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) object  
Required: No

 ** claimsTrueScenario **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningSatisfiableFinding-claimsTrueScenario"></a>
An example scenario demonstrating how the claims could be logically true.  
Type: [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) object  
Required: No

 ** logicWarning **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningSatisfiableFinding-logicWarning"></a>
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.  
Type: [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) object  
Required: No

 ** translation **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningSatisfiableFinding-translation"></a>
The logical translation of the input that this finding evaluates.  
Type: [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningSatisfiableFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningSatisfiableFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningSatisfiableFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningSatisfiableFinding) 

# GuardrailAutomatedReasoningScenario
<a name="API_runtime_GuardrailAutomatedReasoningScenario"></a>

Represents a logical scenario where claims can be evaluated as true or false, containing specific logical assignments.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningScenario_Contents"></a>

 ** statements **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningScenario-statements"></a>
List of logical assignments and statements that define this scenario.  
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningScenario_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningScenario) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningScenario) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningScenario) 

# GuardrailAutomatedReasoningStatement
<a name="API_runtime_GuardrailAutomatedReasoningStatement"></a>

A logical statement that includes both formal logic representation and natural language explanation.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningStatement_Contents"></a>

 ** logic **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningStatement-logic"></a>
The formal logical representation of the statement.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** naturalLanguage **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningStatement-naturalLanguage"></a>
The natural language explanation of the logical statement.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningStatement) 

# GuardrailAutomatedReasoningTooComplexFinding
<a name="API_runtime_GuardrailAutomatedReasoningTooComplexFinding"></a>

Indicates that the input exceeds the processing capacity due to the volume or complexity of the logical information.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningTooComplexFinding_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningTooComplexFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTooComplexFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTooComplexFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTooComplexFinding) 

# GuardrailAutomatedReasoningTranslation
<a name="API_runtime_GuardrailAutomatedReasoningTranslation"></a>

Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningTranslation_Contents"></a>

 ** claims **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningTranslation-claims"></a>
The logical statements that are being validated against the premises and policy rules.  
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects  
Required: No

 ** confidence **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningTranslation-confidence"></a>
A confidence score between 0 and 1 indicating how certain the system is about the logical translation.  
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** premises **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningTranslation-premises"></a>
The logical statements that serve as the foundation or assumptions for the claims.  
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects  
Required: No

 ** untranslatedClaims **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningTranslation-untranslatedClaims"></a>
References to portions of the original input text that correspond to the claims but could not be fully translated.  
Type: Array of [GuardrailAutomatedReasoningInputTextReference](API_runtime_GuardrailAutomatedReasoningInputTextReference.md) objects  
Required: No

 ** untranslatedPremises **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningTranslation-untranslatedPremises"></a>
References to portions of the original input text that correspond to the premises but could not be fully translated.  
Type: Array of [GuardrailAutomatedReasoningInputTextReference](API_runtime_GuardrailAutomatedReasoningInputTextReference.md) objects  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningTranslation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslation) 

# GuardrailAutomatedReasoningTranslationAmbiguousFinding
<a name="API_runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding"></a>

Indicates that the input has multiple valid logical interpretations, requiring additional context or clarification.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding_Contents"></a>

 ** differenceScenarios **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding-differenceScenarios"></a>
Scenarios showing how the different translation options differ in meaning.  
Type: Array of [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

 ** options **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding-options"></a>
Different logical interpretations that were detected during translation of the input.  
Type: Array of [GuardrailAutomatedReasoningTranslationOption](API_runtime_GuardrailAutomatedReasoningTranslationOption.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationAmbiguousFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationAmbiguousFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationAmbiguousFinding) 

# GuardrailAutomatedReasoningTranslationOption
<a name="API_runtime_GuardrailAutomatedReasoningTranslationOption"></a>

Represents one possible logical interpretation of ambiguous input content.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningTranslationOption_Contents"></a>

 ** translations **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningTranslationOption-translations"></a>
Example translations that provide this possible interpretation of the input.  
Type: Array of [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) objects  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningTranslationOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationOption) 

# GuardrailAutomatedReasoningValidFinding
<a name="API_runtime_GuardrailAutomatedReasoningValidFinding"></a>

Indicates that the claims are definitively true and logically implied by the premises, with no possible alternative interpretations.

## Contents
<a name="API_runtime_GuardrailAutomatedReasoningValidFinding_Contents"></a>

 ** claimsTrueScenario **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningValidFinding-claimsTrueScenario"></a>
An example scenario demonstrating how the claims are logically true.  
Type: [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) object  
Required: No

 ** logicWarning **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningValidFinding-logicWarning"></a>
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.  
Type: [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) object  
Required: No

 ** supportingRules **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningValidFinding-supportingRules"></a>
The automated reasoning policy rules that support why this result is considered valid.  
Type: Array of [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md) objects  
Required: No

 ** translation **   <a name="bedrock-Type-runtime_GuardrailAutomatedReasoningValidFinding-translation"></a>
The logical translation of the input that this finding validates.  
Type: [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailAutomatedReasoningValidFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningValidFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningValidFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningValidFinding) 

# GuardrailConfiguration
<a name="API_runtime_GuardrailConfiguration"></a>

Configuration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation.

## Contents
<a name="API_runtime_GuardrailConfiguration_Contents"></a>

 ** guardrailIdentifier **   <a name="bedrock-Type-runtime_GuardrailConfiguration-guardrailIdentifier"></a>
The identifier for the guardrail.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `(|([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`   
Required: No

 ** guardrailVersion **   <a name="bedrock-Type-runtime_GuardrailConfiguration-guardrailVersion"></a>
The version of the guardrail.  
Type: String  
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`   
Required: No

 ** trace **   <a name="bedrock-Type-runtime_GuardrailConfiguration-trace"></a>
The trace behavior for the guardrail.  
Type: String  
Valid Values: `enabled | disabled | enabled_full`   
Required: No

## See Also
<a name="API_runtime_GuardrailConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConfiguration) 

# GuardrailContentBlock
<a name="API_runtime_GuardrailContentBlock"></a>

The content block to be evaluated by the guardrail.

## Contents
<a name="API_runtime_GuardrailContentBlock_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** image **   <a name="bedrock-Type-runtime_GuardrailContentBlock-image"></a>
Image within guardrail content block to be evaluated by the guardrail.  
Type: [GuardrailImageBlock](API_runtime_GuardrailImageBlock.md) object  
Required: No

 ** text **   <a name="bedrock-Type-runtime_GuardrailContentBlock-text"></a>
Text within content block to be evaluated by the guardrail.  
Type: [GuardrailTextBlock](API_runtime_GuardrailTextBlock.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContentBlock) 

# GuardrailContentFilter
<a name="API_runtime_GuardrailContentFilter"></a>

The content filter for a guardrail.

## Contents
<a name="API_runtime_GuardrailContentFilter_Contents"></a>

 ** action **   <a name="bedrock-Type-runtime_GuardrailContentFilter-action"></a>
The guardrail action.  
Type: String  
Valid Values: `BLOCKED | NONE`   
Required: Yes

 ** confidence **   <a name="bedrock-Type-runtime_GuardrailContentFilter-confidence"></a>
The guardrail confidence.  
Type: String  
Valid Values: `NONE | LOW | MEDIUM | HIGH`   
Required: Yes

 ** type **   <a name="bedrock-Type-runtime_GuardrailContentFilter-type"></a>
The guardrail type.  
Type: String  
Valid Values: `INSULTS | HATE | SEXUAL | VIOLENCE | MISCONDUCT | PROMPT_ATTACK`   
Required: Yes

 ** detected **   <a name="bedrock-Type-runtime_GuardrailContentFilter-detected"></a>
Indicates whether content that breaches the guardrail configuration is detected.  
Type: Boolean  
Required: No

 ** filterStrength **   <a name="bedrock-Type-runtime_GuardrailContentFilter-filterStrength"></a>
The filter strength setting for the guardrail content filter.  
Type: String  
Valid Values: `NONE | LOW | MEDIUM | HIGH`   
Required: No

## See Also
<a name="API_runtime_GuardrailContentFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContentFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContentFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContentFilter) 

# GuardrailContentPolicyAssessment
<a name="API_runtime_GuardrailContentPolicyAssessment"></a>

An assessment of a content policy for a guardrail.

## Contents
<a name="API_runtime_GuardrailContentPolicyAssessment_Contents"></a>

 ** filters **   <a name="bedrock-Type-runtime_GuardrailContentPolicyAssessment-filters"></a>
The content policy filters.  
Type: Array of [GuardrailContentFilter](API_runtime_GuardrailContentFilter.md) objects  
Required: Yes

## See Also
<a name="API_runtime_GuardrailContentPolicyAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContentPolicyAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContentPolicyAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContentPolicyAssessment) 

# GuardrailContextualGroundingFilter
<a name="API_runtime_GuardrailContextualGroundingFilter"></a>

The details for the guardrails contextual grounding filter.

## Contents
<a name="API_runtime_GuardrailContextualGroundingFilter_Contents"></a>

 ** action **   <a name="bedrock-Type-runtime_GuardrailContextualGroundingFilter-action"></a>
The action performed by the guardrails contextual grounding filter.  
Type: String  
Valid Values: `BLOCKED | NONE`   
Required: Yes

 ** score **   <a name="bedrock-Type-runtime_GuardrailContextualGroundingFilter-score"></a>
The score generated by contextual grounding filter.  
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: Yes

 ** threshold **   <a name="bedrock-Type-runtime_GuardrailContextualGroundingFilter-threshold"></a>
The threshold used by contextual grounding filter to determine whether the content is grounded or not.  
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: Yes

 ** type **   <a name="bedrock-Type-runtime_GuardrailContextualGroundingFilter-type"></a>
The contextual grounding filter type.  
Type: String  
Valid Values: `GROUNDING | RELEVANCE`   
Required: Yes

 ** detected **   <a name="bedrock-Type-runtime_GuardrailContextualGroundingFilter-detected"></a>
Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.  
Type: Boolean  
Required: No

## See Also
<a name="API_runtime_GuardrailContextualGroundingFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContextualGroundingFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContextualGroundingFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContextualGroundingFilter) 

# GuardrailContextualGroundingPolicyAssessment
<a name="API_runtime_GuardrailContextualGroundingPolicyAssessment"></a>

The policy assessment details for the guardrails contextual grounding filter.

## Contents
<a name="API_runtime_GuardrailContextualGroundingPolicyAssessment_Contents"></a>

 ** filters **   <a name="bedrock-Type-runtime_GuardrailContextualGroundingPolicyAssessment-filters"></a>
The filter details for the guardrails contextual grounding filter.  
Type: Array of [GuardrailContextualGroundingFilter](API_runtime_GuardrailContextualGroundingFilter.md) objects  
Required: No

## See Also
<a name="API_runtime_GuardrailContextualGroundingPolicyAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContextualGroundingPolicyAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContextualGroundingPolicyAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContextualGroundingPolicyAssessment) 

# GuardrailConverseContentBlock
<a name="API_runtime_GuardrailConverseContentBlock"></a>



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. 

## Contents
<a name="API_runtime_GuardrailConverseContentBlock_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** image **   <a name="bedrock-Type-runtime_GuardrailConverseContentBlock-image"></a>
Image within converse content block to be evaluated by the guardrail.  
Type: [GuardrailConverseImageBlock](API_runtime_GuardrailConverseImageBlock.md) object  
Required: No

 ** text **   <a name="bedrock-Type-runtime_GuardrailConverseContentBlock-text"></a>
The text to guard.  
Type: [GuardrailConverseTextBlock](API_runtime_GuardrailConverseTextBlock.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailConverseContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConverseContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConverseContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConverseContentBlock) 

# GuardrailConverseImageBlock
<a name="API_runtime_GuardrailConverseImageBlock"></a>

An image block that contains images that you want to assess with a guardrail.

## Contents
<a name="API_runtime_GuardrailConverseImageBlock_Contents"></a>

 ** format **   <a name="bedrock-Type-runtime_GuardrailConverseImageBlock-format"></a>
The format details for the image type of the guardrail converse image block.  
Type: String  
Valid Values: `png | jpeg`   
Required: Yes

 ** source **   <a name="bedrock-Type-runtime_GuardrailConverseImageBlock-source"></a>
The image source (image bytes) of the guardrail converse image block.  
Type: [GuardrailConverseImageSource](API_runtime_GuardrailConverseImageSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_runtime_GuardrailConverseImageBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConverseImageBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConverseImageBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConverseImageBlock) 

# GuardrailConverseImageSource
<a name="API_runtime_GuardrailConverseImageSource"></a>

The image source (image bytes) of the guardrail converse image source.

## Contents
<a name="API_runtime_GuardrailConverseImageSource_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** bytes **   <a name="bedrock-Type-runtime_GuardrailConverseImageSource-bytes"></a>
The raw image bytes for the image.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_runtime_GuardrailConverseImageSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConverseImageSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConverseImageSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConverseImageSource) 

# GuardrailConverseTextBlock
<a name="API_runtime_GuardrailConverseTextBlock"></a>

A text block that contains text that you want to assess with a guardrail. For more information, see [GuardrailConverseContentBlock](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_GuardrailConverseContentBlock.html).

## Contents
<a name="API_runtime_GuardrailConverseTextBlock_Contents"></a>

 ** text **   <a name="bedrock-Type-runtime_GuardrailConverseTextBlock-text"></a>
The text that you want to guard.  
Type: String  
Required: Yes

 ** qualifiers **   <a name="bedrock-Type-runtime_GuardrailConverseTextBlock-qualifiers"></a>
The qualifier details for the guardrails contextual grounding filter.  
Type: Array of strings  
Valid Values: `grounding_source | query | guard_content`   
Required: No

## See Also
<a name="API_runtime_GuardrailConverseTextBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConverseTextBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConverseTextBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConverseTextBlock) 

# GuardrailCoverage
<a name="API_runtime_GuardrailCoverage"></a>

The action of the guardrail coverage details.

## Contents
<a name="API_runtime_GuardrailCoverage_Contents"></a>

 ** images **   <a name="bedrock-Type-runtime_GuardrailCoverage-images"></a>
The guardrail coverage for images (the number of images that guardrails guarded).  
Type: [GuardrailImageCoverage](API_runtime_GuardrailImageCoverage.md) object  
Required: No

 ** textCharacters **   <a name="bedrock-Type-runtime_GuardrailCoverage-textCharacters"></a>
The text characters of the guardrail coverage details.  
Type: [GuardrailTextCharactersCoverage](API_runtime_GuardrailTextCharactersCoverage.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailCoverage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailCoverage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailCoverage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailCoverage) 

# GuardrailCustomWord
<a name="API_runtime_GuardrailCustomWord"></a>

A custom word configured in a guardrail.

## Contents
<a name="API_runtime_GuardrailCustomWord_Contents"></a>

 ** action **   <a name="bedrock-Type-runtime_GuardrailCustomWord-action"></a>
The action for the custom word.  
Type: String  
Valid Values: `BLOCKED | NONE`   
Required: Yes

 ** match **   <a name="bedrock-Type-runtime_GuardrailCustomWord-match"></a>
The match for the custom word.  
Type: String  
Required: Yes

 ** detected **   <a name="bedrock-Type-runtime_GuardrailCustomWord-detected"></a>
Indicates whether custom word content that breaches the guardrail configuration is detected.  
Type: Boolean  
Required: No

## See Also
<a name="API_runtime_GuardrailCustomWord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailCustomWord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailCustomWord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailCustomWord) 

# GuardrailImageBlock
<a name="API_runtime_GuardrailImageBlock"></a>

Contain an image which user wants guarded. This block is accepted by the guardrails independent API.

## Contents
<a name="API_runtime_GuardrailImageBlock_Contents"></a>

 ** format **   <a name="bedrock-Type-runtime_GuardrailImageBlock-format"></a>
The format details for the file type of the image blocked by the guardrail.  
Type: String  
Valid Values: `png | jpeg`   
Required: Yes

 ** source **   <a name="bedrock-Type-runtime_GuardrailImageBlock-source"></a>
The image source (image bytes) details of the image blocked by the guardrail.  
Type: [GuardrailImageSource](API_runtime_GuardrailImageSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_runtime_GuardrailImageBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailImageBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailImageBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailImageBlock) 

# GuardrailImageCoverage
<a name="API_runtime_GuardrailImageCoverage"></a>

The details of the guardrail image coverage.

## Contents
<a name="API_runtime_GuardrailImageCoverage_Contents"></a>

 ** guarded **   <a name="bedrock-Type-runtime_GuardrailImageCoverage-guarded"></a>
The count (integer) of images guardrails guarded.  
Type: Integer  
Required: No

 ** total **   <a name="bedrock-Type-runtime_GuardrailImageCoverage-total"></a>
Represents the total number of images (integer) that were in the request (guarded and unguarded).  
Type: Integer  
Required: No

## See Also
<a name="API_runtime_GuardrailImageCoverage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailImageCoverage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailImageCoverage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailImageCoverage) 

# GuardrailImageSource
<a name="API_runtime_GuardrailImageSource"></a>

The image source (image bytes) of the guardrail image source. Object used in independent api.

## Contents
<a name="API_runtime_GuardrailImageSource_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** bytes **   <a name="bedrock-Type-runtime_GuardrailImageSource-bytes"></a>
The bytes details of the guardrail image source. Object used in independent api.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_runtime_GuardrailImageSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailImageSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailImageSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailImageSource) 

# GuardrailInvocationMetrics
<a name="API_runtime_GuardrailInvocationMetrics"></a>

The invocation metrics for the guardrail.

## Contents
<a name="API_runtime_GuardrailInvocationMetrics_Contents"></a>

 ** guardrailCoverage **   <a name="bedrock-Type-runtime_GuardrailInvocationMetrics-guardrailCoverage"></a>
The coverage details for the guardrail invocation metrics.  
Type: [GuardrailCoverage](API_runtime_GuardrailCoverage.md) object  
Required: No

 ** guardrailProcessingLatency **   <a name="bedrock-Type-runtime_GuardrailInvocationMetrics-guardrailProcessingLatency"></a>
The processing latency details for the guardrail invocation metrics.  
Type: Long  
Required: No

 ** usage **   <a name="bedrock-Type-runtime_GuardrailInvocationMetrics-usage"></a>
The usage details for the guardrail invocation metrics.  
Type: [GuardrailUsage](API_runtime_GuardrailUsage.md) object  
Required: No

## See Also
<a name="API_runtime_GuardrailInvocationMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailInvocationMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailInvocationMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailInvocationMetrics) 

# GuardrailManagedWord
<a name="API_runtime_GuardrailManagedWord"></a>

A managed word configured in a guardrail.

## Contents
<a name="API_runtime_GuardrailManagedWord_Contents"></a>

 ** action **   <a name="bedrock-Type-runtime_GuardrailManagedWord-action"></a>
The action for the managed word.  
Type: String  
Valid Values: `BLOCKED | NONE`   
Required: Yes

 ** match **   <a name="bedrock-Type-runtime_GuardrailManagedWord-match"></a>
The match for the managed word.  
Type: String  
Required: Yes

 ** type **   <a name="bedrock-Type-runtime_GuardrailManagedWord-type"></a>
The type for the managed word.  
Type: String  
Valid Values: `PROFANITY`   
Required: Yes

 ** detected **   <a name="bedrock-Type-runtime_GuardrailManagedWord-detected"></a>
Indicates whether managed word content that breaches the guardrail configuration is detected.  
Type: Boolean  
Required: No

## See Also
<a name="API_runtime_GuardrailManagedWord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailManagedWord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailManagedWord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailManagedWord) 

# GuardrailOutputContent
<a name="API_runtime_GuardrailOutputContent"></a>

The output content produced by the guardrail.

## Contents
<a name="API_runtime_GuardrailOutputContent_Contents"></a>

 ** text **   <a name="bedrock-Type-runtime_GuardrailOutputContent-text"></a>
The specific text for the output content produced by the guardrail.  
Type: String  
Required: No

## See Also
<a name="API_runtime_GuardrailOutputContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailOutputContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailOutputContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailOutputContent) 

# GuardrailPiiEntityFilter
<a name="API_runtime_GuardrailPiiEntityFilter"></a>

A Personally Identifiable Information (PII) entity configured in a guardrail.

## Contents
<a name="API_runtime_GuardrailPiiEntityFilter_Contents"></a>

 ** action **   <a name="bedrock-Type-runtime_GuardrailPiiEntityFilter-action"></a>
The PII entity filter action.  
Type: String  
Valid Values: `ANONYMIZED | BLOCKED | NONE`   
Required: Yes

 ** match **   <a name="bedrock-Type-runtime_GuardrailPiiEntityFilter-match"></a>
The PII entity filter match.  
Type: String  
Required: Yes

 ** type **   <a name="bedrock-Type-runtime_GuardrailPiiEntityFilter-type"></a>
The PII entity filter type.  
Type: String  
Valid Values: `ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER | CREDIT_DEBIT_CARD_CVV | CREDIT_DEBIT_CARD_EXPIRY | CREDIT_DEBIT_CARD_NUMBER | DRIVER_ID | EMAIL | INTERNATIONAL_BANK_ACCOUNT_NUMBER | IP_ADDRESS | LICENSE_PLATE | MAC_ADDRESS | NAME | PASSWORD | PHONE | PIN | SWIFT_CODE | UK_NATIONAL_HEALTH_SERVICE_NUMBER | UK_NATIONAL_INSURANCE_NUMBER | UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER | URL | USERNAME | US_BANK_ACCOUNT_NUMBER | US_BANK_ROUTING_NUMBER | US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER | US_PASSPORT_NUMBER | US_SOCIAL_SECURITY_NUMBER | VEHICLE_IDENTIFICATION_NUMBER`   
Required: Yes

 ** detected **   <a name="bedrock-Type-runtime_GuardrailPiiEntityFilter-detected"></a>
Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected.  
Type: Boolean  
Required: No

## See Also
<a name="API_runtime_GuardrailPiiEntityFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailPiiEntityFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailPiiEntityFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailPiiEntityFilter) 

# GuardrailRegexFilter
<a name="API_runtime_GuardrailRegexFilter"></a>

A Regex filter configured in a guardrail.

## Contents
<a name="API_runtime_GuardrailRegexFilter_Contents"></a>

 ** action **   <a name="bedrock-Type-runtime_GuardrailRegexFilter-action"></a>
The region filter action.  
Type: String  
Valid Values: `ANONYMIZED | BLOCKED | NONE`   
Required: Yes

 ** detected **   <a name="bedrock-Type-runtime_GuardrailRegexFilter-detected"></a>
Indicates whether custom regex entities that breach the guardrail configuration are detected.  
Type: Boolean  
Required: No

 ** match **   <a name="bedrock-Type-runtime_GuardrailRegexFilter-match"></a>
The regesx filter match.  
Type: String  
Required: No

 ** name **   <a name="bedrock-Type-runtime_GuardrailRegexFilter-name"></a>
The regex filter name.  
Type: String  
Required: No

 ** regex **   <a name="bedrock-Type-runtime_GuardrailRegexFilter-regex"></a>
The regex query.  
Type: String  
Required: No

## See Also
<a name="API_runtime_GuardrailRegexFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailRegexFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailRegexFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailRegexFilter) 

# GuardrailSensitiveInformationPolicyAssessment
<a name="API_runtime_GuardrailSensitiveInformationPolicyAssessment"></a>

The assessment for a Personally Identifiable Information (PII) policy. 

## Contents
<a name="API_runtime_GuardrailSensitiveInformationPolicyAssessment_Contents"></a>

 ** piiEntities **   <a name="bedrock-Type-runtime_GuardrailSensitiveInformationPolicyAssessment-piiEntities"></a>
The PII entities in the assessment.  
Type: Array of [GuardrailPiiEntityFilter](API_runtime_GuardrailPiiEntityFilter.md) objects  
Required: Yes

 ** regexes **   <a name="bedrock-Type-runtime_GuardrailSensitiveInformationPolicyAssessment-regexes"></a>
The regex queries in the assessment.  
Type: Array of [GuardrailRegexFilter](API_runtime_GuardrailRegexFilter.md) objects  
Required: Yes

## See Also
<a name="API_runtime_GuardrailSensitiveInformationPolicyAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailSensitiveInformationPolicyAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailSensitiveInformationPolicyAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailSensitiveInformationPolicyAssessment) 

# GuardrailStreamConfiguration
<a name="API_runtime_GuardrailStreamConfiguration"></a>

Configuration information for a guardrail that you use with the [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) action. 

## Contents
<a name="API_runtime_GuardrailStreamConfiguration_Contents"></a>

 ** guardrailIdentifier **   <a name="bedrock-Type-runtime_GuardrailStreamConfiguration-guardrailIdentifier"></a>
The identifier for the guardrail.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `(|([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`   
Required: No

 ** guardrailVersion **   <a name="bedrock-Type-runtime_GuardrailStreamConfiguration-guardrailVersion"></a>
The version of the guardrail.  
Type: String  
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`   
Required: No

 ** streamProcessingMode **   <a name="bedrock-Type-runtime_GuardrailStreamConfiguration-streamProcessingMode"></a>
The processing mode.   
The processing mode. For more information, see [Configure streaming response behavior](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-streaming.html).   
Type: String  
Valid Values: `sync | async`   
Required: No

 ** trace **   <a name="bedrock-Type-runtime_GuardrailStreamConfiguration-trace"></a>
The trace behavior for the guardrail.  
Type: String  
Valid Values: `enabled | disabled | enabled_full`   
Required: No

## See Also
<a name="API_runtime_GuardrailStreamConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailStreamConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailStreamConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailStreamConfiguration) 

# GuardrailTextBlock
<a name="API_runtime_GuardrailTextBlock"></a>

The text block to be evaluated by the guardrail.

## Contents
<a name="API_runtime_GuardrailTextBlock_Contents"></a>

 ** text **   <a name="bedrock-Type-runtime_GuardrailTextBlock-text"></a>
The input text details to be evaluated by the guardrail.  
Type: String  
Required: Yes

 ** qualifiers **   <a name="bedrock-Type-runtime_GuardrailTextBlock-qualifiers"></a>
The qualifiers describing the text block.  
Type: Array of strings  
Valid Values: `grounding_source | query | guard_content`   
Required: No

## See Also
<a name="API_runtime_GuardrailTextBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTextBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTextBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTextBlock) 

# GuardrailTextCharactersCoverage
<a name="API_runtime_GuardrailTextCharactersCoverage"></a>

The guardrail coverage for the text characters.

## Contents
<a name="API_runtime_GuardrailTextCharactersCoverage_Contents"></a>

 ** guarded **   <a name="bedrock-Type-runtime_GuardrailTextCharactersCoverage-guarded"></a>
The text characters that were guarded by the guardrail coverage.  
Type: Integer  
Required: No

 ** total **   <a name="bedrock-Type-runtime_GuardrailTextCharactersCoverage-total"></a>
The total text characters by the guardrail coverage.  
Type: Integer  
Required: No

## See Also
<a name="API_runtime_GuardrailTextCharactersCoverage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTextCharactersCoverage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTextCharactersCoverage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTextCharactersCoverage) 

# GuardrailTopic
<a name="API_runtime_GuardrailTopic"></a>

Information about a topic guardrail.

## Contents
<a name="API_runtime_GuardrailTopic_Contents"></a>

 ** action **   <a name="bedrock-Type-runtime_GuardrailTopic-action"></a>
The action the guardrail should take when it intervenes on a topic.  
Type: String  
Valid Values: `BLOCKED | NONE`   
Required: Yes

 ** name **   <a name="bedrock-Type-runtime_GuardrailTopic-name"></a>
The name for the guardrail.  
Type: String  
Required: Yes

 ** type **   <a name="bedrock-Type-runtime_GuardrailTopic-type"></a>
The type behavior that the guardrail should perform when the model detects the topic.  
Type: String  
Valid Values: `DENY`   
Required: Yes

 ** detected **   <a name="bedrock-Type-runtime_GuardrailTopic-detected"></a>
Indicates whether topic content that breaches the guardrail configuration is detected.  
Type: Boolean  
Required: No

## See Also
<a name="API_runtime_GuardrailTopic_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTopic) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTopic) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTopic) 

# GuardrailTopicPolicyAssessment
<a name="API_runtime_GuardrailTopicPolicyAssessment"></a>

A behavior assessment of a topic policy.

## Contents
<a name="API_runtime_GuardrailTopicPolicyAssessment_Contents"></a>

 ** topics **   <a name="bedrock-Type-runtime_GuardrailTopicPolicyAssessment-topics"></a>
The topics in the assessment.  
Type: Array of [GuardrailTopic](API_runtime_GuardrailTopic.md) objects  
Required: Yes

## See Also
<a name="API_runtime_GuardrailTopicPolicyAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTopicPolicyAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTopicPolicyAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTopicPolicyAssessment) 

# GuardrailTraceAssessment
<a name="API_runtime_GuardrailTraceAssessment"></a>

A Top level guardrail trace object. For more information, see [ConverseTrace](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseTrace.html).

## Contents
<a name="API_runtime_GuardrailTraceAssessment_Contents"></a>

 ** actionReason **   <a name="bedrock-Type-runtime_GuardrailTraceAssessment-actionReason"></a>
Provides the reason for the action taken when harmful content is detected.  
Type: String  
Required: No

 ** inputAssessment **   <a name="bedrock-Type-runtime_GuardrailTraceAssessment-inputAssessment"></a>
The input assessment.  
Type: String to [GuardrailAssessment](API_runtime_GuardrailAssessment.md) object map  
Required: No

 ** modelOutput **   <a name="bedrock-Type-runtime_GuardrailTraceAssessment-modelOutput"></a>
The output from the model.  
Type: Array of strings  
Required: No

 ** outputAssessments **   <a name="bedrock-Type-runtime_GuardrailTraceAssessment-outputAssessments"></a>
the output assessments.  
Type: String to array of [GuardrailAssessment](API_runtime_GuardrailAssessment.md) objects map  
Required: No

## See Also
<a name="API_runtime_GuardrailTraceAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTraceAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTraceAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTraceAssessment) 

# GuardrailUsage
<a name="API_runtime_GuardrailUsage"></a>

The details on the use of the guardrail.

## Contents
<a name="API_runtime_GuardrailUsage_Contents"></a>

 ** contentPolicyUnits **   <a name="bedrock-Type-runtime_GuardrailUsage-contentPolicyUnits"></a>
The content policy units processed by the guardrail.  
Type: Integer  
Required: Yes

 ** contextualGroundingPolicyUnits **   <a name="bedrock-Type-runtime_GuardrailUsage-contextualGroundingPolicyUnits"></a>
The contextual grounding policy units processed by the guardrail.  
Type: Integer  
Required: Yes

 ** sensitiveInformationPolicyFreeUnits **   <a name="bedrock-Type-runtime_GuardrailUsage-sensitiveInformationPolicyFreeUnits"></a>
The sensitive information policy free units processed by the guardrail.  
Type: Integer  
Required: Yes

 ** sensitiveInformationPolicyUnits **   <a name="bedrock-Type-runtime_GuardrailUsage-sensitiveInformationPolicyUnits"></a>
The sensitive information policy units processed by the guardrail.  
Type: Integer  
Required: Yes

 ** topicPolicyUnits **   <a name="bedrock-Type-runtime_GuardrailUsage-topicPolicyUnits"></a>
The topic policy units processed by the guardrail.  
Type: Integer  
Required: Yes

 ** wordPolicyUnits **   <a name="bedrock-Type-runtime_GuardrailUsage-wordPolicyUnits"></a>
The word policy units processed by the guardrail.  
Type: Integer  
Required: Yes

 ** automatedReasoningPolicies **   <a name="bedrock-Type-runtime_GuardrailUsage-automatedReasoningPolicies"></a>
The number of automated reasoning policies that were processed during the guardrail evaluation.  
Type: Integer  
Required: No

 ** automatedReasoningPolicyUnits **   <a name="bedrock-Type-runtime_GuardrailUsage-automatedReasoningPolicyUnits"></a>
The number of text units processed by the automated reasoning policy.  
Type: Integer  
Required: No

 ** contentPolicyImageUnits **   <a name="bedrock-Type-runtime_GuardrailUsage-contentPolicyImageUnits"></a>
The content policy image units processed by the guardrail.  
Type: Integer  
Required: No

## See Also
<a name="API_runtime_GuardrailUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailUsage) 

# GuardrailWordPolicyAssessment
<a name="API_runtime_GuardrailWordPolicyAssessment"></a>

The word policy assessment.

## Contents
<a name="API_runtime_GuardrailWordPolicyAssessment_Contents"></a>

 ** customWords **   <a name="bedrock-Type-runtime_GuardrailWordPolicyAssessment-customWords"></a>
Custom words in the assessment.  
Type: Array of [GuardrailCustomWord](API_runtime_GuardrailCustomWord.md) objects  
Required: Yes

 ** managedWordLists **   <a name="bedrock-Type-runtime_GuardrailWordPolicyAssessment-managedWordLists"></a>
Managed word lists in the assessment.  
Type: Array of [GuardrailManagedWord](API_runtime_GuardrailManagedWord.md) objects  
Required: Yes

## See Also
<a name="API_runtime_GuardrailWordPolicyAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailWordPolicyAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailWordPolicyAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailWordPolicyAssessment) 

# ImageBlock
<a name="API_runtime_ImageBlock"></a>

Image content for a message.

## Contents
<a name="API_runtime_ImageBlock_Contents"></a>

 ** format **   <a name="bedrock-Type-runtime_ImageBlock-format"></a>
The format of the image.  
Type: String  
Valid Values: `png | jpeg | gif | webp`   
Required: Yes

 ** source **   <a name="bedrock-Type-runtime_ImageBlock-source"></a>
The source for the image.  
Type: [ImageSource](API_runtime_ImageSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** error **   <a name="bedrock-Type-runtime_ImageBlock-error"></a>
Error information if the image block could not be processed or contains invalid data.  
Type: [ErrorBlock](API_runtime_ErrorBlock.md) object  
Required: No

## See Also
<a name="API_runtime_ImageBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ImageBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ImageBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ImageBlock) 

# ImageBlockDelta
<a name="API_runtime_ImageBlockDelta"></a>

A streaming delta event that contains incremental image data during streaming responses.

## Contents
<a name="API_runtime_ImageBlockDelta_Contents"></a>

 ** error **   <a name="bedrock-Type-runtime_ImageBlockDelta-error"></a>
Error information if this image delta could not be processed.  
Type: [ErrorBlock](API_runtime_ErrorBlock.md) object  
Required: No

 ** source **   <a name="bedrock-Type-runtime_ImageBlockDelta-source"></a>
The incremental image source data for this delta event.  
Type: [ImageSource](API_runtime_ImageSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_runtime_ImageBlockDelta_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ImageBlockDelta) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ImageBlockDelta) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ImageBlockDelta) 

# ImageBlockStart
<a name="API_runtime_ImageBlockStart"></a>

The initial event in a streaming image block that indicates the start of image content.

## Contents
<a name="API_runtime_ImageBlockStart_Contents"></a>

 ** format **   <a name="bedrock-Type-runtime_ImageBlockStart-format"></a>
The format of the image data that will be streamed in subsequent delta events.  
Type: String  
Valid Values: `png | jpeg | gif | webp`   
Required: Yes

## See Also
<a name="API_runtime_ImageBlockStart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ImageBlockStart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ImageBlockStart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ImageBlockStart) 

# ImageSource
<a name="API_runtime_ImageSource"></a>

The source for an image.

## Contents
<a name="API_runtime_ImageSource_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** bytes **   <a name="bedrock-Type-runtime_ImageSource-bytes"></a>
The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1.  
Required: No

 ** s3Location **   <a name="bedrock-Type-runtime_ImageSource-s3Location"></a>
The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see [Supported models and features for Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).  
Type: [S3Location](API_runtime_S3Location.md) object  
Required: No

## See Also
<a name="API_runtime_ImageSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ImageSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ImageSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ImageSource) 

# InferenceConfiguration
<a name="API_runtime_InferenceConfiguration"></a>

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). For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).

If you need to pass additional parameters that the model supports, use the `additionalModelRequestFields` request field in the call to `Converse` or `ConverseStream`. For more information, see [Model parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).

## Contents
<a name="API_runtime_InferenceConfiguration_Contents"></a>

 ** maxTokens **   <a name="bedrock-Type-runtime_InferenceConfiguration-maxTokens"></a>
The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).   
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** stopSequences **   <a name="bedrock-Type-runtime_InferenceConfiguration-stopSequences"></a>
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2500 items.  
Length Constraints: Minimum length of 1.  
Required: No

 ** temperature **   <a name="bedrock-Type-runtime_InferenceConfiguration-temperature"></a>
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.  
The default value is the default value for the model that you are using. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).   
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** topP **   <a name="bedrock-Type-runtime_InferenceConfiguration-topP"></a>
The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for `topP`, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.  
The default value is the default value for the model that you are using. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).   
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

## See Also
<a name="API_runtime_InferenceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InferenceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InferenceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InferenceConfiguration) 

# InvokeModelTokensRequest
<a name="API_runtime_InvokeModelTokensRequest"></a>

The body of an `InvokeModel` API request for token counting. This structure mirrors the input format for the `InvokeModel` operation, allowing you to count tokens for raw text inference requests.

## Contents
<a name="API_runtime_InvokeModelTokensRequest_Contents"></a>

 ** body **   <a name="bedrock-Type-runtime_InvokeModelTokensRequest-body"></a>
The request body to count tokens for, formatted according to the model's expected input format. To learn about the input format for different models, see [Model inference parameters and responses](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 0. Maximum length of 25000000.  
Required: Yes

## See Also
<a name="API_runtime_InvokeModelTokensRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModelTokensRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModelTokensRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModelTokensRequest) 

# InvokeModelWithBidirectionalStreamInput
<a name="API_runtime_InvokeModelWithBidirectionalStreamInput"></a>

Payload content, the speech chunk, for the bidirectional input of the invocation step.

## Contents
<a name="API_runtime_InvokeModelWithBidirectionalStreamInput_Contents"></a>

 ** chunk **   <a name="bedrock-Type-runtime_InvokeModelWithBidirectionalStreamInput-chunk"></a>
The audio chunk that is used as input for the invocation step.  
Type: [BidirectionalInputPayloadPart](API_runtime_BidirectionalInputPayloadPart.md) object  
Required: No

## See Also
<a name="API_runtime_InvokeModelWithBidirectionalStreamInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamInput) 

# InvokeModelWithBidirectionalStreamOutput
<a name="API_runtime_InvokeModelWithBidirectionalStreamOutput"></a>

Output from the bidirectional stream that was used for model invocation.

## Contents
<a name="API_runtime_InvokeModelWithBidirectionalStreamOutput_Contents"></a>

 ** chunk **   <a name="bedrock-Type-runtime_InvokeModelWithBidirectionalStreamOutput-chunk"></a>
The speech chunk that was provided as output from the invocation step.  
Type: [BidirectionalOutputPayloadPart](API_runtime_BidirectionalOutputPayloadPart.md) object  
Required: No

 ** internalServerException **   <a name="bedrock-Type-runtime_InvokeModelWithBidirectionalStreamOutput-internalServerException"></a>
The request encountered an unknown internal error.  
Type: Exception  
HTTP Status Code: 500  
Required: No

 ** modelStreamErrorException **   <a name="bedrock-Type-runtime_InvokeModelWithBidirectionalStreamOutput-modelStreamErrorException"></a>
The request encountered an error with the model stream.  
Type: Exception  
HTTP Status Code: 424  
Required: No

 ** modelTimeoutException **   <a name="bedrock-Type-runtime_InvokeModelWithBidirectionalStreamOutput-modelTimeoutException"></a>
The connection was closed because a request was not received within the timeout period.  
Type: Exception  
HTTP Status Code: 408  
Required: No

 ** serviceUnavailableException **   <a name="bedrock-Type-runtime_InvokeModelWithBidirectionalStreamOutput-serviceUnavailableException"></a>
The request has failed due to a temporary failure of the server.  
Type: Exception  
HTTP Status Code: 503  
Required: No

 ** throttlingException **   <a name="bedrock-Type-runtime_InvokeModelWithBidirectionalStreamOutput-throttlingException"></a>
The request was denied due to request throttling.  
Type: Exception  
HTTP Status Code: 429  
Required: No

 ** validationException **   <a name="bedrock-Type-runtime_InvokeModelWithBidirectionalStreamOutput-validationException"></a>
The input fails to satisfy the constraints specified by an AWS service.  
Type: Exception  
HTTP Status Code: 400  
Required: No

## See Also
<a name="API_runtime_InvokeModelWithBidirectionalStreamOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamOutput) 

# JsonSchemaDefinition
<a name="API_runtime_JsonSchemaDefinition"></a>

 JSON schema structured output format options. 

## Contents
<a name="API_runtime_JsonSchemaDefinition_Contents"></a>

 ** schema **   <a name="bedrock-Type-runtime_JsonSchemaDefinition-schema"></a>
 The JSON schema to constrain the model's output. For more information, see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference).   
Type: String  
Required: Yes

 ** description **   <a name="bedrock-Type-runtime_JsonSchemaDefinition-description"></a>
 A description of the JSON schema.   
Type: String  
Required: No

 ** name **   <a name="bedrock-Type-runtime_JsonSchemaDefinition-name"></a>
 The name of the JSON schema.   
Type: String  
Required: No

## See Also
<a name="API_runtime_JsonSchemaDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/JsonSchemaDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/JsonSchemaDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/JsonSchemaDefinition) 

# Message
<a name="API_runtime_Message"></a>

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).

## Contents
<a name="API_runtime_Message_Contents"></a>

 ** content **   <a name="bedrock-Type-runtime_Message-content"></a>
The message content. Note the following restrictions:  
+ You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.
+ You can include up to five documents. Each document's size must be no more than 4.5 MB.
+ If you include a `ContentBlock` with a `document` field in the array, you must also include a `ContentBlock` with a `text` field.
+ You can only include images and documents if the `role` is `user`.
Type: Array of [ContentBlock](API_runtime_ContentBlock.md) objects  
Required: Yes

 ** role **   <a name="bedrock-Type-runtime_Message-role"></a>
The role that the message plays in the message.  
Type: String  
Valid Values: `user | assistant`   
Required: Yes

## See Also
<a name="API_runtime_Message_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Message) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Message) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Message) 

# MessageStartEvent
<a name="API_runtime_MessageStartEvent"></a>

The start of a message.

## Contents
<a name="API_runtime_MessageStartEvent_Contents"></a>

 ** role **   <a name="bedrock-Type-runtime_MessageStartEvent-role"></a>
The role for the message.  
Type: String  
Valid Values: `user | assistant`   
Required: Yes

## See Also
<a name="API_runtime_MessageStartEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/MessageStartEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/MessageStartEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/MessageStartEvent) 

# MessageStopEvent
<a name="API_runtime_MessageStopEvent"></a>

The stop event for a message.

## Contents
<a name="API_runtime_MessageStopEvent_Contents"></a>

 ** stopReason **   <a name="bedrock-Type-runtime_MessageStopEvent-stopReason"></a>
The reason why the model stopped generating output.  
Type: String  
Valid Values: `end_turn | tool_use | max_tokens | stop_sequence | guardrail_intervened | content_filtered | malformed_model_output | malformed_tool_use | model_context_window_exceeded`   
Required: Yes

 ** additionalModelResponseFields **   <a name="bedrock-Type-runtime_MessageStopEvent-additionalModelResponseFields"></a>
The additional model response fields.  
Type: JSON value  
Required: No

## See Also
<a name="API_runtime_MessageStopEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/MessageStopEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/MessageStopEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/MessageStopEvent) 

# OutputConfig
<a name="API_runtime_OutputConfig"></a>

Output configuration for a model response 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).

## Contents
<a name="API_runtime_OutputConfig_Contents"></a>

 ** textFormat **   <a name="bedrock-Type-runtime_OutputConfig-textFormat"></a>
Structured output parameters to control the model's text response.   
Type: [OutputFormat](API_runtime_OutputFormat.md) object  
Required: No

## See Also
<a name="API_runtime_OutputConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/OutputConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/OutputConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/OutputConfig) 

# OutputFormat
<a name="API_runtime_OutputFormat"></a>

 Structured output parameters to control the model's response. 

## Contents
<a name="API_runtime_OutputFormat_Contents"></a>

 ** structure **   <a name="bedrock-Type-runtime_OutputFormat-structure"></a>
 The structure that the model's output must adhere to.   
Type: [OutputFormatStructure](API_runtime_OutputFormatStructure.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** type **   <a name="bedrock-Type-runtime_OutputFormat-type"></a>
 The type of structured output format.   
Type: String  
Valid Values: `json_schema`   
Required: Yes

## See Also
<a name="API_runtime_OutputFormat_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/OutputFormat) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/OutputFormat) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/OutputFormat) 

# OutputFormatStructure
<a name="API_runtime_OutputFormatStructure"></a>

 The structure that the model's output must adhere to. 

## Contents
<a name="API_runtime_OutputFormatStructure_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** jsonSchema **   <a name="bedrock-Type-runtime_OutputFormatStructure-jsonSchema"></a>
 A JSON schema structure that the model's output must adhere to.   
Type: [JsonSchemaDefinition](API_runtime_JsonSchemaDefinition.md) object  
Required: No

## See Also
<a name="API_runtime_OutputFormatStructure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/OutputFormatStructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/OutputFormatStructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/OutputFormatStructure) 

# PayloadPart
<a name="API_runtime_PayloadPart"></a>

Payload content included in the response.

## Contents
<a name="API_runtime_PayloadPart_Contents"></a>

 ** bytes **   <a name="bedrock-Type-runtime_PayloadPart-bytes"></a>
Base64-encoded bytes of payload data.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 0. Maximum length of 1000000.  
Required: No

## See Also
<a name="API_runtime_PayloadPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/PayloadPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/PayloadPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/PayloadPart) 

# PerformanceConfiguration
<a name="API_runtime_PerformanceConfiguration"></a>

Performance settings for a model.

## Contents
<a name="API_runtime_PerformanceConfiguration_Contents"></a>

 ** latency **   <a name="bedrock-Type-runtime_PerformanceConfiguration-latency"></a>
To use a latency-optimized version of the model, set to `optimized`.  
Type: String  
Valid Values: `standard | optimized`   
Required: No

## See Also
<a name="API_runtime_PerformanceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/PerformanceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/PerformanceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/PerformanceConfiguration) 

# PromptRouterTrace
<a name="API_runtime_PromptRouterTrace"></a>

A prompt router trace.

## Contents
<a name="API_runtime_PromptRouterTrace_Contents"></a>

 ** invokedModelId **   <a name="bedrock-Type-runtime_PromptRouterTrace-invokedModelId"></a>
The ID of the invoked model.  
Type: String  
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)`   
Required: No

## See Also
<a name="API_runtime_PromptRouterTrace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/PromptRouterTrace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/PromptRouterTrace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/PromptRouterTrace) 

# PromptVariableValues
<a name="API_runtime_PromptVariableValues"></a>

Contains a map of variables in a prompt from Prompt management to an object containing the values to fill in for them when running model invocation. For more information, see [How Prompt management works](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-how.html).

## Contents
<a name="API_runtime_PromptVariableValues_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** text **   <a name="bedrock-Type-runtime_PromptVariableValues-text"></a>
The text value that the variable maps to.  
Type: String  
Required: No

## See Also
<a name="API_runtime_PromptVariableValues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/PromptVariableValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/PromptVariableValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/PromptVariableValues) 

# ReasoningContentBlock
<a name="API_runtime_ReasoningContentBlock"></a>

Contains content regarding the reasoning that is carried out by the model with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

## Contents
<a name="API_runtime_ReasoningContentBlock_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** reasoningText **   <a name="bedrock-Type-runtime_ReasoningContentBlock-reasoningText"></a>
The reasoning that the model used to return the output.  
Type: [ReasoningTextBlock](API_runtime_ReasoningTextBlock.md) object  
Required: No

 ** redactedContent **   <a name="bedrock-Type-runtime_ReasoningContentBlock-redactedContent"></a>
The content in the reasoning that was encrypted by the model provider for safety reasons. The encryption doesn't affect the quality of responses.  
Type: Base64-encoded binary data object  
Required: No

## See Also
<a name="API_runtime_ReasoningContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ReasoningContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ReasoningContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ReasoningContentBlock) 

# ReasoningContentBlockDelta
<a name="API_runtime_ReasoningContentBlockDelta"></a>

Contains content regarding the reasoning that is carried out by the model with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

## Contents
<a name="API_runtime_ReasoningContentBlockDelta_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** redactedContent **   <a name="bedrock-Type-runtime_ReasoningContentBlockDelta-redactedContent"></a>
The content in the reasoning that was encrypted by the model provider for safety reasons. The encryption doesn't affect the quality of responses.  
Type: Base64-encoded binary data object  
Required: No

 ** signature **   <a name="bedrock-Type-runtime_ReasoningContentBlockDelta-signature"></a>
A token that verifies that the reasoning text was generated by the model. If you pass a reasoning block back to the API in a multi-turn conversation, include the text and its signature unmodified.  
Type: String  
Required: No

 ** text **   <a name="bedrock-Type-runtime_ReasoningContentBlockDelta-text"></a>
The reasoning that the model used to return the output.  
Type: String  
Required: No

## See Also
<a name="API_runtime_ReasoningContentBlockDelta_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ReasoningContentBlockDelta) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ReasoningContentBlockDelta) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ReasoningContentBlockDelta) 

# ReasoningTextBlock
<a name="API_runtime_ReasoningTextBlock"></a>

Contains the reasoning that the model used to return the output.

## Contents
<a name="API_runtime_ReasoningTextBlock_Contents"></a>

 ** text **   <a name="bedrock-Type-runtime_ReasoningTextBlock-text"></a>
The reasoning that the model used to return the output.  
Type: String  
Required: Yes

 ** signature **   <a name="bedrock-Type-runtime_ReasoningTextBlock-signature"></a>
A token that verifies that the reasoning text was generated by the model. If you pass a reasoning block back to the API in a multi-turn conversation, include the text and its signature unmodified.  
Type: String  
Required: No

## See Also
<a name="API_runtime_ReasoningTextBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ReasoningTextBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ReasoningTextBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ReasoningTextBlock) 

# ResponseStream
<a name="API_runtime_ResponseStream"></a>

Definition of content in the response stream.

## Contents
<a name="API_runtime_ResponseStream_Contents"></a>

 ** chunk **   <a name="bedrock-Type-runtime_ResponseStream-chunk"></a>
Content included in the response.  
Type: [PayloadPart](API_runtime_PayloadPart.md) object  
Required: No

 ** internalServerException **   <a name="bedrock-Type-runtime_ResponseStream-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500  
Required: No

 ** modelStreamErrorException **   <a name="bedrock-Type-runtime_ResponseStream-modelStreamErrorException"></a>
An error occurred while streaming the response. Retry your request.  
Type: Exception  
HTTP Status Code: 424  
Required: No

 ** modelTimeoutException **   <a name="bedrock-Type-runtime_ResponseStream-modelTimeoutException"></a>
The request took too long to process. Processing time exceeded the model timeout length.  
Type: Exception  
HTTP Status Code: 408  
Required: No

 ** serviceUnavailableException **   <a name="bedrock-Type-runtime_ResponseStream-serviceUnavailableException"></a>
The service isn't available. Try again later.  
Type: Exception  
HTTP Status Code: 503  
Required: No

 ** throttlingException **   <a name="bedrock-Type-runtime_ResponseStream-throttlingException"></a>
Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) to increase the rate or number of tokens you can process.  
Type: Exception  
HTTP Status Code: 429  
Required: No

 ** validationException **   <a name="bedrock-Type-runtime_ResponseStream-validationException"></a>
Input validation failed. Check your request parameters and retry the request.  
Type: Exception  
HTTP Status Code: 400  
Required: No

## See Also
<a name="API_runtime_ResponseStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ResponseStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ResponseStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ResponseStream) 

# S3Location
<a name="API_runtime_S3Location"></a>

A storage location in an Amazon S3 bucket.

## Contents
<a name="API_runtime_S3Location_Contents"></a>

 ** uri **   <a name="bedrock-Type-runtime_S3Location-uri"></a>
An object URI starting with `s3://`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?`   
Required: Yes

 ** bucketOwner **   <a name="bedrock-Type-runtime_S3Location-bucketOwner"></a>
If the bucket belongs to another AWS account, specify that account's ID.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

## See Also
<a name="API_runtime_S3Location_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/S3Location) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/S3Location) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/S3Location) 

# SearchResultBlock
<a name="API_runtime_SearchResultBlock"></a>

A search result block that enables natural citations with proper source attribution for retrieved content.

**Note**  
This field is only supported by Anthropic Claude Opus 4.1, Opus 4, Sonnet 4.5, Sonnet 4, Sonnet 3.7, and 3.5 Haiku models.

## Contents
<a name="API_runtime_SearchResultBlock_Contents"></a>

 ** content **   <a name="bedrock-Type-runtime_SearchResultBlock-content"></a>
An array of search result content block.  
Type: Array of [SearchResultContentBlock](API_runtime_SearchResultContentBlock.md) objects  
Required: Yes

 ** source **   <a name="bedrock-Type-runtime_SearchResultBlock-source"></a>
The source URL or identifier for the content.  
Type: String  
Required: Yes

 ** title **   <a name="bedrock-Type-runtime_SearchResultBlock-title"></a>
A descriptive title for the search result.  
Type: String  
Required: Yes

 ** citations **   <a name="bedrock-Type-runtime_SearchResultBlock-citations"></a>
Configuration setting for citations  
Type: [CitationsConfig](API_runtime_CitationsConfig.md) object  
Required: No

## See Also
<a name="API_runtime_SearchResultBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SearchResultBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SearchResultBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SearchResultBlock) 

# SearchResultContentBlock
<a name="API_runtime_SearchResultContentBlock"></a>

A block within a search result that contains the content.

## Contents
<a name="API_runtime_SearchResultContentBlock_Contents"></a>

 ** text **   <a name="bedrock-Type-runtime_SearchResultContentBlock-text"></a>
The actual text content  
Type: String  
Required: Yes

## See Also
<a name="API_runtime_SearchResultContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SearchResultContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SearchResultContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SearchResultContentBlock) 

# SearchResultLocation
<a name="API_runtime_SearchResultLocation"></a>

Specifies a search result location within the content array, providing positioning information for cited content using search result index and block positions.

## Contents
<a name="API_runtime_SearchResultLocation_Contents"></a>

 ** end **   <a name="bedrock-Type-runtime_SearchResultLocation-end"></a>
The ending position in the content array where the cited content ends.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** searchResultIndex **   <a name="bedrock-Type-runtime_SearchResultLocation-searchResultIndex"></a>
The index of the search result content block where the cited content is found.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** start **   <a name="bedrock-Type-runtime_SearchResultLocation-start"></a>
The starting position in the content array where the cited content begins.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_runtime_SearchResultLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SearchResultLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SearchResultLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SearchResultLocation) 

# ServiceTier
<a name="API_runtime_ServiceTier"></a>

Specifies the processing tier configuration used for serving the request.

## Contents
<a name="API_runtime_ServiceTier_Contents"></a>

 ** type **   <a name="bedrock-Type-runtime_ServiceTier-type"></a>
Specifies the processing tier type used for serving the request.  
Type: String  
Valid Values: `priority | default | flex | reserved`   
Required: Yes

## See Also
<a name="API_runtime_ServiceTier_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ServiceTier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ServiceTier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ServiceTier) 

# SpecificToolChoice
<a name="API_runtime_SpecificToolChoice"></a>

The model must request a specific tool. For example, `{"tool" : {"name" : "Your tool name"}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide

**Note**  
This field is only supported by Anthropic Claude 3 models.

## Contents
<a name="API_runtime_SpecificToolChoice_Contents"></a>

 ** name **   <a name="bedrock-Type-runtime_SpecificToolChoice-name"></a>
The name of the tool that the model must request.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

## See Also
<a name="API_runtime_SpecificToolChoice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SpecificToolChoice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SpecificToolChoice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SpecificToolChoice) 

# SystemContentBlock
<a name="API_runtime_SystemContentBlock"></a>

Contains configurations for instructions to provide the model for how to handle input. To learn more, see [Using the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html).

## Contents
<a name="API_runtime_SystemContentBlock_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** cachePoint **   <a name="bedrock-Type-runtime_SystemContentBlock-cachePoint"></a>
CachePoint to include in the system prompt.  
Type: [CachePointBlock](API_runtime_CachePointBlock.md) object  
Required: No

 ** guardContent **   <a name="bedrock-Type-runtime_SystemContentBlock-guardContent"></a>
A content block to assess with the guardrail. Use 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.   
For more information, see [Use a guardrail with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-use-converse-api.html).  
Type: [GuardrailConverseContentBlock](API_runtime_GuardrailConverseContentBlock.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** text **   <a name="bedrock-Type-runtime_SystemContentBlock-text"></a>
A system prompt for the model.   
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_runtime_SystemContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SystemContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SystemContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SystemContentBlock) 

# SystemTool
<a name="API_runtime_SystemTool"></a>

Specifies a system-defined tool for the model to use. *System-defined tools* are tools that are created and provided by the model provider.

## Contents
<a name="API_runtime_SystemTool_Contents"></a>

 ** name **   <a name="bedrock-Type-runtime_SystemTool-name"></a>
The name of the system-defined tool that you want to call.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

## See Also
<a name="API_runtime_SystemTool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SystemTool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SystemTool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SystemTool) 

# Tag
<a name="API_runtime_Tag"></a>

A tag.

## Contents
<a name="API_runtime_Tag_Contents"></a>

 ** key **   <a name="bedrock-Type-runtime_Tag-key"></a>
The tag's key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`   
Required: Yes

 ** value **   <a name="bedrock-Type-runtime_Tag-value"></a>
The tag's value.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`   
Required: Yes

## See Also
<a name="API_runtime_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Tag) 

# TokenUsage
<a name="API_runtime_TokenUsage"></a>

The tokens used in a message API inference call. 

## Contents
<a name="API_runtime_TokenUsage_Contents"></a>

 ** inputTokens **   <a name="bedrock-Type-runtime_TokenUsage-inputTokens"></a>
The number of tokens sent in the request to the model.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** outputTokens **   <a name="bedrock-Type-runtime_TokenUsage-outputTokens"></a>
The number of tokens that the model generated for the request.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** totalTokens **   <a name="bedrock-Type-runtime_TokenUsage-totalTokens"></a>
The total of input tokens and tokens generated by the model.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** cacheDetails **   <a name="bedrock-Type-runtime_TokenUsage-cacheDetails"></a>
Detailed breakdown of cache writes by TTL. Empty if no cache creation occurred. Sorted by TTL duration (1h before 5m).  
Type: Array of [CacheDetail](API_runtime_CacheDetail.md) objects  
Required: No

 ** cacheReadInputTokens **   <a name="bedrock-Type-runtime_TokenUsage-cacheReadInputTokens"></a>
The number of input tokens read from the cache for the request.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** cacheWriteInputTokens **   <a name="bedrock-Type-runtime_TokenUsage-cacheWriteInputTokens"></a>
The number of input tokens written to the cache for the request.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_runtime_TokenUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/TokenUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/TokenUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/TokenUsage) 

# Tool
<a name="API_runtime_Tool"></a>

Information about a tool that you can use with the Converse API. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_Tool_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** cachePoint **   <a name="bedrock-Type-runtime_Tool-cachePoint"></a>
CachePoint to include in the tool configuration.  
Type: [CachePointBlock](API_runtime_CachePointBlock.md) object  
Required: No

 ** systemTool **   <a name="bedrock-Type-runtime_Tool-systemTool"></a>
Specifies the system-defined tool that you want use.  
Type: [SystemTool](API_runtime_SystemTool.md) object  
Required: No

 ** toolSpec **   <a name="bedrock-Type-runtime_Tool-toolSpec"></a>
The specfication for the tool.   
Type: [ToolSpecification](API_runtime_ToolSpecification.md) object  
Required: No

## See Also
<a name="API_runtime_Tool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Tool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Tool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Tool) 

# ToolChoice
<a name="API_runtime_ToolChoice"></a>

Determines which tools the model should request in a call to `Converse` or `ConverseStream`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolChoice_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** any **   <a name="bedrock-Type-runtime_ToolChoice-any"></a>
The model must request at least one tool (no text is generated).  
Type: [AnyToolChoice](API_runtime_AnyToolChoice.md) object  
Required: No

 ** auto **   <a name="bedrock-Type-runtime_ToolChoice-auto"></a>
(Default). The Model automatically decides if a tool should be called or whether to generate text instead.   
Type: [AutoToolChoice](API_runtime_AutoToolChoice.md) object  
Required: No

 ** tool **   <a name="bedrock-Type-runtime_ToolChoice-tool"></a>
The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.   
Type: [SpecificToolChoice](API_runtime_SpecificToolChoice.md) object  
Required: No

## See Also
<a name="API_runtime_ToolChoice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolChoice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolChoice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolChoice) 

# ToolConfiguration
<a name="API_runtime_ToolConfiguration"></a>

Configuration information for the tools that you pass to a model. For more information, see [Tool use (function calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolConfiguration_Contents"></a>

 ** tools **   <a name="bedrock-Type-runtime_ToolConfiguration-tools"></a>
An array of tools that you want to pass to a model.   
Type: Array of [Tool](API_runtime_Tool.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** toolChoice **   <a name="bedrock-Type-runtime_ToolConfiguration-toolChoice"></a>
If supported by model, forces the model to request a tool.   
Type: [ToolChoice](API_runtime_ToolChoice.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_runtime_ToolConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolConfiguration) 

# ToolInputSchema
<a name="API_runtime_ToolInputSchema"></a>

The schema for the tool. The top level schema type must be `object`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolInputSchema_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** json **   <a name="bedrock-Type-runtime_ToolInputSchema-json"></a>
The JSON schema for the tool. For more information, see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference).  
Type: JSON value  
Required: No

## See Also
<a name="API_runtime_ToolInputSchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolInputSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolInputSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolInputSchema) 

# ToolResultBlock
<a name="API_runtime_ToolResultBlock"></a>

A tool result block that contains the results for a tool request that the model previously made. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolResultBlock_Contents"></a>

 ** content **   <a name="bedrock-Type-runtime_ToolResultBlock-content"></a>
The content for tool result content block.  
Type: Array of [ToolResultContentBlock](API_runtime_ToolResultContentBlock.md) objects  
Required: Yes

 ** toolUseId **   <a name="bedrock-Type-runtime_ToolResultBlock-toolUseId"></a>
The ID of the tool request that this is the result for.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** status **   <a name="bedrock-Type-runtime_ToolResultBlock-status"></a>
The status for the tool result content block.  
This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.
Type: String  
Valid Values: `success | error`   
Required: No

 ** type **   <a name="bedrock-Type-runtime_ToolResultBlock-type"></a>
The type for the tool result content block.  
Type: String  
Required: No

## See Also
<a name="API_runtime_ToolResultBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolResultBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolResultBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolResultBlock) 

# ToolResultBlockDelta
<a name="API_runtime_ToolResultBlockDelta"></a>

Contains incremental updates to tool results information during streaming responses. This allows clients to build up tool results data progressively as the response is generated.

## Contents
<a name="API_runtime_ToolResultBlockDelta_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** json **   <a name="bedrock-Type-runtime_ToolResultBlockDelta-json"></a>
The JSON schema for the tool result content block. see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference).  
Type: JSON value  
Required: No

 ** text **   <a name="bedrock-Type-runtime_ToolResultBlockDelta-text"></a>
The reasoning the model used to return the output.  
Type: String  
Required: No

## See Also
<a name="API_runtime_ToolResultBlockDelta_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolResultBlockDelta) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolResultBlockDelta) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolResultBlockDelta) 

# ToolResultBlockStart
<a name="API_runtime_ToolResultBlockStart"></a>

The start of a tool result block. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolResultBlockStart_Contents"></a>

 ** toolUseId **   <a name="bedrock-Type-runtime_ToolResultBlockStart-toolUseId"></a>
The ID of the tool that was used to generate this tool result block.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** status **   <a name="bedrock-Type-runtime_ToolResultBlockStart-status"></a>
The status of the tool result block.  
Type: String  
Valid Values: `success | error`   
Required: No

 ** type **   <a name="bedrock-Type-runtime_ToolResultBlockStart-type"></a>
The type for the tool that was used to generate this tool result block.  
Type: String  
Required: No

## See Also
<a name="API_runtime_ToolResultBlockStart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolResultBlockStart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolResultBlockStart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolResultBlockStart) 

# ToolResultContentBlock
<a name="API_runtime_ToolResultContentBlock"></a>

The tool result content block. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolResultContentBlock_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** document **   <a name="bedrock-Type-runtime_ToolResultContentBlock-document"></a>
A tool result that is a document.  
Type: [DocumentBlock](API_runtime_DocumentBlock.md) object  
Required: No

 ** image **   <a name="bedrock-Type-runtime_ToolResultContentBlock-image"></a>
A tool result that is an image.   
This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.
Type: [ImageBlock](API_runtime_ImageBlock.md) object  
Required: No

 ** json **   <a name="bedrock-Type-runtime_ToolResultContentBlock-json"></a>
A tool result that is JSON format data.   
Type: JSON value  
Required: No

 ** searchResult **   <a name="bedrock-Type-runtime_ToolResultContentBlock-searchResult"></a>
A tool result that is a search result.  
Type: [SearchResultBlock](API_runtime_SearchResultBlock.md) object  
Required: No

 ** text **   <a name="bedrock-Type-runtime_ToolResultContentBlock-text"></a>
A tool result that is text.   
Type: String  
Required: No

 ** video **   <a name="bedrock-Type-runtime_ToolResultContentBlock-video"></a>
A tool result that is video.  
Type: [VideoBlock](API_runtime_VideoBlock.md) object  
Required: No

## See Also
<a name="API_runtime_ToolResultContentBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolResultContentBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolResultContentBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolResultContentBlock) 

# ToolSpecification
<a name="API_runtime_ToolSpecification"></a>

The specification for the tool. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolSpecification_Contents"></a>

 ** inputSchema **   <a name="bedrock-Type-runtime_ToolSpecification-inputSchema"></a>
The input schema for the tool in JSON format.  
Type: [ToolInputSchema](API_runtime_ToolInputSchema.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** name **   <a name="bedrock-Type-runtime_ToolSpecification-name"></a>
The name for the tool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** description **   <a name="bedrock-Type-runtime_ToolSpecification-description"></a>
The description for the tool.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** strict **   <a name="bedrock-Type-runtime_ToolSpecification-strict"></a>
Flag to enable structured output enforcement on a tool usage response.  
Type: Boolean  
Required: No

## See Also
<a name="API_runtime_ToolSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolSpecification) 

# ToolUseBlock
<a name="API_runtime_ToolUseBlock"></a>

A tool use content block. Contains information about a tool that the model is requesting be run., The model uses the result from the tool to generate a response. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolUseBlock_Contents"></a>

 ** input **   <a name="bedrock-Type-runtime_ToolUseBlock-input"></a>
The input to pass to the tool.   
Type: JSON value  
Required: Yes

 ** name **   <a name="bedrock-Type-runtime_ToolUseBlock-name"></a>
The name of the tool that the model wants to use.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** toolUseId **   <a name="bedrock-Type-runtime_ToolUseBlock-toolUseId"></a>
The ID for the tool request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** type **   <a name="bedrock-Type-runtime_ToolUseBlock-type"></a>
The type for the tool request.  
Type: String  
Valid Values: `server_tool_use`   
Required: No

## See Also
<a name="API_runtime_ToolUseBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolUseBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolUseBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolUseBlock) 

# ToolUseBlockDelta
<a name="API_runtime_ToolUseBlockDelta"></a>

The delta for a tool use block.

## Contents
<a name="API_runtime_ToolUseBlockDelta_Contents"></a>

 ** input **   <a name="bedrock-Type-runtime_ToolUseBlockDelta-input"></a>
The input for a requested tool.  
Type: String  
Required: Yes

## See Also
<a name="API_runtime_ToolUseBlockDelta_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolUseBlockDelta) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolUseBlockDelta) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolUseBlockDelta) 

# ToolUseBlockStart
<a name="API_runtime_ToolUseBlockStart"></a>

The start of a tool use block. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

## Contents
<a name="API_runtime_ToolUseBlockStart_Contents"></a>

 ** name **   <a name="bedrock-Type-runtime_ToolUseBlockStart-name"></a>
The name of the tool that the model is requesting to use.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** toolUseId **   <a name="bedrock-Type-runtime_ToolUseBlockStart-toolUseId"></a>
The ID for the tool request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_-]+`   
Required: Yes

 ** type **   <a name="bedrock-Type-runtime_ToolUseBlockStart-type"></a>
The type for the tool request.  
Type: String  
Valid Values: `server_tool_use`   
Required: No

## See Also
<a name="API_runtime_ToolUseBlockStart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolUseBlockStart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolUseBlockStart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolUseBlockStart) 

# VideoBlock
<a name="API_runtime_VideoBlock"></a>

A video block.

## Contents
<a name="API_runtime_VideoBlock_Contents"></a>

 ** format **   <a name="bedrock-Type-runtime_VideoBlock-format"></a>
The block's format.  
Type: String  
Valid Values: `mkv | mov | mp4 | webm | flv | mpeg | mpg | wmv | three_gp`   
Required: Yes

 ** source **   <a name="bedrock-Type-runtime_VideoBlock-source"></a>
The block's source.  
Type: [VideoSource](API_runtime_VideoSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_runtime_VideoBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/VideoBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/VideoBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/VideoBlock) 

# VideoSource
<a name="API_runtime_VideoSource"></a>

A video source. You can upload a smaller video as a base64-encoded string as long as the encoded file is less than 25MB. You can also transfer videos up to 1GB in size from an S3 bucket.

## Contents
<a name="API_runtime_VideoSource_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** bytes **   <a name="bedrock-Type-runtime_VideoSource-bytes"></a>
Video content encoded in base64.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1.  
Required: No

 ** s3Location **   <a name="bedrock-Type-runtime_VideoSource-s3Location"></a>
The location of a video object in an Amazon S3 bucket. To see which models support S3 uploads, see [Supported models and features for Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).  
Type: [S3Location](API_runtime_S3Location.md) object  
Required: No

## See Also
<a name="API_runtime_VideoSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/VideoSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/VideoSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/VideoSource) 

# WebLocation
<a name="API_runtime_WebLocation"></a>

Provides the URL and domain information for the website that was cited when performing a web search.

## Contents
<a name="API_runtime_WebLocation_Contents"></a>

 ** domain **   <a name="bedrock-Type-runtime_WebLocation-domain"></a>
The domain that was cited when performing a web search.  
Type: String  
Required: No

 ** url **   <a name="bedrock-Type-runtime_WebLocation-url"></a>
The URL that was cited when performing a web search.  
Type: String  
Required: No

## See Also
<a name="API_runtime_WebLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/WebLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/WebLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/WebLocation)