OpenBB LLM 代理

开发中。

这是一个利用大语言模型和 OpenBB 平台 构建金融分析师代理的项目，这些代理能够自主进行金融研究，并使用最新数据回答问题。之所以能做到这一点，是因为代理通过函数调用与 OpenBB 平台交互。

安装

目前我们支持 Python 3.10 及以上版本。我们将在不久的将来增加对更多 Python 版本的支持。

openbb-agents 已作为 PyPI 包发布：

pip install openbb-agents --upgrade

设置

OpenAI API 密钥

要使用 OpenBB LLM 代理，您需要一个 OpenAI API 密钥。请按照以下步骤操作：

1. 获取 API 密钥：在 OpenAI 上注册并获取您的 API 密钥。
2. 设置环境变量：将以下内容添加到您的 shell 配置文件（.bashrc、.zshrc 等）中：

   export OPENAI_API_KEY="your_openai_api_key"
   

OpenBB 平台的数据提供商凭证

要使用 OpenBB 平台的功能，您需要配置必要的 数据提供商 API 凭证。这可以通过两种方式完成：

1. 本地配置：在 ~/.openbb_platform/user_settings.json 文件中指定您的凭证。请参阅 本地环境设置指南 以获取详细说明。
2. OpenBB Hub：通过您的 OpenBB Hub 账户创建个人访问令牌 (PAT)。然后可以将此 PAT 作为参数传递给代理。

入门

强烈建议您查看 入门笔记本，它将带您从高层次了解 openbb-agents 的各项功能。

使用方法

>>> from openbb_agents.agent import openbb_agent
>>> result = openbb_agent("TSLA 目前的市值是多少？")  # 将打印一些日志以显示进度
>>> print(result)
- TSLA（特斯拉公司）当前的市值约为 695,833,798,800.00 美元。
- 该数据基于最新可用信息，即 2024 年 1 月 15 日。
- 市值是通过当前股价（218.89 美元）乘以流通股数（3,178,920,000 股）计算得出的。

如果您希望使用存储在 OpenBB Hub 中的数据提供商凭证，可以直接将 OpenBB Hub 的 PAT 传递给代理：

>>> openbb_agent("AAPL 的股价是多少？", openbb_pat="<openbb-hub-pat>")

注意：代理会根据可用的数据提供商凭证动态配置自身。因此，在没有相应 API 密钥的情况下，某些数据源和功能可能无法访问。默认情况下，yfinance 已被包含为数据提供商，且无需 API 密钥。有关功能及其支持的数据提供商的完整列表，请参阅 OpenBB 平台文档。

查询可以相当复杂：

>>> openbb_agent("使用最近可用的数据对 AMZN 进行基本面财务分析。你发现了什么有趣的内容？")

查询也可能具有时间依赖性（即后续子问题的答案需要先前子问题的答案）：

>>> openbb_agent("TSLA 的同行有哪些？它们各自的市值是多少？请按市值 _降序_ 返回结果。")

此外，还提供了一个异步版本的代理：

>>> from openbb_agents.agent import aopenbb_agent
>>> await aopenbb_agent("TSLA 当前的市值是多少？")

开发

• 创建一个新的虚拟环境，使用 poetry
• poetry install

代码检查与格式化

我们目前正在尝试使用 ruff 作为 black、isort 和 pylint 的替代工具。

您可以运行代码检查如下：

ruff check

或者修复代码中的错误：

ruff check --fix

又或者格式化代码：

ruff format

我们还将这些工具集成到了 pre-commit 中，以便在提交代码之前自动执行这些检查。您可以这样安装 pre-commit 钩子：

pre-commit install

测试

我们使用 pytest 作为测试运行器：

pytest -n 8 tests/

OpenBB LLM Agents 快速上手指南

OpenBB LLM Agents 是一个利用大语言模型（LLM）和 OpenBB Platform 构建的金融分析智能体项目。它能够自主执行金融研究，并通过函数调用实时获取最新数据来回答用户问题。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows
• Python 版本：要求 Python 3.10 或更高版本
• 前置依赖：
  • OpenAI API Key（用于驱动 LLM）
  • 可选：OpenBB Hub 个人访问令牌（PAT）或其他数据提供商的 API 凭证（如 FMP, Polygon 等），以获取更丰富的数据源。默认内置 yfinance 无需额外配置即可使用基础数据。

安装步骤

推荐使用 pip 进行安装：

pip install openbb-agents --upgrade

提示：国内开发者若遇到下载速度慢的问题，可使用清华或阿里云镜像源加速安装：

pip install openbb-agents --upgrade -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

1. 配置 API Key

在使用前，需设置 OpenAI API Key 环境变量。

Linux/macOS:

export OPENAI_API_KEY="your_openai_api_key"

Windows (PowerShell):

$env:OPENAI_API_KEY="your_openai_api_key"

(可选) 若拥有 OpenBB Hub 账号，可生成 Personal Access Token (PAT) 以解锁更多数据源，后续可在代码中直接传入。

2. 运行示例

创建一个 Python 脚本或在交互式环境中运行以下代码：

from openbb_agents.agent import openbb_agent

# 简单查询示例
result = openbb_agent("What is the current market cap of TSLA?")
print(result)

输出示例：

- The current market cap of TSLA (Tesla, Inc.) is approximately $695,833,798,800.00.
- This figure is based on the most recent data available, which is from January 15, 2024.
- The market cap is calculated by multiplying the current stock price ($218.89) by the number of outstanding shares (3,178,920,000).

3. 高级用法

使用 OpenBB Hub PAT：

openbb_agent("What is the stock price of AAPL?", openbb_pat="<openbb-hub-pat>")

复杂分析与多步推理：

# 基本面分析
openbb_agent("Perform a fundamentals financial analysis of AMZN using the most recently available data. What do you find that's interesting?")

# 依赖上下文的对比查询
openbb_agent("Who are TSLA's peers? What is their respective market cap? Return the results in _descending_ order of market cap.")

异步调用：

from openbb_agents.agent import aopenbb_agent

await aopenbb_agent("What is the current market cap of TSLA?")

注意：智能体会根据已配置的 API 密钥动态调整可用功能。若未配置特定数据源密钥，相关函数将不可用。默认情况下，yfinance 作为免密钥数据源始终可用。