Class FileService

Namespace

FoundationaLLM.Context.Services

Assembly

FoundationaLLM.ContextEngine.dll

Provides the implementation for the FoundationaLLM File service.

public class FileService : IFileService

Inheritance

object

FileService

Implements

IFileService

Inherited Members

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>)

Constructors

FileService(IAzureCosmosDBFileService, IStorageService, IAuthorizationServiceClient, FileServiceSettings, ILogger<FileService>)

Provides the implementation for the FoundationaLLM File service.

public FileService(IAzureCosmosDBFileService cosmosDBService, IStorageService storageService, IAuthorizationServiceClient authorizationServiceClient, FileServiceSettings settings, ILogger<FileService> logger)

Parameters

cosmosDBService IAzureCosmosDBFileService

The Azure Cosmos DB service providing database services.

storageService IStorageService

The IStorageService providing storage services.

authorizationServiceClient IAuthorizationServiceClient

The client for the FoundationaLLM Authorization API.

settings FileServiceSettings

logger ILogger<FileService>

The logger used for logging.

Methods

CreateFileForAgent(string, string, string, string, string, Stream, UnifiedUserIdentity, Dictionary<string, string>?)

Create a new file.

public Task<ContextFileRecord> CreateFileForAgent(string instanceId, string origin, string agentName, string fileName, string contentType, Stream content, UnifiedUserIdentity userIdentity, Dictionary<string, string>? metadata)

Parameters

instanceId string

The FoundationaLLM instance identifier.

origin string

The origin of the file.

agentName string

The name of the agent.

fileName string

The original name of the file.

contentType string

The content type of the file.

content Stream

The Stream providing the raw content of the file.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity providing details about the user identity.

metadata Dictionary<string, string>

Optional metadata dictionary associated with the file.

Returns

Task<ContextFileRecord>

A ContextFileRecord instance with details about the newly created file.

CreateFileForConversation(string, string, string, string, string, Stream, UnifiedUserIdentity, Dictionary<string, string>?)

Create a new file.

public Task<ContextFileRecord> CreateFileForConversation(string instanceId, string origin, string conversationId, string fileName, string contentType, Stream content, UnifiedUserIdentity userIdentity, Dictionary<string, string>? metadata)

Parameters

instanceId string

The FoundationaLLM instance identifier.

origin string

The origin of the file.

conversationId string

The conversation identifier.

fileName string

The original name of the file.

contentType string

The content type of the file.

content Stream

The Stream providing the raw content of the file.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity providing details about the user identity.

metadata Dictionary<string, string>

Optional metadata dictionary associated with the file.

Returns

Task<ContextFileRecord>

A ContextFileRecord instance with details about the newly created file.

DeleteFileRecord(string, string, UnifiedUserIdentity)

Deletes the file record associated with a file.

public Task DeleteFileRecord(string instanceId, string fileId, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The FoundationaLLM instance identifier.

fileId string

The identifier of the file.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity providing details about the user identity.

Returns

Task

GetFileContent(string, string, UnifiedUserIdentity)

Get the binary content of a file.

public Task<ContextFileContent?> GetFileContent(string instanceId, string fileId, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The FoundationaLLM instance identifier.

fileId string

The identifier of the file.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity providing details about the user identity.

Returns

Task<ContextFileContent>

A ContextFileContent instance with the content of the file.

GetFileContent(string, string, string, UnifiedUserIdentity)

Get the binary content of a file.

public Task<ContextFileContent?> GetFileContent(string instanceId, string conversationId, string fileName, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The FoundationaLLM instance identifier.

conversationId string

The conversation identifier.

fileName string

The name of the file to retrieve.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity providing details about the user identity.

Returns

Task<ContextFileContent>

A ContextFileContent instance with the content of the file.

GetFileRecord(string, string, UnifiedUserIdentity)

Get the file record associated with a file.

public Task<ContextFileRecord?> GetFileRecord(string instanceId, string fileId, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The FoundationaLLM instance identifier.

fileId string

The identifier of the file.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity providing details about the user identity.

Returns

Task<ContextFileRecord>

A ContextFileRecord with the file record.

ShouldBypassOwnerCheck(string, UnifiedUserIdentity)

public Task<bool> ShouldBypassOwnerCheck(string instanceId, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

userIdentity UnifiedUserIdentity

Returns

Task<bool>