Class RagBuilder

Namespace

Mythosia.AI.Rag

Assembly

Mythosia.AI.Rag.dll

public class RagBuilder

Inheritance

object

RagBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RagBuilder()

public RagBuilder()

Methods

AddDocument(string)

public RagBuilder AddDocument(string filePath)

Parameters

filePath string

Returns

RagBuilder

AddDocuments(IDocumentLoader, string)

public RagBuilder AddDocuments(IDocumentLoader loader, string source)

Parameters

loader IDocumentLoader

source string

Returns

RagBuilder

AddDocuments(IDocumentLoader, string, ITextSplitter)

public RagBuilder AddDocuments(IDocumentLoader loader, string source, ITextSplitter textSplitter)

Parameters

loader IDocumentLoader

source string

textSplitter ITextSplitter

Returns

RagBuilder

AddDocuments(string)

public RagBuilder AddDocuments(string directoryPath)

Parameters

directoryPath string

Returns

RagBuilder

AddDocuments(string, Action<DocumentSourceBuilder>)

public RagBuilder AddDocuments(string directoryPath, Action<DocumentSourceBuilder> configure)

Parameters

directoryPath string

configure Action<DocumentSourceBuilder>

Returns

RagBuilder

AddExcel(string, IDocumentParser?, OfficeParserOptions?)

public RagBuilder AddExcel(string filePath, IDocumentParser? parser = null, OfficeParserOptions? options = null)

Parameters

filePath string

parser IDocumentParser

options OfficeParserOptions

Returns

RagBuilder

AddPowerPoint(string, IDocumentParser?, OfficeParserOptions?)

public RagBuilder AddPowerPoint(string filePath, IDocumentParser? parser = null, OfficeParserOptions? options = null)

Parameters

filePath string

parser IDocumentParser

options OfficeParserOptions

Returns

RagBuilder

AddText(string, string?)

public RagBuilder AddText(string text, string? id = null)

Parameters

text string

id string

Returns

RagBuilder

AddUrl(string)

public RagBuilder AddUrl(string url)

Parameters

url string

Returns

RagBuilder

AddWord(string, IDocumentParser?, OfficeParserOptions?)

public RagBuilder AddWord(string filePath, IDocumentParser? parser = null, OfficeParserOptions? options = null)

Parameters

filePath string

parser IDocumentParser

options OfficeParserOptions

Returns

RagBuilder

UseEmbedding(IEmbeddingProvider)

public RagBuilder UseEmbedding(IEmbeddingProvider provider)

Parameters

provider IEmbeddingProvider

Returns

RagBuilder

UseFileStore(string)

public RagBuilder UseFileStore(string directory)

Parameters

directory string

Returns

RagBuilder

UseHybridSearch(float, double?)

public RagBuilder UseHybridSearch(float vectorWeight = 0.5, double? minScore = null)

Parameters

vectorWeight float

minScore double?

Returns

RagBuilder

UseInMemoryStore()

public RagBuilder UseInMemoryStore()

Returns

RagBuilder

UseLocalEmbedding(int)

public RagBuilder UseLocalEmbedding(int dimensions = 1024)

Parameters

dimensions int

Returns

RagBuilder

UseOpenAIEmbedding(string, string, int)

public RagBuilder UseOpenAIEmbedding(string apiKey, string model = "text-embedding-3-small", int dimensions = 1536)

Parameters

apiKey string

model string

dimensions int

Returns

RagBuilder

UseStore(IVectorStore)

public RagBuilder UseStore(IVectorStore store)

Parameters

store IVectorStore

Returns

RagBuilder

UseVectorSearch()

public RagBuilder UseVectorSearch()

Returns

RagBuilder

WithChunkOverlap(int)

public RagBuilder WithChunkOverlap(int overlap)

Parameters

overlap int

Returns

RagBuilder

WithChunkSize(int)

public RagBuilder WithChunkSize(int chunkSize)

Parameters

chunkSize int

Returns

RagBuilder

WithContextBuilder(IContextBuilder)

public RagBuilder WithContextBuilder(IContextBuilder contextBuilder)

Parameters

contextBuilder IContextBuilder

Returns

RagBuilder

WithFinalSelectionPolicy(RagFinalSelectionMode, double)

public RagBuilder WithFinalSelectionPolicy(RagFinalSelectionMode mode, double retrievalWeight = 0.65)

Parameters

mode RagFinalSelectionMode

retrievalWeight double

Returns

RagBuilder

WithPromptTemplate(string)

public RagBuilder WithPromptTemplate(string template)

Parameters

template string

Returns

RagBuilder

WithQueryRewriter()

public RagBuilder WithQueryRewriter()

Returns

RagBuilder

WithQueryRewriter(IQueryRewriter)

public RagBuilder WithQueryRewriter(IQueryRewriter queryRewriter)

Parameters

queryRewriter IQueryRewriter

Returns

RagBuilder

WithQueryRewriter(uint)

public RagBuilder WithQueryRewriter(uint maxTokens)

Parameters

maxTokens uint

Returns

RagBuilder

WithReranker(IReranker)

public RagBuilder WithReranker(IReranker reranker)

Parameters

reranker IReranker

Returns

RagBuilder

WithRetrievalMinScore(double)

public RagBuilder WithRetrievalMinScore(double threshold)

Parameters

threshold double

Returns

RagBuilder

WithRetrievalMultiplier(int)

public RagBuilder WithRetrievalMultiplier(int multiplier)

Parameters

multiplier int

Returns

RagBuilder

WithScoreThreshold(double)

public RagBuilder WithScoreThreshold(double threshold)

Parameters

threshold double

Returns

RagBuilder

WithTextSplitter(ITextSplitter)

public RagBuilder WithTextSplitter(ITextSplitter textSplitter)

Parameters

textSplitter ITextSplitter

Returns

RagBuilder

WithTopK(int)

public RagBuilder WithTopK(int topK)

Parameters

topK int

Returns

RagBuilder