bedrockruntime/aws.sdk.kotlin.services.bedrockruntime.model/ContentBlock/GuardContent

GuardContent

data class GuardContent(val value: GuardrailConverseContentBlock) : ContentBlock

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 in the Amazon Bedrock User Guide.

Constructors

GuardContent

constructor(value: GuardrailConverseContentBlock)

Properties

value

val value: GuardrailConverseContentBlock

Inherited functions

asCachePoint

fun asCachePoint(): CachePointBlock

Casts this ContentBlock as a CachePoint and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.CachePointBlock value. Throws an exception if the ContentBlock is not a CachePoint.

asCachePointOrNull

fun asCachePointOrNull(): CachePointBlock?

Casts this ContentBlock as a CachePoint and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.CachePointBlock value. Returns null if the ContentBlock is not a CachePoint.

asCitationsContent

fun asCitationsContent(): CitationsContentBlock

Casts this ContentBlock as a CitationsContent and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.CitationsContentBlock value. Throws an exception if the ContentBlock is not a CitationsContent.

asCitationsContentOrNull

fun asCitationsContentOrNull(): CitationsContentBlock?

Casts this ContentBlock as a CitationsContent and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.CitationsContentBlock value. Returns null if the ContentBlock is not a CitationsContent.

asDocument

fun asDocument(): DocumentBlock

Casts this ContentBlock as a Document and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.DocumentBlock value. Throws an exception if the ContentBlock is not a Document.

asDocumentOrNull

fun asDocumentOrNull(): DocumentBlock?

Casts this ContentBlock as a Document and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.DocumentBlock value. Returns null if the ContentBlock is not a Document.

asGuardContent

fun asGuardContent(): GuardrailConverseContentBlock

Casts this ContentBlock as a GuardContent and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.GuardrailConverseContentBlock value. Throws an exception if the ContentBlock is not a GuardContent.

asGuardContentOrNull

fun asGuardContentOrNull(): GuardrailConverseContentBlock?

Casts this ContentBlock as a GuardContent and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.GuardrailConverseContentBlock value. Returns null if the ContentBlock is not a GuardContent.

asImage

fun asImage(): ImageBlock

Casts this ContentBlock as a Image and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ImageBlock value. Throws an exception if the ContentBlock is not a Image.

asImageOrNull

fun asImageOrNull(): ImageBlock?

Casts this ContentBlock as a Image and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ImageBlock value. Returns null if the ContentBlock is not a Image.

asReasoningContent

fun asReasoningContent(): ReasoningContentBlock

Casts this ContentBlock as a ReasoningContent and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ReasoningContentBlock value. Throws an exception if the ContentBlock is not a ReasoningContent.

asReasoningContentOrNull

fun asReasoningContentOrNull(): ReasoningContentBlock?

Casts this ContentBlock as a ReasoningContent and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ReasoningContentBlock value. Returns null if the ContentBlock is not a ReasoningContent.

asText

fun asText(): String

Casts this ContentBlock as a Text and retrieves its kotlin.String value. Throws an exception if the ContentBlock is not a Text.

asTextOrNull

fun asTextOrNull(): String?

Casts this ContentBlock as a Text and retrieves its kotlin.String value. Returns null if the ContentBlock is not a Text.

asToolResult

fun asToolResult(): ToolResultBlock

Casts this ContentBlock as a ToolResult and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ToolResultBlock value. Throws an exception if the ContentBlock is not a ToolResult.

asToolResultOrNull

fun asToolResultOrNull(): ToolResultBlock?

Casts this ContentBlock as a ToolResult and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ToolResultBlock value. Returns null if the ContentBlock is not a ToolResult.

asToolUse

fun asToolUse(): ToolUseBlock

Casts this ContentBlock as a ToolUse and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ToolUseBlock value. Throws an exception if the ContentBlock is not a ToolUse.

asToolUseOrNull

fun asToolUseOrNull(): ToolUseBlock?

Casts this ContentBlock as a ToolUse and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ToolUseBlock value. Returns null if the ContentBlock is not a ToolUse.

asVideo

fun asVideo(): VideoBlock

Casts this ContentBlock as a Video and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.VideoBlock value. Throws an exception if the ContentBlock is not a Video.

asVideoOrNull

fun asVideoOrNull(): VideoBlock?

Casts this ContentBlock as a Video and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.VideoBlock value. Returns null if the ContentBlock is not a Video.