Class DataPipelineStagePluginBase

Namespace

FoundationaLLM.Common.Services.Plugins

Assembly

FoundationaLLM.Common.dll

Implements a basic Data Pipeline Stage Plugin.

public class DataPipelineStagePluginBase : PluginBase, IDataPipelineStagePlugin

Inheritance

object

PluginBase

DataPipelineStagePluginBase

Implements

IDataPipelineStagePlugin

Derived

AzureAISearchIndexingDataPipelineStagePlugin

GatewayTextEmbeddingDataPipelineStagePlugin

KnowledgeExtractionDataPipelineStagePlugin

KnowledgeGraphDataPipelineStagePlugin

TextExtractionDataPipelineStagePlugin

TextPartitioningDataPipelineStagePlugin

Inherited Members

PluginBase.Name

PluginBase._pluginParameters

PluginBase._packageManager

PluginBase._pluginMetadata

PluginBase._serviceProvider

PluginBase._logger

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

DataPipelineStagePluginBase(Dictionary<string, object>, IPluginPackageManager, IServiceProvider)

Initializes a new instance of the base data pipeline stage plugin.

public DataPipelineStagePluginBase(Dictionary<string, object> pluginParameters, IPluginPackageManager packageManager, IServiceProvider serviceProvider)

Parameters

pluginParameters Dictionary<string, object>

packageManager IPluginPackageManager

serviceProvider IServiceProvider

Fields

_dataPipelineStateService

protected readonly IDataPipelineStateService _dataPipelineStateService

Field Value

IDataPipelineStateService

Methods

GetStageWorkItems(List<string>, string, string, string)

Gets the list of data pipeline work items based on the provided content items canonical identifiers.

public virtual Task<List<DataPipelineRunWorkItem>> GetStageWorkItems(List<string> contentItemsCanonicalIds, string dataPipelineRunId, string dataPipelineStageName, string previousDataPipelineStageName)

Parameters

contentItemsCanonicalIds List<string>

The list of icontent items canonical identifiers.

dataPipelineRunId string

The unique identifier of the data pipeline run.

dataPipelineStageName string

The name of the data pipeline stage.

previousDataPipelineStageName string

The name of the previous data pipeline stage.

Returns

Task<List<DataPipelineRunWorkItem>>

A list of data pipeline work items.

GetStartingStageWorkItems(List<DataPipelineContentItem>, string, string)

Gets the list of data pipeline work items based on the provided content items.

public virtual Task<List<DataPipelineRunWorkItem>> GetStartingStageWorkItems(List<DataPipelineContentItem> contentItems, string dataPipelineRunId, string dataPipelineStageName)

Parameters

contentItems List<DataPipelineContentItem>

The list of content items.

dataPipelineRunId string

The unique identifier of the data pipeline run.

dataPipelineStageName string

The name of the data pipeline stage.

Returns

Task<List<DataPipelineRunWorkItem>>

A list of data pipeline work items.

ProcessWorkItem(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

Processes a specified data pipeline run work item.

public virtual Task<PluginResult> ProcessWorkItem(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition

The definition of the data pipeline associated with the data pipeline run work item.

dataPipelineRun DataPipelineRun

The data pipeline run associated with the data pipeline run work item.

dataPipelineRunWorkItem DataPipelineRunWorkItem

The data pipeline run work item to process.

Returns

Task<PluginResult>

An object that contains the processing result.