Interface IDownstreamAPIService

Namespace

FoundationaLLM.Common.Interfaces

Assembly

FoundationaLLM.Common.dll

Interface for calling a downstream API.

public interface IDownstreamAPIService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

APIName

The name of the downstream API.

string APIName { get; }

Property Value

string

Methods

GetCompletion(string, CompletionRequest)

Gets a completion from the downstream API.

Task<CompletionResponse> GetCompletion(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<CompletionResponse>

The completion response.

GetCompletionOperationStatus(string, string)

Gets the status of a completion operation.

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.

Task<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<LongRunningOperation>

Returns an LongRunningOperation object containing the OperationId and Status.