Tree

Contents:

• Introduction
• User Guide: RAG
  • Quickstart
  • GraphRAG Configuration
    • Using Another LLM Model
      • Using Azure Open AI LLM
      • Using VertexAI LLM
      • Using Anthropic LLM
      • Using MistralAI LLM
      • Using Cohere LLM
      • Using a Local Model via Ollama
      • Using a Model from LangChain
      • Using a Custom Model
    • Configuring the Prompt
  • Retriever Configuration
    • Vector Retriever
      • Search Similar Vector
      • Search Similar Text
      • Embedders
      • Other Vector Retriever Configuration
      • Pre-Filters
    • Vector Cypher Retriever
      • Retrieval Query
      • Format the Results
    • Vector Databases
      • Weaviate Retrievers
      • Pinecone Retrievers
      • Qdrant Retrievers
    • Other Retrievers
      • Hybrid Retrievers
      • Hybrid Cypher Retrievers
      • Text2Cypher Retriever
    • Custom Retriever
  • DB Operations
    • Create a Vector Index
    • Populate a Vector Index
    • Drop a Vector Index
• User Guide: Knowledge Graph Builder
  • Pipeline Structure
  • Simple KG Pipeline
    • Customizing the SimpleKGPipeline
      • Graph Schema
      • Prompt Template, Lexical Graph Config and Error Behavior
      • Skip Entity Resolution
      • Neo4j Database
      • Using Custom Components
    • Using a Config file
      • Defining a Neo4j Driver
      • Parameter resolution
      • Defining an LLM
      • Defining an Embedder
      • Other configuration
  • Knowledge Graph Builder Components
    • Data Loader
    • Text Splitter
    • Chunk Embedder
    • Lexical Graph Builder
    • Neo4j Chunk Reader
      • Configure node labels and relationship types
    • Schema Builder
    • Entity and Relation Extractor
      • Error Behaviour
      • Lexical Graph
      • Customizing the Prompt
      • Subclassing the EntityRelationExtractor
    • Knowledge Graph Writer
    • Entity Resolver
      • Filter Query Parameter
• User Guide: Pipeline
  • Creating Components
  • Connecting Components within a Pipeline
  • Visualising a Pipeline
  • Adding an Event Callback
• API Documentation
  • Components
    • DataLoader
      • DataLoader
        • DataLoader.get_document_metadata()
        • DataLoader.run()
    • PdfLoader
      • PdfLoader
        • PdfLoader.load_file()
        • PdfLoader.run()
    • TextSplitter
      • TextSplitter
        • TextSplitter.run()
    • FixedSizeSplitter
      • FixedSizeSplitter
        • FixedSizeSplitter.run()
    • LangChainTextSplitterAdapter
      • LangChainTextSplitterAdapter
        • LangChainTextSplitterAdapter.run()
    • LlamaIndexTextSplitterAdapter
      • LlamaIndexTextSplitterAdapter
        • LlamaIndexTextSplitterAdapter.run()
    • TextChunkEmbedder
      • TextChunkEmbedder
        • TextChunkEmbedder.run()
    • LexicalGraphBuilder
      • LexicalGraphBuilder
        • LexicalGraphBuilder.run()
        • LexicalGraphBuilder.process_chunk()
        • LexicalGraphBuilder.create_document_node()
        • LexicalGraphBuilder.create_chunk_node()
        • LexicalGraphBuilder.create_chunk_to_document_rel()
        • LexicalGraphBuilder.create_next_chunk_relationship()
        • LexicalGraphBuilder.create_node_to_chunk_rel()
        • LexicalGraphBuilder.process_chunk_extracted_entities()
    • Neo4jChunkReader
      • Neo4jChunkReader
        • Neo4jChunkReader.run()
    • SchemaBuilder
      • SchemaBuilder
        • SchemaBuilder.run()
    • EntityRelationExtractor
      • EntityRelationExtractor
        • EntityRelationExtractor.run()
        • EntityRelationExtractor.update_ids()
    • LLMEntityRelationExtractor
      • LLMEntityRelationExtractor
        • LLMEntityRelationExtractor.run()
    • KGWriter
      • KGWriter
        • KGWriter.run()
    • Neo4jWriter
      • Neo4jWriter
        • Neo4jWriter.run()
    • SinglePropertyExactMatchResolver
      • SinglePropertyExactMatchResolver
        • SinglePropertyExactMatchResolver.run()
  • Pipelines
    • Pipeline
      • Pipeline
        • Pipeline.draw()
        • Pipeline.add_component()
        • Pipeline.connect()
        • Pipeline.run()
    • SimpleKGPipeline
      • SimpleKGPipeline
        • SimpleKGPipeline.run_async()
  • Config files
    • SimpleKGPipelineConfig
      • SimpleKGPipelineConfig
    • PipelineRunner
      • PipelineRunner
  • Retrievers
    • RetrieverInterface
      • Retriever
        • Retriever.index_name
        • Retriever.VERIFY_NEO4J_VERSION
        • Retriever.search()
        • Retriever.get_search_results()
        • Retriever.get_result_formatter()
        • Retriever.default_record_formatter()
    • VectorRetriever
      • VectorRetriever
        • VectorRetriever.search()
    • VectorCypherRetriever
      • VectorCypherRetriever
        • VectorCypherRetriever.search()
    • HybridRetriever
      • HybridRetriever
        • HybridRetriever.search()
    • HybridCypherRetriever
      • HybridCypherRetriever
        • HybridCypherRetriever.search()
    • Text2CypherRetriever
      • Text2CypherRetriever
        • Text2CypherRetriever.search()
  • External Retrievers
    • WeaviateNeo4jRetriever
      • WeaviateNeo4jRetriever
        • WeaviateNeo4jRetriever.search()
    • PineconeNeo4jRetriever
      • PineconeNeo4jRetriever
        • PineconeNeo4jRetriever.search()
    • QdrantNeo4jRetriever
      • QdrantNeo4jRetriever
        • QdrantNeo4jRetriever.search()
  • Embedder
    • Embedder
      • Embedder.embed_query()
    • SentenceTransformerEmbeddings
      • SentenceTransformerEmbeddings
        • SentenceTransformerEmbeddings.embed_query()
    • OpenAIEmbeddings
      • OpenAIEmbeddings
    • AzureOpenAIEmbeddings
      • AzureOpenAIEmbeddings
    • OllamaEmbeddings
      • OllamaEmbeddings
        • OllamaEmbeddings.embed_query()
    • VertexAIEmbeddings
      • VertexAIEmbeddings
        • VertexAIEmbeddings.embed_query()
    • MistralAIEmbeddings
      • MistralAIEmbeddings
        • MistralAIEmbeddings.embed_query()
    • CohereEmbeddings
      • CohereEmbeddings
        • CohereEmbeddings.embed_query()
  • Generation
    • LLM
      • LLMInterface
        • LLMInterface
          • LLMInterface.invoke()
          • LLMInterface.ainvoke()
      • OpenAILLM
        • OpenAILLM
      • AzureOpenAILLM
        • AzureOpenAILLM
      • OllamaLLM
        • OllamaLLM
          • OllamaLLM.get_messages()
          • OllamaLLM.invoke()
          • OllamaLLM.ainvoke()
      • VertexAILLM
        • VertexAILLM
          • VertexAILLM.get_messages()
          • VertexAILLM.invoke()
          • VertexAILLM.ainvoke()
      • AnthropicLLM
        • AnthropicLLM
          • AnthropicLLM.get_messages()
          • AnthropicLLM.invoke()
          • AnthropicLLM.ainvoke()
      • CohereLLM
        • CohereLLM
          • CohereLLM.get_messages()
          • CohereLLM.invoke()
          • CohereLLM.ainvoke()
      • MistralAILLM
        • MistralAILLM
          • MistralAILLM.get_messages()
          • MistralAILLM.invoke()
          • MistralAILLM.ainvoke()
    • PromptTemplate
      • PromptTemplate
        • PromptTemplate.DEFAULT_SYSTEM_INSTRUCTIONS
        • PromptTemplate.DEFAULT_TEMPLATE
        • PromptTemplate.EXPECTED_INPUTS
        • PromptTemplate.format()
      • RagTemplate
        • RagTemplate
          • RagTemplate.DEFAULT_SYSTEM_INSTRUCTIONS
          • RagTemplate.DEFAULT_TEMPLATE
          • RagTemplate.EXPECTED_INPUTS
      • ERExtractionTemplate
        • ERExtractionTemplate
          • ERExtractionTemplate.DEFAULT_TEMPLATE
          • ERExtractionTemplate.EXPECTED_INPUTS
      • Text2CypherTemplate
        • Text2CypherTemplate
          • Text2CypherTemplate.DEFAULT_TEMPLATE
          • Text2CypherTemplate.EXPECTED_INPUTS
  • RAG
    • GraphRAG
      • GraphRAG
        • GraphRAG.search()
        • GraphRAG.conversation_prompt()
  • Database Interaction
    • create_vector_index()
    • create_fulltext_index()
    • drop_index_if_exists()
    • upsert_vectors()
    • upsert_vector()
    • upsert_vector_on_relationship()
    • async_upsert_vector()
    • async_upsert_vector_on_relationship()
    • retrieve_vector_index_info()
    • retrieve_fulltext_index_info()
    • get_structured_schema()
    • get_schema()
    • format_schema()
  • Message History
    • InMemoryMessageHistory
    • Neo4jMessageHistory
  • Errors
    • Neo4jGraphRagError
      • Neo4jGraphRagError
    • RetrieverInitializationError
      • RetrieverInitializationError
    • SearchValidationError
      • SearchValidationError
    • FilterValidationError
      • FilterValidationError
    • EmbeddingsGenerationError
      • EmbeddingsGenerationError
    • EmbeddingRequiredError
      • EmbeddingRequiredError
    • InvalidRetrieverResultError
      • InvalidRetrieverResultError
    • Neo4jIndexError
      • Neo4jIndexError
    • Neo4jInsertionError
      • Neo4jInsertionError
    • Neo4jVersionError
      • Neo4jVersionError
    • Text2CypherRetrievalError
      • Text2CypherRetrievalError
    • SchemaFetchError
      • SchemaFetchError
    • RagInitializationError
      • RagInitializationError
    • PromptMissingInputError
      • PromptMissingInputError
    • LLMGenerationError
      • LLMGenerationError
    • PipelineDefinitionError
      • PipelineDefinitionError
    • PipelineMissingDependencyError
      • PipelineMissingDependencyError
    • PipelineStatusUpdateError
      • PipelineStatusUpdateError
    • InvalidJSONError
      • InvalidJSONError
• Types
  • RawSearchResult
    • RawSearchResult
      • RawSearchResult.records
      • RawSearchResult.metadata
  • RetrieverResult
    • RetrieverResult
      • RetrieverResult.items
      • RetrieverResult.metadata
  • RetrieverResultItem
    • RetrieverResultItem
      • RetrieverResultItem.content
      • RetrieverResultItem.metadata
  • LLMResponse
    • LLMResponse
  • LLMMessage
    • LLMMessage
  • RagResultModel
    • RagResultModel
  • DocumentInfo
    • DocumentInfo
      • DocumentInfo.path
      • DocumentInfo.metadata
      • DocumentInfo.uid
  • TextChunk
    • TextChunk
      • TextChunk.text
      • TextChunk.index
      • TextChunk.metadata
      • TextChunk.uid
  • TextChunks
    • TextChunks
      • TextChunks.chunks
  • Neo4jNode
    • Neo4jNode
      • Neo4jNode.id
      • Neo4jNode.label
      • Neo4jNode.properties
      • Neo4jNode.embedding_properties
  • Neo4jRelationship
    • Neo4jRelationship
      • Neo4jRelationship.start_node_id
      • Neo4jRelationship.end_node_id
      • Neo4jRelationship.type
      • Neo4jRelationship.properties
      • Neo4jRelationship.embedding_properties
  • Neo4jGraph
    • Neo4jGraph
      • Neo4jGraph.nodes
      • Neo4jGraph.relationships
  • KGWriterModel
    • KGWriterModel
      • KGWriterModel.status
  • SchemaProperty
    • SchemaProperty
  • SchemaEntity
    • SchemaEntity
  • SchemaRelation
    • SchemaRelation
  • SchemaConfig
    • SchemaConfig
  • LexicalGraphConfig
    • LexicalGraphConfig
  • Neo4jDriverType
    • Neo4jDriverType
  • Neo4jDriverConfig
    • Neo4jDriverConfig
  • LLMType
    • LLMType
  • LLMConfig
    • LLMConfig
  • EmbedderType
    • EmbedderType
  • EmbedderConfig
    • EmbedderConfig
  • ComponentType
    • ComponentType
  • ComponentConfig
    • ComponentConfig
  • ParamFromEnvConfig
    • ParamFromEnvConfig
  • EventType
    • EventType
      • EventType.PIPELINE_STARTED
      • EventType.TASK_STARTED
      • EventType.TASK_FINISHED
      • EventType.PIPELINE_FINISHED
  • PipelineEvent
    • PipelineEvent
  • TaskEvent
    • TaskEvent
  • EventCallbackProtocol
    • EventCallbackProtocol
      • EventCallbackProtocol.__call__()