agently 4.0.7.2__py3-none-any.whl → 4.0.7.4__py3-none-any.whl

agently/builtins/agent_extensions/SessionExtension.py

@@ -23,9 +23,9 @@ from typing import Any, Sequence, TYPE_CHECKING
 from agently.core import BaseAgent
 from agently.core.Session import Session
 from agently.utils import DataPathBuilder, FunctionShifter
+from agently.types.data import ChatMessage
 
 if TYPE_CHECKING:
-    from agently.types.data import ChatMessage
     from agently.core import Prompt
     from agently.core.ModelRequest import ModelResponseResult
     from agently.utils import Settings
@@ -123,9 +123,15 @@ class SessionExtension(BaseAgent):
     def _normalize_chat_history(
         self, chat_history: Sequence[dict[str, Any] | ChatMessage] | dict[str, Any] | ChatMessage
     ):
-        if not isinstance(chat_history, list):
-            return [chat_history]
-        return chat_history
+        messages: list[ChatMessage] = []
+        if not isinstance(chat_history, Sequence):
+            chat_history = [chat_history]
+        for message in chat_history:
+            if not isinstance(message, ChatMessage):
+                messages.append(ChatMessage(role=message["role"], content=message["content"]))
+            else:
+                messages.append(message)
+        return messages
 
     def _stringify_content(self, content: Any):
         if content is None:

agently/core/Session.py

@@ -22,25 +22,43 @@ if TYPE_CHECKING:
     from agently.core import PluginManager, BaseAgent
     from agently.types.plugins import (
         SessionProtocol,
+        SessionMode,
+        SessionLimit,
+        MemoResizeDecision,
+        MemoResizeType,
         MemoResizePolicyHandler,
         MemoResizeHandler,
         AttachmentSummaryHandler,
         MemoUpdateHandler,
     )
+    from agently.types.data import ChatMessage, ChatMessageDict, SerializableValue, SerializableData
 
 
 class Session:
+    _impl: "SessionProtocol"
+    settings: Settings
+    plugin_manager: "PluginManager"
+    id: str
+    memo: "SerializableData"
+    full_chat_history: "list[ChatMessage]"
+    current_chat_history: "list[ChatMessage]"
+
     def __init__(
         self,
         *,
         policy_handler: "MemoResizePolicyHandler | None" = None,
-        resize_handlers: "dict[Literal['lite', 'deep'] | str, MemoResizeHandler] | None" = None,
+        resize_handlers: "dict[MemoResizeType, MemoResizeHandler] | None" = None,
         attachment_summary_handler: "AttachmentSummaryHandler | None" = None,
         memo_update_handler: "MemoUpdateHandler | None" = None,
         parent_settings: Settings | None = None,
         agent: "BaseAgent | None" = None,
         plugin_manager: "PluginManager | None" = None,
     ):
+        if agent is not None:
+            if plugin_manager is None and hasattr(agent, "plugin_manager"):
+                plugin_manager = agent.plugin_manager
+            if parent_settings is None and hasattr(agent, "settings"):
+                parent_settings = agent.settings
         if plugin_manager is None:
             from agently.base import plugin_manager as global_plugin_manager, settings as global_settings
 
@@ -72,6 +90,126 @@ class Session:
         object.__setattr__(self, "settings", impl.settings)
         object.__setattr__(self, "plugin_manager", plugin_manager)
 
+    def configure(
+        self,
+        *,
+        mode: "SessionMode | None" = None,
+        limit: "SessionLimit | None" = None,
+        every_n_turns: int | None = None,
+    ) -> "Session":
+        self._impl.configure(
+            mode=mode,
+            limit=limit,
+            every_n_turns=every_n_turns,
+        )
+        return self
+
+    def set_limit(
+        self,
+        *,
+        chars: int | None = None,
+        messages: int | None = None,
+    ) -> "Session":
+        self._impl.set_limit(chars=chars, messages=messages)
+        return self
+
+    def use_lite(
+        self,
+        *,
+        chars: int | None = None,
+        messages: int | None = None,
+        every_n_turns: int | None = None,
+    ) -> "Session":
+        self._impl.use_lite(chars=chars, messages=messages, every_n_turns=every_n_turns)
+        return self
+
+    def use_memo(
+        self,
+        *,
+        chars: int | None = None,
+        messages: int | None = None,
+        every_n_turns: int | None = None,
+    ) -> "Session":
+        self._impl.use_memo(chars=chars, messages=messages, every_n_turns=every_n_turns)
+        return self
+
+    def append_message(self, message: "ChatMessage | ChatMessageDict") -> "Session":
+        self._impl.append_message(message)
+        return self
+
+    def set_settings(
+        self,
+        key: str,
+        value: "SerializableValue",
+        *,
+        auto_load_env: bool = False,
+    ) -> Settings:
+        return self._impl.set_settings(key, value, auto_load_env=auto_load_env)
+
+    def set_policy_handler(self, policy_handler: "MemoResizePolicyHandler") -> "Session":
+        self._impl.set_policy_handler(policy_handler)
+        return self
+
+    def set_resize_handlers(
+        self,
+        resize_type: "MemoResizeType",
+        resize_handler: "MemoResizeHandler",
+    ) -> "Session":
+        self._impl.set_resize_handlers(resize_type, resize_handler)
+        return self
+
+    def set_attachment_summary_handler(
+        self,
+        attachment_summary_handler: "AttachmentSummaryHandler",
+    ) -> "Session":
+        self._impl.set_attachment_summary_handler(attachment_summary_handler)
+        return self
+
+    def set_memo_update_handler(
+        self,
+        memo_update_handler: "MemoUpdateHandler",
+    ) -> "Session":
+        self._impl.set_memo_update_handler(memo_update_handler)
+        return self
+
+    def judge_resize(
+        self,
+        force: "Literal['lite', 'deep', False, None] | str" = False,
+    ) -> "MemoResizeDecision | None":
+        return self._impl.judge_resize(force=force)
+
+    def resize(
+        self,
+        force: "Literal['lite', 'deep', False, None] | str" = False,
+    ) -> "list[ChatMessage]":
+        return self._impl.resize(force=force)
+
+    async def async_judge_resize(
+        self,
+        force: "Literal['lite', 'deep', False, None] | str" = False,
+    ) -> "MemoResizeDecision | None":
+        return await self._impl.async_judge_resize(force=force)
+
+    async def async_resize(
+        self,
+        force: "Literal['lite', 'deep', False, None] | str" = False,
+    ) -> "list[ChatMessage]":
+        return await self._impl.async_resize(force=force)
+
+    def to_json(self) -> str:
+        return self._impl.to_json()
+
+    def to_yaml(self) -> str:
+        return self._impl.to_yaml()
+
+    def load_json(self, value: str) -> "Session":
+        self._impl.load_json(value)
+        return self
+
+    def load_yaml(self, value: str) -> "Session":
+        self._impl.load_yaml(value)
+        return self
+
     def __getattr__(self, name: str):
         return getattr(self._impl, name)
 

agently/core/__init__.py

@@ -25,6 +25,7 @@ from .TriggerFlow import (
     TriggerFlowExecution,
     TriggerFlowChunk,
 )
+from .Session import Session
 
 # from .TriggerFlow_old import (
 #     TriggerFlow,

agently/integrations/fastapi.py

@@ -0,0 +1,18 @@
+# Copyright 2023-2025 AgentEra(Agently.Tech)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from agently.utils import LazyImport
+
+LazyImport.import_package("fastapi")

agently/types/plugins/Session.py

@@ -20,10 +20,11 @@ from typing_extensions import TypedDict, NotRequired, Self
 
 if TYPE_CHECKING:
     from agently.utils import Settings
-    from agently.types.data import SerializableData, ChatMessage
+    from agently.types.data import SerializableData, SerializableValue, ChatMessage, ChatMessageDict
 
 MemoResizeType: TypeAlias = Literal["lite", "deep"] | str
 SessionMode: TypeAlias = Literal["lite", "memo"] | str
+ResizeForce: TypeAlias = Literal["lite", "deep", False, None] | str
 
 
 class SessionLimit(TypedDict, total=False):
@@ -86,15 +87,12 @@ class SessionProtocol(Protocol):
     memo: "SerializableData"
     full_chat_history: "list[ChatMessage]"
     current_chat_history: "list[ChatMessage]"
-    set_settings: Callable[..., Any]
-    judge_resize: Callable[..., Any]
-    resize: Callable[..., Any]
 
     def __init__(
         self,
         *,
         policy_handler: MemoResizePolicyHandler | None = None,
-        resize_handlers: dict[Literal["lite", "deep"] | str, MemoResizeHandler] | None = None,
+        resize_handlers: dict[MemoResizeType, MemoResizeHandler] | None = None,
         attachment_summary_handler: AttachmentSummaryHandler | None = None,
         memo_update_handler: MemoUpdateHandler | None = None,
         parent_settings: "Settings | None" = None,
@@ -132,13 +130,25 @@ class SessionProtocol(Protocol):
         every_n_turns: int | None = None,
     ) -> Self: ...
 
-    def append_message(self, message: "ChatMessage | dict[str, Any]") -> Self: ...
+    def append_message(self, message: "ChatMessage | ChatMessageDict") -> Self: ...
+
+    def set_settings(
+        self,
+        key: str,
+        value: "SerializableValue",
+        *,
+        auto_load_env: bool = False,
+    ) -> "Settings": ...
+
+    def judge_resize(self, force: ResizeForce = False) -> "MemoResizeDecision | None": ...
+
+    def resize(self, force: ResizeForce = False) -> "list[ChatMessage]": ...
 
     def set_policy_handler(self, policy_handler: MemoResizePolicyHandler) -> Self: ...
 
     def set_resize_handlers(
         self,
-        resize_type: Literal["lite", "deep"] | str,
+        resize_type: MemoResizeType,
         resize_handler: MemoResizeHandler,
     ) -> Self: ...
 
@@ -146,9 +156,9 @@ class SessionProtocol(Protocol):
 
     def set_memo_update_handler(self, memo_update_handler: MemoUpdateHandler) -> Self: ...
 
-    async def async_judge_resize(self, force: Literal["lite", "deep", False, None] | str = False): ...
+    async def async_judge_resize(self, force: ResizeForce = False) -> "MemoResizeDecision | None": ...
 
-    async def async_resize(self, force: Literal["lite", "deep", False, None] | str = False): ...
+    async def async_resize(self, force: ResizeForce = False) -> "list[ChatMessage]": ...
 
     def to_json(self) -> str: ...
 

agently-4.0.7.4.dist-info/METADATA

@@ -0,0 +1,351 @@
+Metadata-Version: 2.4
+Name: agently
+Version: 4.0.7.4
+Summary: 
+License: Apache-2.0
+License-File: LICENSE
+Author: Agently Team
+Author-email: developer@agently.tech
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: greenlet (>=3.2.3,<4.0.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: httpx-sse (>=0.4.1,<0.5.0)
+Requires-Dist: json5 (>=0.12.0,<0.13.0)
+Requires-Dist: packaging (>=25.0,<26.0)
+Requires-Dist: pydantic (>=2.11.7,<3.0.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Requires-Dist: stamina (>=25.1.0,<26.0.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Description-Content-Type: text/markdown
+
+<img width="640" alt="image" src="https://github.com/user-attachments/assets/c645d031-c8b0-4dba-a515-9d7a4b0a6881" />
+
+# Agently 4 🚀
+
+> **Build production‑grade AI apps faster, with stable outputs and maintainable workflows.**
+
+[English Introduction](https://github.com/AgentEra/Agently/blob/main/README.md) | [中文介绍](https://github.com/AgentEra/Agently/blob/main/README_CN.md)
+
+[![license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/AgentEra/Agently/blob/main/LICENSE)
+[![PyPI version](https://img.shields.io/pypi/v/agently.svg)](https://pypi.org/project/agently/)
+[![Downloads](https://img.shields.io/pypi/dm/agently.svg)](https://pypistats.org/packages/agently)
+[![GitHub Stars](https://img.shields.io/github/stars/AgentEra/Agently.svg?style=social)](https://github.com/AgentEra/Agently/stargazers)
+[![Twitter Follow](https://img.shields.io/twitter/follow/AgentlyTech?style=social)](https://x.com/AgentlyTech)
+<a href="https://doc.weixin.qq.com/forms/AIoA8gcHAFMAScAhgZQABIlW6tV3l7QQf">
+<img alt="WeChat" src="https://img.shields.io/badge/WeChat%20Group-Join-brightgreen?logo=wechat&style=flat-square">
+</a>
+
+<p align="center">
+  <a href="https://github.com/AgentEra/Agently/discussions"><img src="https://img.shields.io/badge/💬_Community-Join-blueviolet?style=for-the-badge"></a>
+  <a href="https://agently.tech"><img src="https://img.shields.io/badge/🌐_Website-Docs-brightgreen?style=for-the-badge"></a>
+  <a href="https://github.com/AgentEra/Agently/issues"><img src="https://img.shields.io/badge/🐛_Issues-Report-red?style=for-the-badge"></a>
+</p>
+
+---
+
+<p align="center">
+  <b>🔥 <a href="https://agently.tech/docs">Latest Docs</a> | 🚀 <a href="#quickstart">5‑minute Quickstart</a> | 💡 <a href="#-core-features">Core Features</a></b>
+</p>
+
+---
+
+## 📚 Quick Links
+
+- **Docs (EN)**: https://agently.tech/docs
+- **Docs (中文)**: https://agently.cn/docs
+- **Agent Systems Playbook (EN)**: https://agently.tech/docs/en/agent-systems/overview.html
+- **Agent Systems Playbook (中文)**: https://agently.cn/docs/agent-systems/overview.html
+- **Coding Agent Guide (EN)**: https://agently.tech/docs/en/agent-docs.html
+- **Coding Agent Guide (中文)**: https://agently.cn/docs/agent-docs.html
+- **Agent Docs Pack**: https://agently.cn/docs/agent_docs.zip
+
+## 🤔 Why Agently?
+
+Many GenAI POCs fail in production not because models are weak, but because **engineering control is missing**:
+
+| Common challenge | How Agently helps |
+|:--|:--|
+| Output schema drifts, JSON parsing fails | **Contract‑first output control** with `output()` + `ensure_keys` |
+| Workflows get complex and hard to maintain | **TriggerFlow orchestration** with `to` / `if` / `match` / `batch` / `for_each` |
+| Multi‑turn state becomes unstable | **Session & Memo** with memory, summaries, and persistence strategies |
+| Tool calls are hard to audit | **Tool logs** via `extra.tool_logs` |
+| Switching models is expensive | **OpenAICompatible** unified model settings |
+
+**Agently turns LLM uncertainty into a stable, testable, maintainable engineering system.**
+
+## ✨ Core Features
+
+### 1) 📝 Contract‑first Output Control
+Define the structure with `output()`, enforce critical keys with `ensure_keys`.
+
+```python
+result = (
+    agent
+    .input("Analyze user feedback")
+    .output({
+        "sentiment": (str, "positive/neutral/negative"),
+        "key_issues": [(str, "issue summary")],
+        "priority": (int, "1-5, 5 is highest")
+    })
+    .start(ensure_keys=["sentiment", "key_issues[*]"])
+)
+```
+
+### 2) ⚡ Structured Streaming (Instant)
+Consume structured fields as they are generated.
+
+```python
+response = (
+    agent
+    .input("Explain recursion and give 2 tips")
+    .output({"definition": (str, "one sentence"), "tips": [(str, "tip")]})
+    .get_response()
+)
+
+for msg in response.get_generator(type="instant"):
+    if msg.path == "definition" and msg.delta:
+        ui.update_definition(msg.delta)
+    if msg.wildcard_path == "tips[*]" and msg.delta:
+        ui.add_tip(msg.delta)
+```
+
+### 3) 🧩 TriggerFlow Orchestration
+Readable, testable workflows with branching and concurrency.
+
+```python
+(
+    flow.to(handle_request)
+    .if_condition(lambda d: d.value["type"] == "query")
+    .to(handle_query)
+    .elif_condition(lambda d: d.value["type"] == "order")
+    .to(check_inventory)
+    .to(create_order)
+    .end_condition()
+)
+```
+
+### 4) 🧠 Session & Memo (Multi‑turn Memory)
+Quick / Lite / Memo modes with summaries and persistence strategies.
+
+```python
+from agently import Agently
+from agently.core import Session
+
+agent = Agently.create_agent()
+session = Session(agent=agent).configure(
+    mode="memo",
+    limit={"chars": 6000, "messages": 12},
+    every_n_turns=2,
+)
+agent.attach_session(session)
+```
+
+### 5) 🔧 Tool Calls + Logs
+Tool selection and usage are logged in `extra.tool_logs`.
+
+```python
+@agent.tool_func
+def add(a: int, b: int) -> int:
+    return a + b
+
+response = agent.input("12+34=?").use_tool(add).get_response()
+full = response.get_data(type="all")
+print(full["extra"]["tool_logs"])
+```
+
+### 6) 🌐 Unified Model Settings (OpenAICompatible)
+One config for multiple providers and local models.
+
+```python
+from agently import Agently
+
+Agently.set_settings(
+    "OpenAICompatible",
+    {
+        "base_url": "https://api.deepseek.com/v1",
+        "model": "deepseek-chat",
+        "auth": "DEEPSEEK_API_KEY",
+    },
+)
+```
+
+## 🚀 Quickstart
+
+### Install
+
+```bash
+pip install -U agently
+```
+
+*Requirements: Python >= 3.10, recommended Agently >= 4.0.7.2*
+
+### 5‑minute example
+
+**1. Structured output**
+
+```python
+from agently import Agently
+
+agent = Agently.create_agent()
+
+result = (
+    agent.input("Introduce Python in one sentence and list 2 advantages")
+    .output({
+        "introduction": (str, "one sentence"),
+        "advantages": [(str, "advantage")]
+    })
+    .start(ensure_keys=["introduction", "advantages[*]"])
+)
+
+print(result)
+```
+
+**2. Workflow routing**
+
+```python
+from agently import TriggerFlow, TriggerFlowEventData
+
+flow = TriggerFlow()
+
+@flow.chunk
+def classify_intent(data: TriggerFlowEventData):
+    text = data.value
+    if "price" in text:
+        return "price_query"
+    if "feature" in text:
+        return "feature_query"
+    if "buy" in text:
+        return "purchase"
+    return "other"
+
+@flow.chunk
+def handle_price(_: TriggerFlowEventData):
+    return {"response": "Pricing depends on the plan..."}
+
+@flow.chunk
+def handle_feature(_: TriggerFlowEventData):
+    return {"response": "Our product supports..."}
+
+(
+    flow.to(classify_intent)
+    .match()
+    .case("price_query")
+    .to(handle_price)
+    .case("feature_query")
+    .to(handle_feature)
+    .case_else()
+    .to(lambda d: {"response": "What would you like to know?"})
+    .end_match()
+    .end()
+)
+
+print(flow.start("How much does it cost?"))
+```
+
+## ✅ Is Your App Production‑Ready? — Release Readiness Checklist
+
+Based on teams shipping real projects with Agently, this **production readiness checklist** helps reduce common risks before release.
+
+| Area | Check | Recommended Practice |
+| :--- | :--- | :--- |
+| **📝 Output Stability** | Are key interfaces stable? | Define schemas with `output()` and lock critical fields with `ensure_keys`. |
+| **⚡ Real‑time UX** | Need updates while generating? | Consume `type="instant"` structured streaming events. |
+| **🔍 Observability** | Tool calls auditable? | Inspect `extra.tool_logs` for full arguments and results. |
+| **🧩 Workflow Robustness** | Complex flows fully tested? | Unit test each TriggerFlow branch and concurrency limit with expected outputs. |
+| **🧠 Memory & Context** | Multi‑turn experience consistent? | Define Session/Memo summary, trimming, and persistence policies. |
+| **📄 Prompt Management** | Can logic evolve safely? | Version and configure prompts to keep changes traceable. |
+| **🌐 Model Strategy** | Can you switch or downgrade models? | Centralize settings with `OpenAICompatible` for fast provider switching. |
+| **🚀 Performance & Scale** | Can it handle concurrency? | Validate async performance in real web‑service scenarios. |
+| **🧪 Quality Assurance** | Regression tests complete? | Create fixed inputs with expected outputs for core scenarios. |
+
+
+## 📈 Who Uses Agently to Solve Real Problems?
+
+> "Agently helped us turn evaluation rules into executable workflows and keep key scoring accuracy at 75%+, significantly improving bid‑evaluation efficiency." — Project lead at a large energy SOE
+
+> "Agently enabled a closed loop from clarification to query planning to rendering, reaching 90%+ first‑response accuracy and stable production performance." — Data lead at a large energy group
+
+> "Agently’s orchestration and session capabilities let us ship a teaching assistant for course management and Q&A quickly, with continuous iteration." — Project lead at a university teaching‑assistant initiative
+
+**Your project can be next.**  
+📢 [Share your case on GitHub Discussions →](https://github.com/AgentEra/Agently/discussions/categories/show-and-tell)
+## ❓ FAQ
+
+**Q: How is Agently different from LangChain or LlamaIndex?**  
+**A:** Agently is **built for production**. It focuses on stable interfaces (contract‑first outputs), readable/testable orchestration (TriggerFlow), and observable tool calls (`tool_logs`). It’s a better fit for teams that need reliability and maintainability after launch.
+
+**Q: Which models are supported? Is switching expensive?**  
+**A:** With `OpenAICompatible`, you can connect OpenAI, Claude, DeepSeek, Qwen and most OpenAI‑compatible endpoints, plus local models like Llama/Qwen. **The same business code can switch models without rewrites**, reducing vendor lock‑in.
+
+**Q: What’s the learning curve? Where should I start?**  
+**A:** The core API is straightforward—**you can run your first agent in minutes**. Start with [Quickstart](https://agently.tech/docs/en/quickstart.html), then dive into [Output Control](https://agently.tech/docs/en/output-control/overview.html) and [TriggerFlow](https://agently.tech/docs/en/triggerflow/overview.html).
+
+**Q: How do I deploy an Agently‑based service?**  
+**A:** Agently doesn’t lock you into a specific deployment path. It provides async APIs and FastAPI examples. The [FastAPI integration example](https://github.com/AgentEra/Agently/tree/main/examples/step_by_step/13-auto_loop_fastapi) covers SSE, WebSocket, and standard POST.
+
+**Q: Do you offer enterprise support?**  
+**A:** The core framework is open‑source under **Apache 2.0**. For enterprise support, training, or deep collaboration, contact us via the [community](https://doc.weixin.qq.com/forms/AIoA8gcHAFMAScAhgZQABIlW6tV3l7QQf).
+
+
+## 🧭 Docs Guide (Key Paths)
+
+- **Getting Started**
+  - Quickstart: https://agently.tech/docs/en/quickstart.html
+  - Model Settings: https://agently.tech/docs/en/model-settings.html
+  - Coding Agent Guide: https://agently.tech/docs/en/agent-docs.html
+- **Output Control (Structured Output)**
+  - Overview: https://agently.tech/docs/en/output-control/overview.html
+  - Output Format: https://agently.tech/docs/en/output-control/format.html
+  - ensure_keys: https://agently.tech/docs/en/output-control/ensure-keys.html
+  - Instant Streaming: https://agently.tech/docs/en/output-control/instant-streaming.html
+- **Result & Streaming Events**
+  - Result Data: https://agently.tech/docs/en/model-response/result-data.html
+  - Streaming Events: https://agently.tech/docs/en/model-response/streaming.html
+- **Session & Memo**
+  - Overview: https://agently.tech/docs/en/agent-extensions/session-memo/
+  - Quickstart: https://agently.tech/docs/en/agent-extensions/session-memo/quickstart.html
+- **TriggerFlow Orchestration**
+  - Overview: https://agently.tech/docs/en/triggerflow/overview.html
+  - when Branch: https://agently.tech/docs/en/triggerflow/when-branch.html
+  - if / elif / else: https://agently.tech/docs/en/triggerflow/if-branch.html
+  - match / case: https://agently.tech/docs/en/triggerflow/match-branch.html
+  - batch: https://agently.tech/docs/en/triggerflow/batch.html
+  - for_each: https://agently.tech/docs/en/triggerflow/for-each.html
+  - Runtime Stream: https://agently.tech/docs/en/triggerflow/runtime-stream.html
+- **Tools & Extensions**
+  - Tools: https://agently.tech/docs/en/agent-extensions/tools.html
+  - MCP: https://agently.tech/docs/en/agent-extensions/mcp.html
+  - auto_func: https://agently.tech/docs/en/agent-extensions/auto-func.html
+  - KeyWaiter: https://agently.tech/docs/en/agent-extensions/key-waiter.html
+- **Prompt Management**: https://agently.tech/docs/en/prompt-management/overview.html
+- **Async & Settings**: https://agently.tech/docs/en/async-support.html / https://agently.tech/docs/en/settings.html
+- **Playbook**: https://agently.tech/docs/en/agent-systems/overview.html
+
+## 🤝 Community
+
+- Discussions: https://github.com/AgentEra/Agently/discussions
+- Issues: https://github.com/AgentEra/Agently/issues
+- WeChat Group: https://doc.weixin.qq.com/forms/AIoA8gcHAFMAScAhgZQABIlW6tV3l7QQf
+
+## 📄 License
+
+Agently is licensed under [Apache 2.0](LICENSE).
+
+---
+
+<p align="center">
+  <b>Start building your production‑ready AI apps →</b><br>
+  <code>pip install -U agently</code>
+</p>
+
+<p align="center">
+  <sub>Questions? Read the <a href="https://agently.tech/docs">docs</a> or join the <a href="https://doc.weixin.qq.com/forms/AIoA8gcHAFMAScAhgZQABIlW6tV3l7QQf">community</a>.</sub>
+</p>
+

{agently-4.0.7.2.dist-info → agently-4.0.7.4.dist-info}/RECORD

@@ -6,7 +6,7 @@ agently/builtins/agent_extensions/AutoFuncExtension.py,sha256=TmwMazwPzb5WXfDqfe
 agently/builtins/agent_extensions/ChatSessionExtension.py,sha256=Bbrc9cn3m-uOY0i8EGq1Cvp71nNpEORrrXTiy_JuCCQ,12048
 agently/builtins/agent_extensions/ConfigurePromptExtension.py,sha256=9wy2zHIDVHbUlj5sI0A03SscUWSzZNc9hNJSEdXFXd0,11390
 agently/builtins/agent_extensions/KeyWaiterExtension.py,sha256=Rf8dB8Yt3_9IJifpiE-Rn6lLIXqZjaNp94lnX6Betgw,5555
-agently/builtins/agent_extensions/SessionExtension.py,sha256=P4T_13IB_K8zFi_OAEs_pfeyhoBgJ9yuRGeey0hT2Os,11873
+agently/builtins/agent_extensions/SessionExtension.py,sha256=s_pzyLg34D-3rew60gdTxBEiLm1wi0AcoHM7J62-A3U,12162
 agently/builtins/agent_extensions/ToolExtension.py,sha256=S3jjumHiauEQ-m46Zkh-1I9ih02kKoj8sBEU82woz1E,6886
 agently/builtins/agent_extensions/__init__.py,sha256=rWD8hzJ0ymxxpjxJCdB0x1L5AnhYQnAJUeIAD_MTQ5I,899
 agently/builtins/hookers/ConsoleHooker.py,sha256=aJdDj_nG8CiwyelA505zvtpzBSwD52nFIkBRDJGgq3Y,8099
@@ -28,7 +28,7 @@ agently/core/ExtensionHandlers.py,sha256=88iSAW50bgMshB56cTgKg30eOjZQyXiJY1en4w7
 agently/core/ModelRequest.py,sha256=hroVb-U-knygXMZ1CCy84pJlP1GHSBNZPI809jEgQak,24350
 agently/core/PluginManager.py,sha256=fwRxvqPMgXYIrclhRHtkaPsyvn6SaeBFqvL7tTzYwck,4410
 agently/core/Prompt.py,sha256=vCi_64A-ITiJ-6ZL2PduRdTXoHp8xpKJa2z0ejCJ4uQ,6899
-agently/core/Session.py,sha256=tWRyjX4cKR_cyK5LaiEqaqkSeyemjzceoaM033mMWMM,3163
+agently/core/Session.py,sha256=YhhwMRfrs6pXKcwQWPcpFCElD2BrSk9JhnZjdP_tUQU,7343
 agently/core/Tool.py,sha256=PNYf_BwVefr8IOqf5asLaVq2fU7hQaFJwJVj3S4fq84,1871
 agently/core/TriggerFlow/BluePrint.py,sha256=H_TYymWOci-ZvQzqyRxpkHjO77zlzXLukLUUctX4ftM,4887
 agently/core/TriggerFlow/Chunk.py,sha256=xPWr_ofpl-iG4jHIJfB5mPanmn70pq7x8GCcz3G8NPc,1583
@@ -40,8 +40,9 @@ agently/core/TriggerFlow/process/BaseProcess.py,sha256=tBAMCI2Yd8Ylfi5CpkhlSVLH5
 agently/core/TriggerFlow/process/ForEachProcess.py,sha256=DD4frz9mTsKgnPXnHJD53hL6uiiU6h338p7ipud8zMU,4897
 agently/core/TriggerFlow/process/MatchCaseProcess.py,sha256=MKY5Yh66JiMABhCzamRl8UZOBjbD75TFp84Jw6o_t68,7900
 agently/core/TriggerFlow/process/__init__.py,sha256=BP5bAr9LRVVD83KFqXeprgTmXA1iCSOSsD509BtoX_E,753
-agently/core/__init__.py,sha256=CPglSpW5oEEmWpCpdvv9wK4myXmVipjuZm5HtMq6Vxo,1214
+agently/core/__init__.py,sha256=7QJdqGWgmiGvyXVxvRang9eQkbyNAzJu7RissUtzvcw,1243
 agently/integrations/chromadb.py,sha256=oGc-eZRK4pXo5QPbjpC1_RoRzhv2Hqadp80TPEEvw8c,10374
+agently/integrations/fastapi.py,sha256=lxOOAcdY36UxuuVsPhvl0MAUjaJT3drv5CubVdqEHyk,668
 agently/types/__init__.py,sha256=xb8GMY-ULncO_PY9rfRUsyi12wAQQJx8gAAnoM30uZA,592
 agently/types/data/__init__.py,sha256=ulo2p9SBV-v75zPZWcTczDnAcYO_IlDe3JMGNOZa4vM,1662
 agently/types/data/event.py,sha256=LFQW7MN_QGOis3XV-8K6jNXWsLvT7tYxo4BZbUBCpfI,1790
@@ -55,7 +56,7 @@ agently/types/plugins/EventHooker.py,sha256=kb80-baVc3fVlrddW5syv9uSD8a2Mcw8Fd3I
 agently/types/plugins/ModelRequester.py,sha256=urG1zFX0b4U6ZKSO50IbW5IHK3ydmRgUom7O7Niqk8s,3875
 agently/types/plugins/PromptGenerator.py,sha256=V8kqT0Eeq09AQqfGA-SZ5mNKeit1UrmqlDQCquSMzUU,4752
 agently/types/plugins/ResponseParser.py,sha256=6dCVWz61gaHOxsX9e5sYFqcWRZ5hBnNXAarT0-9uCUY,4566
-agently/types/plugins/Session.py,sha256=SJGBUkUZPTCv7f4Ml3XbhL3A_RgE5no5XT9vHJvMzHY,5189
+agently/types/plugins/Session.py,sha256=WO_V2hW8jWh1bs-cHEIKgLDy6-zj22DjCgFzhdp1VdY,5485
 agently/types/plugins/ToolManager.py,sha256=q1Y3G_tzh1AU3s13H-zTDZIkR4W1mjh9E6AKudFOvyg,2421
 agently/types/plugins/__init__.py,sha256=CtSeuBvC9EiS3uX2FWFLLKBkdP6EAdakO-T7LX9TWII,1361
 agently/types/plugins/base.py,sha256=O3dskXxoc7E1_qd8nTfJr7sP42jbJlPYijXKDX-cM2E,1178
@@ -79,7 +80,7 @@ agently/utils/StreamingJSONCompleter.py,sha256=aZ9zuGUTQlP-QKbXHUZCf6EtVuG49MKn8
 agently/utils/StreamingJSONParser.py,sha256=sPPJOtj5OYvsrukRErcoxRl4yuV1zDuf7pQ_pvw_Zow,21116
 agently/utils/TimeInfo.py,sha256=lgdeXpTJQOqw0czvrsMcxNeY84wuvCF7kWpY4W8nhDY,750
 agently/utils/__init__.py,sha256=A2EXx-TVU3Ca1s3fMlWM0se0BgI-ZRCXZgl4Hue-lco,1352
-agently-4.0.7.2.dist-info/METADATA,sha256=QoTPNNNEXhuSgLvqDHL1d9lSE6hjL3dEpEIDH9WeDVY,17085
-agently-4.0.7.2.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
-agently-4.0.7.2.dist-info/licenses/LICENSE,sha256=Y5ZgAdYgMFigPT8dhN18dTLRtBshOSfWhTDRO1t0Cq4,11360
-agently-4.0.7.2.dist-info/RECORD,,
+agently-4.0.7.4.dist-info/METADATA,sha256=gAx8gcMTXLExJBjBRnaILcIezn44bDn9QTn5E_NXJ38,14447
+agently-4.0.7.4.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+agently-4.0.7.4.dist-info/licenses/LICENSE,sha256=Y5ZgAdYgMFigPT8dhN18dTLRtBshOSfWhTDRO1t0Cq4,11360
+agently-4.0.7.4.dist-info/RECORD,,

agently-4.0.7.2.dist-info/METADATA

@@ -1,433 +0,0 @@
-Metadata-Version: 2.4
-Name: agently
-Version: 4.0.7.2
-Summary: 
-License: Apache-2.0
-License-File: LICENSE
-Author: Agently Team
-Author-email: developer@agently.tech
-Requires-Python: >=3.10
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: greenlet (>=3.2.3,<4.0.0)
-Requires-Dist: httpx (>=0.28.1,<0.29.0)
-Requires-Dist: httpx-sse (>=0.4.1,<0.5.0)
-Requires-Dist: json5 (>=0.12.0,<0.13.0)
-Requires-Dist: packaging (>=25.0,<26.0)
-Requires-Dist: pydantic (>=2.11.7,<3.0.0)
-Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
-Requires-Dist: stamina (>=25.1.0,<26.0.0)
-Requires-Dist: toml (>=0.10.2,<0.11.0)
-Description-Content-Type: text/markdown
-
-<img width="640" alt="image" src="https://github.com/user-attachments/assets/c645d031-c8b0-4dba-a515-9d7a4b0a6881" />
-
-# Agently 4
-
-[English Introduction](https://github.com/AgentEra/Agently/blob/main/README.md) | [中文介绍](https://github.com/AgentEra/Agently/blob/main/README_CN.md)
-
-
-> *Speed Up Your GenAI Application Development*
-
-[![license](https://img.shields.io/badge/license-Apache2.0-blue.svg?style=flat-square)](https://github.com/AgentEra/Agently/blob/main/LICENSE)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/agently?style=flat-square)](https://pypistats.org/packages/agently)
-[![GitHub star chart](https://img.shields.io/github/stars/agentera/agently?style=flat-square)](https://star-history.com/#agentera/agently)
-[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/AgentlyTech.svg?style=social&label=Follow%20%40AgentlyTech)](https://x.com/AgentlyTech)
-<a href="https://doc.weixin.qq.com/forms/AIoA8gcHAFMAScAhgZQABIlW6tV3l7QQf">
-<img alt="WeChat" src="https://img.shields.io/badge/WeChat%20Group-Apply-brightgreen?logo=wechat&style=flat-square">
-</a>
-
-<p>
-  <a href="https://github.com/AgentEra/Agently/discussions/categories/general">
-    <img alt="Discussions" src="https://img.shields.io/badge/Agently%20General%20Discussions-JOIN-brightgreen.svg?style=for-the-badge" />
-  </a>
-  <a href="https://github.com/AgentEra/Agently/discussions/categories/contribute-to-agently-4">
-    <img alt="Contribute" src="https://img.shields.io/badge/Contribute%20to%20Agently%204%20-Join-blueviolet.svg?style=for-the-badge">
-  </a>
-  <a href="https://github.com/AgentEra/Agently/issues">
-    <img alt="Issues" src="https://img.shields.io/badge/Report%20Issues-Report-red.svg?style=for-the-badge">
-  </a>
-</p>
-
-<hr />
-
-<p align="center">
-    <b><a href = "https://Agently.tech">💥 Official WebSite</a> - Everything about Agently and what's coming next</b>
-</p>
-
-<hr />
-
-## Getting Started
-
-Agently is a Python-based framework for building GenAI applications. You can install it via pip and import features using `from agently import Agently`.
-
-Install the latest version via pip:
-
-```shell
-pip install -U agently
-```
-
-> ℹ️ If you're looking for Agently v3's code and documents, please visit branch [`v3-final`](https://github.com/AgentEra/Agently/tree/v3-final)
-
-Clone the repository and install locally:
-
-```shell
-git clone git@github.com:AgentEra/Agently.git
-cd Agently
-pip install -e .
-```
-
-## Documentation
-
-- Docs Site: https://Agently.tech/docs
-- Step-by-step tutorials: `examples/step_by_step/`
-- Auto Loop FastAPI (SSE/WS/POST, Docker-ready): `examples/step_by_step/13-auto_loop_fastapi/`
-
-## What is Agently?
-
-Agently aims to provide an intuitive, efficient, and developer-friendly framework for GenAI application development. By deeply understanding the runtime control needs of model outputs, Agently bridges the gap between large language models and real-world applications.
-
-Agently abstracts away the complexities of:
-- Varying model parameters
-- Output formatting
-- Communication between engineering modules and GenAI logic
-
-...while giving developers full control over business logic and integration with existing systems.
-
-We believe GenAI is not a generational replacement for current systems but a powerful extension. Engineers and tools are key to turning GenAI's possibilities into reality.
-
-Our mission is to build the best developer experience (DX) for GenAI application engineers.
-
-## From Demo to Production
-
-In real teams, the hardest part is rarely “can the model answer?”—it’s whether the system can survive real traffic, real data, and real dependencies while staying testable, observable, and maintainable. Agently is built to pull LLM uncertainty back inside an engineering boundary.
-
-- **Contract-first structured outputs (framework-native, provider-agnostic)**: define schemas with `output()`, enforce critical paths with `ensure_keys`, and parse/repair in the framework pipeline (no hard dependency on provider-specific `response_format` / JSON-schema switches). This keeps interfaces stable even when you switch models or inference servers.
-- **Tool planning + traceability without vendor lock-in**: deciding whether to use a tool, selecting a tool, and building kwargs is a built-in planning step in the framework, not something that requires function-calling support. Every run leaves evidence in `extra` (`tool_logs` / tool calls) for debugging and audit.
-- **Workflow orchestration you can maintain**: TriggerFlow translates visual “low-code graphs” (n8n/Dify/Coze style) into readable code with events, branching, joins, loops, and concurrency limits. Combined with Instant-mode partial node capture + signal-driven execution, you can do real-time UX like “companion robot speaks while actions trigger”.
-- **Grounded answers with citations**: KB retrieval results are structured (`id/document/metadata`) and can be turned into enforced citations (e.g. `source_id` + `quote`) so answers are traceable and reviewable.
-
-## Core Features Overview
-
-These are the production pain points we keep seeing across teams:
-- **“I asked for JSON, got a paragraph.”** Missing keys, format drift, extra prose → broken parsers.
-- **Tools that work… until they don’t.** Failures become hard to reproduce, debug, and audit.
-- **Low-code graphs that outgrow themselves.** More branches, more state, less confidence to change.
-- **RAG without accountability.** You can’t answer: “Which doc supports this claim?”
-
-Agently turns them into engineering primitives you can ship with confidence: schema-first outputs (`output()` + `ensure_keys`), Instant-mode structured streaming, framework-native tool planning with traces, TriggerFlow orchestration, and KB grounding with citations.
-
-### Structured and Streamed Output Control for LLMs
-
-Schema-first outputs are often the difference between a demo and an API: you define what the system must return, and the framework enforces it at runtime.
-
-Agently allows you to control and consume model outputs using a developer-centric pattern:
-
-```python
-from agently import Agently
-
-agent = Agently.create_agent()
-
-(
-    agent
-        .input("What time is it now?", always=True)
-        .info({
-            "default_timezone": "",
-            "tool_list": [{
-                "name": "get_current_time",
-                "desc": "Get current time by time zone provided",
-                "kwargs": {
-                    "timezone_str": (str, "time zone string in ZoneInfo()"),
-                },
-            }]
-        })
-        .output({
-            "first_time_response": (str, ),
-            "tool_using_judgement": (bool, ),
-            "tool_using_command": (
-                {
-                    "name": (str, "Decide which tool to use by tool name:{tool_list.[].name}"),
-                    "kwargs": (dict, "According {tool_list.[].args} to output kwargs dictionary"),
-                },
-                "If {tool_using_judgement}==False, just output {}",
-            ),
-        })
-)
-```
-
-Then, consume the model response:
-
-```python
-response = agent.get_response()
-
-# Get raw text
-response_text = response.get_text()
-
-# Get parsed structured data
-response_data = response.get_data()
-
-# Instant parsing mode (structured streaming)
-instant_response_generator = response.get_generator(type="instant")
-
-use_tool = False
-
-for instant_message in instant_response_generator:
-    if instant_message.path == "first_time_response":
-        if instant_message.delta is not None:
-            print(instant_message.delta, end="", flush=True)
-    elif instant_message.path == "tool_using_judgement":
-        use_tool = instant_message.value
-        print()
-        if use_tool:
-            print("[USE TOOL!]")
-        else:
-            print("[NO NEED TO USE TOOL!]")
-    if use_tool:
-        if instant_message.path == "tool_using_command.name" and instant_message.is_complete:
-            print(f"I want to use: '{ instant_message.value }'")
-        elif instant_message.path == "tool_using_command":
-            print(f"call: { instant_message.value }")
-            print(f"kwargs: { instant_message.value }")
-```
-
-```shell
-I can check the current time for you. Please specify a timezone (e.g., 'America/New_York') so I can provide the accurate time.
-[NO NEED TO USE TOOL!]
-```
-
-### Provider Compatibility (Local / Hosted / Proxy)
-
-Agently unifies model configuration via `OpenAICompatible`, so you can switch between providers while keeping the same developer experience. It also supports common “production reality” knobs like `full_url` and custom auth headers.
-
-- Minimal example:
-```python
-from agently import Agently
-
-Agently.set_settings(
-    "OpenAICompatible",
-    {
-        "base_url": "https://api.deepseek.com/v1",
-        "model": "deepseek-chat",
-        "auth": "DEEPSEEK_API_KEY",
-    },
-)
-```
-
-- Example configs: `examples/model_configures/`
-- Step-by-step: `examples/step_by_step/01-settings.py`
-
-### Output Reliability (ensure_keys + retries)
-
-In batch tasks and pipelines, a missing field can crash the whole job. Agently provides `ensure_keys` + retries for structured output so you can enforce required fields (including wildcard paths for list items).
-
-- Minimal example:
-```python
-from agently import Agently
-
-agent = Agently.create_agent()
-result = (
-    agent.input("Give me 3 todos")
-    .output({"todos": [("str", "todo item")]})
-    .start(ensure_keys=["todos[*]"], max_retries=2, raise_ensure_failure=False)
-)
-print(result)
-```
-```text
-Output (qwen2.5:7b):
-{'todos': ['Schedule morning exercise routine', 'Prepare presentation slides for the meeting', 'Respond to emails from clients']}
-```
-
-- Step-by-step: `examples/step_by_step/03-output_format_control.py`
-
-### Streaming UX (delta / instant / typed_delta)
-
-Agently streaming is designed for real applications: reduce waiting, expose decisions early, and route structured fields to different UI regions. For example in a “companion robot” HCI scenario, you often want to mix user-facing text with machine/behavior commands, and consume them as soon as they are parsed.
-
-- Minimal example:
-```python
-from agently import Agently
-
-agent = Agently.create_agent()
-response = (
-    agent.input("Act as a companion robot: greet me and propose a small action you can do next.")
-    .output(
-        {
-            "thinking": ("str", "internal planning (not for users)"),
-            "say": ("str", "what the user sees/hears"),
-            "actions": [("str", "robot action command(s) for your app to execute")],
-        }
-    )
-    .get_response()
-)
-
-say_label_printed = False
-
-def execute_action(action: str) -> None:
-    # In real apps, route this to your robot controller / UI event bus.
-    print(f"\n[action] {action}")
-
-for msg in response.get_generator(type="instant"):
-    if msg.path == "say" and msg.delta:
-        if not say_label_printed:
-            print("[say] ", end="")
-            say_label_printed = True
-        print(msg.delta, end="", flush=True)
-    if msg.path.startswith("actions[") and msg.is_complete:
-        execute_action(msg.value)
-print()
-```
-```text
-Output (qwen2.5:7b):
-[say] Hello! Nice to meet you. How about we start with some light conversation? Do you have any favorite hobbies or interests that we could talk about?
-[action] initiate_conversation
-```
-
-- Step-by-step: `examples/step_by_step/06-streaming.py`
-- Reference patterns: `examples/basic/streaming_print.py`
-
-### Tools (built-in + custom + traceable)
-
-When a project grows from 1 tool to 20 tools, “it worked yesterday” isn’t enough—you need predictable planning and a trail you can audit.
-
-Tools let the model call external functions deterministically. Agently supports:
-- built-in `Search` / `Browse`
-- custom tools via decorator
-- tool call tracing from response metadata (`extra`)
-
-Unlike workflows that rely on provider-side function calling, Agently can run a framework-native “tool planning” step even on plain chat endpoints, so tool orchestration stays portable across most modern models.
-
-- Minimal example:
-```python
-from agently import Agently
-
-agent = Agently.create_agent()
-
-@agent.tool_func
-def add(*, a: int, b: int) -> int:
-    return a + b
-
-agent.use_tools(add)
-print(agent.input("Use the add tool to calculate 12 + 34.").start())
-```
-```text
-Output (qwen2.5:7b):
-The sum of 12 and 34 is calculated as follows:
-
-12
-+34
------
-46
-
-Therefore, the result of 12 + 34 is **46**. 
-
-No external sources were used in this calculation.
-```
-
-- Step-by-step: `examples/step_by_step/07-tools.py`
-
-### Workflow Orchestration (TriggerFlow)
-
-TriggerFlow is for the moment your workflow stops being a sketch: you need events, joins, loops, concurrency limits, and long-term maintainability (including migrating from n8n/Dify/Coze-style graphs into code).
-
-TriggerFlow is Agently’s event-driven workflow engine, designed for:
-- branching (`when`, `if_condition`, `match`)
-- concurrency limits (`batch`, `for_each`)
-- loops (`emit` + `when`)
-- runtime stream events (`put_into_stream`)
-
-- Minimal example:
-```python
-from agently import TriggerFlow
-
-flow = TriggerFlow()
-flow.to(lambda d: f"Hello, {d.value}").end()
-print(flow.start("Agently"))
-```
-```text
-Output (qwen2.5:7b):
-Hello, Agently
-```
-
-- TriggerFlow series: `examples/step_by_step/11-triggerflow-01_basics.py`
-
-### Knowledge Base (embeddings + vector DB)
-
-In enterprise RAG, the question is rarely “can we retrieve?”—it’s “can we cite and defend the answer?”.
-
-Agently integrates KB pipelines (e.g., Chroma) to ground responses with real documents and metadata.
-
-- Minimal example:
-```python
-from agently import Agently
-from agently.integrations.chromadb import ChromaCollection
-
-embedding = Agently.create_agent()
-embedding.set_settings(
-    "OpenAICompatible",
-    {
-        "model": "qwen3-embedding:0.6b",
-        "base_url": "http://127.0.0.1:11434/v1/",
-        "auth": "nothing",
-        "model_type": "embeddings",
-    },
-)
-kb = ChromaCollection(collection_name="demo", embedding_agent=embedding)
-kb.add([{"document": "Agently is a GenAI framework.", "metadata": {"source": "demo"}}])
-print(kb.query("What is Agently?"))
-```
-
-- Step-by-step: `examples/step_by_step/09-knowledge_base.py`
-
-### Deployment Templates (FastAPI, Docker)
-
-For engineering delivery, the repo includes a docker-ready FastAPI project that exposes Auto Loop through:
-- SSE streaming
-- WebSocket
-- POST
-
-- Minimal example:
-```shell
-cd examples/step_by_step/13-auto_loop_fastapi
-uvicorn app.main:app --reload
-```
-
-- Project: `examples/step_by_step/13-auto_loop_fastapi/`
-
-### Learn by Examples (Recommended Path)
-
-Start with these step-by-step chapters (runnable code + explanations in docs):
-- Settings → `examples/step_by_step/01-settings.py`
-- Prompt Methods → `examples/step_by_step/02-prompt_methods.py`
-- Output Control → `examples/step_by_step/03-output_format_control.py`
-- Streaming → `examples/step_by_step/06-streaming.py`
-- Tools → `examples/step_by_step/07-tools.py`
-- TriggerFlow → `examples/step_by_step/11-triggerflow-01_basics.py`
-- Auto Loop → `examples/step_by_step/12-auto_loop.py`
-
-## Agently Helper (Desktop)
-
-Agently Helper is a desktop tool to help you quickly **understand** and **test** Agently capabilities without setting up a full project first:
-- Multi-model management and switching
-- Switching between different prompt styles
-- Structured output
-- Streaming output
-
-- Windows: https://1drv.ms/u/c/13d5207d1b13e4d3/IQC9XITZl83hR5vU9Z_t-0oKAd3jtMh_fYRypp7T2k8JhCY?e=I72GVH
-- macOS (Apple Silicon): https://1drv.ms/u/c/13d5207d1b13e4d3/IQBhdxYw9Ev1R6qTWb-esVK2AY8PwCxnBHLNuf06Ic4w7sw?e=unMjaD
-- macOS (Intel): https://1drv.ms/u/c/13d5207d1b13e4d3/IQDqUPSqRq7LR7gpCjK60FOSASl4PBsRZPGtHvBAA63U_js?e=EmwVMA
-- Linux: https://1drv.ms/u/c/13d5207d1b13e4d3/IQDVenHvItjFTqnlv294MPD9AUQDvkAKwvBcNufEXSl1nAs?e=Ti5aJ7
-
-## 💬 WeChat Group (Join Us)
-
-> [Click Here to Apply](https://doc.weixin.qq.com/forms/AIoA8gcHAFMAScAhgZQABIlW6tV3l7QQf)
-> or Scan the QR Code Below:
-
-<p align="center">
-  <img width="120" alt="WeChat QR" src="https://github.com/AgentEra/Agently/assets/4413155/7f4bc9bf-a125-4a1e-a0a4-0170b718c1a6">
-</p>
-