RedTeam interface

Package:

@azure/ai-projects

Red team details.

Properties

applicationScenario	Application scenario for the red team operation, to generate scenario specific attacks.
attackStrategies	List of attack strategies or nested lists of attack strategies.
displayName	Name of the red-team run.
name	Identifier of the red team run.
numTurns	Number of simulation rounds.
properties	Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
riskCategories	List of risk categories to generate attack objectives for.
simulationOnly	Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.
status	Status of the red-team. It is set by service and is read-only.
tags	Red team's tags. Unlike properties, tags are fully mutable.
target	Target configuration for the red-team run.

Property Details

applicationScenario

Application scenario for the red team operation, to generate scenario specific attacks.

applicationScenario?: string

Property Value

string

attackStrategies

List of attack strategies or nested lists of attack strategies.

attackStrategies?: AttackStrategy[]

Property Value

AttackStrategy[]

displayName

Name of the red-team run.

displayName?: string

Property Value

string

name

Identifier of the red team run.

name: string

Property Value

string

numTurns

Number of simulation rounds.

numTurns?: number

Property Value

number

properties

Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

properties?: Record<string, string>

Property Value

Record<string, string>

riskCategories

List of risk categories to generate attack objectives for.

riskCategories?: RiskCategory[]

Property Value

RiskCategory[]

simulationOnly

Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.

simulationOnly?: boolean

Property Value

boolean

status

Status of the red-team. It is set by service and is read-only.

status?: string

Property Value

string

tags

Red team's tags. Unlike properties, tags are fully mutable.

tags?: Record<string, string>

Property Value

Record<string, string>

target

Target configuration for the red-team run.

target: TargetConfigUnion

Property Value

TargetConfigUnion