Share via

RedTeam Class

Red team details.

Constructor

RedTeam(*args: Any, **kwargs: Any)

Variables

Name Description
name
str

Identifier of the red team run. Required.
display_name
str

Name of the red-team run.
num_turns
int

Number of simulation rounds.
attack_strategies
list[str or AttackStrategy]

List of attack strategies or nested lists of attack strategies.
simulation_only
bool

Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.
risk_categories
list[str or RiskCategory]

List of risk categories to generate attack objectives for.
application_scenario
str

Application scenario for the red team operation, to generate scenario specific attacks.
tags
dict[str, str]

Red team's tags. Unlike properties, tags are fully mutable.
properties
dict[str, str]

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

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

Target configuration for the red-team run. Required.

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from D.
copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy 

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> Tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on D's values

Attributes

application_scenario

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

application_scenario: str | None

attack_strategies

List of attack strategies or nested lists of attack strategies.

attack_strategies: List[str | _models.AttackStrategy] | None

display_name

Name of the red-team run.

display_name: str | None

name

Identifier of the red team run. Required.

name: str

num_turns

Number of simulation rounds.

num_turns: int | None

properties

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

properties: Dict[str, str] | None

risk_categories

List of risk categories to generate attack objectives for.

risk_categories: List[str | _models.RiskCategory] | None

simulation_only

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

simulation_only: bool | None

status

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

status: str | None

tags

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

tags: Dict[str, str] | None

target

Target configuration for the red-team run. Required.

target: _models.TargetConfig