Interface ILiveKitAgentSimulationService

Namespace

LiveKit.Services

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

Service for managing agent simulations, scenarios, and scenario groups.

Provides methods for creating and managing simulation runs, scenarios, and scenario groups to test and validate AI agent behavior.

public interface ILiveKitAgentSimulationService

Methods

CancelSimulationRunAsync(Request, CancellationToken)

Cancels a simulation run.

Task<SimulationRun.Types.Cancel.Types.Response> CancelSimulationRunAsync(SimulationRun.Types.Cancel.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request SimulationRun.Types.Cancel.Types.Request

cancellationToken CancellationToken

Returns

Task<SimulationRun.Types.Cancel.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

ConfirmSimulationSourceUploadAsync(Request, CancellationToken)

Confirms that the simulation source has been uploaded.

Task<SimulationRun.Types.ConfirmSourceUpload.Types.Response> ConfirmSimulationSourceUploadAsync(SimulationRun.Types.ConfirmSourceUpload.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request SimulationRun.Types.ConfirmSourceUpload.Types.Request

cancellationToken CancellationToken

Returns

Task<SimulationRun.Types.ConfirmSourceUpload.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

CreateScenarioAsync(Request, CancellationToken)

Creates a new scenario.

Task<Scenario.Types.Create.Types.Response> CreateScenarioAsync(Scenario.Types.Create.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request Scenario.Types.Create.Types.Request

cancellationToken CancellationToken

Returns

Task<Scenario.Types.Create.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

CreateScenarioFromSessionAsync(Request, CancellationToken)

Creates a scenario from an existing session.

Task<Scenario.Types.CreateFromSession.Types.Response> CreateScenarioFromSessionAsync(Scenario.Types.CreateFromSession.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request Scenario.Types.CreateFromSession.Types.Request

cancellationToken CancellationToken

Returns

Task<Scenario.Types.CreateFromSession.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

CreateScenarioGroupAsync(Request, CancellationToken)

Creates a new scenario group.

Task<ScenarioGroup.Types.Create.Types.Response> CreateScenarioGroupAsync(ScenarioGroup.Types.Create.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request ScenarioGroup.Types.Create.Types.Request

cancellationToken CancellationToken

Returns

Task<ScenarioGroup.Types.Create.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

CreateSimulationRunAsync(Request, CancellationToken)

Creates a new simulation run.

Task<SimulationRun.Types.Create.Types.Response> CreateSimulationRunAsync(SimulationRun.Types.Create.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request SimulationRun.Types.Create.Types.Request

cancellationToken CancellationToken

Returns

Task<SimulationRun.Types.Create.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

DeleteScenarioAsync(Request, CancellationToken)

Deletes a scenario.

Task<Scenario.Types.Delete.Types.Response> DeleteScenarioAsync(Scenario.Types.Delete.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request Scenario.Types.Delete.Types.Request

cancellationToken CancellationToken

Returns

Task<Scenario.Types.Delete.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

DeleteScenarioGroupAsync(Request, CancellationToken)

Deletes a scenario group.

Task<ScenarioGroup.Types.Delete.Types.Response> DeleteScenarioGroupAsync(ScenarioGroup.Types.Delete.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request ScenarioGroup.Types.Delete.Types.Request

cancellationToken CancellationToken

Returns

Task<ScenarioGroup.Types.Delete.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

GetSimulationRunAsync(Request, CancellationToken)

Gets details of a simulation run.

Task<SimulationRun.Types.Get.Types.Response> GetSimulationRunAsync(SimulationRun.Types.Get.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request SimulationRun.Types.Get.Types.Request

cancellationToken CancellationToken

Returns

Task<SimulationRun.Types.Get.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

ListScenarioGroupsAsync(Request, CancellationToken)

Lists scenario groups.

Task<ScenarioGroup.Types.List.Types.Response> ListScenarioGroupsAsync(ScenarioGroup.Types.List.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request ScenarioGroup.Types.List.Types.Request

cancellationToken CancellationToken

Returns

Task<ScenarioGroup.Types.List.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

ListScenariosAsync(Request, CancellationToken)

Lists scenarios.

Task<Scenario.Types.List.Types.Response> ListScenariosAsync(Scenario.Types.List.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request Scenario.Types.List.Types.Request

cancellationToken CancellationToken

Returns

Task<Scenario.Types.List.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

ListSimulationRunsAsync(Request, CancellationToken)

Lists simulation runs.

Task<SimulationRun.Types.List.Types.Response> ListSimulationRunsAsync(SimulationRun.Types.List.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request SimulationRun.Types.List.Types.Request

cancellationToken CancellationToken

Returns

Task<SimulationRun.Types.List.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

UpdateScenarioAsync(Request, CancellationToken)

Updates a scenario.

Task<Scenario.Types.Update.Types.Response> UpdateScenarioAsync(Scenario.Types.Update.Types.Request request, CancellationToken cancellationToken = default)

Parameters

request Scenario.Types.Update.Types.Request

cancellationToken CancellationToken

Returns

Task<Scenario.Types.Update.Types.Response>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.