利用LLM的强大功能丰富API描述和URL ...

简介

在快速发展的技术领域，应用程序编程接口（API）已成为软件应用程序之间实现无缝通信的关键桥梁。开发人员通常依赖API文档来理解和使用这些接口，但在海量文档中找到正确的API可能是一项艰巨的任务。本文将介绍如何利用大型语言模型（LLM）简化API文档的浏览、信息提取以及API URL的生成过程，从而提升开发效率。

LLM中的提示功能解析

在本文中，我们使用了高级语言模型 Cohere。在深入探讨 Cohere 的能力之前，先了解一下 LLM 中的“提示”概念。提示是提供给模型的一组指令或初始文本，用于指导其生成内容。例如，开发人员可以输入以下提示：

“为 Oracle HCM API 生成描述以检索员工信息。”

这种提示能够引导模型生成与特定查询相关的内容，从而确保输出结果的精准性和实用性。

API文档搜索的挑战

在技术快速迭代的背景下，搜索API文档对开发人员来说可能是一项复杂且耗时的任务。以下是常见的挑战：

命名约定不明确或不一致：增加了理解难度。
文档不完整或过时：导致信息不准确。
缺乏相关示例：使开发人员难以快速上手。
难以识别正确的API参数：增加了试错成本。
需要手动搜索多个文档：效率低下。

以 Oracle HCM（人力资本管理）为例，其提供了多种API，从员工信息检索到薪资管理不等。然而，浏览大量API文档以找到适合特定用例的API，往往既复杂又耗时。

为了解决这些问题，我们提出了一种系统化的流程：

从API文档URL获取Swagger文件。
使用Python模块处理文档。
利用LLM生成带有丰富描述的格式化API文档。
初始化嵌入并将API文档存储为向量，便于高效检索。
基于生成的描述和格式化文档，自动生成API URL。

使用LLM丰富API描述

LLM通过自然语言处理技术，能够为API生成更具描述性的内容。例如，开发人员可以使用以下提示：

“从 Oracle HCM 检索员工信息。”

Cohere 会根据提示分析上下文，并生成相关的API描述。这种方式无需手动浏览冗长的文档，大幅提升了开发效率。

嵌入技术与向量数据库的结合

LLM的应用不仅限于生成API描述，还可以通过嵌入技术将API数据存储在向量数据库中，以实现快速检索。嵌入是一种将API文档表示为多维向量的技术，每个向量都包含文档的独特特征和关系。

通过将API文档转换为向量并存储在数据库中，开发人员可以根据相关性高效搜索和比较API，从而快速找到最适合的解决方案。

以下是一个示例代码片段，展示如何使用 Cohere 的嵌入服务生成API文档的嵌入：

from cohere.embeddings import CohereEmbeddings
from chromadb import PersistentClient

# 初始化 Cohere 嵌入对象
cohere_embeddings = CohereEmbeddings(api_key="your_api_key")
client = PersistentClient("./chroma_db")

# 读取API文档并生成嵌入
with open("hcm_API_doc.txt", "r") as file:
    api_docs = file.read()

# 文本分块处理
text_chunks = RecursiveCharacterTextSplitter(api_docs)
embeddings = cohere_embeddings.generate(text_chunks)

# 存储嵌入到数据库
client.store_embeddings(embeddings)

通过上述流程，开发人员可以快速检索最相关的API文档。例如，以下代码展示了如何基于查询检索相关API：

query = "我可以使用哪个API获取注册数据？"
relevant_docs = db_retriever.get_relevant_documents(query)
print(relevant_docs[0])

使用LLM生成API URL

LLM还可以通过交互式提示帮助开发人员生成API URL。例如，开发人员可以提出以下问题：

“我没有凯西·布朗的员工证，但凯西·布朗是谁？他什么时候被录用的？”

Cohere 会根据问题解析上下文，并生成如下API URL：

https://example.com/hcmRestApi/resources/11.13.18.05/emps?q=FirstName=Casey;LastName=Brown&fields=HireDate

这种基于问题的提示结合少量示例学习的方式，能够显著提升API URL生成的准确性和效率。

结论

大型语言模型（LLM）为开发人员提供了一种强大的工具，能够显著简化API文档的搜索、理解和使用过程。通过提示生成、向量数据库嵌入以及交互式问题解析，LLM能够帮助开发人员提高生产力、效率和创新能力。

随着LLM技术的不断发展，开发人员将能够更加专注于核心任务——开发高质量的软件解决方案，推动技术进步。未来，LLM有望彻底改变开发人员与API文档的交互方式，使软件开发更加高效和便捷。

原文链接: https://www.ateam-oracle.com/post/harnessing-the-power-of-llm-to-enrich-api-description-and-url-generation