Class KnowledgeRelationship

Namespace

FoundationaLLM.Common.Models.Knowledge

Assembly

FoundationaLLM.Common.dll

Represents a relationship between two knowledge entities in a knowledge graph.

public class KnowledgeRelationship

Inheritance

object

KnowledgeRelationship

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

KnowledgeRelationship()

Initializes a new instance of the KnowledgeRelationship class.

public KnowledgeRelationship()

Properties

ChunkIds

Gets or sets the list of chunk identifiers associated with the relationship.

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

Property Value

List<string>

Descriptions

Gets or sets the list of detailed descriptions associated with the relationship.

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

Property Value

List<string>

Position

Gets or sets the position of the relationship in the list of relationships.

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

Property Value

int

ShortDescriptions

Gets or sets the list of short descriptions associated with the relationship.

[JsonPropertyName("short_descriptions")]
[JsonPropertyOrder(5)]
public List<string> ShortDescriptions { get; set; }

Property Value

List<string>

Source

Gets or sets the source entity of the relationship.

[JsonPropertyName("source")]
[JsonPropertyOrder(1)]
public string Source { get; set; }

Property Value

string

SourceType

Gets or sets the type of the source entity.

[JsonPropertyName("source_type")]
[JsonPropertyOrder(2)]
public string SourceType { get; set; }

Property Value

string

SourceUniqueId

Gets the unique identifier for the source, combining the source type and source value.

[JsonIgnore]
public string SourceUniqueId { get; }

Property Value

string

Strengths

Gets or sets the list of strengths associated with the relationship.

[JsonPropertyName("strengths")]
[JsonPropertyOrder(7)]
public List<int> Strengths { get; set; }

Property Value

List<int>

SummaryDescription

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

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

Property Value

string

SummaryDescriptionEmbedding

Gets or sets the embedding of the summary description.

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

Property Value

float[]

Target

Gets or sets the target entity of the relationship.

[JsonPropertyName("target")]
[JsonPropertyOrder(3)]
public string Target { get; set; }

Property Value

string

TargetType

Gets or sets the type of the target entity.

[JsonPropertyName("target_type")]
[JsonPropertyOrder(4)]
public string TargetType { get; set; }

Property Value

string

TargetUniqueId

Gets the unique identifier for the target, combining the target type and target value.

[JsonIgnore]
public string TargetUniqueId { get; }

Property Value

string