Interface IPluginPackageManager

Namespace

FoundationaLLM.Common.Interfaces.Plugins

Assembly

FoundationaLLM.Common.dll

Provides methods to manage plugins in FoundationaLLM plugin packages.

public interface IPluginPackageManager

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

GetContentTextExtractionPlugin(string, Dictionary<string, object>, IServiceProvider)

Gets a content text extraction plugin by its name.

IContentTextExtractionPlugin GetContentTextExtractionPlugin(string pluginName, Dictionary<string, object> pluginParameters, IServiceProvider serviceProvider)

Parameters

pluginName string

The name of the content text extraction plugin.

pluginParameters Dictionary<string, object>

The dictionary containing the plugin parameters.

serviceProvider IServiceProvider

The service provider of the dependency injection container.

Returns

IContentTextExtractionPlugin

The IContentTextExtractionPlugin interface implemented by the content text extraction plugin.

Exceptions

NotImplementedException

GetContentTextPartitioningPlugin(string, Dictionary<string, object>, IServiceProvider)

Gets a content text partitioning plugin by its name.

IContentTextPartitioningPlugin GetContentTextPartitioningPlugin(string pluginName, Dictionary<string, object> pluginParameters, IServiceProvider serviceProvider)

Parameters

pluginName string

The name of the content text partitioning plugin.

pluginParameters Dictionary<string, object>

The dictionary containing the plugin parameters.

serviceProvider IServiceProvider

The service provider of the dependency injection container.

Returns

IContentTextPartitioningPlugin

The IContentTextExtractionPlugin interface implemented by the content text partitioning plugin.

Exceptions

NotImplementedException

GetDataPipelineStagePlugin(string, Dictionary<string, object>, IServiceProvider)

Gets a data pipeline stage plugin by its name.

IDataPipelineStagePlugin GetDataPipelineStagePlugin(string pluginName, Dictionary<string, object> pluginParameters, IServiceProvider serviceProvider)

Parameters

pluginName string

The name of the data pipeline stage plugin.

pluginParameters Dictionary<string, object>

The dictionary containing the plugin parameters.

serviceProvider IServiceProvider

The service provider of the dependency injection container.

Returns

IDataPipelineStagePlugin

The IDataPipelineStagePlugin interface implemented by the data pipeline stage plugin.

Exceptions

NotImplementedException

GetDataSourcePlugin(string, string, Dictionary<string, object>, IServiceProvider)

Gets a data source plugin by its name.

IDataSourcePlugin GetDataSourcePlugin(string pluginName, string dataSourceObjectId, Dictionary<string, object> pluginParameters, IServiceProvider serviceProvider)

Parameters

pluginName string

The name of the data source plugin.

dataSourceObjectId string

The FoundationaLLM object identifier of the data source.

pluginParameters Dictionary<string, object>

The dictionary containing the plugin parameters.

serviceProvider IServiceProvider

The service provider of the dependency injection container.

Returns

IDataSourcePlugin

The IDataSourcePlugin interface implemented by the data source plugin.

Exceptions

NotImplementedException

GetMetadata(string)

Gets the plugin package configuration with the plugin configurations of to the plugins in the package.

PluginPackageMetadata GetMetadata(string instanceId)

Parameters

instanceId string

The FoundationaLLM instance identifier.

Returns

PluginPackageMetadata

An object of type PluginPackageMetadata.

RegisterService(string, object)

Registers an internal service in the plugin package.

void RegisterService(string serviceName, object service)

Parameters

serviceName string

The name of the service.

service object

The service to be registered.

TryGetService(string, out object?)

Tries to get a service that is registered internally in the plugin package.

bool TryGetService(string serviceName, out object? service)

Parameters

serviceName string

The name of the service to be retrieved.

service object

When the method returns, contains the requested service if it was found; otherwise, null.

Returns

bool

true if the service was successfully retrieved.