openai kotlin

عميل Openai API لـ Kotlin

عميل Kotlin لـ Openai's API مع إمكانيات 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 '
}

multiplatform

في المشاريع المتعددة ، أضف تبعية عميل 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 >

لا يتم دعم BOM لمشاريع 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 لإصدار الرمز المميز.

أدلة

ابدأ وفهم المزيد حول كيفية استخدام عميل Openai API لـ Kotlin مع هذه الأدلة:

• ابدء
• مكالمة الدردشة والوظيفة
• دليل Filesource
• المساعدون

عينة التطبيقات

عينة التطبيقات متوفرة ضمن sample ، يرجى التحقق من README للحصول على تعليمات تشغيل.

Proguard / R8

يتم بالفعل تجميع القواعد المحددة في الجرة التي يمكن تفسيرها بواسطة R8 تلقائيًا.

؟ لقطات

تعلم كيفية استيراد إصدار اللقطة

لاستيراد إصدارات اللقطة في مشروعك ، أضف مقتطف الرمز التالي إلى ملف Gradle:

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

استكشاف الأخطاء وإصلاحها

للقضايا المشتركة وحلولها ، تحقق من دليل استكشاف الأخطاء وإصلاحها.

️ الدعم

نقدر المشروع؟ إليك كيف يمكنك المساعدة:

1. النجمة : أعطها نجمة في الأعلى اليمين. وهذا يعني الكثير!
2. المساهمة : وجدت مشكلة أو لديك فكرة ميزة؟ إرسال العلاقات العامة.
3. ردود الفعل : لديك اقتراحات؟ افتح مشكلة أو ابدأ مناقشة.

؟ رخصة

Openai Kotlin API Client هو برنامج مفتوح المصادر مرخصة بموجب ترخيص MIT. هذه مكتبة غير رسمية ، لا تابعة أو معتمدة من قبل Openai . المساهمات موضع ترحيب.