Documentation
¶
Index ¶
- Constants
- Variables
- func NewVectorStoreRetriever(vectorStore rag.VectorStore, embedder rag.Embedder, topK int) rag.Retriever
- type EntityExtractionResult
- type ExtractedEntity
- type ExtractedRelationship
- type GraphRAGEngine
- func (g *GraphRAGEngine) AddDocuments(ctx context.Context, docs []rag.Document) error
- func (g *GraphRAGEngine) DeleteDocument(ctx context.Context, docID string) error
- func (g *GraphRAGEngine) GetKnowledgeGraph() rag.KnowledgeGraph
- func (g *GraphRAGEngine) GetMetrics() *rag.Metrics
- func (g *GraphRAGEngine) Query(ctx context.Context, query string) (*rag.QueryResult, error)
- func (g *GraphRAGEngine) QueryWithConfig(ctx context.Context, query string, config *rag.RetrievalConfig) (*rag.QueryResult, error)
- func (g *GraphRAGEngine) SimilaritySearch(ctx context.Context, query string, k int) ([]rag.Document, error)
- func (g *GraphRAGEngine) SimilaritySearchWithScores(ctx context.Context, query string, k int) ([]rag.DocumentSearchResult, error)
- func (g *GraphRAGEngine) UpdateDocument(ctx context.Context, doc rag.Document) error
- type RelationshipExtractionResult
- type VectorRAGEngine
- func (v *VectorRAGEngine) AddDocuments(ctx context.Context, docs []rag.Document) error
- func (v *VectorRAGEngine) DeleteDocument(ctx context.Context, docID string) error
- func (v *VectorRAGEngine) GetMetrics() *rag.Metrics
- func (v *VectorRAGEngine) GetStats(ctx context.Context) (*rag.VectorStoreStats, error)
- func (v *VectorRAGEngine) GetVectorStore() rag.VectorStore
- func (v *VectorRAGEngine) Query(ctx context.Context, query string) (*rag.QueryResult, error)
- func (v *VectorRAGEngine) QueryWithConfig(ctx context.Context, query string, config *rag.RetrievalConfig) (*rag.QueryResult, error)
- func (v *VectorRAGEngine) SimilaritySearch(ctx context.Context, query string, k int) ([]rag.Document, error)
- func (v *VectorRAGEngine) SimilaritySearchWithScores(ctx context.Context, query string, k int) ([]rag.DocumentSearchResult, error)
- func (v *VectorRAGEngine) UpdateDocument(ctx context.Context, doc rag.Document) error
Constants ¶
const ( DefaultExtractionPrompt = `` /* 289-byte string literal not displayed */ RelationshipExtractionPrompt = `` /* 416-byte string literal not displayed */ )
Constants for default prompts and entity types
Variables ¶
var DefaultEntityTypes = []string{
"PERSON",
"ORGANIZATION",
"LOCATION",
"DATE",
"PRODUCT",
"EVENT",
"CONCEPT",
"TECHNOLOGY",
}
DefaultEntityTypes contains commonly used entity types
Functions ¶
func NewVectorStoreRetriever ¶
func NewVectorStoreRetriever(vectorStore rag.VectorStore, embedder rag.Embedder, topK int) rag.Retriever
NewVectorStoreRetriever creates a vector store retriever
Types ¶
type EntityExtractionResult ¶
type EntityExtractionResult struct {
Entities []ExtractedEntity `json:"entities"`
}
Supporting structs for JSON parsing
type ExtractedEntity ¶
type ExtractedRelationship ¶
type GraphRAGEngine ¶
type GraphRAGEngine struct {
// contains filtered or unexported fields
}
GraphRAGEngine implements GraphRAG functionality with knowledge graphs
func NewGraphRAGEngine ¶
func NewGraphRAGEngine(config rag.GraphRAGConfig, llm rag.LLMInterface, embedder rag.Embedder, kg rag.KnowledgeGraph) (*GraphRAGEngine, error)
NewGraphRAGEngine creates a new GraphRAG engine
func (*GraphRAGEngine) AddDocuments ¶
AddDocuments adds documents to the knowledge graph
func (*GraphRAGEngine) DeleteDocument ¶
func (g *GraphRAGEngine) DeleteDocument(ctx context.Context, docID string) error
DeleteDocument removes entities and relationships associated with a document
func (*GraphRAGEngine) GetKnowledgeGraph ¶
func (g *GraphRAGEngine) GetKnowledgeGraph() rag.KnowledgeGraph
GetKnowledgeGraph returns the underlying knowledge graph for advanced operations
func (*GraphRAGEngine) GetMetrics ¶
func (g *GraphRAGEngine) GetMetrics() *rag.Metrics
GetMetrics returns the current metrics
func (*GraphRAGEngine) Query ¶
func (g *GraphRAGEngine) Query(ctx context.Context, query string) (*rag.QueryResult, error)
Query performs a GraphRAG query
func (*GraphRAGEngine) QueryWithConfig ¶
func (g *GraphRAGEngine) QueryWithConfig(ctx context.Context, query string, config *rag.RetrievalConfig) (*rag.QueryResult, error)
QueryWithConfig performs a GraphRAG query with custom configuration
func (*GraphRAGEngine) SimilaritySearch ¶
func (g *GraphRAGEngine) SimilaritySearch(ctx context.Context, query string, k int) ([]rag.Document, error)
SimilaritySearch performs entity-based similarity search
func (*GraphRAGEngine) SimilaritySearchWithScores ¶
func (g *GraphRAGEngine) SimilaritySearchWithScores(ctx context.Context, query string, k int) ([]rag.DocumentSearchResult, error)
SimilaritySearchWithScores performs entity-based similarity search with scores
func (*GraphRAGEngine) UpdateDocument ¶
UpdateDocument updates a document in the knowledge graph
type RelationshipExtractionResult ¶
type RelationshipExtractionResult struct {
Relationships []ExtractedRelationship `json:"relationships"`
}
type VectorRAGEngine ¶
type VectorRAGEngine struct {
// contains filtered or unexported fields
}
VectorRAGEngine implements traditional vector-based RAG
func NewVectorRAGEngine ¶
func NewVectorRAGEngine(llm rag.LLMInterface, embedder rag.Embedder, vectorStore rag.VectorStore, k int) (*VectorRAGEngine, error)
NewVectorRAGEngine creates a new vector RAG engine
func NewVectorRAGEngineWithConfig ¶
func NewVectorRAGEngineWithConfig(llm rag.LLMInterface, embedder rag.Embedder, vectorStore rag.VectorStore, config rag.VectorRAGConfig) (*VectorRAGEngine, error)
NewVectorRAGEngineWithConfig creates a new vector RAG engine with custom configuration
func (*VectorRAGEngine) AddDocuments ¶
AddDocuments adds documents to the vector store
func (*VectorRAGEngine) DeleteDocument ¶
func (v *VectorRAGEngine) DeleteDocument(ctx context.Context, docID string) error
DeleteDocument removes documents from the vector store
func (*VectorRAGEngine) GetMetrics ¶
func (v *VectorRAGEngine) GetMetrics() *rag.Metrics
GetMetrics returns the current metrics
func (*VectorRAGEngine) GetStats ¶
func (v *VectorRAGEngine) GetStats(ctx context.Context) (*rag.VectorStoreStats, error)
GetStats returns vector store statistics
func (*VectorRAGEngine) GetVectorStore ¶
func (v *VectorRAGEngine) GetVectorStore() rag.VectorStore
GetVectorStore returns the underlying vector store for advanced operations
func (*VectorRAGEngine) Query ¶
func (v *VectorRAGEngine) Query(ctx context.Context, query string) (*rag.QueryResult, error)
Query performs a vector RAG query
func (*VectorRAGEngine) QueryWithConfig ¶
func (v *VectorRAGEngine) QueryWithConfig(ctx context.Context, query string, config *rag.RetrievalConfig) (*rag.QueryResult, error)
QueryWithConfig performs a vector RAG query with custom configuration
func (*VectorRAGEngine) SimilaritySearch ¶
func (v *VectorRAGEngine) SimilaritySearch(ctx context.Context, query string, k int) ([]rag.Document, error)
SimilaritySearch performs similarity search without generation
func (*VectorRAGEngine) SimilaritySearchWithScores ¶
func (v *VectorRAGEngine) SimilaritySearchWithScores(ctx context.Context, query string, k int) ([]rag.DocumentSearchResult, error)
SimilaritySearchWithScores performs similarity search with scores
func (*VectorRAGEngine) UpdateDocument ¶
UpdateDocument updates documents in the vector store
Source Files