aigne.yaml 文件是 AIGNE 项目的核心。它作为中央清单文件,定义了项目的元数据、语言模型设置以及其核心组件(如 agent 和技能)之间的关系。一个结构良好的 aigne.yaml 是构建强大且有组织的 agent 的第一步。
该文件使用 YAML 格式,这种格式旨在方便人类阅读和编写。
核心配置项
让我们来分解一下典型的 aigne.yaml 文件中的主要部分。
项目元数据
这些字段提供有关您项目的基本信息。
- name
string(required) — 项目的唯一标识符。 - description
string— 关于项目功能的简要总结。
aigne.yaml
name: test_aigne_project
description: A test project for the aigne agent聊天模型 (chat_model)
这是一个关键部分,您可以在这里配置为 agent 提供支持的大语言模型 (LLM)。AIGNE 提供了一种灵活的方式来定义模型提供商、名称和其他参数。
| 键 | 类型 | 描述 |
|---|---|---|
provider | string | LLM 提供商(例如 openai)。也可以在 model 键中作为前缀指定。 |
name / model | string | 要使用的具体模型(例如 gpt-4o-mini)。 |
temperature | number | 一个介于 0 和 2 之间的值,用于控制模型输出的随机性。值越高,响应越具创造性。 |
以下是两种配置模型的常见方法:
示例 1:使用 provider 和 name
这是一种清晰、明确地定义模型的方式。
aigne.yaml
chat_model:
provider: openai
name: gpt-4o-mini
temperature: 0.8示例 2:使用带前缀的 model 键
这是一种更简洁的速记格式。
aigne.yaml
chat_model:
model: openai:gpt-4o-mini
temperature: 0.8Agents (agents)
agents 键列出了项目中包含的所有 agent 定义文件(.yaml)。此处列出的每个文件都定义了特定 agent 的行为、提示和工具使用。
aigne.yaml
# ... other configurations
agents:
- chat.yaml技能 (skills)
skills 键列出了为 agent 提供工具和能力的可执行代码或定义。这些可以是包含函数的 JavaScript 文件(.js),也可以是定义复杂技能的其他 YAML 文件。
aigne.yaml
# ... other configurations
skills:
- sandbox.js
- filesystem.yaml服务和 CLI 暴露
您还可以配置如何将 agent 暴露给外部世界,无论是通过服务器还是作为命令行工具。
mcp_server: 配置当您运行aigne serve-mcp命令时,哪些 agent 通过模型上下文协议 (MCP) 提供服务。cli: 配置哪些 agent 可以直接从命令行运行。
aigne.yaml
# ... other configurations
mcp_server:
agents:
- chat.yaml
cli:
agents:
- chat.yaml完整示例
以下是一个完整的 aigne.yaml 文件,它将所有这些元素整合在一起:
aigne.yaml
name: test_aigne_project
description: A test project for the aigne agent
chat_model:
model: openai:gpt-4o-mini
temperature: 0.8
agents:
- chat.yaml
skills:
- sandbox.js
mcp_server:
agents:
- chat.yaml
cli:
agents:
- chat.yaml有了这个配置文件,您的项目就有了一个坚实的基础。下一步是定义您的 agent 和技能的实际功能。
既然您已经了解了如何配置项目,让我们更详细地探讨核心组件。请继续下一部分,学习Agent 和技能。