Skip to main content

graniteGuardianClient

Workspace API

Workspace API / services/granite/graniteGuardianClient

services/granite/graniteGuardianClient

Classes​

GraniteGuardianClient​

Defined in: services/granite/graniteGuardianClient.ts:78

Client for Granite Guardian content safety model

Constructors​

Constructor​

new GraniteGuardianClient(): GraniteGuardianClient

Defined in: services/granite/graniteGuardianClient.ts:85

Returns​

GraniteGuardianClient

Methods​

isEnabled()​

isEnabled(): boolean

Defined in: services/granite/graniteGuardianClient.ts:115

Check if Guardian is enabled

Returns​

boolean

isPreFilterEnabled()​

isPreFilterEnabled(): boolean

Defined in: services/granite/graniteGuardianClient.ts:122

Check if pre-filtering is enabled

Returns​

boolean

isPostFilterEnabled()​

isPostFilterEnabled(): boolean

Defined in: services/granite/graniteGuardianClient.ts:129

Check if post-filtering is enabled

Returns​

boolean

checkInput()​

checkInput(userInput): Promise<GuardianCheckResult>

Defined in: services/granite/graniteGuardianClient.ts:136

Pre-filter user input for security risks

Parameters​
userInput​

string

Returns​

Promise<GuardianCheckResult>

checkOutput()​

checkOutput(aiOutput): Promise<GuardianCheckResult>

Defined in: services/granite/graniteGuardianClient.ts:152

Post-filter AI output for content safety

Parameters​
aiOutput​

string

Returns​

Promise<GuardianCheckResult>

Interfaces​

GuardianCheckResult​

Defined in: services/granite/graniteGuardianClient.ts:38

Properties​

safe​

safe: boolean

Defined in: services/granite/graniteGuardianClient.ts:39

risk​

risk: GuardianRisk

Defined in: services/granite/graniteGuardianClient.ts:40

confidence​

confidence: number

Defined in: services/granite/graniteGuardianClient.ts:41

explanation​

explanation: string

Defined in: services/granite/graniteGuardianClient.ts:42

rawResponse?​

optional rawResponse: string

Defined in: services/granite/graniteGuardianClient.ts:43

Type Aliases​

GuardianRisk​

GuardianRisk = "safe" | "jailbreak" | "prompt_injection" | "harmful_content" | "pii_exposure" | "unknown"

Defined in: services/granite/graniteGuardianClient.ts:30

Variables​

GRANITE_GUARDIAN_MODEL_ID​

const GRANITE_GUARDIAN_MODEL_ID: string = GUARDIAN_CONFIG.model

Defined in: services/granite/graniteGuardianClient.ts:28

Functions​

getGraniteGuardianClient()​

getGraniteGuardianClient(): GraniteGuardianClient

Defined in: services/granite/graniteGuardianClient.ts:324

Returns​

GraniteGuardianClient