GuardContentBlock

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

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.

Implements

• GuardContentBlockData
• JSONSerializable<{ guardContent: Serialized<GuardContentBlockData>; }>

Constructors

Constructor

new GuardContentBlock(data): GuardContentBlock;

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

Parameters

Parameter	Type
data	GuardContentBlockData

Returns

GuardContentBlock

Properties

type

readonly type: "guardContentBlock";

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

Discriminator for guard content.

---

text?

readonly optional text?: GuardContentText;

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

Text content with evaluation qualifiers.

Implementation of

GuardContentBlockData.text

---

image?

readonly optional image?: GuardContentImage;

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

Image content with evaluation qualifiers.

Implementation of

GuardContentBlockData.image

Methods

toJSON()

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

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

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

Returns

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

Name	Type	Description	Defined in
guardContent	{ text?: { qualifiers: GuardQualifier[]; text: string; }; image?: { format: GuardImageFormat; source: { bytes: string; }; }; }	-	src/types/messages.ts:818
guardContent.text?	{ qualifiers: GuardQualifier[]; text: string; }	Text content with evaluation qualifiers.	src/types/messages.ts:767
guardContent.text.qualifiers	GuardQualifier[]	Qualifiers that specify how this content should be evaluated.	src/types/messages.ts:736
guardContent.text.text	string	The text content to be evaluated.	src/types/messages.ts:741
guardContent.image?	{ format: GuardImageFormat; source: { bytes: string; }; }	Image content with evaluation qualifiers.	src/types/messages.ts:772
guardContent.image.format	GuardImageFormat	Image format.	src/types/messages.ts:751
guardContent.image.source	{ bytes: string; }	Image source (bytes only).	src/types/messages.ts:756
guardContent.image.source.bytes	string	-	src/types/messages.ts:727

Implementation of

JSONSerializable.toJSON

---

fromJSON()

static fromJSON(data): GuardContentBlock;

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

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

Parameters

Parameter	Type	Description
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.qualifiers	GuardQualifier[]	Qualifiers that specify how this content should be evaluated.
data.guardContent.text.text	string	The text content to be evaluated.
data.guardContent.image?	{ format: GuardImageFormat; source: { bytes: string | Uint8Array<ArrayBufferLike>; }; }	Image content with evaluation qualifiers.
data.guardContent.image.format	GuardImageFormat	Image format.
data.guardContent.image.source	{ bytes: string | Uint8Array<ArrayBufferLike>; }	Image source (bytes only).
data.guardContent.image.source.bytes	string | Uint8Array<ArrayBufferLike>	-

Returns

GuardContentBlock

GuardContentBlock instance