快速开始

本页是 Agently 开发手册的第一课。目标不是一次讲完所有能力，而是在几分钟内带你跑通一条最小但正确的开发路径。

适合什么时候读

你第一次接触 Agently
你想先确认环境、模型设置和最小请求链路都能工作
你希望之后按 docs 的顺序继续学习

你会学到什么

如何安装 Agently
如何完成最小模型设置
如何通过 input() + output() + start() 拿到结构化结果
跑通之后下一步该去哪一章

TIP

本页的最小示例故意使用同步写法，目的是降低第一次上手的复杂度。真正进入服务端、流式 UI、SSE 或 TriggerFlow 编排时，推荐改为 Async First 实践里的异步接口。

1. 安装

bash

pip install -U agently

也可以使用：

bash

uv pip install -U agently

2. 设置模型

Agently v4 的常用接入方式是 OpenAICompatible。先填好 base_url + api_key + model：

python

from agently import Agently

Agently.set_settings(
    "OpenAICompatible",
    {
        "base_url": "https://api.deepseek.com/v1",
        "api_key": "YOUR_DEEPSEEK_API_KEY",
        "model": "deepseek-chat",
    },
)

如果你需要看更多 provider 写法，继续读模型设置总览。

3. 跑通最小结构化输出

python

from agently import Agently

agent = Agently.create_agent()

result = (
    agent
    .input("为 Agently 写一个一句话定位，并给出 2 个卖点")
    .output(
        {
            "定位": ("str", "一句话定位"),
            "卖点": [
                {
                    "标题": ("str", "卖点标题"),
                    "说明": ("str", "卖点说明"),
                }
            ],
        }
    )
    .start()
)

print(result)

你拿到的结果会是一个结构化对象，而不是一段难以稳定消费的自由文本。

4. 接下来怎么学

跑通上面的例子后，按这个顺序继续：

如果你已经明确会把 Agently 接进 Web 服务、流式界面或工作流，请把这条路线当成并行主线：

常见误区

还没跑通最小链路，就先上 TriggerFlow。
一开始就写自定义 JSON parser，而不是先用 output()。
把 Prompt、设置和业务逻辑全写进一个脚本里，后面难以扩展。

下一步去哪

要接更多 provider：看模型设置总览
要让字段更稳：看输出控制概览
要消费 streaming、text、data、meta：看模型返回结果概览
要按推荐方式进入工程落地：看 Async First 实践
要理解长期可维护的项目骨架：看推荐项目结构

快速开始 ​

适合什么时候读 ​

你会学到什么 ​

1. 安装 ​

2. 设置模型 ​

3. 跑通最小结构化输出 ​

4. 接下来怎么学 ​

常见误区 ​

下一步去哪 ​

相关案例 ​

Related Skills（可选） ​