Class KnowledgeEntity

Namespace

FoundationaLLM.Common.Models.Knowledge

Assembly

FoundationaLLM.Common.dll

Represents a knowledge entity used in a knowledge graph.

public class KnowledgeEntity

Inheritance

object

KnowledgeEntity

Inherited Members

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

KnowledgeEntity()

Initializes a new instance of the KnowledgeEntity class.

public KnowledgeEntity()

Properties

ChunkIds

Gets or sets the list of text chunk identifiers associated with the entity.

[JsonPropertyName("chunk_ids")]
[JsonPropertyOrder(4)]
public List<string> ChunkIds { get; set; }

Property Value

List<string>

Descriptions

Gets or sets the list of descriptions associated with the entity.

[JsonPropertyName("descriptions")]
[JsonPropertyOrder(3)]
public List<string> Descriptions { get; set; }

Property Value

List<string>

Name

Gets or sets the name of the entity.

[JsonPropertyName("name")]
[JsonPropertyOrder(2)]
public string Name { get; set; }

Property Value

string

Position

Gets or sets the position of the entity in the list of entities.

[JsonPropertyName("position")]
[JsonPropertyOrder(0)]
public int Position { get; set; }

Property Value

int

SummaryDescription

Gets or sets the summary description of the entity, which provides a concise overview.

[JsonPropertyName("summary_description")]
[JsonPropertyOrder(5)]
public string? SummaryDescription { get; set; }

Property Value

string

SummaryDescriptionEmbedding

Gets or sets the embedding of the summary description.

[JsonPropertyName("summary_description_embedding")]
[JsonPropertyOrder(6)]
public float[]? SummaryDescriptionEmbedding { get; set; }

Property Value

float[]

Type

Gets or sets the type of the entity.

[JsonPropertyName("type")]
[JsonPropertyOrder(1)]
public string Type { get; set; }

Property Value

string

UniqueId

Gets the unique identifier for the object, composed of its type and name.

[JsonIgnore]
public string UniqueId { get; }

Property Value

string