abstracts-explorer

User Guide

  • Web Interface
    • Search Abstracts
    • AI Chat
    • Interesting Papers
    • Conference Statistics
      • Papers Per Year
      • Custom Topic Search
      • Embedding Clusters
    • Starting the Web UI
      • Quick Start
      • Command-line options
      • Docker / Podman
  • Usage Guide
    • Basic Workflow
      • 1. Download Papers
      • 2. Create Embeddings
      • 3. Search Papers
      • 4. Chat with Papers (RAG)
    • Python API
      • Database Operations
      • Downloading Papers
      • Embeddings
      • RAG Chat
    • Advanced Usage
      • Batch Processing
      • Custom Configuration
      • Programmatic Search
  • Docker and Podman Setup Guide
    • Rootless Containers with Podman Quadlets (recommended systemd-native setup)
      • Architecture
      • Automated install
      • Configuration
      • Managing secrets
      • Checking status and logs
      • Updating containers
      • Download data
        • Get pre-computed data from the registry
        • Run the full pipeline inside the container
        • Migrate existing data
    • Available Images
    • Security hardening
    • Testing Pull Requests
    • Data Persistence
      • Backup
      • Restore
    • Traditional Docker Compose Setup (deprecated)
      • 1. Create .env File
      • 2. Download the compose file
      • 3. Start Services
      • HTTPS / SSL Setup
    • Further Reading
    • Support
  • Installation
    • Requirements
    • Install uv
    • Install from Source
    • Python Dependencies
      • Development Dependencies
      • Web Interface Dependencies
      • Documentation Dependencies
    • Node.js Dependencies
      • Vendor Files
    • Optional Dependencies
    • Verify Installation
    • Troubleshooting
      • Missing Vendor Files
      • Node.js Not Found
      • Python Version Issues
    • Quick Start: Download Pre-Built Data from a Registry
  • Configuration
    • Configuration Priority
    • Configuration File
    • Available Settings
      • Chat/Language Model Settings
      • Embedding Model Settings
      • LLM Backend Configuration
      • Data Directory
      • Database Configuration
        • Paper Database
        • Embedding Database
      • RAG Settings
      • Registry Settings
    • Example Configurations
      • Local Development (SQLite)
      • Production/Docker (PostgreSQL)
      • Alternative: Absolute Paths
    • Using Configuration in Code
    • Environment Variables
    • Security Best Practices
  • Registry: Sharing Data via OCI Container Registries
    • Overview
    • Authentication
    • Commands
      • registry upload
      • registry download
      • registry list
    • Tag Format
    • Typical Workflow
      • Uploading data from one instance
      • Downloading data on another instance
    • Data Integrity
    • Docker / Container Usage
  • Plugin System
    • Overview
    • Available Plugins
      • neurips
      • ml4ps
      • haicon
    • Using Plugins via CLI
      • List Available Plugins
      • Download with a Plugin
    • Creating Your Own Plugin
      • When to Use Each API
      • Lightweight API (Recommended)
        • Required Fields
        • Optional Fields
        • Example: Simple Workshop Plugin
        • Using Your Plugin
        • Flexible Author Format
      • Full Schema API
        • Example: Advanced Plugin
    • Schema Conversion
      • Converter Parameters
    • Plugin Installation
      • From Package
      • External Plugin
    • Testing Your Plugin
      • Unit Test Example
      • Manual Testing
    • Best Practices
      • 1. Error Handling
      • 2. Caching
      • 3. Logging
      • 4. Progress Indication
      • 5. Rate Limiting
    • API Comparison
    • See Also
  • Command-Line Interface Reference
    • Global Options
    • Commands
      • download
      • create-embeddings
      • search
      • chat
      • info
      • registry
        • registry upload
        • registry download
        • registry list
    • Environment Variables
    • Exit Codes
  • MCP Server for Cluster Analysis
    • What is MCP?
    • Features
      • 1. get_conference_topics
      • 2. get_topic_evolution
      • 3. search_papers
      • 4. get_cluster_visualization
    • Starting the MCP Server
      • Basic Usage
      • Custom Host and Port
      • STDIO Transport
    • Configuration
    • Integration with LLM Assistants
      • RAG Chat Integration (Recommended)
      • Claude Desktop Integration
      • Example Tool Call
    • API Reference
      • Tool Response Format
      • Error Handling
    • Requirements
    • Troubleshooting
      • “No embeddings found”
      • “Failed to connect to database”
      • Port already in use
    • Advanced Usage
      • Custom Clustering Parameters
      • Filtering by Conference
    • See Also

API Reference

  • API Reference
    • Core Modules
    • Plugin & Registry
    • MCP Integration
    • Utilities
  • Database Module
    • Overview
    • Class Reference
      • DatabaseError
      • EmbeddingModelConflictError
        • EmbeddingModelConflictError.__init__()
      • normalize_model_name()
      • DatabaseManager
        • DatabaseManager.__init__()
        • DatabaseManager.connect()
        • DatabaseManager.close()
        • DatabaseManager.__enter__()
        • DatabaseManager.__exit__()
        • DatabaseManager.compute_uid()
        • DatabaseManager.create_tables()
        • DatabaseManager.add_paper()
        • DatabaseManager.add_papers()
        • DatabaseManager.donate_validation_data()
        • DatabaseManager.donate_chat_transcript()
        • DatabaseManager.get_chat_donations()
        • DatabaseManager.get_chat_donation_stats()
        • DatabaseManager.get_validation_data()
        • DatabaseManager.get_validation_data_stats()
        • DatabaseManager.delete_chat_donations()
        • DatabaseManager.delete_validation_data()
        • DatabaseManager.query()
        • DatabaseManager.get_paper_count()
        • DatabaseManager.get_paper_by_uid()
        • DatabaseManager.get_paper_by_original_id_or_uid()
        • DatabaseManager.SEARCHABLE_FIELDS
        • DatabaseManager.FIELD_ALIASES
        • DatabaseManager.search_papers()
        • DatabaseManager.parse_field_filters()
        • DatabaseManager.search_papers_keyword()
        • DatabaseManager.get_stats()
        • DatabaseManager.get_author_count()
        • DatabaseManager.get_years_for_conference()
        • DatabaseManager.get_conference_years_from_db()
        • DatabaseManager.resolve_default_conference_year()
        • DatabaseManager.resolve_conference_name()
        • DatabaseManager.resolve_conference_for_url()
        • DatabaseManager.get_sessions()
        • DatabaseManager.get_conferences()
        • DatabaseManager.get_years()
        • DatabaseManager.get_embedding_model()
        • DatabaseManager.set_embedding_model()
        • DatabaseManager.get_clustering_cache()
        • DatabaseManager.save_clustering_cache()
        • DatabaseManager.delete_papers_by_conference_year()
        • DatabaseManager.delete_clustering_cache_by_conference_year()
        • DatabaseManager.count_clustering_cache_by_conference_year()
        • DatabaseManager.clear_clustering_cache()
        • DatabaseManager.update_clustering_cache_embedding_model()
        • DatabaseManager.get_hierarchical_label_cache()
        • DatabaseManager.save_hierarchical_label_cache()
        • DatabaseManager.add_eval_qa_pair()
        • DatabaseManager.get_eval_qa_pairs()
        • DatabaseManager.get_eval_qa_pair_count()
        • DatabaseManager.update_eval_qa_pair()
        • DatabaseManager.delete_eval_qa_pair()
        • DatabaseManager.delete_verified_eval_qa_pairs()
        • DatabaseManager.delete_eval_results()
        • DatabaseManager.add_eval_result()
        • DatabaseManager.get_eval_results()
        • DatabaseManager.get_eval_run_ids()
        • DatabaseManager.get_eval_run_summary()
        • DatabaseManager.export_papers_to_sqlite()
        • DatabaseManager.import_papers_from_sqlite()
        • DatabaseManager.export_clustering_cache_to_json()
        • DatabaseManager.import_clustering_cache_from_json()
    • Usage Examples
      • Basic Operations
      • Searching Papers
      • Retrieving Data
    • Database Schema
      • papers Table
      • authors Table
    • Error Handling
  • Embeddings Module
    • Overview
    • Class Reference
      • RateLimitedTransport
        • RateLimitedTransport.__init__()
        • RateLimitedTransport.handle_request()
        • RateLimitedTransport.close()
      • AsyncRateLimitedTransport
        • AsyncRateLimitedTransport.__init__()
        • AsyncRateLimitedTransport.handle_async_request()
        • AsyncRateLimitedTransport.aclose()
      • EmbeddingsError
      • EmbeddingsManager
        • EmbeddingsManager.__init__()
        • EmbeddingsManager.client
        • EmbeddingsManager.collection
        • EmbeddingsManager.openai_client
        • EmbeddingsManager.connect()
        • EmbeddingsManager.close()
        • EmbeddingsManager.__enter__()
        • EmbeddingsManager.__exit__()
        • EmbeddingsManager.test_lm_studio_connection()
        • EmbeddingsManager.generate_embedding()
        • EmbeddingsManager.create_collection()
        • EmbeddingsManager.paper_exists()
        • EmbeddingsManager.paper_needs_update()
        • EmbeddingsManager.embedding_text_from_paper()
        • EmbeddingsManager.parse_chromadb_metadata()
        • EmbeddingsManager.add_paper()
        • EmbeddingsManager.search_similar()
        • EmbeddingsManager.get_collection_stats()
        • EmbeddingsManager.check_model_compatibility()
        • EmbeddingsManager.embed_from_database()
        • EmbeddingsManager.search_papers_semantic()
        • EmbeddingsManager.count_papers_within_distance()
        • EmbeddingsManager.find_papers_within_distance()
        • EmbeddingsManager.delete_embeddings_by_filter()
        • EmbeddingsManager.export_embeddings()
        • EmbeddingsManager.import_embeddings()
        • EmbeddingsManager.update_paper_metadata()
    • Usage Examples
      • Basic Setup
      • Creating Embeddings
      • Semantic Search
      • Filtered Search
    • Embedding Models
      • Popular Models
      • Configuring Model
    • ChromaDB Integration
      • Collection Structure
      • Collection Management
    • Search Results Format
    • Performance Considerations
      • Batch Processing
      • Caching
      • Memory Usage
    • Error Handling
    • Best Practices
  • Clustering Module
    • Features
    • Quick Start
    • API Reference
      • Cluster Labeling
      • Hierarchical Clustering
      • ClusteringError
      • calculate_default_clusters()
      • ClusteringManager
        • ClusteringManager.__init__()
        • ClusteringManager.load_embeddings()
        • ClusteringManager.reduce_dimensions()
        • ClusteringManager.cluster()
        • ClusteringManager.get_hierarchy_level_clusters()
        • ClusteringManager.generate_hierarchical_labels()
        • ClusteringManager.get_cluster_statistics()
        • ClusteringManager.extract_cluster_keywords()
        • ClusteringManager.generate_cluster_labels()
        • ClusteringManager.get_cluster_representative_papers()
        • ClusteringManager.get_clustering_results()
        • ClusteringManager.export_to_json()
      • perform_clustering()
      • compute_clusters_with_cache()
  • RAG Module
    • Overview
    • Class Reference
      • RAGError
      • RAGDeps
        • RAGDeps.tool_results
        • RAGDeps.conferences
        • RAGDeps.years
        • RAGDeps.__init__()
      • RAGChat
        • RAGChat.__init__()
        • RAGChat.query()
        • RAGChat.chat()
        • RAGChat.reset_conversation()
        • RAGChat.conversation_history
        • RAGChat.export_conversation()
    • Usage Examples
      • Basic Setup
      • Simple Query
      • Conversation
      • Custom Parameters
    • MCP Clustering Tools Integration
      • What Are MCP Tools?
      • How It Works
      • Tool Selection
      • Disabling MCP Tools
      • Combining Tools with RAG
      • Tool Call Examples
      • Advanced: Tool Call Debugging
      • Requirements
      • Metadata Filtering
    • Conversation Management
      • Reset Conversation
      • Export Conversation
      • Conversation Format
    • LLM Backend Configuration
      • Supported Backends
      • Authentication
      • Custom Endpoints
    • Response Generation
      • How RAG Works
      • Context Building
      • System Prompts
    • Error Handling
    • Performance Considerations
      • Response Time
      • Memory Usage
      • Optimization Tips
    • Best Practices
  • Config Module
    • Overview
    • Class Reference
      • load_env_file()
      • Config
        • Config.__init__()
        • Config.get_supported_env_vars()
        • Config.to_dict()
        • Config.__repr__()
      • get_config()
    • Usage Examples
      • Getting Configuration
      • Configuration Values
      • Custom .env File
    • Configuration Priority
      • Example Priority
    • .env File Format
      • Supported Features
      • Not Supported
    • Type Conversion
    • Default Values
    • Configuration in Tests
      • Overriding in Tests
    • Security Best Practices
      • Do Not Commit Secrets
      • Use Environment Variables in Production
      • Provide Template
    • Best Practices
  • Plugin Module
    • Overview
    • Available Plugins
    • Quick Start
    • Creating a Custom Plugin
    • API Reference
      • Plugin Framework
      • DownloaderPlugin
        • DownloaderPlugin.plugin_name
        • DownloaderPlugin.plugin_description
        • DownloaderPlugin.supported_years
        • DownloaderPlugin.get_url()
        • DownloaderPlugin.download()
        • DownloaderPlugin.get_metadata()
        • DownloaderPlugin.validate_year()
      • LightweightDownloaderPlugin
        • LightweightDownloaderPlugin.plugin_name
        • LightweightDownloaderPlugin.plugin_description
      • PluginRegistry
        • PluginRegistry.__init__()
        • PluginRegistry.register()
        • PluginRegistry.unregister()
        • PluginRegistry.get()
        • PluginRegistry.list_plugins()
        • PluginRegistry.list_plugin_names()
      • register_plugin()
      • get_plugin()
      • list_plugins()
      • list_plugin_names()
      • convert_to_lightweight_schema()
      • LightweightPaper
        • LightweightPaper.title
        • LightweightPaper.authors
        • LightweightPaper.abstract
        • LightweightPaper.session
        • LightweightPaper.poster_position
        • LightweightPaper.year
        • LightweightPaper.conference
        • LightweightPaper.original_id
        • LightweightPaper.paper_pdf_url
        • LightweightPaper.poster_image_url
        • LightweightPaper.url
        • LightweightPaper.room_name
        • LightweightPaper.keywords
        • LightweightPaper.starttime
        • LightweightPaper.endtime
        • LightweightPaper.award
        • LightweightPaper.validate_title()
        • LightweightPaper.validate_authors()
        • LightweightPaper.validate_abstract()
        • LightweightPaper.validate_session()
        • LightweightPaper.validate_conference()
        • LightweightPaper.validate_year()
        • LightweightPaper.model_config
      • sanitize_author_names()
      • validate_lightweight_paper()
      • validate_lightweight_papers()
  • Registry Module
    • Overview
    • Quick Start
    • API Reference
      • RegistryError
      • EmbeddingModelMismatchError
        • EmbeddingModelMismatchError.__init__()
      • RegistryClient
        • RegistryClient.__init__()
        • RegistryClient.list_tags()
        • RegistryClient.clear_local_embedding_data()
        • RegistryClient.upload()
        • RegistryClient.download()
        • RegistryClient.upload_all()
        • RegistryClient.download_all()
        • RegistryClient.get_artifact_info()
        • RegistryClient.delete_old_versions()
  • MCP Server Module
    • Features
    • Quick Start
    • API Reference
      • MCP Server for Cluster Analysis
      • ClusterAnalysisError
      • load_clustering_data()
      • analyze_cluster_topics()
      • get_conference_topics()
      • merge_where_clause_with_conference()
      • merge_where_clause_with_years()
      • get_topic_evolution()
      • search_papers()
      • get_paper_details()
      • analyze_topic_relevance()
      • get_cluster_visualization()
      • run_mcp_server()
  • MCP Tools Module
    • Overview
    • Quick Start
    • API Reference
      • MCP Tools Integration for RAG Chat
      • MCPToolsError
      • execute_mcp_tool()
      • get_mcp_tools_schema()
      • format_tool_result_for_llm()
  • Export Utilities Module
    • Features
    • Quick Start
    • API Reference
      • natural_sort_key()
      • fetch_conference_info()
      • get_poster_url()
      • generate_all_papers_markdown()
      • generate_search_term_markdown()
      • generate_main_readme()
      • generate_folder_structure_export()
      • export_papers_to_zip()
  • Paper Utilities Module
    • Quick Start
    • API Reference
      • PaperFormattingError
      • format_search_results()
      • build_context_from_papers()
      • extract_top_keywords()
  • Database Models Module
    • Models
    • Quick Start
    • API Reference
      • Database Models
      • Base
        • Base.__init__()
      • Paper
        • Paper.uid
        • Paper.original_id
        • Paper.title
        • Paper.authors
        • Paper.abstract
        • Paper.session
        • Paper.poster_position
        • Paper.paper_pdf_url
        • Paper.poster_image_url
        • Paper.url
        • Paper.room_name
        • Paper.keywords
        • Paper.starttime
        • Paper.endtime
        • Paper.award
        • Paper.year
        • Paper.conference
        • Paper.created_at
        • Paper.__repr__()
        • Paper.__init__()
      • EmbeddingsMetadata
        • EmbeddingsMetadata.id
        • EmbeddingsMetadata.embedding_model
        • EmbeddingsMetadata.created_at
        • EmbeddingsMetadata.updated_at
        • EmbeddingsMetadata.__repr__()
        • EmbeddingsMetadata.__init__()
      • ClusteringCache
        • ClusteringCache.id
        • ClusteringCache.embedding_model
        • ClusteringCache.conference
        • ClusteringCache.year
        • ClusteringCache.reduction_method
        • ClusteringCache.n_components
        • ClusteringCache.clustering_method
        • ClusteringCache.n_clusters
        • ClusteringCache.clustering_params
        • ClusteringCache.results_json
        • ClusteringCache.created_at
        • ClusteringCache.__repr__()
        • ClusteringCache.__init__()
      • HierarchicalLabelCache
        • HierarchicalLabelCache.id
        • HierarchicalLabelCache.embedding_model
        • HierarchicalLabelCache.linkage
        • HierarchicalLabelCache.labels_json
        • HierarchicalLabelCache.created_at
        • HierarchicalLabelCache.__repr__()
        • HierarchicalLabelCache.__init__()
      • ValidationData
        • ValidationData.id
        • ValidationData.paper_uid
        • ValidationData.priority
        • ValidationData.search_term
        • ValidationData.donated_at
        • ValidationData.__repr__()
        • ValidationData.__init__()
      • ChatDonation
        • ChatDonation.id
        • ChatDonation.rating
        • ChatDonation.transcript
        • ChatDonation.donated_at
        • ChatDonation.__repr__()
        • ChatDonation.__init__()
      • EvalQAPair
        • EvalQAPair.id
        • EvalQAPair.conversation_id
        • EvalQAPair.turn_number
        • EvalQAPair.query
        • EvalQAPair.expected_answer
        • EvalQAPair.tool_name
        • EvalQAPair.verified
        • EvalQAPair.source_info
        • EvalQAPair.created_at
        • EvalQAPair.updated_at
        • EvalQAPair.__repr__()
        • EvalQAPair.__init__()
      • EvalResult
        • EvalResult.id
        • EvalResult.run_id
        • EvalResult.qa_pair_id
        • EvalResult.actual_answer
        • EvalResult.actual_tool_name
        • EvalResult.answer_score
        • EvalResult.tool_correct
        • EvalResult.latency_ms
        • EvalResult.error
        • EvalResult.judge_reasoning
        • EvalResult.created_at
        • EvalResult.__repr__()
        • EvalResult.__init__()
  • Evaluation Module
    • Features
    • Quick Start
    • API Reference
      • Automatic Evaluation
      • EvaluationError
      • format_eval_summary()
      • format_eval_result_detail()
      • Evaluator
        • Evaluator.__init__()
        • Evaluator.openai_client
        • Evaluator.generate_qa_pairs()
        • Evaluator.store_qa_pairs()
        • Evaluator.run_evaluation()
        • Evaluator.format_run_summary()

Development

  • Contributing
    • Development Setup
      • 1. Clone Repository
      • 2. Install uv
      • 3. Install Dependencies
      • 4. Configure Environment
    • Docker Development Setup
      • Quick Start
      • Running Commands in Container
      • Development Workflow
    • Code Style
      • Python Style
      • Example Function
    • Testing
      • Python Testing
        • Running Python Tests
        • Python Test Organization
        • Writing Python Tests
        • Example Python Test
      • JavaScript Testing
        • Running JavaScript Tests
        • JavaScript Test Coverage
        • JavaScript Test Organization
        • Writing JavaScript Tests
        • Example JavaScript Test
        • Viewing Coverage Reports
    • Documentation
      • Docstrings
      • Building Documentation
      • Updating Documentation
    • Pull Request Process
      • 1. Create Branch
      • 2. Make Changes
      • 3. Commit Changes
      • 4. Push Branch
      • 5. Create Pull Request
    • Code Review
      • What We Look For
      • Review Process
    • Database Backend Support
      • Architecture
      • Working with Databases
    • Development Guidelines
      • Adding New Features
      • Fixing Bugs
      • Refactoring
    • Performance
      • Benchmarking
      • Profiling
    • Security Considerations
      • Debug Mode and Production Server
    • Questions?
  • Branching Strategy
    • Overview
    • Branch types
      • main
      • develop
      • Feature branches
      • Hotfix branches
    • Release workflow
    • Staging end-to-end tests
      • 1. Application startup
      • 2. Core search functionality
      • 3. Paper display
      • 4. Chat (RAG) interface
        • MCP tool smoke tests
      • 5. Clustering tab
      • 6. Accessibility & responsiveness
  • Codebase Architecture & Flow-Charts
    • Module Overview
    • High-Level Module Dependency Graph
    • CLI Command Flow
    • Data Pipeline Flow
    • Database Layer Flow
    • Embeddings & Clustering Flow
    • RAG Chat & MCP Tools Flow
    • Web UI Request Flow
    • Export & Paper Utilities Flow
    • Registry Upload/Download Flow
    • Summary of Duplicate Code Paths
abstracts-explorer
  • Python Module Index

Python Module Index

a
 
a
- abstracts_explorer
    abstracts_explorer.clustering
    abstracts_explorer.config
    abstracts_explorer.database
    abstracts_explorer.db_models
    abstracts_explorer.embeddings
    abstracts_explorer.evaluation
    abstracts_explorer.export_utils
    abstracts_explorer.mcp_server
    abstracts_explorer.mcp_tools
    abstracts_explorer.paper_utils
    abstracts_explorer.plugin
    abstracts_explorer.rag
    abstracts_explorer.registry

© Copyright 2025, Abstracts Explorer Contributors.

Built with Sphinx using a theme provided by Read the Docs.
Docs v: dev
Versions
stable
dev