Table of Contents

Class KnowledgeGraphDataPipelineStagePluginBase

Namespace
FoundationaLLM.Plugins.DataPipeline.Plugins.DataPipelineStage
Assembly
FoundationaLLM.DataPipelinePlugins.dll

Implements basic capabilities for Knowledge Graph Data Pipeline Stage Plugins.

public class KnowledgeGraphDataPipelineStagePluginBase : DataPipelineStagePluginBase, IDataPipelineStagePlugin
Inheritance
KnowledgeGraphDataPipelineStagePluginBase
Implements
Derived
Inherited Members
Extension Methods

Constructors

KnowledgeGraphDataPipelineStagePluginBase(Dictionary<string, object>, IPluginPackageManager, IPluginPackageManagerResolver, IServiceProvider)

Implements basic capabilities for Knowledge Graph Data Pipeline Stage Plugins.

public KnowledgeGraphDataPipelineStagePluginBase(Dictionary<string, object> pluginParameters, IPluginPackageManager packageManager, IPluginPackageManagerResolver packageManagerResolver, IServiceProvider serviceProvider)

Parameters

pluginParameters Dictionary<string, object>

The dictionary containing the plugin parameters.

packageManager IPluginPackageManager

The package manager for the plugin.

packageManagerResolver IPluginPackageManagerResolver

The package manager resolver for the plugin.

serviceProvider IServiceProvider

The service provider of the dependency injection container.

Fields

GATEWAY_SERVICE_CLIENT_POLLING_INTERVAL_SECONDS

protected const int GATEWAY_SERVICE_CLIENT_POLLING_INTERVAL_SECONDS = 5

Field Value

int

KNOWLEDGE_GRAPH_BUCKETS_REGISTRY_FILE_NAME

protected const string KNOWLEDGE_GRAPH_BUCKETS_REGISTRY_FILE_NAME = "knowledge-graph-buckets.json"

Field Value

string

KNOWLEDGE_GRAPH_ENTITIES_EMBEDDINGS_FILE_NAME

protected const string KNOWLEDGE_GRAPH_ENTITIES_EMBEDDINGS_FILE_NAME = "knowledge-graph-entities-embeddings.parquet"

Field Value

string

KNOWLEDGE_GRAPH_ENTITIES_FILE_NAME

protected const string KNOWLEDGE_GRAPH_ENTITIES_FILE_NAME = "knowledge-graph-entities.parquet"

Field Value

string

KNOWLEDGE_GRAPH_ENTITY

protected const string KNOWLEDGE_GRAPH_ENTITY = "Entity"

Field Value

string

KNOWLEDGE_GRAPH_RELATIONSHIP

protected const string KNOWLEDGE_GRAPH_RELATIONSHIP = "Relationship"

Field Value

string

KNOWLEDGE_GRAPH_RELATIONSHIPS_EMBEDDINGS_FILE_NAME

protected const string KNOWLEDGE_GRAPH_RELATIONSHIPS_EMBEDDINGS_FILE_NAME = "knowledge-graph-relationships-embeddings.parquet"

Field Value

string

KNOWLEDGE_GRAPH_RELATIONSHIPS_FILE_NAME

protected const string KNOWLEDGE_GRAPH_RELATIONSHIPS_FILE_NAME = "knowledge-graph-relationships.parquet"

Field Value

string

KNOWLEDGE_GRAPH_ROOT_PATH

protected const string KNOWLEDGE_GRAPH_ROOT_PATH = "knowledge-graph"

Field Value

string

KNOWLEDGE_PARTS_FILE_NAME

protected const string KNOWLEDGE_PARTS_FILE_NAME = "knowledge-parts.parquet"

Field Value

string

_contextResourceProvider

protected readonly IResourceProviderService? _contextResourceProvider

Field Value

IResourceProviderService

_entitiesEmbeddings

protected Dictionary<string, KnowledgeEntityEmbedding> _entitiesEmbeddings

Field Value

Dictionary<string, KnowledgeEntityEmbedding>

_entityRelationships

protected readonly KnowledgeEntityRelationshipCollection<KnowledgeEntity, KnowledgeRelationship> _entityRelationships

Field Value

KnowledgeEntityRelationshipCollection<KnowledgeEntity, KnowledgeRelationship>

_gatewayServiceClient

protected GatewayServiceClient _gatewayServiceClient

Field Value

GatewayServiceClient

_promptResourceProvider

protected readonly IResourceProviderService? _promptResourceProvider

Field Value

IResourceProviderService

_relationshipsEmbeddings

protected Dictionary<string, KnowledgeRelationshipEmbedding> _relationshipsEmbeddings

Field Value

Dictionary<string, KnowledgeRelationshipEmbedding>

_tokenizer

protected readonly ITokenizerService _tokenizer

Field Value

ITokenizerService

_vectorResourceProvider

protected readonly IResourceProviderService? _vectorResourceProvider

Field Value

IResourceProviderService

Methods

CreateGatewayServiceClient(string)

protected Task CreateGatewayServiceClient(string instanceId)

Parameters

instanceId string

Returns

Task

LoadEntities(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

protected Task LoadEntities(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
dataPipelineRunWorkItem DataPipelineRunWorkItem

Returns

Task

LoadEntitiesEmbeddings(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

protected Task LoadEntitiesEmbeddings(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
dataPipelineRunWorkItem DataPipelineRunWorkItem

Returns

Task

LoadKnowledgeBucketsRegistry(DataPipelineDefinition, DataPipelineRun)

protected Task<KnowledgeBucketsRegistry> LoadKnowledgeBucketsRegistry(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun

Returns

Task<KnowledgeBucketsRegistry>

LoadRelationships(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

protected Task LoadRelationships(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
dataPipelineRunWorkItem DataPipelineRunWorkItem

Returns

Task

LoadRelationshipsEmbeddings(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

protected Task LoadRelationshipsEmbeddings(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
dataPipelineRunWorkItem DataPipelineRunWorkItem

Returns

Task

SaveEntities(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

protected Task SaveEntities(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
dataPipelineRunWorkItem DataPipelineRunWorkItem

Returns

Task

SaveEntitiesEmbeddings(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

protected Task SaveEntitiesEmbeddings(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
dataPipelineRunWorkItem DataPipelineRunWorkItem

Returns

Task

SaveKnowledgeBucketsRegistry(DataPipelineDefinition, DataPipelineRun, KnowledgeBucketsRegistry)

protected Task SaveKnowledgeBucketsRegistry(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, KnowledgeBucketsRegistry knowledgeBucketsRegistry)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
knowledgeBucketsRegistry KnowledgeBucketsRegistry

Returns

Task

SaveRelationships(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

protected Task SaveRelationships(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
dataPipelineRunWorkItem DataPipelineRunWorkItem

Returns

Task

SaveRelationshipsEmbeddings(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

protected Task SaveRelationshipsEmbeddings(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition
dataPipelineRun DataPipelineRun
dataPipelineRunWorkItem DataPipelineRunWorkItem

Returns

Task