Documentation

Scenario extends Message
in package

A single scenario, mirroring one entry in a scenarios.yaml file. Scenarios are no longer stored server-side; the yaml file is the source of truth.

Generated from protobuf message livekit.Scenario

Table of Contents

Properties

$agent_expectations  : mixed
Generated from protobuf field <code>string agent_expectations = 3;</code>
$instructions  : mixed
Generated from protobuf field <code>string instructions = 2;</code>
$label  : mixed
Generated from protobuf field <code>string label = 1;</code>
$userdata  : mixed
Arbitrary JSON-encoded object, surfaced to the agent under test as SimulationContext userdata (e.g. inputs and benchmark target state).
$tags  : mixed
Set as participant attributes on the simulation participant's access token.

Methods

__construct()  : mixed
Constructor.
getAgentExpectations()  : string
Generated from protobuf field <code>string agent_expectations = 3;</code>
getInstructions()  : string
Generated from protobuf field <code>string instructions = 2;</code>
getLabel()  : string
Generated from protobuf field <code>string label = 1;</code>
getTags()  : MapField
Set as participant attributes on the simulation participant's access token.
getUserdata()  : string
Arbitrary JSON-encoded object, surfaced to the agent under test as SimulationContext userdata (e.g. inputs and benchmark target state).
setAgentExpectations()  : $this
Generated from protobuf field <code>string agent_expectations = 3;</code>
setInstructions()  : $this
Generated from protobuf field <code>string instructions = 2;</code>
setLabel()  : $this
Generated from protobuf field <code>string label = 1;</code>
setTags()  : $this
Set as participant attributes on the simulation participant's access token.
setUserdata()  : $this
Arbitrary JSON-encoded object, surfaced to the agent under test as SimulationContext userdata (e.g. inputs and benchmark target state).

Properties

$agent_expectations

Generated from protobuf field <code>string agent_expectations = 3;</code>

protected mixed $agent_expectations = ''

$instructions

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

protected mixed $instructions = ''

$label

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

protected mixed $label = ''

$userdata

Arbitrary JSON-encoded object, surfaced to the agent under test as SimulationContext userdata (e.g. inputs and benchmark target state).

protected mixed $userdata = ''

Generated from protobuf field string userdata = 5;

$tags

Set as participant attributes on the simulation participant's access token.

private mixed $tags

Generated from protobuf field map<string, string> tags = 4;

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 $label
@type string $instructions
@type string $agent_expectations
@type array|\Google\Protobuf\Internal\MapField $tags
      Set as participant attributes on the simulation participant's access token.
@type string $userdata
      Arbitrary JSON-encoded object, surfaced to the agent under test as
      SimulationContext userdata (e.g. inputs and benchmark target state).

}

getAgentExpectations()

Generated from protobuf field <code>string agent_expectations = 3;</code>

public getAgentExpectations() : string
Return values
string

getInstructions()

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

public getInstructions() : string
Return values
string

getLabel()

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

public getLabel() : string
Return values
string

getTags()

Set as participant attributes on the simulation participant's access token.

public getTags() : MapField

Generated from protobuf field map<string, string> tags = 4;

Return values
MapField

getUserdata()

Arbitrary JSON-encoded object, surfaced to the agent under test as SimulationContext userdata (e.g. inputs and benchmark target state).

public getUserdata() : string

Generated from protobuf field string userdata = 5;

Return values
string

setAgentExpectations()

Generated from protobuf field <code>string agent_expectations = 3;</code>

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

setInstructions()

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

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

setLabel()

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

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

setTags()

Set as participant attributes on the simulation participant's access token.

public setTags(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> tags = 4;

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setUserdata()

Arbitrary JSON-encoded object, surfaced to the agent under test as SimulationContext userdata (e.g. inputs and benchmark target state).

public setUserdata(string $var) : $this

Generated from protobuf field string userdata = 5;

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

Search results