Class ContextKnowledgeSourceQueryRequest

Namespace

FoundationaLLM.Common.Models.Context.Knowledge

Assembly

FoundationaLLM.Common.dll

Represents a request to query a collection of text chunks.

public class ContextKnowledgeSourceQueryRequest

Inheritance

object

ContextKnowledgeSourceQueryRequest

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

Properties

KnowledgeGraphQuery

Gets or sets the knowledge graph query parameters.

[JsonPropertyName("knowledge_graph_query")]
public ContextKnowledgeGraphQuery? KnowledgeGraphQuery { get; set; }

Property Value

ContextKnowledgeGraphQuery

MetadataFilter

Gets or sets the metadata filter used to filter the text chunks.

[JsonPropertyName("metadata_filter")]
public Dictionary<string, string>? MetadataFilter { get; set; }

Property Value

Dictionary<string, string>

TextChunksMaxCount

Gets or sets the maximum number of text chunks included in the query result.

[JsonPropertyName("text_chunks_max_count")]
public int TextChunksMaxCount { get; set; }

Property Value

int

TextChunksSimilarityThreshold

Gets or sets the minimum similarity measure threshold used to identify relevant text chunks.

[JsonPropertyName("text_chunks_similarity_threshold")]
public float TextChunksSimilarityThreshold { get; set; }

Property Value

float

UseSemanticRanking

Gets or sets a flag that indicates whether semantic ranking should be used or not.

[JsonPropertyName("use_semantic_ranking")]
public bool UseSemanticRanking { get; set; }

Property Value

bool

UserPrompt

Gets or sets the user prompt used to query the knowledge graph.

[JsonPropertyName("user_prompt")]
public string? UserPrompt { get; set; }

Property Value

string

VectorStoreId

Gets or sets the vector store identifier used to query the knowledge source.

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

Property Value

string

Remarks

This value is used only when the knowledge source does not have static vector store identier set.