Class KnowledgeSource

Namespace

FoundationaLLM.Common.Models.ResourceProviders.Context

Assembly

FoundationaLLM.Common.dll

Represents a FoundationaLLM knowledge source.

public class KnowledgeSource : ResourceBase

Inheritance

object

ResourceName

ResourceBase

KnowledgeSource

Inherited Members

ResourceBase.ObjectId

ResourceBase.DisplayName

ResourceBase.Description

ResourceBase.CostCenter

ResourceBase.Properties

ResourceBase.CreatedOn

ResourceBase.UpdatedOn

ResourceBase.CreatedBy

ResourceBase.UpdatedBy

ResourceBase.Deleted

ResourceBase.ExpirationDate

ResourceName.Type

ResourceName.Name

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>)

Properties

EmbeddingDimensions

Gets or sets the number of dimensions for the embeddings used in the knowledge source.

[JsonPropertyName("embedding_dimensions")]
public required int EmbeddingDimensions { get; set; }

Property Value

int

EmbeddingModel

Gets or sets the embedding model used for the knowledge source.

[JsonPropertyName("embedding_model")]
public required string EmbeddingModel { get; set; }

Property Value

string

HasKnowledgeGraph

Gets or sets a flag that indicates whether the knowledge source has a knowledge graph.

[JsonPropertyName("has_knowledge_graph")]
public bool HasKnowledgeGraph { get; set; }

Property Value

bool

VectorDatabaseObjectId

Gets or sets the object identifier of the vector database associated with the knowledge source.

[JsonPropertyName("vector_database_object_id")]
public required string VectorDatabaseObjectId { get; set; }

Property Value

string

VectorStoreId

Gets or sets the object identifier of the vector store associated with the knowledge source.

[JsonPropertyName("vector_store_id")]
public string? VectorStoreId { get; set; }

Property Value

string

Remarks

If this value is null, the knowledge source queries must specify the vector store identifier explicitly.