Class ContextKnowledgeSourceQueryRequest

Namespace

FoundationaLLM.Common.Models.Context.Knowledge

Assembly

FoundationaLLM.Common.dll

Represents a request to query a knowledge source.

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

FormatResponse

Gets or sets a value indicating whether the response should be formatted.

[JsonPropertyName("format_response")]
public bool? FormatResponse { get; set; }

Property Value

bool?

Remarks

When true, the response will be plain text. Otherwise, the response will be structured.

KnowledgeGraphQuery

Gets or sets the knowledge graph query parameters.

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

Property Value

ContextKnowledgeGraphQuery

UserPrompt

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

[JsonPropertyName("user_prompt")]
public required 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 a static vector store identier set.

VectorStoreMetadataFilter

Gets or sets the metadata filter used to provide additional filtering in the vector store queries.

[JsonPropertyName("vector_store_metadata_filter")]
public Dictionary<string, object>? VectorStoreMetadataFilter { get; set; }

Property Value

Dictionary<string, object>

VectorStoreQuery

Gets or sets the vector store query parameters.

[JsonPropertyName("vector_store_query")]
public ContextVectorStoreQuery? VectorStoreQuery { get; set; }

Property Value

ContextVectorStoreQuery