openai kotlin

Kotlin的OpenAI API客户端

Kotlin客户端的OpenAI API具有乘数和Coroutines功能。

？设置

1. 通过将以下依赖关系添加到build.gradle文件：

repositories {
    mavenCentral()
}

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

2. 选择并添加到您的依赖项中，这是KTOR的引擎之一。

bom

另外，您可以通过将以下依赖关系添加到build.gradle文件来使用OpenAi-Client-Bom

dependencies {
    // import Kotlin API client BOM
    implementation platform( ' com.aallam.openai:openai-client-bom:3.8.2 ' )

    // define dependencies without versions
    implementation ' com.aallam.openai:openai-client '
    runtimeOnly ' io.ktor:ktor-client-okhttp '
}

乘数

在多页面项目中，将OpenAI客户端依赖性添加到commonMain ，然后为每个目标选择一个引擎。

小牛

Gradle是多平台支持所必需的，但是没有什么可以阻止您在Maven项目中使用JVM客户端。您仍然需要添加依赖项之一，这是KTOR的引擎之一。

用Maven设置客户

< dependencies >
    < dependency >
        < groupId >com.aallam.openai</ groupId >
        < artifactId >openai-client-jvm</ artifactId >
        < version >3.8.0</ version >
    </ dependency >
            
    < dependency >
        < groupId >io.ktor</ groupId >
        < artifactId >ktor-client-okhttp-jvm</ artifactId >
        < version >2.3.2</ version >
        < scope >runtime</ scope >
    </ dependency >
</ dependencies >

BOM不支持Maven项目。

⚡️开始

笔记

OpenAI鼓励对API键使用环境变量。阅读更多。

创建一个OpenAI客户端的实例：

 val openai = OpenAI (
    token = " your-api-key " ,
    timeout = Timeout (socket = 60 .seconds),
    // additional configurations...
)

或者，您可以使用预先配置的OpenAIConfig创建OpenAI实例：

 val config = OpenAIConfig (
    token = apiKey,
    timeout = Timeout (socket = 60 .seconds),
    // additional configurations...
)

val openAI = OpenAI (config)

使用您的OpenAI实例进行API请求。了解更多。

支持的功能

• 型号
• 聊天
• 图像
• 嵌入
• 文件
• 微调
• 适中
• 声音的

beta

• 助手
• 线程
• 消息
• 运行

弃用

• 完成
• 微调
• 编辑

寻找令牌？尝试KTOKEN，Ktoken，kotlin库，用于引导文本。

向导

开始并了解如何使用这些指南为Kotlin使用OpenAI API客户端：

• 入门
• 聊天和功能电话
• FileSource指南
• 助手

示例应用程序

示例应用程序可在sample下找到，请检查读书我的运行说明。

proguard / r8

特定规则已经捆绑到可以由R8自动解释的JAR中。

？快照

了解如何导入快照版本

要将快照版本导入项目中，请在Gradle文件中添加以下代码段：

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

故障排除

有关常见问题及其解决方案，请检查故障排除指南。

️支持

感谢这个项目？这是您可以提供帮助的方式：

1. 明星：在右上角给它一颗星星。这意味着很多！
2. 贡献：找到问题或有特征想法？提交公关。
3. 反馈：有建议吗？打开问题或开始讨论。

？执照

Openai Kotlin API客户端是根据MIT许可证许可的开源软件。这是一个非正式的图书馆，它与Openai不属于或认可。欢迎捐款。