openai-kotlin

OpenAI Kotlin 项目介绍

OpenAI Kotlin 是一个专为使用 OpenAI API 而开发的 Kotlin 客户端。该项目支持多平台开发和协程功能，致力于简化开发者与 OpenAI 的交互。

项目设置

要使用 OpenAI Kotlin 客户端，您首先需要通过以下步骤在项目中设置相关依赖：

1. 在您的 build.gradle 文件中添加以下依赖：

repositories {
    mavenCentral()
}

dependencies {
    implementation "com.aallam.openai:openai-client:3.8.2"
}

2. 选择并添加一个 Ktor 引擎 到依赖中。

使用 BOM

您也可以选择使用 openai-client-bom，通过以下方式添加至 build.gradle 文件中：

dependencies {
    // 导入 Kotlin API 客户端 BOM
    implementation platform('com.aallam.openai:openai-client-bom:3.8.2')

    // 定义无版本号的依赖
    implementation 'com.aallam.openai:openai-client'
    runtimeOnly 'io.ktor:ktor-client-okhttp'
}

对于多平台项目，将 openai 客户端依赖添加到 commonMain 中，并为每个目标选择一个适当的引擎。

快速开始

设置好环境后，您可以通过以下方式创建 OpenAI 客户端实例：

val openai = OpenAI(
    token = "your-api-key",
    timeout = Timeout(socket = 60.seconds),
    // 其他配置...
)

或者使用预先配置的 OpenAIConfig 创建实例：

val config = OpenAIConfig(
    token = apiKey,
    timeout = Timeout(socket = 60.seconds),
    // 其他配置...
)

val openAI = OpenAI(config)

一旦拥有 OpenAI 实例，便可进行 API 请求。

支持的功能

OpenAI Kotlin 客户端支持多种功能，包括但不限于以下几项：

• 模型
• 聊天
• 图片
• 嵌入
• 文件
• 精调
• 内容审核
• 音频

与此同时，项目还提供了一些测试版功能，例如助手和线程。此外，某些功能已标记为不推荐使用，例如完成和精细调整。

指南

项目提供了一些指南，帮助您更好地理解和使用 OpenAI Kotlin 客户端：

• 快速入门指南
• 聊天与功能调用指南
• 文件源指南
• 助手指南

示例应用

项目中包含多个示例应用，您可以查阅 sample 目录下的 README 获取运行指引。

ProGuard / R8

项目已在 Jar 包中内置了特定的 ProGuard 或 R8 规则，方便自动解析。

快照版本

如果您需要使用快照版本，可以在 gradle 文件中添加以下代码：

repositories {
   //...
   maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
}

故障排除

项目提供故障排除指南，帮助您解决常见问题。

支持项目

若您喜欢这个项目，可以通过以下方式支持：

1. 给项目加星。
2. 提交问题或创意。
3. 提供反馈。

许可证

OpenAI Kotlin API 客户端是一个开源软件，采用 MIT 许可证。欢迎贡献！

注意：这是一个非官方库，与 OpenAI 无关且未获得其认可。