Class OperationsController
- Namespace
- FoundationaLLM.State.API.Controllers
- Assembly
- FoundationaLLM.State.API.dll
Provides methods for managing long-running operations.
[ApiController]
[APIKeyAuthentication]
[Route("instances/{instanceId}/[controller]")]
public class OperationsController : ControllerBase- Inheritance
-
OperationsController
- Inherited Members
- Extension Methods
Constructors
OperationsController(IStateService)
Provides methods for managing long-running operations.
public OperationsController(IStateService stateService)Parameters
stateServiceIStateServiceProvides methods for managing state for long-running operations.
Methods
CreateLongRunningOperation(string, string, JsonElement)
Inserts a long-running operation and creates a log entry.
[HttpPost("{operationId}")]
public Task<IActionResult> CreateLongRunningOperation(string instanceId, string operationId, JsonElement body)Parameters
instanceIdstringThe FoundationaLLM instance ID.
operationIdstringThe ID of the long running operation.
bodyJsonElementThe request body, containing the identity of the user who triggered the long-running operation.
Returns
CreateLongRunningOperationResult(string, string, JsonElement)
Inserts the result of a long-running operation.
[HttpPost("{operationId}/result")]
public Task<IActionResult> CreateLongRunningOperationResult(string instanceId, string operationId, JsonElement operationResult)Parameters
instanceIdstringThe FoundationaLLM instance ID.
operationIdstringThe long-running operation identifier.
operationResultJsonElementThe operation result to insert.
Returns
GetLongRunningOperation(string, string)
Retrieves a long-running operation by its identifier.
[HttpGet("{operationId}")]
public Task<IActionResult> GetLongRunningOperation(string instanceId, string operationId)Parameters
instanceIdstringThe FoundationaLLM instance ID.
operationIdstringThe long-running operation identifier.
Returns
GetLongRunningOperationLogs(string, string)
Retrieves all log entries for a long-running operation.
[HttpGet("{operationId}/logs")]
public Task<IActionResult> GetLongRunningOperationLogs(string instanceId, string operationId)Parameters
instanceIdstringThe FoundationaLLM instance ID.
operationIdstringThe long-running operation identifier.
Returns
GetLongRunningOperationResult(string, string)
Retrieves the result of a long-running operation.
[HttpGet("{operationId}/result")]
public Task<IActionResult> GetLongRunningOperationResult(string instanceId, string operationId)Parameters
instanceIdstringThe FoundationaLLM instance ID.
operationIdstringThe long-running operation identifier.
Returns
GetLongRunningOperations()
Retrieves all long-running operations.
[HttpGet]
public Task<IActionResult> GetLongRunningOperations()Returns
UpdateLongRunningOperation(string, string, LongRunningOperation)
Updates a long-running operation and creates a log entry.
[HttpPut("{operationId}")]
public Task<IActionResult> UpdateLongRunningOperation(string instanceId, string operationId, LongRunningOperation operation)Parameters
instanceIdstringThe FoundationaLLM instance ID.
operationIdstringThe long-running operation identifier.
operationLongRunningOperationThe long-running operation entry to update.