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
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
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<MutationResponse>
Defined in: src/airs/promptsets.ts:173
Create a property name.
Parameters
name
string
Returns
Promise<MutationResponse>
Implementation of
PromptSetService.createPropertyName
createPropertyValue()
createPropertyValue(
name,value):Promise<MutationResponse>
Defined in: src/airs/promptsets.ts:184
Create a property value.
Parameters
name
string
value
string
Returns
Promise<MutationResponse>
Implementation of
PromptSetService.createPropertyValue
deletePrompt()
deletePrompt(
setUuid,promptUuid):Promise<void>
Defined in: src/airs/promptsets.ts:163
Delete a prompt.
Parameters
setUuid
string
promptUuid
string
Returns
Promise<void>
Implementation of
downloadTemplate()
downloadTemplate(
uuid):Promise<string>
Defined in: src/airs/promptsets.ts:126
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:145
Get a single prompt.
Parameters
setUuid
string
promptUuid
string
Returns
Promise<PromptDetail>
Implementation of
getPromptSet()
getPromptSet(
uuid):Promise<PromptSetDetail>
Defined in: src/airs/promptsets.ts:79
Get prompt set details.
Parameters
uuid
string
Returns
Promise<PromptSetDetail>
Implementation of
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
getPromptSetWithVersionInfo()
getPromptSetWithVersionInfo(
uuid):Promise<{set:PromptSetDetail;versionInfo?:PromptSetVersionInfo; }>
Defined in: src/airs/promptsets.ts:113
Fetch a prompt set and its version info in one call, degrading gracefully when the
version-info endpoint is unavailable. The upstream /version-info route currently
returns 500 for every prompt set (see prisma-airs-cli#117); without this, a 500 there
would abort the whole prompt-sets get command even though the set itself fetched fine.
The set is always returned; versionInfo is undefined when that lookup fails.
Parameters
uuid
string
Returns
Promise<{ set: PromptSetDetail; versionInfo?: PromptSetVersionInfo; }>
getPropertyNames()
getPropertyNames():
Promise<string[]>
Defined in: src/airs/promptsets.ts:167
List property names.
Returns
Promise<string[]>
Implementation of
PromptSetService.getPropertyNames
getPropertyValues()
getPropertyValues(
name):Promise<PropertyValueList>
Defined in: src/airs/promptsets.ts:178
Get values for a property.
Parameters
name
string
Returns
Promise<PropertyValueList>
Implementation of
PromptSetService.getPropertyValues
listPrompts()
listPrompts(
setUuid,opts?):Promise<PromptDetail[]>
Defined in: src/airs/promptsets.ts:135
List prompts in a prompt set.
Parameters
setUuid
string
opts?
limit?
number
skip?
number
Returns
Promise<PromptDetail[]>
Implementation of
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:150
Update a prompt.
Parameters
setUuid
string
promptUuid
string
request
goal?
string
prompt?
string
Returns
Promise<PromptDetail>
Implementation of
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:130
Upload CSV file to a prompt set.
Parameters
uuid
string
file
Blob
Returns
Promise<{ message: string; status: number; }>