Interface IUserProfileService

Namespace

FoundationaLLM.Common.Interfaces

Assembly

FoundationaLLM.Common.dll

Provides methods for working with user profiles.

public interface IUserProfileService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

AddAgent(string, string)

Adds an agent to the user's profile.

Task AddAgent(string instanceId, string agentObjectId)

Parameters

instanceId string

The FoundationaLLM instance identifier.

agentObjectId string

The object identifier of the agent to add.

Returns

Task

GetUserProfileAsync(string)

Returns the user profile of the signed in user.

Task<UserProfile?> GetUserProfileAsync(string instanceId)

Parameters

instanceId string

The instance ID.

Returns

Task<UserProfile>

Exceptions

InvalidOperationException

GetUserProfileForUserAsync(string, string)

Returns the user profile of the specified user.

Task<UserProfile?> GetUserProfileForUserAsync(string instanceId, string upn)

Parameters

instanceId string

The instance ID.

upn string

The user principal name of the user for whom to return the user profile.

Returns

Task<UserProfile>

RemoveAgent(string, string)

Removes an agent to the user's profile.

Task RemoveAgent(string instanceId, string agentObjectId)

Parameters

instanceId string

The FoundationaLLM instance identifier.

agentObjectId string

The object identifier of the agent to remove.

Returns

Task

UpsertUserProfileAsync(string, UserProfile)

Inserts or updates a user profile.

Task UpsertUserProfileAsync(string instanceId, UserProfile userProfile)

Parameters

instanceId string

The instance ID.

userProfile UserProfile

The user profile to upsert.

Returns

Task

Exceptions

InvalidOperationException