Class CompletionsController

Namespace

FoundationaLLM.Orchestration.API.Controllers

Assembly

FoundationaLLM.Orchestration.API.dll

CompletionsController class

[ApiController]
[APIKeyAuthentication]
[Route("instances/{instanceId}")]
public class CompletionsController : ControllerBase

Inheritance

object

ControllerBase

CompletionsController

Inherited Members

ControllerBase.StatusCode(int)

ControllerBase.StatusCode(int, object)

ControllerBase.Content(string)

ControllerBase.Content(string, string)

ControllerBase.Content(string, string, Encoding)

ControllerBase.Content(string, MediaTypeHeaderValue)

ControllerBase.NoContent()

ControllerBase.Ok()

ControllerBase.Ok(object)

ControllerBase.Redirect(string)

ControllerBase.RedirectPermanent(string)

ControllerBase.RedirectPreserveMethod(string)

ControllerBase.RedirectPermanentPreserveMethod(string)

ControllerBase.LocalRedirect(string)

ControllerBase.LocalRedirectPermanent(string)

ControllerBase.LocalRedirectPreserveMethod(string)

ControllerBase.LocalRedirectPermanentPreserveMethod(string)

ControllerBase.RedirectToAction()

ControllerBase.RedirectToAction(string)

ControllerBase.RedirectToAction(string, object)

ControllerBase.RedirectToAction(string, string)

ControllerBase.RedirectToAction(string, string, object)

ControllerBase.RedirectToAction(string, string, string)

ControllerBase.RedirectToAction(string, string, object, string)

ControllerBase.RedirectToActionPreserveMethod(string, string, object, string)

ControllerBase.RedirectToActionPermanent(string)

ControllerBase.RedirectToActionPermanent(string, object)

ControllerBase.RedirectToActionPermanent(string, string)

ControllerBase.RedirectToActionPermanent(string, string, string)

ControllerBase.RedirectToActionPermanent(string, string, object)

ControllerBase.RedirectToActionPermanent(string, string, object, string)

ControllerBase.RedirectToActionPermanentPreserveMethod(string, string, object, string)

ControllerBase.RedirectToRoute(string)

ControllerBase.RedirectToRoute(object)

ControllerBase.RedirectToRoute(string, object)

ControllerBase.RedirectToRoute(string, string)

ControllerBase.RedirectToRoute(string, object, string)

ControllerBase.RedirectToRoutePreserveMethod(string, object, string)

ControllerBase.RedirectToRoutePermanent(string)

ControllerBase.RedirectToRoutePermanent(object)

ControllerBase.RedirectToRoutePermanent(string, object)

ControllerBase.RedirectToRoutePermanent(string, string)

ControllerBase.RedirectToRoutePermanent(string, object, string)

ControllerBase.RedirectToRoutePermanentPreserveMethod(string, object, string)

ControllerBase.RedirectToPage(string)

ControllerBase.RedirectToPage(string, object)

ControllerBase.RedirectToPage(string, string)

ControllerBase.RedirectToPage(string, string, object)

ControllerBase.RedirectToPage(string, string, string)

ControllerBase.RedirectToPage(string, string, object, string)

ControllerBase.RedirectToPagePermanent(string)

ControllerBase.RedirectToPagePermanent(string, object)

ControllerBase.RedirectToPagePermanent(string, string)

ControllerBase.RedirectToPagePermanent(string, string, string)

ControllerBase.RedirectToPagePermanent(string, string, object, string)

ControllerBase.RedirectToPagePreserveMethod(string, string, object, string)

ControllerBase.RedirectToPagePermanentPreserveMethod(string, string, object, string)

ControllerBase.File(byte[], string)

ControllerBase.File(byte[], string, bool)

ControllerBase.File(byte[], string, string)

ControllerBase.File(byte[], string, string, bool)

ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(Stream, string)

ControllerBase.File(Stream, string, bool)

ControllerBase.File(Stream, string, string)

ControllerBase.File(Stream, string, string, bool)

ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(string, string)

ControllerBase.File(string, string, bool)

ControllerBase.File(string, string, string)

ControllerBase.File(string, string, string, bool)

ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.PhysicalFile(string, string)

ControllerBase.PhysicalFile(string, string, bool)

ControllerBase.PhysicalFile(string, string, string)

ControllerBase.PhysicalFile(string, string, string, bool)

ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.Unauthorized()

ControllerBase.Unauthorized(object)

ControllerBase.NotFound()

ControllerBase.NotFound(object)

ControllerBase.BadRequest()

ControllerBase.BadRequest(object)

ControllerBase.BadRequest(ModelStateDictionary)

ControllerBase.UnprocessableEntity()

ControllerBase.UnprocessableEntity(object)

ControllerBase.UnprocessableEntity(ModelStateDictionary)

ControllerBase.Conflict()

ControllerBase.Conflict(object)

ControllerBase.Conflict(ModelStateDictionary)

ControllerBase.Problem(string, string, int?, string, string)

ControllerBase.ValidationProblem(ValidationProblemDetails)

ControllerBase.ValidationProblem(ModelStateDictionary)

ControllerBase.ValidationProblem()

ControllerBase.ValidationProblem(string, string, int?, string, string, ModelStateDictionary)

ControllerBase.Created()

ControllerBase.Created(string, object)

ControllerBase.Created(Uri, object)

ControllerBase.CreatedAtAction(string, object)

ControllerBase.CreatedAtAction(string, object, object)

ControllerBase.CreatedAtAction(string, string, object, object)

ControllerBase.CreatedAtRoute(string, object)

ControllerBase.CreatedAtRoute(object, object)

ControllerBase.CreatedAtRoute(string, object, object)

ControllerBase.Accepted()

ControllerBase.Accepted(object)

ControllerBase.Accepted(Uri)

ControllerBase.Accepted(string)

ControllerBase.Accepted(string, object)

ControllerBase.Accepted(Uri, object)

ControllerBase.AcceptedAtAction(string)

ControllerBase.AcceptedAtAction(string, string)

ControllerBase.AcceptedAtAction(string, object)

ControllerBase.AcceptedAtAction(string, string, object)

ControllerBase.AcceptedAtAction(string, object, object)

ControllerBase.AcceptedAtAction(string, string, object, object)

ControllerBase.AcceptedAtRoute(object)

ControllerBase.AcceptedAtRoute(string)

ControllerBase.AcceptedAtRoute(string, object)

ControllerBase.AcceptedAtRoute(object, object)

ControllerBase.AcceptedAtRoute(string, object, object)

ControllerBase.Challenge()

ControllerBase.Challenge(params string[])

ControllerBase.Challenge(AuthenticationProperties)

ControllerBase.Challenge(AuthenticationProperties, params string[])

ControllerBase.Forbid()

ControllerBase.Forbid(params string[])

ControllerBase.Forbid(AuthenticationProperties)

ControllerBase.Forbid(AuthenticationProperties, params string[])

ControllerBase.SignIn(ClaimsPrincipal)

ControllerBase.SignIn(ClaimsPrincipal, string)

ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties)

ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties, string)

ControllerBase.SignOut()

ControllerBase.SignOut(AuthenticationProperties)

ControllerBase.SignOut(params string[])

ControllerBase.SignOut(AuthenticationProperties, params string[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, params Expression<Func<TModel, object>>[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, Func<ModelMetadata, bool>)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider, params Expression<Func<TModel, object>>[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider, Func<ModelMetadata, bool>)

ControllerBase.TryUpdateModelAsync(object, Type, string)

ControllerBase.TryUpdateModelAsync(object, Type, string, IValueProvider, Func<ModelMetadata, bool>)

ControllerBase.TryValidateModel(object)

ControllerBase.TryValidateModel(object, string)

ControllerBase.HttpContext

ControllerBase.Request

ControllerBase.Response

ControllerBase.RouteData

ControllerBase.ModelState

ControllerBase.ControllerContext

ControllerBase.MetadataProvider

ControllerBase.ModelBinderFactory

ControllerBase.Url

ControllerBase.ObjectValidator

ControllerBase.ProblemDetailsFactory

ControllerBase.User

ControllerBase.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Remarks

Constructor for the Orchestration orchestration controller

Constructors

CompletionsController(IOrchestrationService, ILogger<CompletionsController>)

CompletionsController class

public CompletionsController(IOrchestrationService orchestrationService, ILogger<CompletionsController> logger)

Parameters

orchestrationService IOrchestrationService

logger ILogger<CompletionsController>

Remarks

Constructor for the Orchestration orchestration controller

Methods

GetCompletion(string, CompletionRequest)

Retrieves a completion from an orchestration service

[HttpPost("completions")]
public Task<CompletionResponse> GetCompletion(string instanceId, CompletionRequest completionRequest)

Parameters

instanceId string

The FoundationaLLM instance id.

completionRequest CompletionRequest

The completion request.

Returns

Task<CompletionResponse>

The completion response.

GetCompletionOperationStatus(string, string)

Gets the status of a completion operation.

[HttpGet("async-completions/{operationId}/status")]
public Task<LongRunningOperation> GetCompletionOperationStatus(string instanceId, string operationId)

Parameters

instanceId string

The FoundationaLLM instance id.

operationId string

The OperationId for which to retrieve the status.

Returns

Task<LongRunningOperation>

Returns an LongRunningOperation object containing the OperationId and Status.

StartCompletionOperation(string, CompletionRequest)

Begins a completion operation.

[HttpPost("async-completions")]
public Task<ActionResult<LongRunningOperation>> StartCompletionOperation(string instanceId, CompletionRequest completionRequest)

Parameters

instanceId string

The FoundationaLLM instance id.

completionRequest CompletionRequest

The completion request containing the user prompt and message history.

Returns

Task<ActionResult<LongRunningOperation>>

Returns an LongRunningOperation object containing the OperationId and Status.