Skip to content

GuardContentBlock

Defined in: src/types/messages.ts:1151

Guard content block for guardrail evaluation. Marks content that should be evaluated by guardrails for safety, grounding, or other policies. Can be used in both message content and system prompts.

new GuardContentBlock(data): GuardContentBlock;

Defined in: src/types/messages.ts:1169

ParameterType
dataGuardContentBlockData

GuardContentBlock

readonly type: "guardContentBlock";

Defined in: src/types/messages.ts:1157

Discriminator for guard content.


readonly text?: GuardContentText;

Defined in: src/types/messages.ts:1162

Text content with evaluation qualifiers.

GuardContentBlockData.text


readonly image?: GuardContentImage;

Defined in: src/types/messages.ts:1167

Image content with evaluation qualifiers.

GuardContentBlockData.image

toJSON(): {
guardContent: {
text?: {
qualifiers: GuardQualifier[];
text: string;
};
image?: {
format: GuardImageFormat;
source: {
bytes: string;
};
};
};
};

Defined in: src/types/messages.ts:1189

Serializes the GuardContentBlock to a JSON-compatible ContentBlockData object. Called automatically by JSON.stringify(). Uint8Array image bytes are encoded as base64 string.

{
guardContent: {
text?: {
qualifiers: GuardQualifier[];
text: string;
};
image?: {
format: GuardImageFormat;
source: {
bytes: string;
};
};
};
}
NameTypeDescriptionDefined in
guardContent{ text?: { qualifiers: GuardQualifier[]; text: string; }; image?: { format: GuardImageFormat; source: { bytes: string; }; }; }-src/types/messages.ts:1189
guardContent.text?{ qualifiers: GuardQualifier[]; text: string; }Text content with evaluation qualifiers.src/types/messages.ts:1138
guardContent.text.qualifiersGuardQualifier[]Qualifiers that specify how this content should be evaluated.src/types/messages.ts:1107
guardContent.text.textstringThe text content to be evaluated.src/types/messages.ts:1112
guardContent.image?{ format: GuardImageFormat; source: { bytes: string; }; }Image content with evaluation qualifiers.src/types/messages.ts:1143
guardContent.image.formatGuardImageFormatImage format.src/types/messages.ts:1122
guardContent.image.source{ bytes: string; }Image source (bytes only).src/types/messages.ts:1127
guardContent.image.source.bytesstring-src/types/messages.ts:1098

JSONSerializable.toJSON


static fromJSON(data): GuardContentBlock;

Defined in: src/types/messages.ts:1210

Creates a GuardContentBlock instance from its wrapped data format. Base64-encoded image bytes are decoded back to Uint8Array.

ParameterTypeDescription
data{ guardContent: { text?: { qualifiers: GuardQualifier[]; text: string; }; image?: { format: GuardImageFormat; source: { bytes: string | Uint8Array<ArrayBufferLike>; }; }; }; }Wrapped GuardContentBlockData to deserialize (accepts both string and Uint8Array for image bytes)
data.guardContent{ text?: { qualifiers: GuardQualifier[]; text: string; }; image?: { format: GuardImageFormat; source: { bytes: string | Uint8Array<ArrayBufferLike>; }; }; }-
data.guardContent.text?{ qualifiers: GuardQualifier[]; text: string; }Text content with evaluation qualifiers.
data.guardContent.text.qualifiersGuardQualifier[]Qualifiers that specify how this content should be evaluated.
data.guardContent.text.textstringThe text content to be evaluated.
data.guardContent.image?{ format: GuardImageFormat; source: { bytes: string | Uint8Array<ArrayBufferLike>; }; }Image content with evaluation qualifiers.
data.guardContent.image.formatGuardImageFormatImage format.
data.guardContent.image.source{ bytes: string | Uint8Array<ArrayBufferLike>; }Image source (bytes only).
data.guardContent.image.source.bytesstring | Uint8Array<ArrayBufferLike>-

GuardContentBlock

GuardContentBlock instance