跳转到主要内容

​
Maxim 概览

Maxim AI 为您的 CrewAI 应用程序提供全面的代理监控、评估和可观测性。通过 Maxim 的一行集成，您可以轻松追踪和分析代理交互、性能指标等。

​
功能

​
提示管理

Maxim 的提示管理功能使您能够为 CrewAI 代理创建、组织和优化提示。无需硬编码指令，利用 Maxim 的 SDK 动态检索和应用版本控制的提示。
  • 提示 Playground
  • 提示版本
  • 提示比较
通过 Playground 创建、完善、实验和部署您的提示。使用文件夹和版本组织您的提示，通过链接工具和上下文试验真实世界案例，并根据自定义逻辑进行部署。通过配置模型并从提示 Playground 顶部的下拉菜单中选择相关模型，轻松地跨模型进行实验。

​
可观测性与评估

Maxim AI 为您的 CrewAI 代理提供全面的可观测性与评估，帮助您准确了解每次执行过程中发生的情况。
  • 代理追踪
  • 分析 + 评估
  • 警报
  • 仪表盘
轻松追踪代理的完整生命周期，包括工具调用、代理轨迹和决策流程。

​
开始入门

​
先决条件

  • Python 版本 >=3.10
  • 一个 Maxim 账户（在此注册）
  • 生成 Maxim API 密钥
  • 一个 CrewAI 项目

​
安装

通过 pip 安装 Maxim SDK 
pip install maxim-py
或者将其添加到您的 requirements.txt 中 
maxim-py

​
基本设置

​
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 仪表盘中。 查看此 Google Colab Notebook 以获取快速参考 - Notebook

​
查看您的追踪

运行您的 CrewAI 应用程序后
  1. 登录您的Maxim 仪表盘
  2. 导航到您的存储库
  3. 查看详细的代理追踪，包括
    • 代理对话
    • 工具使用模式
    • 性能指标
    • 成本分析

​
故障排除

​
常见问题

  • 未出现追踪：确保您的 API 密钥和存储库 ID 正确
  • 确保您在运行 crew 之前 调用了 instrument_crewai()。这可以正确初始化日志记录钩子。
  • 在您的 instrument_crewai() 调用中设置 debug=True 以显示任何内部错误 
    instrument_crewai(logger, debug=True)
  • 使用 verbose=True 配置您的代理以捕获详细日志 
    agent = CrewAgent(..., verbose=True)
  • 仔细检查 instrument_crewai() 是否在创建或执行代理之前被调用。这可能很明显，但这是一个常见的疏忽。

​
资源

CrewAI 文档

CrewAI 官方文档

Maxim 文档

Maxim 官方文档

Maxim Github

Maxim Github