openai kotlin

OpenAI API -клиент для Kotlin

Клиент Kotlin для API Openai с Multiplatform и Coroutines.

? Настраивать

1. Установите клиент OpenAI API Kotlin, добавив следующую зависимость в ваш файл build.gradle :

repositories {
    mavenCentral()
}

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

2. Выберите и добавьте в свои зависимости один из двигателей Ktor.

Категория

В качестве альтернативы, вы можете использовать Openai-Client-Bom, добавив следующую зависимость в свой файл build.gradle

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 требуется для многоплатформенной поддержки, но ничто не мешает вам использовать клиент JVM в проекте Maven. Вам все еще нужно добавить к вашим зависимостям один из двигателей 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 >

Дом не поддерживается для проектов Maven.

⚡ Начало работы

Примечание

OpenAI поощряет использование переменных среды для ключа API. Читать далее.

Создайте экземпляр OpenAI Client:

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

Или вы можете создать экземпляр OpenAI , используя предварительно сконфигурированный OpenAIConfig :

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

val openAI = OpenAI (config)

Используйте экземпляр OpenAI , чтобы сделать запросы API. Узнать больше.

Поддерживаемые функции

• Модели
• Чат
• Изображения
• Внедрения
• Файлы
• Тонкая настройка
• Модерации
• Аудио

Бета

• Помощники
• Нить
• Сообщения
• Пробеги

Устарел

• Завершают
• Тонкие надуны
• Редактирование

Ищете токенизатор? Попробуйте Ktoken, библиотеку Kotlin для ориентирования текста.

Гиды

Начните и понимайте больше о том, как использовать клиент API OpenAI для Kotlin с этими гидами:

• Начиная
• CHAT и функциональный вызов
• Руководство Filesource
• Помощники

Образцы приложений

Образцы приложений доступны под sample , пожалуйста, проверьте readme для запуска инструкций.

Прогуард / R8

Конкретные правила уже объединены в банку, которая может быть автоматически интерпретирована с помощью R8.

? Снимки

Узнайте, как импортировать версию снимка

Чтобы импортировать версии снимка в свой проект, добавьте следующий фрагмент кода в свой файл Gradle:

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

Поиск неисправностей

По общим вопросам и их решениям, проверьте руководство по устранению неполадок.

️ поддержка

Ценить проект? Вот как вы можете помочь:

1. Звезда : Дайте ему звезду в правом верхнем углу. Это много значит!
2. Внести свой вклад : Нашел проблему или у вас есть идея функции? Отправить PR.
3. Обратная связь : есть предложения? Откройте проблему или начните обсуждение.

? Лицензия

Openai Kotlin API Client-это программное обеспечение с открытым исходным кодом, лицензированное по лицензии MIT. Это неофициальная библиотека, она не связана ни с ни с и не одобренной OpenAI . Взносы приветствуются.