All Implemented Interfaces:

com.hiddenlayer.api.core.Params
```
public final class RedTeamCreateParams
 implements Params
                    
```
BETA This endpoint is not GA or Production ready and is subject to changes at any time. Breaking changes may occur.
Start a new red team client workflow. Auto-triggers planning phase. Client should then poll /next-action.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`RedTeamCreateParams.Builder`	A builder for RedTeamCreateParams.
`public final class`	`RedTeamCreateParams.Body`	Request to start a client-driven red team workflow.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`name()`	Name for this evaluation
`final String`	`targetModel()`	Target model identifier
`final Optional<Integer>`	`attackerMaxGenerationAttempts()`	Maximum generation attempts for attacker
`final Optional<String>`	`attackerModel()`	Model for attacker
`final Optional<String>`	`evaluationReportModel()`	Model for evaluation report
`final Optional<String>`	`executionStrategyType()`	Execution strategy type
`final Optional<String>`	`hlProjectId()`	HiddenLayer project ID
`final Optional<Integer>`	`maxParallelTechniques()`	Maximum parallel techniques
`final Optional<Integer>`	`maxTurns()`	Maximum conversation turns
`final Optional<Integer>`	`nRandomTechniques()`	Number of random techniques to use
`final Optional<List<String>>`	`objectiveIds()`	Objective IDs to evaluate
`final Optional<String>`	`objectiveJudgeModel()`	Model for objective judging
`final Optional<String>`	`promptSetId()`	Prompt set ID for static prompt evaluation
`final Optional<String>`	`refusalJudgeModel()`	Model for refusal judging
`final Optional<Integer>`	`sessionsPerTechnique()`	Number of sessions per technique
`final Optional<String>`	`targetSystemPrompt()`	System prompt for the target
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final JsonField<String>`	`_targetModel()`	Returns the raw JSON value of targetModel.
`final JsonField<Integer>`	`_attackerMaxGenerationAttempts()`	Returns the raw JSON value of attackerMaxGenerationAttempts.
`final JsonField<String>`	`_attackerModel()`	Returns the raw JSON value of attackerModel.
`final JsonField<String>`	`_evaluationReportModel()`	Returns the raw JSON value of evaluationReportModel.
`final JsonField<String>`	`_executionStrategyType()`	Returns the raw JSON value of executionStrategyType.
`final JsonField<String>`	`_hlProjectId()`	Returns the raw JSON value of hlProjectId.
`final JsonField<Integer>`	`_maxParallelTechniques()`	Returns the raw JSON value of maxParallelTechniques.
`final JsonField<Integer>`	`_maxTurns()`	Returns the raw JSON value of maxTurns.
`final JsonField<Integer>`	`_nRandomTechniques()`	Returns the raw JSON value of nRandomTechniques.
`final JsonField<List<String>>`	`_objectiveIds()`	Returns the raw JSON value of objectiveIds.
`final JsonField<String>`	`_objectiveJudgeModel()`	Returns the raw JSON value of objectiveJudgeModel.
`final JsonField<String>`	`_promptSetId()`	Returns the raw JSON value of promptSetId.
`final JsonField<String>`	`_refusalJudgeModel()`	Returns the raw JSON value of refusalJudgeModel.
`final JsonField<Integer>`	`_sessionsPerTechnique()`	Returns the raw JSON value of sessionsPerTechnique.
`final JsonField<String>`	`_targetSystemPrompt()`	Returns the raw JSON value of targetSystemPrompt.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final RedTeamCreateParams.Builder`	`toBuilder()`
`final RedTeamCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RedTeamCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of RedTeamCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - name
```
 final String name()
```
    Name for this evaluation
  - targetModel
```
 final String targetModel()
```
    Target model identifier
  - attackerMaxGenerationAttempts
```
 final Optional<Integer> attackerMaxGenerationAttempts()
```
    Maximum generation attempts for attacker
  - attackerModel
```
 final Optional<String> attackerModel()
```
    Model for attacker
  - evaluationReportModel
```
 final Optional<String> evaluationReportModel()
```
    Model for evaluation report
  - executionStrategyType
```
 final Optional<String> executionStrategyType()
```
    Execution strategy type
  - hlProjectId
```
 final Optional<String> hlProjectId()
```
    HiddenLayer project ID
  - maxParallelTechniques
```
 final Optional<Integer> maxParallelTechniques()
```
    Maximum parallel techniques
  - maxTurns
```
 final Optional<Integer> maxTurns()
```
    Maximum conversation turns
  - nRandomTechniques
```
 final Optional<Integer> nRandomTechniques()
```
    Number of random techniques to use
  - objectiveIds
```
 final Optional<List<String>> objectiveIds()
```
    Objective IDs to evaluate
  - objectiveJudgeModel
```
 final Optional<String> objectiveJudgeModel()
```
    Model for objective judging
  - promptSetId
```
 final Optional<String> promptSetId()
```
    Prompt set ID for static prompt evaluation
  - refusalJudgeModel
```
 final Optional<String> refusalJudgeModel()
```
    Model for refusal judging
  - sessionsPerTechnique
```
 final Optional<Integer> sessionsPerTechnique()
```
    Number of sessions per technique
  - targetSystemPrompt
```
 final Optional<String> targetSystemPrompt()
```
    System prompt for the target
  - _name
```
 final JsonField<String> _name()
```
    Returns the raw JSON value of name.
    Unlike name, this method doesn't throw if the JSON field has an unexpected type.
  - _targetModel
```
 final JsonField<String> _targetModel()
```
    Returns the raw JSON value of targetModel.
    Unlike targetModel, this method doesn't throw if the JSON field has an unexpected type.
  - _attackerMaxGenerationAttempts
```
 final JsonField<Integer> _attackerMaxGenerationAttempts()
```
    Returns the raw JSON value of attackerMaxGenerationAttempts.
    Unlike attackerMaxGenerationAttempts, this method doesn't throw if the JSON field has an unexpected type.
  - _attackerModel
```
 final JsonField<String> _attackerModel()
```
    Returns the raw JSON value of attackerModel.
    Unlike attackerModel, this method doesn't throw if the JSON field has an unexpected type.
  - _evaluationReportModel
```
 final JsonField<String> _evaluationReportModel()
```
    Returns the raw JSON value of evaluationReportModel.
    Unlike evaluationReportModel, this method doesn't throw if the JSON field has an unexpected type.
  - _executionStrategyType
```
 final JsonField<String> _executionStrategyType()
```
    Returns the raw JSON value of executionStrategyType.
    Unlike executionStrategyType, this method doesn't throw if the JSON field has an unexpected type.
  - _hlProjectId
```
 final JsonField<String> _hlProjectId()
```
    Returns the raw JSON value of hlProjectId.
    Unlike hlProjectId, this method doesn't throw if the JSON field has an unexpected type.
  - _maxParallelTechniques
```
 final JsonField<Integer> _maxParallelTechniques()
```
    Returns the raw JSON value of maxParallelTechniques.
    Unlike maxParallelTechniques, this method doesn't throw if the JSON field has an unexpected type.
  - _maxTurns
```
 final JsonField<Integer> _maxTurns()
```
    Returns the raw JSON value of maxTurns.
    Unlike maxTurns, this method doesn't throw if the JSON field has an unexpected type.
  - _nRandomTechniques
```
 final JsonField<Integer> _nRandomTechniques()
```
    Returns the raw JSON value of nRandomTechniques.
    Unlike nRandomTechniques, this method doesn't throw if the JSON field has an unexpected type.
  - _objectiveIds
```
 final JsonField<List<String>> _objectiveIds()
```
    Returns the raw JSON value of objectiveIds.
    Unlike objectiveIds, this method doesn't throw if the JSON field has an unexpected type.
  - _objectiveJudgeModel
```
 final JsonField<String> _objectiveJudgeModel()
```
    Returns the raw JSON value of objectiveJudgeModel.
    Unlike objectiveJudgeModel, this method doesn't throw if the JSON field has an unexpected type.
  - _promptSetId
```
 final JsonField<String> _promptSetId()
```
    Returns the raw JSON value of promptSetId.
    Unlike promptSetId, this method doesn't throw if the JSON field has an unexpected type.
  - _refusalJudgeModel
```
 final JsonField<String> _refusalJudgeModel()
```
    Returns the raw JSON value of refusalJudgeModel.
    Unlike refusalJudgeModel, this method doesn't throw if the JSON field has an unexpected type.
  - _sessionsPerTechnique
```
 final JsonField<Integer> _sessionsPerTechnique()
```
    Returns the raw JSON value of sessionsPerTechnique.
    Unlike sessionsPerTechnique, this method doesn't throw if the JSON field has an unexpected type.
  - _targetSystemPrompt
```
 final JsonField<String> _targetSystemPrompt()
```
    Returns the raw JSON value of targetSystemPrompt.
    Unlike targetSystemPrompt, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final RedTeamCreateParams.Builder toBuilder()
```
  - _body
```
 final RedTeamCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RedTeamCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of RedTeamCreateParams.
    The following fields are required:
    .name() .targetModel()

Class RedTeamCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

name

targetModel

attackerMaxGenerationAttempts

attackerModel

evaluationReportModel

executionStrategyType

hlProjectId

maxParallelTechniques

maxTurns

nRandomTechniques

objectiveIds

objectiveJudgeModel

promptSetId

refusalJudgeModel

sessionsPerTechnique

targetSystemPrompt

_name

_targetModel

_attackerMaxGenerationAttempts

_attackerModel

_evaluationReportModel

_executionStrategyType

_hlProjectId

_maxParallelTechniques

_maxTurns

_nRandomTechniques

_objectiveIds

_objectiveJudgeModel

_promptSetId

_refusalJudgeModel

_sessionsPerTechnique

_targetSystemPrompt

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder