Class: SdkPromptSetService¶

Defined in: src/airs/promptsets.ts:39

Wraps the SDK's RedTeamClient.customAttacks to implement PromptSetService. Creates and populates custom prompt sets for AI Red Team.

Implements¶

PromptSetService

Constructors¶

Constructor¶

new SdkPromptSetService(opts?): SdkPromptSetService

Defined in: src/airs/promptsets.ts:42

Parameters¶

opts?¶

RedTeamClientOptions

Returns¶

SdkPromptSetService

Methods¶

addPrompt()¶

addPrompt(promptSetId, prompt, goal?): Promise\<{ prompt: string; uuid: string; }>

Defined in: src/airs/promptsets.ts:57

Add a prompt to an existing prompt set.

Parameters¶

promptSetId¶

string

prompt¶

string

goal?¶

string

Returns¶

Promise\<{ prompt: string; uuid: string; }>

Implementation of¶

PromptSetService.addPrompt

archivePromptSet()¶

archivePromptSet(uuid, archive): Promise\<void>

Defined in: src/airs/promptsets.ts:92

Archive or unarchive a prompt set.

Parameters¶

uuid¶

string

archive¶

boolean

Returns¶

Promise\<void>

Implementation of¶

PromptSetService.archivePromptSet

createPromptSet()¶

createPromptSet(name, description?): Promise\<{ name: string; uuid: string; }>

Defined in: src/airs/promptsets.ts:46

Create a new custom prompt set.

Parameters¶

name¶

string

description?¶

string

Returns¶

Promise\<{ name: string; uuid: string; }>

Implementation of¶

PromptSetService.createPromptSet

createPropertyName()¶

createPropertyName(name): Promise\<PropertyName>

Defined in: src/airs/promptsets.ts:153

Create a property name.

Parameters¶

name¶

string

Returns¶

Promise\<PropertyName>

Implementation of¶

PromptSetService.createPropertyName

createPropertyValue()¶

createPropertyValue(name, value): Promise\<PropertyValue>

Defined in: src/airs/promptsets.ts:164

Create a property value.

Parameters¶

name¶

string

value¶

string

Returns¶

Promise\<PropertyValue>

Implementation of¶

PromptSetService.createPropertyValue

deletePrompt()¶

deletePrompt(setUuid, promptUuid): Promise\<void>

Defined in: src/airs/promptsets.ts:143

Delete a prompt.

Parameters¶

setUuid¶

string

promptUuid¶

string

Returns¶

Promise\<void>

Implementation of¶

PromptSetService.deletePrompt

downloadTemplate()¶

downloadTemplate(uuid): Promise\<string>

Defined in: src/airs/promptsets.ts:106

Download CSV template for a prompt set.

Parameters¶

uuid¶

string

Returns¶

Promise\<string>

Implementation of¶

PromptSetService.downloadTemplate

getPrompt()¶

getPrompt(setUuid, promptUuid): Promise\<PromptDetail>

Defined in: src/airs/promptsets.ts:125

Get a single prompt.

Parameters¶

setUuid¶

string

promptUuid¶

string

Returns¶

Promise\<PromptDetail>

Implementation of¶

PromptSetService.getPrompt

getPromptSet()¶

getPromptSet(uuid): Promise\<PromptSetDetail>

Defined in: src/airs/promptsets.ts:79

Get prompt set details.

Parameters¶

uuid¶

string

Returns¶

Promise\<PromptSetDetail>

Implementation of¶

PromptSetService.getPromptSet

getPromptSetVersionInfo()¶

getPromptSetVersionInfo(uuid): Promise\<PromptSetVersionInfo>

Defined in: src/airs/promptsets.ts:96

Get prompt set version info with stats.

Parameters¶

uuid¶

string

Returns¶

Promise\<PromptSetVersionInfo>

Implementation of¶

PromptSetService.getPromptSetVersionInfo

getPropertyNames()¶

getPropertyNames(): Promise\<PropertyName[]>

Defined in: src/airs/promptsets.ts:147

List property names.

Returns¶

Promise\<PropertyName[]>

Implementation of¶

PromptSetService.getPropertyNames

getPropertyValues()¶

getPropertyValues(name): Promise\<PropertyValue[]>

Defined in: src/airs/promptsets.ts:158

Get values for a property.

Parameters¶

name¶

string

Returns¶

Promise\<PropertyValue[]>

Implementation of¶

PromptSetService.getPropertyValues

listPrompts()¶

listPrompts(setUuid, opts?): Promise\<PromptDetail[]>

Defined in: src/airs/promptsets.ts:115

List prompts in a prompt set.

Parameters¶

setUuid¶

string

opts?¶

limit?¶

number

skip?¶

number

Returns¶

Promise\<PromptDetail[]>

Implementation of¶

PromptSetService.listPrompts

listPromptSets()¶

listPromptSets(): Promise\<object[]>

Defined in: src/airs/promptsets.ts:70

List all custom prompt sets.

Returns¶

Promise\<object[]>

Implementation of¶

PromptSetService.listPromptSets

updatePrompt()¶

updatePrompt(setUuid, promptUuid, request): Promise\<PromptDetail>

Defined in: src/airs/promptsets.ts:130

Update a prompt.

Parameters¶

setUuid¶

string

promptUuid¶

string

request¶

goal?¶

string

prompt?¶

string

Returns¶

Promise\<PromptDetail>

Implementation of¶

PromptSetService.updatePrompt

updatePromptSet()¶

updatePromptSet(uuid, request): Promise\<PromptSetDetail>

Defined in: src/airs/promptsets.ts:84

Update prompt set name/description.

Parameters¶

uuid¶

string

request¶

description?¶

string

name?¶

string

Returns¶

Promise\<PromptSetDetail>

Implementation of¶

PromptSetService.updatePromptSet

uploadPromptsCsv()¶

uploadPromptsCsv(uuid, file): Promise\<{ message: string; status: number; }>

Defined in: src/airs/promptsets.ts:110

Upload CSV file to a prompt set.

Parameters¶

uuid¶

string

file¶

Blob

Returns¶

Promise\<{ message: string; status: number; }>

Implementation of¶

PromptSetService.uploadPromptsCsv