Class RagPipeline

Namespace

Mythosia.AI.Rag

Assembly

Mythosia.AI.Rag.dll

public class RagPipeline : IRagPipeline

Inheritance

object

RagPipeline

Implements

IRagPipeline

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

RagDiagnosticsExtensions.Diagnose(RagPipeline)

Constructors

RagPipeline(IEmbeddingProvider, IVectorStore, ITextSplitter, IContextBuilder, IRetrievalStrategy?, IReranker?, RagPipelineOptions?)

public RagPipeline(IEmbeddingProvider embeddingProvider, IVectorStore vectorStore, ITextSplitter textSplitter, IContextBuilder contextBuilder, IRetrievalStrategy? retrievalStrategy, IReranker? reranker, RagPipelineOptions? options = null)

Parameters

embeddingProvider IEmbeddingProvider

vectorStore IVectorStore

textSplitter ITextSplitter

contextBuilder IContextBuilder

retrievalStrategy IRetrievalStrategy

reranker IReranker

options RagPipelineOptions

RagPipeline(IEmbeddingProvider, IVectorStore, ITextSplitter, IContextBuilder, RagPipelineOptions?)

public RagPipeline(IEmbeddingProvider embeddingProvider, IVectorStore vectorStore, ITextSplitter textSplitter, IContextBuilder contextBuilder, RagPipelineOptions? options = null)

Parameters

embeddingProvider IEmbeddingProvider

vectorStore IVectorStore

textSplitter ITextSplitter

contextBuilder IContextBuilder

options RagPipelineOptions

Properties

Options

public RagPipelineOptions Options { get; set; }

Property Value

RagPipelineOptions

Methods

DeleteDocumentAsync(string, CancellationToken)

public Task DeleteDocumentAsync(string documentId, CancellationToken cancellationToken = default)

Parameters

documentId string

cancellationToken CancellationToken

Returns

Task

IndexAsync(IDocumentLoader, string, CancellationToken)

public Task IndexAsync(IDocumentLoader loader, string source, CancellationToken cancellationToken = default)

Parameters

loader IDocumentLoader

source string

cancellationToken CancellationToken

Returns

Task

IndexDocumentAsync(RagDocument, ITextSplitter?, CancellationToken)

public Task IndexDocumentAsync(RagDocument document, ITextSplitter? textSplitter, CancellationToken cancellationToken = default)

Parameters

document RagDocument

textSplitter ITextSplitter

cancellationToken CancellationToken

Returns

Task

IndexDocumentAsync(RagDocument, CancellationToken)

public Task IndexDocumentAsync(RagDocument document, CancellationToken cancellationToken = default)

Parameters

document RagDocument

cancellationToken CancellationToken

Returns

Task

IndexDocumentsAsync(IEnumerable<RagDocument>, ITextSplitter?, CancellationToken)

public Task IndexDocumentsAsync(IEnumerable<RagDocument> documents, ITextSplitter? textSplitter, CancellationToken cancellationToken = default)

Parameters

documents IEnumerable<RagDocument>

textSplitter ITextSplitter

cancellationToken CancellationToken

Returns

Task

IndexDocumentsAsync(IEnumerable<RagDocument>, CancellationToken)

public Task IndexDocumentsAsync(IEnumerable<RagDocument> documents, CancellationToken cancellationToken = default)

Parameters

documents IEnumerable<RagDocument>

cancellationToken CancellationToken

Returns

Task

ProcessAsync(string, RagQueryOptions?, CancellationToken)

public Task<RagProcessedQuery> ProcessAsync(string query, RagQueryOptions? options, CancellationToken cancellationToken = default)

Parameters

query string

options RagQueryOptions

cancellationToken CancellationToken

Returns

Task<RagProcessedQuery>

ProcessAsync(string, CancellationToken)

public Task<RagProcessedQuery> ProcessAsync(string query, CancellationToken cancellationToken = default)

Parameters

query string

cancellationToken CancellationToken

Returns

Task<RagProcessedQuery>

QueryAndGenerateAsync(IAIService, string, RagQueryOptions?, VectorFilter?, CancellationToken)

public Task<string> QueryAndGenerateAsync(IAIService aiService, string query, RagQueryOptions? queryOptions, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

aiService IAIService

query string

queryOptions RagQueryOptions

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<string>

QueryAndGenerateAsync(IAIService, string, int?, VectorFilter?, CancellationToken)

public Task<string> QueryAndGenerateAsync(IAIService aiService, string query, int? topK = null, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

aiService IAIService

query string

topK int?

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<string>

QueryAsync(string, RagQueryOptions?, VectorFilter?, CancellationToken)

public Task<RagQueryResult> QueryAsync(string query, RagQueryOptions? queryOptions, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

query string

queryOptions RagQueryOptions

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<RagQueryResult>

QueryAsync(string, int?, VectorFilter?, CancellationToken)

public Task<RagQueryResult> QueryAsync(string query, int? topK = null, VectorFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

query string

topK int?

filter VectorFilter

cancellationToken CancellationToken

Returns

Task<RagQueryResult>

SetRetrievalStrategy(IRetrievalStrategy?)

public void SetRetrievalStrategy(IRetrievalStrategy? retrievalStrategy)

Parameters

retrievalStrategy IRetrievalStrategy