Class KnowledgeService
- Namespace
- FoundationaLLM.Context.Services
- Assembly
- FoundationaLLM.ContextEngine.dll
Provides the implementation for the FoundationaLLM Knowledge Graph service.
public class KnowledgeService : IKnowledgeService
- Inheritance
-
KnowledgeService
- Implements
- Inherited Members
- Extension Methods
Constructors
KnowledgeService(IStorageService, IAuthorizationServiceClient, IResourceProviderService, IResourceProviderService, IResourceProviderService, IHttpClientFactoryService, KnowledgeServiceSettings, ILoggerFactory)
Provides the implementation for the FoundationaLLM Knowledge Graph service.
public KnowledgeService(IStorageService storageService, IAuthorizationServiceClient authorizationServiceClient, IResourceProviderService contextResourceProvider, IResourceProviderService configurationResourceProvider, IResourceProviderService vectorResourceProvider, IHttpClientFactoryService httpClientFactory, KnowledgeServiceSettings settings, ILoggerFactory loggerFactory)
Parameters
storageService
IStorageServiceThe IStorageService providing storage services.
authorizationServiceClient
IAuthorizationServiceClientThe client for the FoundationaLLM Authorization API.
contextResourceProvider
IResourceProviderServiceThe FoundationaLLM.Context resource provider service.
configurationResourceProvider
IResourceProviderServiceThe FoundationaLLM.Configuration resource provider service.
vectorResourceProvider
IResourceProviderServiceThe FoundationaLLM.Vector resource provider service.
httpClientFactory
IHttpClientFactoryServiceThe factory for creating HTTP clients.
settings
KnowledgeServiceSettingsThe settings for the Knowledge Graph service.
loggerFactory
ILoggerFactoryThe logger factory used to create loggers.
Methods
GetKnowledgeSource(string, string, UnifiedUserIdentity)
Retrieves a specified knowledge source.
public Task<ContextServiceResponse<ResourceProviderGetResult<KnowledgeSource>>> GetKnowledgeSource(string instanceId, string knowledgeSourceId, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
knowledgeSourceId
stringThe knowledge source identifier.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.
Returns
GetKnowledgeSources(string, ContextKnowledgeResourceListRequest, UnifiedUserIdentity)
Retrieves the list of knowledge sources.
public Task<ContextServiceResponse<IEnumerable<ResourceProviderGetResult<KnowledgeSource>>>> GetKnowledgeSources(string instanceId, ContextKnowledgeResourceListRequest listRequest, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
listRequest
ContextKnowledgeResourceListRequestThe request containing the information used to filter the knowledge resources.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.
Returns
GetKnowledgeUnit(string, string, UnifiedUserIdentity)
Retrieves a specified knowledge unit.
public Task<ContextServiceResponse<ResourceProviderGetResult<KnowledgeUnit>>> GetKnowledgeUnit(string instanceId, string knowledgeUnitId, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
knowledgeUnitId
stringThe knowledge unit identifier.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.
Returns
GetKnowledgeUnits(string, ContextKnowledgeResourceListRequest, UnifiedUserIdentity)
Retrieves the list of knowledge units.
public Task<ContextServiceResponse<IEnumerable<ResourceProviderGetResult<KnowledgeUnit>>>> GetKnowledgeUnits(string instanceId, ContextKnowledgeResourceListRequest listRequest, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
listRequest
ContextKnowledgeResourceListRequestThe request containing the information used to filter the knowledge resources.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.
Returns
QueryKnowledgeSource(string, string, ContextKnowledgeSourceQueryRequest, UnifiedUserIdentity)
Queries a knowledge source.
public Task<ContextKnowledgeSourceQueryResponse> QueryKnowledgeSource(string instanceId, string knowledgeSourceId, ContextKnowledgeSourceQueryRequest queryRequest, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
knowledgeSourceId
stringThe knowledge source identifier.
queryRequest
ContextKnowledgeSourceQueryRequestThe request containing the details of the query.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.
Returns
RenderKnowledgeUnitGraph(string, string, ContextKnowledgeSourceQueryRequest?, UnifiedUserIdentity)
Retrieves the knowledge unit's knowledge graph in a format suitable for visualization or further processing.
public Task<ContextKnowledgeUnitRenderGraphResponse> RenderKnowledgeUnitGraph(string instanceId, string knowledgeUnitId, ContextKnowledgeSourceQueryRequest? queryRequest, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
knowledgeUnitId
stringThe knowledge unit identifier.
queryRequest
ContextKnowledgeSourceQueryRequestThe request containing the details of the query.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.
Returns
SetKnowledgeUnitGraph(string, string, ContextKnowledgeUnitSetGraphRequest, UnifiedUserIdentity)
Sets the knowledge graph associated with a knowledge unit.
public Task<ContextServiceResponse<ResourceProviderActionResult>> SetKnowledgeUnitGraph(string instanceId, string knowledgeUnitId, ContextKnowledgeUnitSetGraphRequest setGraphRequest, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
knowledgeUnitId
stringThe knowledge unit identifier.
setGraphRequest
ContextKnowledgeUnitSetGraphRequestThe request containing the knowledge graph details.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.
Returns
UpsertKnowledgeSource(string, KnowledgeSource, UnifiedUserIdentity)
Creates or updates a knowledge source in the context service.
public Task<ContextServiceResponse<ResourceProviderUpsertResult<KnowledgeSource>>> UpsertKnowledgeSource(string instanceId, KnowledgeSource knowledgeSource, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
knowledgeSource
KnowledgeSourceThe knowledge source to be created or updated.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.
Returns
UpsertKnowledgeUnit(string, KnowledgeUnit, UnifiedUserIdentity)
Creates or updates a knowledge unit in the context service.
public Task<ContextServiceResponse<ResourceProviderUpsertResult<KnowledgeUnit>>> UpsertKnowledgeUnit(string instanceId, KnowledgeUnit knowledgeUnit, UnifiedUserIdentity userIdentity)
Parameters
instanceId
stringThe FoundationaLLM instance identifier.
knowledgeUnit
KnowledgeUnitThe knowledge unit to be created or updated.
userIdentity
UnifiedUserIdentityThe identity of the security principal submitting the request.