Project Icon

openai-cpp

轻量级C++库,用于简化与OpenAI API的集成

开源的OpenAI C++库,简化了在C++应用中调用OpenAI API的过程。兼容C++11及以上版本编译器,仅需两个头文件,无需额外依赖。支持全部OpenAI API功能,包括模型管理、完成、编辑、图像生成、嵌入和文件管理等。简单设置环境变量或直接在代码中配置API密钥即可使用,支持自定义实例管理,详情参见示例代码。

项目介绍

OpenAI-C++库

OpenAI-C++库是一个由社区维护的轻量级现代C++库,旨在为使用C++编写的应用程序提供便捷的OpenAI API访问接口。这个库十分精简,只包含两个头文件(如果你已经在使用Nlohmann Json,则只需要一个头文件)。它允许开发者轻松集成OpenAI的强大功能到他们的项目中。

项目特点

  • 语言:C++
  • C++标准:支持C++11及更高版本
  • 许可证:MIT
  • 使用libcurl进行网络请求

系统需求

要使用OpenAI-C++库,你需要确保你的开发环境中有以下组件:

  • 支持C++11、C++14、C++17或C++20的编译器
  • 已安装libcurl库

当前实现

OpenAI-C++库实现了OpenAI文档中的所有API请求。如果有新的API更新或任何遗漏的部分,用户可以提交issue提出建议。目前支持的功能包括但不限于:

  • 列出或检索模型信息
  • 创建补全文本
  • 创建图像及图像变体
  • 管理和上传文件
  • 创建fine-tune模型
  • 创建聊天会话
  • 处理音频转录和翻译
  • 生成审查内容

安装步骤

该库由两个文件组成:[include/openai/openai.hpp]和[include/openai/nlohmann/json.hpp]。用户只需将这些文件夹复制到自己的项目中,并在代码中使用#include "openai.hpp"即可进行调用。

注意:如果有需要,用户可以使用自己的Nlohmann Json副本以加快编译速度。

使用指南

简单示例

在使用库前,需要使用你的账户密钥进行配置。推荐的做法是设置环境变量OPENAI_API_KEY。例如:

export OPENAI_API_KEY='sk-...'

用户可以参考[examples/00-showcase.cpp]中的例子进行简单体验:

#include "openai.hpp"
#include <iostream>

int main() {
    openai::start();  // 使用`OPENAI_API_KEY`环境变量提供的API密钥

    auto completion = openai::completion().create(R"({
        "model": "text-davinci-003",
        "prompt": "Say this is a test",
        "max_tokens": 7,
        "temperature": 0
    })"_json);
    std::cout << "Response is:\n" << completion.dump(2) << '\n'; 

    auto image = openai::image().create({
        { "prompt", "A cute koala playing the violin"},
        { "n", 1 },
        { "size", "512x512" }
    });
    std::cout << "Image URL is: " << image["data"][0]["url"] << '\n'; 
}

错误处理

默认情况下,如果curl请求失败,OpenAI-CPP会抛出运行时错误异常。用户可以选择自定义异常处理方式,也可以通过设置setThrowException(false)来避免异常抛出,并显示警告。

一些高级用法

OpenAI-C++库提供了对实现的更大控制权。用户可以使用openai::post()openai::get()方法来全面定制请求。此外,用户可以通过引用传递OpenAI实例以管理多个密钥。

常见问题

在Windows上使用libcurl时可能会遇到一些问题,CMake可能会抛出“Could NOT find CURL”错误。用户可以参考详细的安装步骤来解决这些安装问题。

许可证

OpenAI-C++库使用MIT许可证,用户可以在自由软件的基本条款下使用和修改该库。

致谢

项目灵感主要来自slacking项目和cpr的curl封装代码。

赞助商

由OLREA赞助支持。

以上内容为OpenAI-C++项目的详细介绍,希望能帮助开发者更好地理解和使用此库来增强他们的C++项目功能。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

白日梦AI

白日梦AI提供专注于AI视频生成的多样化功能,包括文生视频、动态画面和形象生成等,帮助用户快速上手,创造专业级内容。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

讯飞绘镜

讯飞绘镜是一个支持从创意到完整视频创作的智能平台,用户可以快速生成视频素材并创作独特的音乐视频和故事。平台提供多样化的主题和精选作品,帮助用户探索创意灵感。

Project Cover

讯飞文书

讯飞文书依托讯飞星火大模型,为文书写作者提供从素材筹备到稿件撰写及审稿的全程支持。通过录音智记和以稿写稿等功能,满足事务性工作的高频需求,帮助撰稿人节省精力,提高效率,优化工作与生活。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号