{"id":25125870,"url":"https://github.com/soralabs/zen","last_synced_at":"2025-04-23T07:14:50.701Z","repository":{"id":270970417,"uuid":"906599155","full_name":"soralabs/zen","owner":"soralabs","description":"Zen is a highly modular conversation engine built in Go that emphasizes pluggable architecture and platform independence.","archived":false,"fork":false,"pushed_at":"2025-02-06T05:08:30.000Z","size":3020,"stargazers_count":50,"open_issues_count":0,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-06T06:23:02.337Z","etag":null,"topics":["agent","ai","artificial-intelligence","automation","generative-ai","go","llm","twitter"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/soralabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-21T11:01:43.000Z","updated_at":"2025-02-06T05:08:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"0bec77c8-7c58-4bd2-817d-89151f424c41","html_url":"https://github.com/soralabs/zen","commit_stats":null,"previous_names":["soralabs/zen"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soralabs%2Fzen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soralabs%2Fzen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soralabs%2Fzen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soralabs%2Fzen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/soralabs","download_url":"https://codeload.github.com/soralabs/zen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237781741,"owners_count":19365349,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","ai","artificial-intelligence","automation","generative-ai","go","llm","twitter"],"created_at":"2025-02-08T09:16:37.626Z","updated_at":"2025-02-08T09:16:38.210Z","avatar_url":"https://github.com/soralabs.png","language":"Go","funding_links":[],"categories":["🛠️ Developer Tools \u0026 Frameworks"],"sub_categories":[],"readme":"# Zen - An Advanced Conversational LLM Framework\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./img/sora_readme_banner.png\" alt=\"Sora Banner\" width=\"100%\" /\u003e\n\u003c/div\u003e\n\n## Table of Contents\n- [Overview](#Overview)\n- [Core Features](#core-features)\n- [Extension Points](#extension-points)\n- [Quick Start](#quick-start)\n- [Using Zen as a Module](#using-zen-as-a-module)\n\n## Overview\nZen is a highly modular AI conversation engine built in Go that emphasizes pluggable architecture and platform independence. It provides a flexible foundation for building conversational systems through:\n\n- Plugin-based architecture with hot-swappable components\n- Multi-provider LLM support (OpenAI, custom providers)\n- Cross-platform conversation management\n- Extensible manager system for custom behaviors\n- Vector-based semantic storage with pgvector\n\n## Core Features\n\n### Plugin Architecture\n- **Manager System**: Extend functionality through custom managers\n  - Insight Manager: Extracts and maintains conversation insights\n  - Personality Manager: Handles response behavior and style\n  - Custom Managers: Add your own specialized behaviors\n\n### State Management\n- **Shared State System**: Centralized state management across components\n  - Manager-specific data storage\n  - Custom data injection\n  - Cross-manager communication\n\n### LLM Integration\n- **Provider Abstraction**: Support for multiple LLM providers\n  - Built-in OpenAI support\n  - Extensible provider interface for custom LLMs\n  - Configurable model selection per operation\n  - Automatic fallback and retry handling\n\n### Platform Support\n- **Platform Agnostic Core**: \n  - Abstract conversation engine independent of platforms\n  - Built-in support for CLI chat and Twitter\n  - Extensible platform manager interface\n  - Example implementations for new platform integration\n\n### Storage Layer\n- **Flexible Data Storage**:\n  - PostgreSQL with pgvector for semantic search\n  - GORM-based data models\n  - Customizable fragment storage\n  - Vector embedding support\n\n### Toolkit/Function System\n- **Pluggable Tool/Function Integration**:\n  - Support for custom tool implementations\n  - Built-in toolkit management\n  - Function calling capabilities\n  - Automatic tool response handling\n  - State-aware tool execution\n\n## Extension Points\n1. **LLM Providers**: Add new AI providers by implementing the LLM interface\n```go\ntype Provider interface {\n    GenerateCompletion(context.Context, CompletionRequest) (string, error)\n    GenerateJSON(context.Context, JSONRequest, interface{}) error\n    EmbedText(context.Context, string) ([]float32, error)\n}\n```\n\n2. **Managers**: Create new behaviors by implementing the Manager interface\n```go\ntype Manager interface {\n    GetID() ManagerID\n    GetDependencies() []ManagerID\n    Process(state *state.State) error\n    PostProcess(state *state.State) error\n    Context(state *state.State) ([]state.StateData, error)\n    Store(fragment *db.Fragment) error\n    StartBackgroundProcesses()\n    StopBackgroundProcesses()\n    RegisterEventHandler(callback EventCallbackFunc)\n    triggerEvent(eventData EventData)\n}\n```\n\n## Quick Start\n1. Clone the repository\n```bash \ngit clone https://github.com/soralabs/zen\n```   \n2. Copy `.env.example` to `.env` and configure your environment variables\n3. Install dependencies:\n```bash\ngo mod download\n```\n4. Run the chat example:\n```bash\ngo run examples/chat/main.go\n```\n6. Run the Twitter bot:\n```bash\ngo run examples/twitter/main.go\n```\n\n## Environment Variables\n```env\nDB_URL=postgresql://user:password@localhost:5432/zen\nOPENAI_API_KEY=your_openai_api_key\nDEEPSEEK_API_KEY=your_deepseek_api_key\n\nPlatform-specific credentials as needed\n```\n\n## Architecture\nThe project follows a clean, modular architecture:\n\n- `engine`: Core conversation engine\n- `manager`: Plugin manager system\n- `managers/*`: Built-in manager implementations\n- `state`: Shared state management\n- `llm`: LLM provider interfaces\n- `stores`: Data storage implementations\n- `tools/*`: Built-in tool implementations\n- `examples/`: Reference implementations\n\n## Using Zen as a Module\n\n1. Add Zen to your Go project:\n```bash\ngo get github.com/soralabs/zen\n```\n\n2. Import Zen in your code:\n```go\nimport (\n  \"github.com/soralabs/zen/engine\"\n  \"github.com/soralabs/zen/llm\"\n  \"github.com/soralabs/zen/manager\"\n  \"github.com/soralabs/zen/managers/personality\"\n  \"github.com/soralabs/zen/managers/insight\"\n  ... etc\n)\n```\n\n3. Basic usage example:\n```go\n// Initialize LLM client\nllmClient, err := llm.NewLLMClient(llm.Config{\n  ProviderType: llm.ProviderOpenAI,\n  APIKey: os.Getenv(\"OPENAI_API_KEY\"),\n  ModelConfig: map[llm.ModelType]string{\n    llm.ModelTypeDefault: openai.GPT4,\n  },\n  Logger: logger,\n  Context: ctx,\n})\n\n// Create engine instance\nengine, err := engine.New(\n  engine.WithContext(ctx),\n  engine.WithLogger(logger),\n  engine.WithDB(db),\n  engine.WithLLM(llmClient),\n)\n\n// Process input\nstate, err := engine.NewState(actorID, sessionID, \"Your input text here\")\nif err != nil {\n  log.Fatal(err)\n}\n\nresponse, err := engine.Process(state)\nif err != nil {\n  log.Fatal(err)\n}\n```\n\n4. Available packages:\n- `zen/engine`: Core conversation engine\n- `zen/llm`: LLM provider interfaces and implementations\n- `zen/manager`: Base manager system\n- `zen/managers/*`: Built-in manager implementations\n- `zen/state`: State management utilities\n- `zen/stores`: Data storage implementations\n\nFor detailed examples, see the `examples/` directory in the repository.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoralabs%2Fzen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoralabs%2Fzen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoralabs%2Fzen/lists"}