Class: RedTeamCustomAttackReportsClient

Defined in: src/red-team/custom-attack-reports-client.ts:43

Client for Red Team custom attack report operations.

Constructors

Constructor

new RedTeamCustomAttackReportsClient(opts): RedTeamCustomAttackReportsClient;

Defined in: src/red-team/custom-attack-reports-client.ts:48

Parameters

Parameter	Type
opts	RedTeamCustomAttackReportsClientOptions

Returns

RedTeamCustomAttackReportsClient

Methods

getReport()

getReport(jobId): Promise<objectOutputType<{
  total_prompts: ZodNumber;
  total_attacks: ZodNumber;
  total_threats: ZodNumber;
  failed_attacks: ZodNumber;
  score: ZodNumber;
  asr: ZodNumber;
  custom_attack_reports: ZodOptional<ZodArray<ZodObject<{
     prompt_set_id: ZodString;
     prompt_set_name: ZodString;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     total_threats: ZodNumber;
     failed_attacks: ZodNumber;
     threat_rate: ZodNumber;
     property_names: ZodOptional<ZodArray<ZodString, "many">>;
     property_statistics: ZodOptional<ZodArray<ZodObject<{
        property_name: ...;
        values: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     prompt_set_id: ZodString;
     prompt_set_name: ZodString;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     total_threats: ZodNumber;
     failed_attacks: ZodNumber;
     threat_rate: ZodNumber;
     property_names: ZodOptional<ZodArray<ZodString, "many">>;
     property_statistics: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     prompt_set_id: ZodString;
     prompt_set_name: ZodString;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     total_threats: ZodNumber;
     failed_attacks: ZodNumber;
     threat_rate: ZodNumber;
     property_names: ZodOptional<ZodArray<ZodString, "many">>;
     property_statistics: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  property_statistics: ZodOptional<ZodArray<ZodObject<{
     property_name: ZodString;
     values: ZodArray<ZodObject<{
        value: ZodString;
        successful_attack_count: ZodNumber;
        total_attack_count: ZodNumber;
        success_rate: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        value: ...;
        successful_attack_count: ...;
        total_attack_count: ...;
        success_rate: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        value: ...;
        successful_attack_count: ...;
        total_attack_count: ...;
        success_rate: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     property_name: ZodString;
     values: ZodArray<ZodObject<{
        value: ...;
        successful_attack_count: ...;
        total_attack_count: ...;
        success_rate: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     property_name: ZodString;
     values: ZodArray<ZodObject<{
        value: ...;
        successful_attack_count: ...;
        total_attack_count: ...;
        success_rate: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/custom-attack-reports-client.ts:68

Get custom attack report for a scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ total_prompts: ZodNumber; total_attacks: ZodNumber; total_threats: ZodNumber; failed_attacks: ZodNumber; score: ZodNumber; asr: ZodNumber; custom_attack_reports: ZodOptional<ZodArray<ZodObject<{ prompt_set_id: ZodString; prompt_set_name: ZodString; total_prompts: ZodNumber; total_attacks: ZodNumber; total_threats: ZodNumber; failed_attacks: ZodNumber; threat_rate: ZodNumber; property_names: ZodOptional<ZodArray<ZodString, "many">>; property_statistics: ZodOptional<ZodArray<ZodObject<{ property_name: ...; values: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; }, "passthrough", ZodTypeAny, objectOutputType<{ prompt_set_id: ZodString; prompt_set_name: ZodString; total_prompts: ZodNumber; total_attacks: ZodNumber; total_threats: ZodNumber; failed_attacks: ZodNumber; threat_rate: ZodNumber; property_names: ZodOptional<ZodArray<ZodString, "many">>; property_statistics: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; }, ZodTypeAny, "passthrough">, objectInputType<{ prompt_set_id: ZodString; prompt_set_name: ZodString; total_prompts: ZodNumber; total_attacks: ZodNumber; total_threats: ZodNumber; failed_attacks: ZodNumber; threat_rate: ZodNumber; property_names: ZodOptional<ZodArray<ZodString, "many">>; property_statistics: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; }, ZodTypeAny, "passthrough">>, "many">>; property_statistics: ZodOptional<ZodArray<ZodObject<{ property_name: ZodString; values: ZodArray<ZodObject<{ value: ZodString; successful_attack_count: ZodNumber; total_attack_count: ZodNumber; success_rate: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ value: ...; successful_attack_count: ...; total_attack_count: ...; success_rate: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ value: ...; successful_attack_count: ...; total_attack_count: ...; success_rate: ...; }, ZodTypeAny, "passthrough">>, "many">; }, "passthrough", ZodTypeAny, objectOutputType<{ property_name: ZodString; values: ZodArray<ZodObject<{ value: ...; successful_attack_count: ...; total_attack_count: ...; success_rate: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; }, ZodTypeAny, "passthrough">, objectInputType<{ property_name: ZodString; values: ZodArray<ZodObject<{ value: ...; successful_attack_count: ...; total_attack_count: ...; success_rate: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

The custom attack report response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const report = await rt.customAttackReports.getReport('550e8400-e29b-41d4-a716-446655440000');
// report =>
// { job_id: '550e8400-...', total_prompts: 100, total_attacks: 80, total_threats: 12, score: 0.85, asr: 0.15 }

---

getPromptSets()

getPromptSets(jobId): Promise<objectOutputType<{
  prompt_sets: ZodArray<ZodObject<{
     prompt_set_id: ZodString;
     prompt_set_name: ZodString;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     total_threats: ZodNumber;
     failed_attacks: ZodNumber;
     threat_rate: ZodNumber;
     property_names: ZodOptional<ZodArray<ZodString, "many">>;
     property_statistics: ZodOptional<ZodArray<ZodObject<{
        property_name: ZodString;
        values: ZodArray<..., ...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        property_name: ...;
        values: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        property_name: ...;
        values: ...;
     }, ZodTypeAny, "passthrough">>, "many">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     prompt_set_id: ZodString;
     prompt_set_name: ZodString;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     total_threats: ZodNumber;
     failed_attacks: ZodNumber;
     threat_rate: ZodNumber;
     property_names: ZodOptional<ZodArray<ZodString, "many">>;
     property_statistics: ZodOptional<ZodArray<ZodObject<{
        property_name: ...;
        values: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     prompt_set_id: ZodString;
     prompt_set_name: ZodString;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     total_threats: ZodNumber;
     failed_attacks: ZodNumber;
     threat_rate: ZodNumber;
     property_names: ZodOptional<ZodArray<ZodString, "many">>;
     property_statistics: ZodOptional<ZodArray<ZodObject<{
        property_name: ...;
        values: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
  }, ZodTypeAny, "passthrough">>, "many">;
  total_prompt_sets: ZodNumber;
  applied_filters: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/custom-attack-reports-client.ts:94

Get prompt sets for a custom attack scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ prompt_sets: ZodArray<ZodObject<{ prompt_set_id: ZodString; prompt_set_name: ZodString; total_prompts: ZodNumber; total_attacks: ZodNumber; total_threats: ZodNumber; failed_attacks: ZodNumber; threat_rate: ZodNumber; property_names: ZodOptional<ZodArray<ZodString, "many">>; property_statistics: ZodOptional<ZodArray<ZodObject<{ property_name: ZodString; values: ZodArray<..., ...>; }, "passthrough", ZodTypeAny, objectOutputType<{ property_name: ...; values: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ property_name: ...; values: ...; }, ZodTypeAny, "passthrough">>, "many">>; }, "passthrough", ZodTypeAny, objectOutputType<{ prompt_set_id: ZodString; prompt_set_name: ZodString; total_prompts: ZodNumber; total_attacks: ZodNumber; total_threats: ZodNumber; failed_attacks: ZodNumber; threat_rate: ZodNumber; property_names: ZodOptional<ZodArray<ZodString, "many">>; property_statistics: ZodOptional<ZodArray<ZodObject<{ property_name: ...; values: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; }, ZodTypeAny, "passthrough">, objectInputType<{ prompt_set_id: ZodString; prompt_set_name: ZodString; total_prompts: ZodNumber; total_attacks: ZodNumber; total_threats: ZodNumber; failed_attacks: ZodNumber; threat_rate: ZodNumber; property_names: ZodOptional<ZodArray<ZodString, "many">>; property_statistics: ZodOptional<ZodArray<ZodObject<{ property_name: ...; values: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; }, ZodTypeAny, "passthrough">>, "many">; total_prompt_sets: ZodNumber; applied_filters: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; }, ZodTypeAny, "passthrough">>

The prompt sets report response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const sets = await rt.customAttackReports.getPromptSets('550e8400-e29b-41d4-a716-446655440000');
// sets =>
// { total_prompt_sets: 1, prompt_sets: [{ uuid: '550e8400-...', name: 'jailbreaks' }] }

---

getPromptsBySet()

getPromptsBySet(
   jobId, 
   promptSetId, 
   opts?): Promise<objectOutputType<{
  prompt_id: ZodString;
  prompt_text: ZodString;
  goal: ZodOptional<ZodNullable<ZodString>>;
  user_defined_goal: ZodOptional<ZodBoolean>;
  properties: ZodOptional<ZodArray<ZodObject<{
     name: ZodString;
     value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     name: ZodString;
     value: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     name: ZodString;
     value: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">>;
  attack_id: ZodOptional<ZodNullable<ZodString>>;
  threat: ZodOptional<ZodNullable<ZodBoolean>>;
  attack_outputs: ZodOptional<ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     custom_attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     custom_attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<...>>;
     marked_safe: ZodOptional<ZodNullable<...>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     custom_attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<...>>;
     marked_safe: ZodOptional<ZodNullable<...>>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  asr: ZodOptional<ZodNullable<ZodNumber>>;
  prompt_set_id: ZodOptional<ZodNullable<ZodString>>;
  prompt_set_name: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">[]>;

Defined in: src/red-team/custom-attack-reports-client.ts:126

Get prompts for a specific prompt set in a scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
promptSetId	string	The prompt set UUID.
opts?	PromptsBySetListOptions	Optional pagination, search, and filter options.

Returns

Promise<objectOutputType<{ prompt_id: ZodString; prompt_text: ZodString; goal: ZodOptional<ZodNullable<ZodString>>; user_defined_goal: ZodOptional<ZodBoolean>; properties: ZodOptional<ZodArray<ZodObject<{ name: ZodString; value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ name: ZodString; value: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ name: ZodString; value: ZodString; }, ZodTypeAny, "passthrough">>, "many">>; attack_id: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodNullable<ZodBoolean>>; attack_outputs: ZodOptional<ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; custom_attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; custom_attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<...>>; marked_safe: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; custom_attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<...>>; marked_safe: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">>, "many">>; asr: ZodOptional<ZodNullable<ZodNumber>>; prompt_set_id: ZodOptional<ZodNullable<ZodString>>; prompt_set_name: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">[]>

The list of prompt detail responses.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const prompts = await rt.customAttackReports.getPromptsBySet(
  '550e8400-e29b-41d4-a716-446655440000',
  '550e8400-e29b-41d4-a716-446655440000',
  { is_threat: true },
);
// prompts =>
// [{ prompt_id: '550e8400-...', prompt_text: 'Inject system prompt' }]

---

getPromptDetail()

getPromptDetail(jobId, promptId): Promise<objectOutputType<{
  prompt_id: ZodString;
  prompt_text: ZodString;
  goal: ZodOptional<ZodNullable<ZodString>>;
  user_defined_goal: ZodOptional<ZodBoolean>;
  properties: ZodOptional<ZodArray<ZodObject<{
     name: ZodString;
     value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     name: ZodString;
     value: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     name: ZodString;
     value: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">>;
  attack_id: ZodOptional<ZodNullable<ZodString>>;
  threat: ZodOptional<ZodNullable<ZodBoolean>>;
  attack_outputs: ZodOptional<ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     custom_attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     custom_attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     custom_attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  asr: ZodOptional<ZodNullable<ZodNumber>>;
  prompt_set_id: ZodOptional<ZodNullable<ZodString>>;
  prompt_set_name: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/custom-attack-reports-client.ts:166

Get details for a specific prompt.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
promptId	string	The prompt UUID.

Returns

Promise<objectOutputType<{ prompt_id: ZodString; prompt_text: ZodString; goal: ZodOptional<ZodNullable<ZodString>>; user_defined_goal: ZodOptional<ZodBoolean>; properties: ZodOptional<ZodArray<ZodObject<{ name: ZodString; value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ name: ZodString; value: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ name: ZodString; value: ZodString; }, ZodTypeAny, "passthrough">>, "many">>; attack_id: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodNullable<ZodBoolean>>; attack_outputs: ZodOptional<ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; custom_attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; custom_attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; custom_attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; }, ZodTypeAny, "passthrough">>, "many">>; asr: ZodOptional<ZodNullable<ZodNumber>>; prompt_set_id: ZodOptional<ZodNullable<ZodString>>; prompt_set_name: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>

The prompt detail response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const prompt = await rt.customAttackReports.getPromptDetail(
  '550e8400-e29b-41d4-a716-446655440000',
  '550e8400-e29b-41d4-a716-446655440000',
);
// prompt =>
// { prompt_id: '550e8400-...', prompt_text: 'Inject system prompt' }

---

listCustomAttacks()

listCustomAttacks(jobId, opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  data: ZodArray<ZodUnknown, "many">;
  total_attacks: ZodNumber;
  total_threats: ZodNumber;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/custom-attack-reports-client.ts:198

List custom attacks for a scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
opts?	CustomAttacksReportListOptions	Optional pagination, search, and filter options.

Returns

Promise<objectOutputType<{ pagination: ZodObject<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>; data: ZodArray<ZodUnknown, "many">; total_attacks: ZodNumber; total_threats: ZodNumber; }, ZodTypeAny, "passthrough">>

The paginated list of custom attacks.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const attacks = await rt.customAttackReports.listCustomAttacks(
  '550e8400-e29b-41d4-a716-446655440000',
  { threat: true, limit: 20 },
);
// attacks =>
// { pagination: { total_items: 3 }, data: [...], total_attacks: 3, total_threats: 1 }

---

getAttackOutputs()

getAttackOutputs(jobId, attackId): Promise<objectOutputType<{
  uuid: ZodString;
  tsg_id: ZodString;
  custom_attack_id: ZodString;
  job_id: ZodString;
  target_id: ZodString;
  output: ZodString;
  threat: ZodOptional<ZodNullable<ZodBoolean>>;
  marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
}, ZodTypeAny, "passthrough">[]>;

Defined in: src/red-team/custom-attack-reports-client.ts:237

Get attack outputs for a custom attack.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
attackId	string	The attack UUID.

Returns

Promise<objectOutputType<{ uuid: ZodString; tsg_id: ZodString; custom_attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; }, ZodTypeAny, "passthrough">[]>

The list of attack outputs.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const outputs = await rt.customAttackReports.getAttackOutputs(
  '550e8400-e29b-41d4-a716-446655440000',
  '550e8400-e29b-41d4-a716-446655440000',
);
// outputs =>
// [{ uuid: '550e8400-...', custom_attack_id: '550e8400-...', target_id: '550e8400-...', output: '...' }]

---

getPropertyStats()

getPropertyStats(jobId): Promise<objectOutputType<{
  property_name: ZodString;
  values: ZodArray<ZodObject<{
     value: ZodString;
     successful_attack_count: ZodNumber;
     total_attack_count: ZodNumber;
     success_rate: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     value: ZodString;
     successful_attack_count: ZodNumber;
     total_attack_count: ZodNumber;
     success_rate: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     value: ZodString;
     successful_attack_count: ZodNumber;
     total_attack_count: ZodNumber;
     success_rate: ZodNumber;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">[]>;

Defined in: src/red-team/custom-attack-reports-client.ts:265

Get property statistics for a custom attack scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ property_name: ZodString; values: ZodArray<ZodObject<{ value: ZodString; successful_attack_count: ZodNumber; total_attack_count: ZodNumber; success_rate: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ value: ZodString; successful_attack_count: ZodNumber; total_attack_count: ZodNumber; success_rate: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ value: ZodString; successful_attack_count: ZodNumber; total_attack_count: ZodNumber; success_rate: ZodNumber; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">[]>

The list of property statistics.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const stats = await rt.customAttackReports.getPropertyStats('550e8400-e29b-41d4-a716-446655440000');
// stats =>
// [{ property_name: 'category', values: [{ value: 'jailbreak', count: 12 }] }]