openai-kotlin

环境要求

• Kotlin 项目（Gradle 构建，多平台项目需 Gradle）
• JDK 运行环境（用于 JVM 端调用）
• 一个 OpenAI API Key
• 选择一个 Ktor HTTP 引擎并加入依赖

安装与启动步骤

1. 1添加客户端依赖

   在 build.gradle 的 repositories 中加入 mavenCentral()，并在 dependencies 里声明 openai-client 依赖，版本按 README 为 4.1.0。

   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation "com.aallam.openai:openai-client:4.1.0"
   }

   复制

2. 2添加 Ktor 引擎

   README 要求必须从 Ktor 的引擎中挑一个加入依赖，官方示例用的是 okhttp 引擎；不添加引擎则无法发起 HTTP 请求。

   dependencies {
       runtimeOnly "io.ktor:ktor-client-okhttp"
   }

   复制

3. 3或用 BOM 管理版本

   替代方案：引入 openai-client-bom 平台依赖后，其余依赖可不写版本号，便于统一版本管理。

   dependencies {
       implementation platform('com.aallam.openai:openai-client-bom:4.1.0')
       implementation 'com.aallam.openai:openai-client'
       runtimeOnly 'io.ktor:ktor-client-okhttp'
   }

   复制

4. 4多平台项目放 commonMain

   多平台工程中把 openai client 依赖加到 commonMain，并为每个目标平台分别选择并添加对应的 Ktor 引擎。

5. 5创建 OpenAI 实例

   用 API Key 创建 OpenAI 客户端，可同时配置超时等参数；也可先用 OpenAIConfig 配置好再传给 OpenAI。

   val openai = OpenAI(
       token = "your-api-key",
       timeout = Timeout(socket = 60.seconds),
       // additional configurations...
   )
   
   // 或使用预配置的 OpenAIConfig
   val config = OpenAIConfig(
       token = apiKey,
       timeout = Timeout(socket = 60.seconds),
   )
   
   val openAI = OpenAI(config)

   复制

6. 6发起 API 请求

   用创建好的 OpenAI 实例调用接口，例如文本生成、图像生成、语音转文字等，具体用法见 README 链接的 GettingStarted 指南。

关键配置

如何确认成功

Gradle 同步依赖无报错，代码能成功构建出 OpenAI 实例并调用接口返回结果、不抛鉴权或网络异常即可。

常见问题

注意事项

• 本教程所有命令与配置均来自 README 节选，Maven 部分原文被截断，未给出完整示例。
• README 未指定 Ktor 引擎的具体版本号与 JDK 版本，请按自己项目实际情况选择。
• README 未提供完整可运行的调用示例，具体接口用法需参考仓库中的 guides/GettingStarted.md。