Skip to content

Complete API Reference

This page provides links to comprehensive API documentation for all Dataknobs packages. Each package has detailed documentation with auto-generated references from source code docstrings.

💡 Tip: Each package page includes complete class and method signatures with type annotations. For tutorials and guides, see the main documentation.


AI & LLM Packages

dataknobs-bots

Complete auto-generated API documentation for AI chatbots and agents.

dataknobs-llm

Complete auto-generated API documentation for LLM provider interfaces, prompts, and conversations.


Data & Configuration Packages

dataknobs-data

Complete auto-generated API documentation for data abstraction layer with multiple backends.

dataknobs-config

Complete auto-generated API documentation for configuration management.


Workflow & Processing Packages

dataknobs-fsm

Complete auto-generated API documentation for Finite State Machine framework.


Core Utilities Packages

dataknobs-structures

Complete auto-generated API documentation for core data structures.

dataknobs-utils

Complete auto-generated API documentation for utility functions.

dataknobs-xization

Complete auto-generated API documentation for text processing utilities.

dataknobs-common

Complete auto-generated API documentation for common components and base classes.


Documentation Organization

Each package's complete API reference is auto-generated from source code docstrings and includes:

  • Complete signatures - All classes, methods, and functions with type annotations
  • Docstrings - Detailed descriptions extracted from source code
  • Source links - Direct links to GitHub source files
  • Inheritance - Base classes and inheritance chains
  • Comprehensive coverage - Every public API documented

For hand-crafted tutorials, design patterns, and integration examples, see: - Curated API Guides - Hand-written guides with examples - Getting Started - Quick start tutorials - User Guide - Step-by-step guides - Package Guides - Package-specific documentation


Using This Reference

  • Browse by package - Click package names above to see full API documentation
  • Search - Use the search box (top of page) to find specific classes or methods
  • Type information - All signatures include complete type annotations
  • View source - Follow GitHub links to see implementation details

For questions or feedback, see our GitHub repository.