Interface IAgentManagementClient

Namespace

FoundationaLLM.Client.Management.Interfaces

Assembly

FoundationaLLM.Client.Management.dll

Provides methods to manage agent resources.

public interface IAgentManagementClient

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

CheckAgentNameAsync(ResourceName)

Checks the availability of a resource name for an agent. If the name is available, the Status value will be "Allowed". If the name is not available, the Status value will be "Denied" and the Message will explain the reason why. Typically, a denied name is due to a name conflict with an existing agent or an agent that was deleted but not purged.

Task<ResourceNameCheckResult> CheckAgentNameAsync(ResourceName resourceName)

Parameters

resourceName ResourceName

Contains the name of the resource to check.

Returns

Task<ResourceNameCheckResult>

Exceptions

ArgumentException

Thrown when the required properties within the argument are empty or missing.

DeleteAgentAsync(string)

Deletes an agent resource by name. Please note that all deletes are soft deletes. The resource will be marked as deleted but not purged. To permanently remove a resource, execute the PurgeAgentAsync(string) method with the same name.

Task DeleteAgentAsync(string agentName)

Parameters

agentName string

The name of the agent resource to delete.

Returns

Task

GetAgentAsync(string)

Retrieves a specific agent by name.

Task<ResourceProviderGetResult<AgentBase>> GetAgentAsync(string agentName)

Parameters

agentName string

The name of the agent resource to retrieve.

Returns

Task<ResourceProviderGetResult<AgentBase>>

GetAgentsAsync()

Retrieves all agent resources.

Task<List<ResourceProviderGetResult<AgentBase>>> GetAgentsAsync()

Returns

Task<List<ResourceProviderGetResult<AgentBase>>>

All agent resources to which the caller has access and which have not been marked as deleted.

PurgeAgentAsync(string)

Purges a deleted agent by its name. This action is irreversible.

Task<ResourceProviderActionResult> PurgeAgentAsync(string agentName)

Parameters

agentName string

The name of the agent to purge.

Returns

Task<ResourceProviderActionResult>

UpsertAgentAsync(AgentBase)

Upserts an agent resource. If an agent does not exist, it will be created. If an agent does exist, it will be updated.

Task<ResourceProviderUpsertResult> UpsertAgentAsync(AgentBase agent)

Parameters

agent AgentBase

The agent resource to create or update.

Returns

Task<ResourceProviderUpsertResult>

Returns a ResourceProviderUpsertResult, which contains the Object ID of the resource.