simple-openai

📌 Simple-OpenAI 项目介绍

项目概述

Simple-OpenAI 是一个 Java 库，旨在以最简单的方式使用 OpenAI API。这个库提供了一致的接口，类似于其他编程语言如 Python 或 NodeJs 的简单性。尽管是一个非官方库，但 Simple-OpenAI 确保与最新的 OpenAI 变化保持同步，目前支持大多数现有功能并将随着未来的变化继续更新。

支持的服务

Simple-OpenAI 支持以下 OpenAI 的所有服务：

• 音频服务：支持语音转换、转录和翻译。
• 批处理功能：支持批量聊天完成。
• 聊天完成：支持文本生成、流媒体、函数调用、视觉、结构化输出和音频。
• 完成：支持传统的文本生成。
• 嵌入：进行文本的矢量化处理。
• 文件：支持文件上传。
• 微调：自定义模型。
• 图像：图像生成、编辑和变异。
• 模型：列出所有模型。
• 内容审核：检测不当内容。
• 上传：支持分段上传大文件。

安装方法

Maven 安装

在 Maven 项目中添加以下依赖即可安装 Simple-OpenAI：

<dependency>
    <groupId>io.github.sashirestela</groupId>
    <artifactId>simple-openai</artifactId>
    <version>[最新版本]</version>
</dependency>

Gradle 安装

对于 Gradle 项目，可以使用以下方式：

dependencies {
    implementation 'io.github.sashirestela:simple-openai:[latest version]'
}

使用指南

创建 SimpleOpenAI 对象

在开始使用 Simple-OpenAI 提供的服务前，需首先创建一个 SimpleOpenAI 对象。在对象创建时，至少需要提供 OpenAI 的 API 密钥：

var openAI = SimpleOpenAI.builder()
    .apiKey(System.getenv("OPENAI_API_KEY"))
    .build();

此外，用户可以选择提供 OpenAI 组织 ID 和项目 ID，以区分多组织使用情况或限制为单项目使用。

示例代码

以下是几个使用 Simple-OpenAI 的示例：

• 音频示例：将文本转换为音频，并接收二进制格式返回。
• 图像示例：根据提示生成图像，并获取图像的 URL。
• 聊天完成：通过问题获得完整回答。
• 函数调用示例：定义自定义函数以实现特定任务。

支持的其他 OpenAI 提供商

Simple-OpenAI 支持可兼容 OpenAI API 的其他提供商，包括 Azure OpenAI 和 Anyscale。

Azure OpenAI

支持使用 SimpleOpenAIAzure 类来实现 Azure 提供的 OpenAI 服务：

var openai = SimpleOpenAIAzure.builder()
    .apiKey(System.getenv("AZURE_OPENAI_API_KEY"))
    .baseUrl(System.getenv("AZURE_OPENAI_BASE_URL"))
    .apiVersion(System.getenv("AZURE_OPENAI_API_VERSION"))
    .build();

Anyscale

支持使用 SimpleOpenAIAnyscale 类来对接 Anyscale 提供的服务：

var openai = SimpleOpenAIAnyscale.builder()
    .apiKey(System.getenv("ANYSCALE_API_KEY"))
    .build();

运行示例

项目中提供了多种服务的使用示例，可以通过以下步骤运行这些示例：

1. 克隆仓库：

   git clone https://github.com/sashirestela/simple-openai.git
   cd simple-openai

2. 构建项目：

   mvn clean install

3. 设置 OpenAI API 密钥环境变量：

   export OPENAI_API_KEY=<您的 api 密钥>

4. 运行范例代码：

   ./rundemo.sh <demo> [debug]

   例如，运行聊天示例并生成日志文件：

   ./rundemo.sh Chat debug

通过这些步骤，用户可以快速上手 Simple-OpenAI 项目并集成到自己的应用中。