Documentation

Request extends Message
in package

Generated from protobuf message <code>livekit.SimulationRun.Create.Request</code>

Table of Contents

Properties

$agent_name  : mixed
Generated from protobuf field <code>string agent_name = 2;</code>
$concurrency  : mixed
Maximum simulate jobs running in parallel for this run. Clamped to the project's concurrency quota; 0/unset uses the server default.
$mode  : mixed
Conversation mode for every job in this run; unspecified = TEXT.
$num_simulations  : mixed
Generated from protobuf field <code>int32 num_simulations = 4;</code>
$project_id  : mixed
Generated from protobuf field <code>string project_id = 1;</code>
$region  : mixed
Generated from protobuf field <code>string region = 6;</code>
$scenario_group  : mixed
When set, run these scenarios (loaded from a scenarios.yaml).

Methods

__construct()  : mixed
Constructor.
clearConcurrency()  : mixed
clearScenarioGroup()  : mixed
getAgentName()  : string
Generated from protobuf field <code>string agent_name = 2;</code>
getConcurrency()  : int
Maximum simulate jobs running in parallel for this run. Clamped to the project's concurrency quota; 0/unset uses the server default.
getMode()  : int
Conversation mode for every job in this run; unspecified = TEXT.
getNumSimulations()  : int
Generated from protobuf field <code>int32 num_simulations = 4;</code>
getProjectId()  : string
Generated from protobuf field <code>string project_id = 1;</code>
getRegion()  : string
Generated from protobuf field <code>string region = 6;</code>
getScenarioGroup()  : ScenarioGroup|null
When set, run these scenarios (loaded from a scenarios.yaml).
hasConcurrency()  : mixed
hasScenarioGroup()  : mixed
setAgentName()  : $this
Generated from protobuf field <code>string agent_name = 2;</code>
setConcurrency()  : $this
Maximum simulate jobs running in parallel for this run. Clamped to the project's concurrency quota; 0/unset uses the server default.
setMode()  : $this
Conversation mode for every job in this run; unspecified = TEXT.
setNumSimulations()  : $this
Generated from protobuf field <code>int32 num_simulations = 4;</code>
setProjectId()  : $this
Generated from protobuf field <code>string project_id = 1;</code>
setRegion()  : $this
Generated from protobuf field <code>string region = 6;</code>
setScenarioGroup()  : $this
When set, run these scenarios (loaded from a scenarios.yaml).

Properties

$agent_name

Generated from protobuf field <code>string agent_name = 2;</code>

protected mixed $agent_name = ''

$concurrency

Maximum simulate jobs running in parallel for this run. Clamped to the project's concurrency quota; 0/unset uses the server default.

protected mixed $concurrency = null

Generated from protobuf field optional int32 concurrency = 8;

$mode

Conversation mode for every job in this run; unspecified = TEXT.

protected mixed $mode = 0

Generated from protobuf field .livekit.SimulationMode mode = 9;

$num_simulations

Generated from protobuf field <code>int32 num_simulations = 4;</code>

protected mixed $num_simulations = 0

$project_id

Generated from protobuf field <code>string project_id = 1;</code>

protected mixed $project_id = ''

$region

Generated from protobuf field <code>string region = 6;</code>

protected mixed $region = ''

$scenario_group

When set, run these scenarios (loaded from a scenarios.yaml).

protected mixed $scenario_group = null

When unset, generate num_simulations scenarios from the uploaded agent source.

Generated from protobuf field optional .livekit.ScenarioGroup scenario_group = 7;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type string $project_id
@type string $agent_name
@type int $num_simulations
@type string $region
@type \Livekit\ScenarioGroup $scenario_group
      When set, run these scenarios (loaded from a scenarios.yaml).
      When unset, generate num_simulations scenarios from the uploaded agent source.
@type int $concurrency
      Maximum simulate jobs running in parallel for this run. Clamped to the
      project's concurrency quota; 0/unset uses the server default.
@type int $mode
      Conversation mode for every job in this run; unspecified = TEXT.

}

clearConcurrency()

public clearConcurrency() : mixed

clearScenarioGroup()

public clearScenarioGroup() : mixed

getAgentName()

Generated from protobuf field <code>string agent_name = 2;</code>

public getAgentName() : string
Return values
string

getConcurrency()

Maximum simulate jobs running in parallel for this run. Clamped to the project's concurrency quota; 0/unset uses the server default.

public getConcurrency() : int

Generated from protobuf field optional int32 concurrency = 8;

Return values
int

getMode()

Conversation mode for every job in this run; unspecified = TEXT.

public getMode() : int

Generated from protobuf field .livekit.SimulationMode mode = 9;

Return values
int

getNumSimulations()

Generated from protobuf field <code>int32 num_simulations = 4;</code>

public getNumSimulations() : int
Return values
int

getProjectId()

Generated from protobuf field <code>string project_id = 1;</code>

public getProjectId() : string
Return values
string

getRegion()

Generated from protobuf field <code>string region = 6;</code>

public getRegion() : string
Return values
string

getScenarioGroup()

When set, run these scenarios (loaded from a scenarios.yaml).

public getScenarioGroup() : ScenarioGroup|null

When unset, generate num_simulations scenarios from the uploaded agent source.

Generated from protobuf field optional .livekit.ScenarioGroup scenario_group = 7;

Return values
ScenarioGroup|null

hasConcurrency()

public hasConcurrency() : mixed

hasScenarioGroup()

public hasScenarioGroup() : mixed

setAgentName()

Generated from protobuf field <code>string agent_name = 2;</code>

public setAgentName(string $var) : $this
Parameters
$var : string
Return values
$this

setConcurrency()

Maximum simulate jobs running in parallel for this run. Clamped to the project's concurrency quota; 0/unset uses the server default.

public setConcurrency(int $var) : $this

Generated from protobuf field optional int32 concurrency = 8;

Parameters
$var : int
Return values
$this

setMode()

Conversation mode for every job in this run; unspecified = TEXT.

public setMode(int $var) : $this

Generated from protobuf field .livekit.SimulationMode mode = 9;

Parameters
$var : int
Return values
$this

setNumSimulations()

Generated from protobuf field <code>int32 num_simulations = 4;</code>

public setNumSimulations(int $var) : $this
Parameters
$var : int
Return values
$this

setProjectId()

Generated from protobuf field <code>string project_id = 1;</code>

public setProjectId(string $var) : $this
Parameters
$var : string
Return values
$this

setRegion()

Generated from protobuf field <code>string region = 6;</code>

public setRegion(string $var) : $this
Parameters
$var : string
Return values
$this

setScenarioGroup()

When set, run these scenarios (loaded from a scenarios.yaml).

public setScenarioGroup(ScenarioGroup $var) : $this

When unset, generate num_simulations scenarios from the uploaded agent source.

Generated from protobuf field optional .livekit.ScenarioGroup scenario_group = 7;

Parameters
$var : ScenarioGroup
Return values
$this
On this page

Search results