Skip to main content

Interface: PromptSetService

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

Contract for custom prompt set operations in AI Red Team.

Methods​

addPrompt()​

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

Defined in: src/airs/types.ts:88

Add a prompt to an existing prompt set.

Parameters​

promptSetId​

string

prompt​

string

goal?​

string

Returns​

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

archivePromptSet()​

archivePromptSet(uuid, archive): Promise<void>

Defined in: src/airs/types.ts:103

Archive or unarchive a prompt set.

Parameters​

uuid​

string

archive​

boolean

Returns​

Promise<void>

createPromptSet()​

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

Defined in: src/airs/types.ts:86

Create a new custom prompt set.

Parameters​

name​

string

description?​

string

Returns​

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

createPropertyName()​

createPropertyName(name): Promise<MutationResponse>

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

Create a property name.

Parameters​

name​

string

Returns​

Promise<MutationResponse>

createPropertyValue()​

createPropertyValue(name, value): Promise<MutationResponse>

Defined in: src/airs/types.ts:129

Create a property value.

Parameters​

name​

string

value​

string

Returns​

Promise<MutationResponse>

deletePrompt()​

deletePrompt(setUuid, promptUuid): Promise<void>

Defined in: src/airs/types.ts:121

Delete a prompt.

Parameters​

setUuid​

string

promptUuid​

string

Returns​

Promise<void>

downloadTemplate()​

downloadTemplate(uuid): Promise<string>

Defined in: src/airs/types.ts:107

Download CSV template for a prompt set.

Parameters​

uuid​

string

Returns​

Promise<string>

getPrompt()​

getPrompt(setUuid, promptUuid): Promise<PromptDetail>

Defined in: src/airs/types.ts:113

Get a single prompt.

Parameters​

setUuid​

string

promptUuid​

string

Returns​

Promise<PromptDetail>

getPromptSet()​

getPromptSet(uuid): Promise<PromptSetDetail>

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

Get prompt set details.

Parameters​

uuid​

string

Returns​

Promise<PromptSetDetail>

getPromptSetVersionInfo()​

getPromptSetVersionInfo(uuid): Promise<PromptSetVersionInfo>

Defined in: src/airs/types.ts:105

Get prompt set version info with stats.

Parameters​

uuid​

string

Returns​

Promise<PromptSetVersionInfo>

getPropertyNames()​

getPropertyNames(): Promise<string[]>

Defined in: src/airs/types.ts:123

List property names.

Returns​

Promise<string[]>

getPropertyValues()​

getPropertyValues(name): Promise<PropertyValueList>

Defined in: src/airs/types.ts:127

Get values for a property.

Parameters​

name​

string

Returns​

Promise<PropertyValueList>

listPrompts()​

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

Defined in: src/airs/types.ts:111

List prompts in a prompt set.

Parameters​

setUuid​

string

opts?​
limit?​

number

skip?​

number

Returns​

Promise<PromptDetail[]>

listPromptSets()​

listPromptSets(): Promise<object[]>

Defined in: src/airs/types.ts:94

List all custom prompt sets.

Returns​

Promise<object[]>

updatePrompt()​

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

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

Update a prompt.

Parameters​

setUuid​

string

promptUuid​

string

request​
goal?​

string

prompt?​

string

Returns​

Promise<PromptDetail>

updatePromptSet()​

updatePromptSet(uuid, request): Promise<PromptSetDetail>

Defined in: src/airs/types.ts:98

Update prompt set name/description.

Parameters​

uuid​

string

request​
description?​

string

name?​

string

Returns​

Promise<PromptSetDetail>

uploadPromptsCsv()​

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

Defined in: src/airs/types.ts:109

Upload CSV file to a prompt set.

Parameters​

uuid​

string

file​

Blob

Returns​

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