文档索引
获取完整文档索引： https://docs.crewai.com.cn/llms.txt
在深入了解之前，请使用此文件来浏览所有可用页面。
Maxim 概述
Maxim AI 为您的 CrewAI 应用程序提供全面的智能体监控、评估和可观测性功能。通过 Maxim 的一行代码集成，您可以轻松追踪和分析智能体交互、性能指标等。
提示词管理
Maxim 的提示词管理功能使您能够为 CrewAI 智能体创建、组织和优化提示词。无需硬编码指令，利用 Maxim 的 SDK 即可动态检索和应用版本控制的提示词。
提示词测试场 (Playground)
提示词版本
提示词对比
通过测试场创建、优化、实验和部署您的提示词。使用文件夹和版本来组织您的提示词，通过链接工具和上下文在真实案例中进行实验，并根据自定义逻辑进行部署。通过配置模型并从提示词测试场顶部的下拉菜单中选择相关模型，可以轻松地跨模型进行实验。
随着团队构建 AI 应用程序，实验的一个重要部分是迭代提示词结构。为了有效地协作并清晰地组织您的更改，Maxim 允许进行提示词版本控制和跨版本对比运行。
在改进 AI 应用程序的过程中迭代提示词时，需要跨模型、提示词结构等进行实验。为了对比版本并就更改做出明智的决定，对比测试场允许并排查看结果。为什么要使用提示词对比？
提示词对比将多个单一提示词组合到一个视图中，为各种工作流提供了简化的方法
- 模型对比：评估不同模型在同一提示词上的性能。
- 提示词优化：比较提示词的不同版本，以确定最有效的表述。
- 跨模型一致性：确保同一提示词在不同模型下产生一致的输出。
- 性能基准测试：分析跨不同模型和提示词的延迟、成本和令牌计数等指标。
可观测性与评估
Maxim AI 为您的 CrewAI 智能体提供全面的可观测性和评估功能，帮助您准确了解每次执行期间发生的情况。
智能体追踪 (Tracing)
分析 + 评估
告警
仪表板
轻松追踪智能体的完整生命周期，包括工具调用、智能体轨迹和决策流。
对完整轨迹或单个节点运行详细评估，支持：
- 多步交互和细粒度轨迹分析
- 会话级评估
- 用于真实世界测试的模拟
对错误、成本、令牌使用量、用户反馈、延迟设置阈值，并通过 Slack 或 PagerDuty 获取实时告警。
轻松可视化随时间变化的轨迹、使用指标、延迟和错误率。
开始入门
先决条件
- Python 版本 >=3.10
- 一个 Maxim 帐户（点击此处注册）
- 生成 Maxim API 密钥
- 一个 CrewAI 项目
通过 pip 安装 Maxim SDK
或者将其添加到您的 requirements.txt 中
基本设置
1. 设置环境变量
### Environment Variables Setup
# Create a `.env` file in your project root:
# Maxim API Configuration
MAXIM_API_KEY=your_api_key_here
MAXIM_LOG_REPO_ID=your_repo_id_here
2. 导入所需的包
from crewai import Agent, Task, Crew, Process
from maxim import Maxim
from maxim.logger.crewai import instrument_crewai
3. 使用您的 API 密钥初始化 Maxim
# Instrument CrewAI with just one line
instrument_crewai(Maxim().logger())
4. 像往常一样创建并运行您的 CrewAI 应用程序
# Create your agent
researcher = Agent(
role='Senior Research Analyst',
goal='Uncover cutting-edge developments in AI',
backstory="You are an expert researcher at a tech think tank...",
verbose=True,
llm=llm
)
# Define the task
research_task = Task(
description="Research the latest AI advancements...",
expected_output="",
agent=researcher
)
# Configure and run the crew
crew = Crew(
agents=[researcher],
tasks=[research_task],
verbose=True
)
try:
result = crew.kickoff()
finally:
maxim.cleanup() # Ensure cleanup happens even if errors occur
查看您的追踪记录
运行您的 CrewAI 应用程序后
-
登录您的 Maxim 仪表板
-
导航到您的存储库
-
查看详细的智能体追踪记录，包括：
故障排除
常见问题
-
没有出现追踪记录：确保您的 API 密钥和存储库 ID 正确无误
-
确保您在运行任务（crew）之前
调用了 instrument_crewai()。这能正确初始化日志钩子。
-
在您的
instrument_crewai() 调用中设置 debug=True 以显现任何内部错误
instrument_crewai(logger, debug=True)
-
将您的智能体配置为
verbose=True 以捕获详细日志
agent = CrewAgent(..., verbose=True)
-
仔细检查
instrument_crewai() 是否在创建或执行智能体之前调用。这虽然显而易见，但却是一个常见的疏忽。
