Logo

async-openai: 异步Rust库助力OpenAI API开发

async-openai:为Rust开发者打造的OpenAI异步库

在人工智能快速发展的今天,OpenAI的各种强大API为开发者提供了无限可能。然而,如何高效、便捷地调用这些API,一直是开发者关注的焦点。async-openai应运而生,它是一个专为Rust开发者设计的非官方异步库,旨在简化OpenAI API的调用过程,提高开发效率。

库的主要特性

async-openai基于OpenAI的OpenAPI规范开发,提供了丰富的功能支持:

  1. 全面的API覆盖:支持Assistants(v2)、Audio、Batch、Chat、Completions(Legacy)、Embeddings、Files、Fine-Tuning、Images、Models、Moderations等多种OpenAI API。

  2. 异步支持:利用Rust的异步特性,提供高效的API调用方式。

  3. SSE流式处理:对于支持的API,提供服务器发送事件(SSE)的流式处理能力。

  4. 自动重试机制:除SSE流式处理外,所有请求(包括表单提交)在遇到速率限制时会自动进行指数退避重试。

  5. 人性化的构建模式:为所有请求对象提供符合人体工程学的构建器模式。

  6. Azure OpenAI支持:兼容Microsoft Azure OpenAI Service(仅限与OpenAI规范匹配的API)。

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并处理响应。

生成的猫咪图片1 生成的猫咪图片2

贡献指南

async-openai是一个开源项目,欢迎社区成员参与贡献。无论是新功能请求、bug修复、文档改进还是测试用例编写,都是非常宝贵的贡献形式。

为了保证项目质量,贡献者需要注意以下几点:

  1. 命名与文档:所有结构体名称、字段名称和文档注释应遵循OpenAPI规范。

  2. 测试覆盖:对于新增或修改的功能,需要提供相应的测试用例。

  3. 范围限制:保持功能范围限于官方文档中提供的API。

  4. 一致性:保持代码风格的一致性,以提供良好的开发者体验。

项目遵循Rust行为准则,确保一个友好、包容的社区环境。

相关生态

除了async-openai,还有一些补充性的crate可以增强你的OpenAI开发体验:

结语

async-openai为Rust开发者提供了一个强大、灵活且易用的工具,大大简化了与OpenAI API的交互过程。无论你是想要构建聊天机器人、生成图像,还是进行自然语言处理,async-openai都能为你的项目提供有力支持。

随着AI技术的不断发展,OpenAI的API也在持续更新和扩展。async-openai项目也将与时俱进,不断增加新特性和改进现有功能。欢迎开发者们积极参与,共同打造这个优秀的Rust OpenAI库。

最后,async-openai采用MIT许可证开源,为开发者提供了最大的自由度。无论是个人项目还是商业应用,都可以放心使用这个库,充分发挥OpenAI API的潜力,创造出更多令人惊叹的AI应用。

最新项目

Project Cover
豆包MarsCode
豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。
Project Cover
AI写歌
Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。
Project Cover
商汤小浣熊
小浣熊家族Raccoon,您的AI智能助手,致力于通过先进的人工智能技术,为用户提供高效、便捷的智能服务。无论是日常咨询还是专业问题解答,小浣熊都能以快速、准确的响应满足您的需求,让您的生活更加智能便捷。
Project Cover
有言AI
有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。
Project Cover
Kimi
Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。
Project Cover
吐司
探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。
Project Cover
SubCat字幕猫
SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。
Project Cover
稿定AI
稿定设计 是一个多功能的在线设计和创意平台,提供广泛的设计工具和资源,以满足不同用户的需求。从专业的图形设计师到普通用户,无论是进行图片处理、智能抠图、H5页面制作还是视频剪辑,稿定设计都能提供简单、高效的解决方案。该平台以其用户友好的界面和强大的功能集合,帮助用户轻松实现创意设计。
Project Cover
AIWritePaper论文写作
AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。
投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号