Interface ICodeSessionProviderService

Namespace

FoundationaLLM.Context.Interfaces

Assembly

FoundationaLLM.ContextEngine.dll

Defines the interface for code session provider services.

public interface ICodeSessionProviderService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

ProviderName

Gets the name of the code session provider.

string ProviderName { get; }

Property Value

string

Methods

CreateCodeSession(string, string, string, string, string, UnifiedUserIdentity)

Creates a new code session.

Task<CreateCodeSessionResponse> CreateCodeSession(string instanceId, string agentName, string conversationId, string context, string language, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The unique identifier of the FoundationaLLM instance.

agentName string

The name of the agent for which the code execution session is created.

conversationId string

The unique identifier of the conversation.

context string

The context in which the code execution session is created. This is usually the name of the agent tool, but it is not limited to that.

language string

The code session programing language.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity providing the user identity information.

Returns

Task<CreateCodeSessionResponse>

A CreateCodeSessionResponse object with the properties of the code execution session.

DeleteCodeSessionFileStoreItems(string, string)

Deletes all files from a code session.

Task DeleteCodeSessionFileStoreItems(string codeSessionId, string endpoint)

Parameters

codeSessionId string

The identifier of the code session.

endpoint string

The endpoint of the code session service.

Returns

Task

DownloadFileFromCodeSession(string, string, string, string)

Downloads a file from a code session.

Task<Stream?> DownloadFileFromCodeSession(string codeSessionId, string endpoint, string fileName, string filePath)

Parameters

codeSessionId string

The identifier of the code session.

endpoint string

The endpoint of the code session service.

fileName string

The name of the file to download.

filePath string

The path to the file to download.

Returns

Task<Stream>

A stream with the binary content of the file.

ExecuteCodeInCodeSession(string, string, string)

Executes code in a code session.

Task<CodeSessionCodeExecuteResponse> ExecuteCodeInCodeSession(string codeSessionId, string endpoint, string codeToExecute)

Parameters

codeSessionId string

The identifier of the code session.

endpoint string

The endpoint of the code session service.

codeToExecute string

The code to execute.

Returns

Task<CodeSessionCodeExecuteResponse>

The result of the code execution including standard and error outputs.

GetCodeSessionFileStoreItems(string, string)

Lists files from a code session.

Task<List<CodeSessionFileStoreItem>> GetCodeSessionFileStoreItems(string codeSessionId, string endpoint)

Parameters

codeSessionId string

The identifier of the code session.

endpoint string

The endpoint of the code session service.

Returns

Task<List<CodeSessionFileStoreItem>>

The list of file paths from the code session.

UploadFileToCodeSession(string, string, string, Stream)

Uploads a file to a code execution session.

Task<bool> UploadFileToCodeSession(string codeSessionId, string endpoint, string fileName, Stream fileContent)

Parameters

codeSessionId string

The identifier of the code session.

endpoint string

The endpoint of the code session service.

fileName string

The name of the file to upload.

fileContent Stream

The stream containing the binary content of the file to upload.

Returns

Task<bool>