RedTeam Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Red team details.
public class RedTeam : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RedTeam>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.RedTeam>type RedTeam = class
interface IJsonModel<RedTeam>
interface IPersistableModel<RedTeam>Public Class RedTeam
Implements IJsonModel(Of RedTeam), IPersistableModel(Of RedTeam)- Inheritance
-
RedTeam
- Implements
Constructors
| RedTeam(TargetConfig) |
Initializes a new instance of RedTeam. |
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. Please note TargetConfig is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureOpenAIModelConfiguration. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
| IJsonModel<RedTeam>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<RedTeam>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<RedTeam>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<RedTeam>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<RedTeam>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
