Modules API Reference

Below is an overview of all modules in the LionAGI library:

Modules:

• Action System
  • Overview
  • Contents
  • FunctionCalling
  • ActionManager
  • Request & Response Models
  • Tool
  • Utilities
  • Example Usage
  • File Locations
• Adapter System
  • Overview
  • Contents
  • Adapter and Registry
  • JSON Adapters
  • CSV and Excel Adapters
  • Pandas DataFrame and Series Adapters
  • Example Usage
  • File Locations
• Branch-Level Operations
  • _act
  • act
  • chat
  • communicate
  • operate
  • parse
  • instruct
  • interpret
  • ReAct
  • select
  • translate
  • Differences and Usage Notes
  • File References
• Branch: The Orchestrator
  • Overview
  • Contents
  • Branch
  • Key Differences from a Basic Session
• Abstract Concepts
  • Overview
  • Observer
  • Manager
  • Relational
  • Sendable
  • Observable
  • Communicatable
  • Condition
  • Collective
  • Ordering
  • File Location
• Element, IDType, and ID
  • Overview
  • IDType
  • Element
  • validate_order
  • ID
  • File Location
• Event, EventStatus, and Execution
  • Overview
  • EventStatus
  • Execution
  • Event
  • File Location
• Form & Flow
  • Base Form
  • Flow System
  • Form
  • Report
  • Additional Notes
• Node, Edge, and Graph
  • Overview
  • Contents
  • EdgeCondition
  • Edge
  • Node
  • Graph
  • File Locations
• Instruct System
  • 1. Core Instruct Fields
  • 2. The Instruct Model
  • 3. Instruct Collection
  • 4. InstructNode
  • 5. Example: Combining Instruct
  • Summary
• Log, LogManager, and Config
  • Overview
  • Contents
  • LogManagerConfig
  • Log
  • LogManager
  • File Location
• Mail System
  • Overview
  • Contents
  • Exchange
  • Mail
  • Mailbox
  • MailManager
  • Package and PackageCategory
  • File Locations
• Messages Subsystem
  • Overview
  • Contents
  • Base Types
  • RoledMessage
  • System
  • Instruction
  • AssistantResponse
  • ActionRequest
  • ActionResponse
  • MessageManager
  • Example Usage
  • File Locations
• Model System
  • 1. FieldModel (field_model.py)
  • 2. ModelParams (model_params.py)
  • 3. OperableModel (operable_model.py)
  • 4. Note (note.py)
  • 5. SchemaModel (schema_model.py)
  • 6. HashableModel (hashable_model.py)
  • Putting It All Together
• Operative & Step
  • 1. Operative (operative.py)
  • 2. Step (operative.py)
  • Summary
• Pile
  • Overview
  • Pile
  • pile
  • Helper Functions
  • File Location
• Event Processor and Executor
  • Overview
  • Processor
  • Executor
  • File Location
• Progression
  • Overview
  • Progression
  • prog
  • File Location
• API Service System
  • 1. EndpointConfig & EndPoint
  • 2. TokenCalculator
  • 3. APICalling (Event)
  • 4. ChatCompletionEndPoint & Subclasses
  • 5. Rate-Limited Execution
  • 6. iModel
  • 7. iModelManager
  • Summary
• Session
  • 1. The Session Class
  • 2. Creation & Basics
  • 3. Branch Management
  • 4. Mail Operations
  • 5. Inspecting Messages
  • 6. Example Flow
  • Summary
• General Purpose Helpers
  • Key Types & Constant: UNDEFINED
  • Hashable Model & Helpers
  • General Utility Types
  • Time & Path Management
  • Copy, Flatten, & List Ops
  • Higher-Order Calls: lcall, alcall, bcall
  • Fuzzy JSON / XML Parsing
  • Fuzzy Checking & Recursion
  • Concurrency/Throttling Decorators
  • Numeric Conversions
  • System Helpers & Others
• libs.file Subpackage
  • 1) chunk.py: Splitting into Chunks
  • 2) ops.py: File-level Utilities
  • 3) dir_process.py: Directory Handling
  • 4) save.py: Saving Text or Chunk Files
  • Usage Example
• libs.nested Subpackage
  • 1) flatten.py: Flattening
  • 2) filter.py: nfilter
  • 3) nget.py: Nested Getter
  • 4) ninsert.py: Nested Insert
  • 5) nmerge.py: Merging
  • 6) npop.py: Nested Pop
  • 7) nset.py: Nested Set
  • 8) utils.py: Internal Helpers
  • Usage Example
• libs.package Subpackage
  • 1) import_check.py
  • 2) list_uninstall_update.py
  • 3) schema.py
  • 4) platform_info.py
  • Basic Usage Example
  • Summary
• libs.schema Subpackage
  • 1) as_readable.py
  • 2) code_block.py
  • 3) extract_docstring.py
  • 4) function_to_schema.py
  • 5) json_schema_extractor.py
  • Usage Example
• libs.validate Subpackage
  • 1) validate_boolean.py
  • 2) common_field_validators.py (alias)
  • 3) string_similarity.py
  • 4) fuzzy_match_keys.py
  • 5) fuzzy_validate_mapping.py
  • 6) validate_boolean.py
  • Usage Example: Fuzzy Key Matching
  • Usage Example: Field Validators
  • Summary