OpenAI-Java: 强大的Java语言OpenAI API客户端库

openai-java

OpenAI-Java简介

OpenAI-Java是一个为Java开发者设计的OpenAI API客户端库,旨在简化与OpenAI强大的语言模型的交互过程。这个库支持多种OpenAI的API,包括GPT-3、ChatGPT和最新的GPT-4,为开发者提供了一种简单而高效的方式来集成OpenAI的人工智能能力到他们的Java应用中。

OpenAI Java Library

主要特性

OpenAI-Java库包含以下主要组件:

api: 包含与GPT API交互所需的请求和响应POJO类。
client: 一个基于Retrofit的基础客户端,用于调用GPT端点,包含api模块。
service: 一个基础服务类,用于创建和调用客户端,是最简单的使用方式。

除此之外,该项目还提供了一个使用服务的示例项目,方便开发者快速上手。

支持的API

OpenAI-Java支持广泛的OpenAI API,包括但不限于:

模型 (Models)
补全 (Completions)
聊天补全 (Chat Completions)
编辑 (Edits)
嵌入 (Embeddings)
音频 (Audio)
文件 (Files)
微调 (Fine-tuning)
图像 (Images)
内容审核 (Moderations)
助手 (Assistants)

值得注意的是,OpenAI已经弃用了基于引擎的API,转而使用基于模型的API。OpenAI-Java库仍然保留了对这些弃用端点的支持,直到OpenAI完全关闭它们。

如何使用OpenAI-Java

导入库

要开始使用OpenAI-Java,首先需要将其添加到你的项目中。你可以使用Gradle或Maven来导入库。

Gradle

implementation 'com.theokanning.openai-gpt3-java:<api|client|service>:<version>'

Maven

<dependency>
    <groupId>com.theokanning.openai-gpt3-java</groupId>
    <artifactId>{api|client|service}</artifactId>
    <version>version</version>       
</dependency>

基本用法

OpenAI-Java提供了多种使用方式,以适应不同的需求和偏好。

1. 仅使用数据类

如果你想创建自己的客户端,只需从api模块导入POJO类即可。注意,你的客户端需要使用蛇形命名法(snake case)来与OpenAI API兼容。

2. 使用Retrofit客户端

如果你使用Retrofit,可以导入client模块并使用OpenAiApi接口。你需要添加认证令牌作为头部,并设置转换器工厂以使用蛇形命名法并只包含非空字段。

3. 使用OpenAiService

对于最快速的解决方案,你可以导入service模块并使用OpenAiService类。以下是一个简单的示例:

OpenAiService service = new OpenAiService("your_token");
CompletionRequest completionRequest = CompletionRequest.builder()
        .prompt("Somebody once told me the world is gonna roll me")
        .model("babbage-002")
        .echo(true)
        .build();
service.createCompletion(completionRequest).getChoices().forEach(System.out::println);

自定义OpenAiService

如果你需要自定义OpenAiService,可以创建自己的Retrofit客户端并将其传递给构造函数。例如,要添加请求日志记录:

ObjectMapper mapper = defaultObjectMapper();
OkHttpClient client = defaultClient(token, timeout)
        .newBuilder()
        .interceptor(HttpLoggingInterceptor())
        .build();
Retrofit retrofit = defaultRetrofit(client, mapper);

OpenAiApi api = retrofit.create(OpenAiApi.class);
OpenAiService service = new OpenAiService(api);

添加代理

要使用代理,可以修改OkHttp客户端:

ObjectMapper mapper = defaultObjectMapper();
Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(host, port));
OkHttpClient client = defaultClient(token, timeout)
        .newBuilder()
        .proxy(proxy)
        .build();
Retrofit retrofit = defaultRetrofit(client, mapper);
OpenAiApi api = retrofit.create(OpenAiApi.class);
OpenAiService service = new OpenAiService(api);

高级功能: 函数调用

OpenAI-Java库支持函数调用,这是一个强大的功能,允许你定义和执行自定义函数。以下是使用函数的基本步骤:

声明函数参数
定义函数并关联执行器
使用FunctionExecutor对象来辅助执行和转换

这里有一个简单的天气函数示例:

public class Weather {
    @JsonPropertyDescription("City and state, for example: León, Guanajuato")
    public String location;
    @JsonPropertyDescription("The temperature unit, can be 'celsius' or 'fahrenheit'")
    @JsonProperty(required = true)
    public WeatherUnit unit;
}

ChatFunction weatherFunction = ChatFunction.builder()
        .name("get_weather")
        .description("Get the current weather of a location")
        .executor(Weather.class, w -> new WeatherResponse(w.location, w.unit, new Random().nextInt(50), "sunny"))
        .build();

List<ChatFunction> functionList = Arrays.asList(weatherFunction);
FunctionExecutor functionExecutor = new FunctionExecutor(functionList);

// 使用函数执行器进行对话

更详细的函数使用示例可以参考项目中的OpenAiApiFunctionsExample.java和OpenAiApiFunctionsWithStreamExample.java文件。

流式响应和线程关闭

对于流式响应,如果你想在接收完响应后立即关闭进程,可以调用OpenAiService.shutdownExecutor()。这对于非流式调用不是必需的。

运行示例项目

OpenAI-Java提供了一个示例项目,你只需要提供你的OpenAI API令牌即可运行:

export OPENAI_TOKEN="sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
./gradlew runExample

常见问题解答

支持GPT-4吗? 是的,GPT-4使用ChatCompletion API,你可以在OpenAI的文档中查看最新的模型选项。
支持函数吗? 绝对支持!使用自定义函数非常简单,无需担心复杂的实现细节。
为什么我遇到连接超时? 请确保OpenAI在你所在的国家/地区可用。
为什么OpenAiService不支持某些配置选项? 为了保持简单性,OpenAiService的功能被刻意限制。如果需要更多自定义选项,你可以创建自己的OpenAiApi实例。

结语

OpenAI-Java为Java开发者提供了一个强大而灵活的工具,使他们能够轻松地将OpenAI的先进AI能力集成到自己的应用中。无论你是想要简单地使用GPT模型生成文本,还是想要实现更复杂的功能如函数调用,OpenAI-Java都能满足你的需求。

随着AI技术的不断发展,OpenAI-Java也在持续更新以支持最新的功能。虽然该项目目前已经存档,不再维护,但它仍然是一个宝贵的资源,可以帮助开发者理解如何与OpenAI API进行交互。对于那些希望在现有项目中继续使用或扩展这个库的开发者来说,可以考虑fork项目并根据需要进行修改。

最后,在使用OpenAI-Java时,请始终关注OpenAI的最新API文档和更新,以确保你的应用与最新的API变更保持同步。同时,也要注意遵守OpenAI的使用政策和最佳实践,以确保负责任和有效地使用这些强大的AI工具。