OpenChatBI

Documentation:

  • OpenChatBI Documentation

API Reference:

  • Core Module
    • Main Module
    • Agent Graph
    • State Management
      • add_history_messages()
      • AgentState
        • AgentState.history_messages
        • AgentState.agent_next_node
        • AgentState.sends
        • AgentState.sql
        • AgentState.final_answer
        • AgentState.messages
      • SQLGraphState
        • SQLGraphState.rewrite_question
        • SQLGraphState.tables
        • SQLGraphState.info_entities
        • SQLGraphState.sql
        • SQLGraphState.sql_retry_count
        • SQLGraphState.sql_execution_result
        • SQLGraphState.schema_info
        • SQLGraphState.data
        • SQLGraphState.previous_sql_errors
        • SQLGraphState.visualization_dsl
        • SQLGraphState.messages
      • InputState
        • InputState.messages
      • OutputState
        • OutputState.messages
      • SQLOutputState
        • SQLOutputState.rewrite_question
        • SQLOutputState.tables
        • SQLOutputState.sql
        • SQLOutputState.schema_info
        • SQLOutputState.data
        • SQLOutputState.visualization_dsl
        • SQLOutputState.messages
    • Utilities
      • log()
      • get_text_from_content()
      • get_text_from_message_chunk()
      • extract_json_from_answer()
      • get_report_download_response()
      • create_vector_db()
      • recover_incomplete_tool_calls()
  • Configuration
    • Config
      • Config
        • Config.organization
        • Config.dialect
        • Config.default_llm
        • Config.embedding_model
        • Config.text2sql_llm
        • Config.bi_config
        • Config.data_warehouse_config
        • Config.model_config
        • Config.visualization_mode
        • Config.context_config
        • Config.timeseries_forecasting_service_url
        • Config.from_dict()
    • ConfigLoader
      • ConfigLoader
        • ConfigLoader.llm_configs
        • ConfigLoader.get()
        • ConfigLoader.load()
        • ConfigLoader.load_bi_config()
        • ConfigLoader.set()
  • Catalog System
    • Overview
    • Catalog Store
      • CatalogStore
        • CatalogStore.get_data_warehouse_config()
        • CatalogStore.get_sql_engine()
        • CatalogStore.get_database_list()
        • CatalogStore.get_table_list()
        • CatalogStore.get_column_list()
        • CatalogStore.get_table_information()
        • CatalogStore.get_sql_examples()
        • CatalogStore.get_table_selection_examples()
        • CatalogStore.save_table_information()
        • CatalogStore.save_table_sql_examples()
        • CatalogStore.save_table_selection_examples()
        • CatalogStore.check_exists()
      • split_db_table_name()
      • Filesystem Implementation
        • FileSystemCatalogStore
    • Catalog Loader
      • DataCatalogLoader
        • DataCatalogLoader.__init__()
        • DataCatalogLoader.get_tables_and_columns()
        • DataCatalogLoader.get_table_indexes()
        • DataCatalogLoader.get_foreign_keys()
        • DataCatalogLoader.save_to_catalog_store()
      • load_catalog_from_data_warehouse()
    • Schema Retrieval
  • Text2SQL System
    • Overview
    • SQL Graph
    • SQL Generation
    • Schema Linking
    • Information Extraction
    • Text2SQL Utilities
  • Code Execution
    • Code Module
    • Executor Base
    • Local Executor
  • LLM Integration
    • LLM Module
    • LLM Implementation
  • Tools and Utilities
    • Overview
    • Python Code Execution
    • Human Interaction
    • Memory Management
    • Knowledge Search
  • Time Series Forecasting Service
    • Transformer Time Series Forecasting Service
      • Features
      • Prerequisites
      • Quick Start
        • 1. Download Transformer Model
        • 2. Make a Prediction
        • 4. Test the Service
      • API Reference
        • Prediction Endpoint
      • Configuration
        • Environment Variables
        • Docker Run Options
      • Testing
        • Service Tests
      • Model Information
      • Troubleshooting
        • Common Issues
        • Debug Mode
      • Performance
      • Limitations
OpenChatBI
  • Python Module Index

Python Module Index

o
 
o
- openchatbi
    openchatbi.catalog.catalog_loader
    openchatbi.catalog.catalog_store
    openchatbi.catalog.store.file_system
    openchatbi.graph_state
    openchatbi.utils

© Copyright 2025, Yu Zhong.

Built with Sphinx using a theme provided by Read the Docs.