async-openai:为Rust开发者打造的OpenAI异步库
在人工智能快速发展的今天,OpenAI的各种强大API为开发者提供了无限可能。然而,如何高效、便捷地调用这些API,一直是开发者关注的焦点。async-openai应运而生,它是一个专为Rust开发者设计的非官方异步库,旨在简化OpenAI API的调用过程,提高开发效率。
库的主要特性
async-openai基于OpenAI的OpenAPI规范开发,提供了丰富的功能支持:
-
全面的API覆盖:支持Assistants(v2)、Audio、Batch、Chat、Completions(Legacy)、Embeddings、Files、Fine-Tuning、Images、Models、Moderations等多种OpenAI API。
-
异步支持:利用Rust的异步特性,提供高效的API调用方式。
-
SSE流式处理:对于支持的API,提供服务器发送事件(SSE)的流式处理能力。
-
自动重试机制:除SSE流式处理外,所有请求(包括表单提交)在遇到速率限制时会自动进行指数退避重试。
-
人性化的构建模式:为所有请求对象提供符合人体工程学的构建器模式。
-
Azure OpenAI支持:兼容Microsoft Azure OpenAI Service(仅限与OpenAI规范匹配的API)。
使用指南
使用async-openai非常简单。首先,你需要设置OpenAI的API密钥。库会从环境变量OPENAI_API_KEY
中读取API密钥:
# 在macOS/Linux上
export OPENAI_API_KEY='sk-...'
# 在Windows Powershell上
$Env:OPENAI_API_KEY='sk-...'
接下来,让我们通过一个图像生成的例子来展示async-openai的使用方法:
use async_openai::{
types::{CreateImageRequestArgs, ImageSize, ImageResponseFormat},
Client,
};
use std::error::Error;
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
// 创建客户端,从环境变量读取API密钥
let client = Client::new();
let request = CreateImageRequestArgs::default()
.prompt("cats on sofa and carpet in living room")
.n(2)
.response_format(ImageResponseFormat::Url)
.size(ImageSize::S256x256)
.user("async-openai")
.build()?;
let response = client.images().create(request).await?;
// 下载并保存图片到./data目录
// 每个URL在专用的Tokio任务中下载和保存
// 如果目录不存在会自动创建
let paths = response.save("./data").await?;
paths
.iter()
.for_each(|path| println!("Image file path: {}", path.display()));
Ok(())
}
这个例子展示了如何使用async-openai生成图像并保存。它利用了库提供的构建器模式来创建请求,然后异步调用API并处理响应。
贡献指南
async-openai是一个开源项目,欢迎社区成员参与贡献。无论是新功能请求、bug修复、文档改进还是测试用例编写,都是非常宝贵的贡献形式。
为了保证项目质量,贡献者需要注意以下几点:
-
命名与文档:所有结构体名称、字段名称和文档注释应遵循OpenAPI规范。
-
测试覆盖:对于新增或修改的功能,需要提供相应的测试用例。
-
范围限制:保持功能范围限于官方文档中提供的API。
-
一致性:保持代码风格的一致性,以提供良好的开发者体验。
项目遵循Rust行为准则,确保一个友好、包容的社区环境。
相关生态
除了async-openai,还有一些补充性的crate可以增强你的OpenAI开发体验:
- openai-func-enums:提供过程宏,简化OpenAI API的工具调用功能使用。
- async-openai-wasm:为async-openai提供WebAssembly支持。
结语
async-openai为Rust开发者提供了一个强大、灵活且易用的工具,大大简化了与OpenAI API的交互过程。无论你是想要构建聊天机器人、生成图像,还是进行自然语言处理,async-openai都能为你的项目提供有力支持。
随着AI技术的不断发展,OpenAI的API也在持续更新和扩展。async-openai项目也将与时俱进,不断增加新特性和改进现有功能。欢迎开发者们积极参与,共同打造这个优秀的Rust OpenAI库。
最后,async-openai采用MIT许可证开源,为开发者提供了最大的自由度。无论是个人项目还是商业应用,都可以放心使用这个库,充分发挥OpenAI API的潜力,创造出更多令人惊叹的AI应用。