利用 OpenAPI 代理实现复杂 API 的层次化规划

最新推荐文章于 2025-05-01 23:36:42 发布

fGVBSAbe

最新推荐文章于 2025-05-01 23:36:42 发布

阅读量311

点赞数 4

文章标签： python 前端开发语言

本文链接：https://blog.youkuaiyun.com/fGVBSAbe/article/details/145332043

版权

在现代软件开发中，如何高效地集成和使用复杂的 API 是一个普遍且重要的问题。特别是当 API 规范遵循 OpenAPI 或 Swagger 标准时，我们可以通过构建具有层次化规划能力的代理来处理这些 API。在本文中，我们将介绍如何使用这种方法来处理复杂的 API，演示代码实现，并分析其应用场景和实践建议。

技术背景介绍

层次化规划是一个常用于机器人学中的方法，现在也被引入到自然语言处理和 API 集成领域。它的基本思想是通过分离关注点，来实现对长序列行为的一致性管理：规划器（planner）负责决定调用哪些端点，而控制器（controller）负责具体调用这些端点的细节。

核心原理解析

规划器：使用大语言模型（LLM）链来处理每个端点的名称和简要描述。
控制器：被初始化为仅包含规划中涉及端点的文档。

通过这种方式，可以更好地管理在不同操作中需要调用的 API 端点，从而提高系统的健壮性。

代码实现演示

以下代码演示了如何实现一个 Spotify API 的代理，该代理可以创建播放列表，并根据用户请求添加歌曲。我们使用了 langchain_community 和 langchain_openai 库来简化操作。

import os
import yaml
import spotipy.util as util
from langchain_community.agent_toolkits.openapi.spec import reduce_openapi_spec
from langchain_community.agent_toolkits.openapi import planner
from langchain_openai import ChatOpenAI
from langchain.requests import RequestsWrapper

# 加载 OpenAPI 规范
with open("spotify_openapi.yaml") as f:
    raw_spotify_api_spec = yaml.load(f, Loader=yaml.Loader)
spotify_api_spec = reduce_openapi_spec(raw_spotify_api_spec)

# 构建 Spotify 鉴权
def construct_spotify_auth_headers(raw_spec: dict):
    scopes = list(
        raw_spec["components"]["securitySchemes"]["oauth_2_0"]["flows"][
            "authorizationCode"
        ]["scopes"].keys()
    )
    access_token = util.prompt_for_user_token(scope=",".join(scopes))
    return {"Authorization": f"Bearer {access_token}"}

# 获取 API 凭证
headers = construct_spotify_auth_headers(raw_spotify_api_spec)
requests_wrapper = RequestsWrapper(headers=headers)

# 使用 GPT-4 构建 API 代理
llm = ChatOpenAI(model_name="gpt-4", temperature=0.0)
spotify_agent = planner.create_openapi_agent(
    spotify_api_spec,
    requests_wrapper,
    llm,
    allow_dangerous_requests=True,
)

# 演示用户查询
user_query = "make me a playlist with the first song from Kind of Blue. call it machine blues."
spotify_agent.invoke(user_query)