divi 0.0.1b0__tar.gz → 0.0.1b2__tar.gz

divi-0.0.1b2/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

divi-0.0.1b2/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

divi-0.0.1b2/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+<!-- Thanks for contributing to divine-agent! 🥳
+Given this is a project maintained by volunteers, please read this template to not waste your time, or ours! 😇 -->
+
+# Summary
+
+<!-- Write a small summary about what is happening here. -->
+
+# Checklist
+
+- [ ] I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
+- [ ] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
+- [ ] I've updated the documentation accordingly.

{divi-0.0.1b0 → divi-0.0.1b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: divi
-Version: 0.0.1b0
+Version: 0.0.1b2
 Summary: The Agent Platform for Observability & Evaluation
 License-File: LICENSE
 Requires-Python: >=3.11

divi-0.0.1b2/README.md

@@ -0,0 +1,75 @@
+<p align="center">
+  <a href="https://divine-agent.com/"><img width="128" height="128" src="https://raw.githubusercontent.com/Kaikaikaifang/divine-agent/main/docs/images/thinking-angel.png" alt='Divine Agent'></a>
+</p>
+
+<p align="center"><strong>Divine Agent</strong> <em>– Fully open-source agent observability. Simple. Clear.</em></p>
+
+<p align="center">
+<a href="https://pypi.org/project/divi/">
+    <img src="https://img.shields.io/pypi/v/divi.svg" alt="Package version">
+</a>
+</p>
+
+<p align="center">
+    <a href="./docs/README_ZH.md">中文</a> / English
+</p>
+
+divine-agent is an observability tool for LLM-based agents, offering tracing, evaluation, and usage statistics.
+
+---
+
+> [!IMPORTANT]
+> **divine-agent is currently experimental** and may undergo significant changes at any time. This project is in active development, which means APIs and features might change without prior notice.
+>
+> We do not recommend using divine-agent in production environments until a stable release is available.
+
+## Install
+
+Requires Python 3.11+
+
+```shell
+pip install divi
+```
+
+## Trace
+
+1. Get API Key from [Web](https://www.divine-agent.com/dashboard/api-keys).
+2. Create a `.env` file and add the following line:
+  ```env
+  DIVI_API_KEY=your_api_key
+  ```
+3. Run the following code:
+  ```python
+  from divi import obs_openai, observable
+  from dotenv import load_dotenv
+  from openai import OpenAI
+
+  load_dotenv()
+
+
+  class Pirate:
+      def __init__(self):
+          self.client = obs_openai(
+              OpenAI(),
+              name="Pirate",
+          )
+
+      @observable(name="Talk with pirate")
+      def talk(self, message: str):
+          """Talk like a pirate."""
+          res = self.client.chat.completions.create(
+              model="gpt-4o",
+              messages=[
+                  {"role": "developer", "content": "Talk like a pirate."},
+                  {
+                      "role": "user",
+                      "content": message,
+                  },
+              ],
+          )
+          return res.choices[0].message.content
+
+
+  pirate = Pirate()
+  pirate.talk("How do I check if a Python object is an instance of a class?")
+  ```

{divi-0.0.1b0 → divi-0.0.1b2}/apps/README.md

@@ -9,7 +9,3 @@
 | graphql | A GraphQL server | 4000 |
 | web | A Next.js web server | 4001 |
 | docs | A documentation server | 4002 |
-
-## Rules
-
-1. [Split project files by feature or route](https://nextjs.org/docs/app/getting-started/project-structure#split-project-files-by-feature-or-route)

divi-0.0.1b2/apps/docs/README.md

@@ -0,0 +1,3 @@
+# Divi Docs
+
+> This is a documentation site for the divine-agent project.

{divi-0.0.1b0 → divi-0.0.1b2}/apps/docs/docs.json

@@ -15,11 +15,11 @@
         "groups": [
           {
             "group": "Get Started",
-            "pages": ["en/introduction"]
-          },
-          {
-            "group": "Tutorials",
-            "pages": ["en/tutorials/self-refine"]
+            "pages": [
+              "en/introduction",
+              "en/quickstart/trace",
+              "en/quickstart/evaluation"
+            ]
           }
         ]
       },
@@ -28,11 +28,11 @@
         "groups": [
           {
             "group": "快速开始",
-            "pages": ["zh/introduction"]
-          },
-          {
-            "group": "使用案例",
-            "pages": ["zh/tutorials/self-refine"]
+            "pages": [
+              "zh/introduction",
+              "zh/quickstart/trace",
+              "zh/quickstart/evaluation"
+            ]
           }
         ]
       }

{divi-0.0.1b0 → divi-0.0.1b2}/apps/docs/en/introduction.mdx

@@ -13,3 +13,5 @@ description: "Welcome to the docs of Divine Agent"
   src="/images/scholar-angel.png"
   alt="Hero Dark"
 />
+
+**Divine-Agent** is an observability tool for agents, offering tracing, evaluation, and usage statistics to help users observe the performance and behavior of their agents.

divi-0.0.1b2/apps/docs/en/quickstart/evaluation.mdx

@@ -0,0 +1,34 @@
+---
+title: 'Evaluation'
+description: 'Evaluate your agents in one line'
+---
+import PirateEval from '/snippets/evaluation/pirate-eval.mdx';
+import PirateCustomEval from '/snippets/evaluation/pirate-custom-eval.mdx';
+
+<img className="block dark:hidden" src="/images/pirate-eval-example.png" />
+<img className="hidden dark:block" src="/images/pirate-eval-example-dark.png" />
+
+## Behavior Evaluation
+
+> Automate evaluation of instruction adherence and task completion for your [traced](./trace) Pirate agent.
+
+<PirateEval />
+
+## Custom Configuration
+
+| Property        | Type   | Default             | Description         |
+|-----------------|--------|---------------------|---------------------|
+| `model`         | str    | gpt-4o              | Model name used for evaluation |
+| `temperature`   | float  | 0.5                 | Temperature parameter for evaluation |
+| `n_rounds`      | int    | 5                   | Number of evaluation rounds |
+| `max_concurrency` | int  | 10                  | Maximum number of concurrent requests |
+| `api_key`       | str    | OPENAI_API_KEY      | API key for evaluation |
+| `base_url`      | str    | OPENAI_BASE_URL     | Service URL for evaluation |
+
+By default, `api_key` and `base_url` will use values from environment variables, and other options are configured as shown in the table above. You can customize the settings as follows:
+
+<PirateCustomEval />
+
+## Notes
+
+<Warning>The current evaluation functionality depends on OpenAI's [structured output](https://platform.openai.com/docs/guides/structured-outputs). Please ensure that your chosen [model](https://platform.openai.com/docs/models) supports this feature. We strongly recommend using `gpt-4o` or newer models to ensure evaluation effectiveness and compatibility.</Warning>

divi-0.0.1b2/apps/docs/en/quickstart/trace.mdx

@@ -0,0 +1,36 @@
+---
+title: 'Trace'
+description: 'Start observe your agents in under 5 minutes'
+---
+
+import PirateExample from '/snippets/pirate-example.mdx';
+
+<img className="block dark:hidden" src="/images/pirate-example.png" />
+<img className="hidden dark:block" src="/images/pirate-example-dark.png" />
+
+<Steps>
+    <Step title="Create an Account">
+        Create an account on [Divine Agent](https://www.divine-agent.com/signup?source=docs).
+    </Step>
+    <Step title="Install Divi">
+        Install the Divine Agent Python package:
+        ```shell
+        pip install divi
+        ```
+    </Step>
+    <Step title="Get API Key">
+      Get API Key from [Web](https://www.divine-agent.com/dashboard/api-keys).
+    </Step>
+    <Step title="Set up Environment">
+        Create a `.env` file and add the following line:
+        ```env
+        DIVI_API_KEY=your_api_key
+        OPENAI_BASE_URL=https://api.openai.com/v1
+        OPENAI_API_KEY=your_llm_api_key
+        ```
+    </Step>
+    <Step title="Trace Pirate Agent">
+        Run the following code:
+        <PirateExample />
+    </Step>
+</Steps>

divi-0.0.1b2/apps/docs/snippets/evaluation/pirate-custom-eval.mdx

@@ -0,0 +1,40 @@
+```python Pirate Example {2,15-18} [expandable]
+from divi import obs_openai, observable
+from divi.evaluation import EvaluatorConfig, Score
+from dotenv import load_dotenv
+from openai import OpenAI
+
+load_dotenv()
+
+
+class Pirate:
+    def __init__(self):
+        self.client = obs_openai(
+            OpenAI(),
+            name="Pirate",
+            scores=[Score.instruction_adherence, Score.task_completion],
+            eval=EvaluatorConfig(
+                model="gpt-4.1",
+                n_rounds=2,
+            ),
+        )
+
+    @observable(name="Talk with pirate")
+    def talk(self, message: str):
+        """Talk like a pirate."""
+        res = self.client.chat.completions.create(
+            model="gpt-4o",
+            messages=[
+                {"role": "developer", "content": "Talk like a pirate."},
+                {
+                    "role": "user",
+                    "content": message,
+                },
+            ],
+        )
+        return res.choices[0].message.content
+
+
+pirate = Pirate()
+pirate.talk("How do I check if a Python object is an instance of a class?")
+```

divi-0.0.1b2/apps/docs/snippets/evaluation/pirate-eval.mdx

@@ -0,0 +1,36 @@
+```python Pirate Example {2,14} [expandable]
+from divi import obs_openai, observable
+from divi.evaluation import Score
+from dotenv import load_dotenv
+from openai import OpenAI
+
+load_dotenv()
+
+
+class Pirate:
+    def __init__(self):
+        self.client = obs_openai(
+            OpenAI(),
+            name="Pirate",
+            scores=[Score.instruction_adherence, Score.task_completion],
+        )
+
+    @observable(name="Talk with pirate")
+    def talk(self, message: str):
+        """Talk like a pirate."""
+        res = self.client.chat.completions.create(
+            model="gpt-4o",
+            messages=[
+                {"role": "developer", "content": "Talk like a pirate."},
+                {
+                    "role": "user",
+                    "content": message,
+                },
+            ],
+        )
+        return res.choices[0].message.content
+
+
+pirate = Pirate()
+pirate.talk("How do I check if a Python object is an instance of a class?")
+```

divi-0.0.1b2/apps/docs/snippets/pirate-example.mdx

@@ -0,0 +1,34 @@
+```python Pirate Example {1,10-13,15} [expandable]
+from divi import obs_openai, observable
+from dotenv import load_dotenv
+from openai import OpenAI
+
+load_dotenv()
+
+
+class Pirate:
+    def __init__(self):
+        self.client = obs_openai(
+            OpenAI(),
+            name="Pirate",
+        )
+
+    @observable(name="Talk with pirate")
+    def talk(self, message: str):
+        """Talk like a pirate."""
+        res = self.client.chat.completions.create(
+            model="gpt-4o",
+            messages=[
+                {"role": "developer", "content": "Talk like a pirate."},
+                {
+                    "role": "user",
+                    "content": message,
+                },
+            ],
+        )
+        return res.choices[0].message.content
+
+
+pirate = Pirate()
+pirate.talk("How do I check if a Python object is an instance of a class?")
+```

{divi-0.0.1b0 → divi-0.0.1b2}/apps/docs/zh/development/roadmap.mdx

@@ -2,3 +2,5 @@
 title: '开发路线图'
 description: '开发路线图'
 ---
+
+- [ ] 完善相关文档

{divi-0.0.1b0 → divi-0.0.1b2}/apps/docs/zh/introduction.mdx

@@ -13,3 +13,5 @@ description: "欢迎使用 Divine Agent"
   src="/images/scholar-angel.png"
   alt="Hero Dark"
 />
+
+**神明代理人 (Divine Agent)** 是一个智能体可观测工具，提供追踪、评估和用量统计功能，帮助用户观察智能体的性能和行为。

divi-0.0.1b2/apps/docs/zh/quickstart/evaluation.mdx

@@ -0,0 +1,34 @@
+---
+title: '评估'
+description: '一行代码完成智能体评估'
+---
+import PirateEval from '/snippets/evaluation/pirate-eval.mdx';
+import PirateCustomEval from '/snippets/evaluation/pirate-custom-eval.mdx';
+
+<img className="block dark:hidden" src="/images/pirate-eval-example.png" />
+<img className="hidden dark:block" src="/images/pirate-eval-example-dark.png" />
+
+## 行为评估
+
+> 自动化评估[跟踪](./trace)的海盗 (Pirate) 智能体的指令遵从性和任务完成度。
+
+<PirateEval />
+
+## 自定义设置
+
+| Property        | Type   | Default             | Description         |
+|-----------------|--------|:-------------------:|---------------------|
+| `model`         | str    | gpt-4o              | 用于评估的模型名称     |
+| `temperature`   | float  | 0.5                 | 评估过程中的温度参数    |
+| `n_rounds`      | int    | 5                   | 评估的轮数            |
+| `max_concurrency` | int  | 10                  | 最大并发请求数         |
+| `api_key`       | str    | OPENAI_API_KEY      | 用于评估的 API 密钥    |
+| `base_url`      | str    | OPENAI_BASE_URL     | 评估所用的服务商 URL   |
+
+默认情况下，`api_key` 与 `base_url` 会使用环境变量中的值，其他选项配置如上表所示。您可以通过以下方式自定义设置：
+
+<PirateCustomEval />
+
+## 注意事项
+
+<Warning>当前评估功能依赖于 OpenAI 的[结构化输出](https://platform.openai.com/docs/guides/structured-outputs)，请确保您所选择的[模型](https://platform.openai.com/docs/models)支持该功能，我们强烈建议使用 `gpt-4o` 或更新版本的模型以确保评估效果和兼容性。</Warning>

divi-0.0.1b2/apps/docs/zh/quickstart/trace.mdx

@@ -0,0 +1,36 @@
+---
+title: '追踪'
+description: '5 分钟内开启智能体追踪'
+---
+
+import PirateExample from '/snippets/pirate-example.mdx';
+
+<img className="block dark:hidden" src="/images/pirate-example.png" />
+<img className="hidden dark:block" src="/images/pirate-example-dark.png" />
+
+<Steps>
+    <Step title="创建账户">
+        在 [Divine Agent](https://www.divine-agent.com/signup?source=docs) 上创建一个账户。
+    </Step>
+    <Step title="安装 Divi">
+        安装 Divine Agent Python 包:
+        ```shell
+        pip install divi
+        ```
+    </Step>
+    <Step title="获取 API Key">
+      从 [Web](https://www.divine-agent.com/dashboard/api-keys) 获取 API Key。
+    </Step>
+    <Step title="设置环境">
+        创建一个 `.env` 文件并添加以下行:
+        ```env
+        DIVI_API_KEY=your_api_key
+        OPENAI_BASE_URL=https://api.openai.com/v1
+        OPENAI_API_KEY=your_llm_api_key
+        ```
+    </Step>
+    <Step title="追踪 Pirate Agent">
+        运行以下代码:
+        <PirateExample />
+    </Step>
+</Steps>

divi-0.0.1b2/apps/graphql/README.md

@@ -0,0 +1,3 @@
+# Divi GraphQL
+
+> This is the GraphQL API for the divine-agent project.

divi-0.0.1b2/apps/web/README.md

@@ -0,0 +1,3 @@
+# Divi Web
+
+> This is the web application for the divine-agent project.

divi-0.0.1b2/divi/README.md

@@ -0,0 +1,3 @@
+# DIVI SDK
+
+> this is the Python SDK for the divine-agent project.

{divi-0.0.1b0 → divi-0.0.1b2}/divi/__init__.py

@@ -1,10 +1,9 @@
 from typing import Optional
 
 from .decorators import obs_openai, observable
-from .evaluation import Evaluator, Score
+from .evaluation import Evaluator
 from .services import Auth, Core, DataPark
 from .session import Session
-from .signals import Kind
 
 name: str = "divi"
 
@@ -14,5 +13,5 @@ _auth: Optional[Auth] = None
 _datapark: Optional[DataPark] = None
 _evaluator: Optional[Evaluator] = None
 
-__version__ = "0.0.1b0"
-__all__ = ["obs_openai", "observable", "Score", "Kind"]
+__version__ = "0.0.1b2"
+__all__ = ["obs_openai", "observable"]

{divi-0.0.1b0 → divi-0.0.1b2}/divi/decorators/obs_openai.py

@@ -5,6 +5,7 @@ from typing import TYPE_CHECKING, TypeVar, Union
 from typing_extensions import Optional
 
 from divi.decorators.observable import observable
+from divi.evaluation.evaluator import EvaluatorConfig
 from divi.evaluation.scores import Score
 from divi.signals.span import Kind
 from divi.utils import is_async
@@ -19,10 +20,13 @@ def _get_observable_create(
     create: Callable,
     name: Optional[str] = None,
     scores: Optional[list[Score]] = None,
+    eval: Optional[EvaluatorConfig] = None,
 ) -> Callable:
     @functools.wraps(create)
     def observable_create(*args, stream: bool = False, **kwargs):
-        decorator = observable(kind=Kind.llm, name=name, scores=scores)
+        decorator = observable(
+            kind=Kind.llm, name=name, scores=scores, eval=eval
+        )
         return decorator(create)(*args, stream=stream, **kwargs)
 
     # TODO Async Observable Create
@@ -33,16 +37,13 @@ def obs_openai(
     client: C,
     name: Optional[str] = "Agent",
     scores: Optional[list[Score]] = None,
+    eval: Optional[EvaluatorConfig] = None,
 ) -> C:
     """Make OpenAI client observable."""
     client.chat.completions.create = _get_observable_create(
         client.chat.completions.create,
         name=name,
         scores=scores,
-    )
-    client.completions.create = _get_observable_create(
-        client.completions.create,
-        name=name,
-        scores=scores,
+        eval=eval,
     )
     return client

{divi-0.0.1b0 → divi-0.0.1b2}/divi/decorators/observable.py

@@ -15,6 +15,7 @@ from typing import (
 
 from divi.decorators.observe import observe
 from divi.evaluation.evaluate import evaluate_scores
+from divi.evaluation.evaluator import EvaluatorConfig
 from divi.evaluation.scores import Score
 from divi.session import SessionExtra
 from divi.signals.span import Kind, Span
@@ -43,6 +44,7 @@ def observable(
     *,
     name: Optional[str] = None,
     scores: Optional[list[Score]] = None,
+    eval: Optional[EvaluatorConfig] = None,
     metadata: Optional[Mapping[str, Any]] = None,
 ) -> Callable[[Callable[P, R]], WithSessionExtra[P, R]]: ...
 
@@ -56,6 +58,7 @@ def observable(
     name = kwargs.pop("name", None)
     metadata = kwargs.pop("metadata", None)
     scores: list[Score] = kwargs.pop("scores", None)
+    eval: EvaluatorConfig = kwargs.pop("eval", None)
 
     def decorator(func):
         @functools.wraps(func)
@@ -78,7 +81,9 @@ def observable(
 
             # 3. evaluate the scores if they are provided
             messages = kwargs.get("messages", [])
-            evaluate_scores(messages, outputs=result, scores=scores)
+            evaluate_scores(
+                messages, outputs=result, scores=scores, config=eval
+            )
 
             return result
 

divi-0.0.1b2/divi/evaluation/__init__.py

@@ -0,0 +1,4 @@
+from .evaluator import Evaluator, EvaluatorConfig
+from .scores import Score
+
+__all__ = ["Evaluator", "Score", "EvaluatorConfig"]