async openai

Async-openai

مكتبة الصدأ غير المتزامن لـ Openai

_{الشعار الذي أنشأه هذا الريبو نفسه}

ملخص

async-openai هي مكتبة صدأ غير رسمية لـ Openai.

• يعتمد على مواصفات Openai Openapi
• الميزات الحالية:
  • المساعدون (V2)
  • صوتي
  • حزمة
  • محادثة
  • الانتهاء (إرث)
  • التضمين
  • الملفات
  • الكون المثالى
  • الصور
  • النماذج
  • التعتيم
  • المنظمات | إدارة
  • أنواع API في الوقت الحقيقي (بيتا)
  • تحميلات
• SSE تدفق على واجهات برمجة التطبيقات المتاحة
• تتم إعادة تجديد الطلبات (باستثناء دفق SSE) بما في ذلك عمليات إرسال النماذج مع التراجع الأسي عندما يكون المعدل محدودًا.
• نمط البناء المريح لجميع كائنات الطلب.
• خدمة Microsoft Azure Openai (فقط لمواصفات واجهات برمجة التطبيقات (APIs)

الاستخدام

تقرأ المكتبة مفتاح API من متغير البيئة OPENAI_API_KEY .

 # On macOS/Linux
export OPENAI_API_KEY= ' sk-... ' 

 # On Windows Powershell
$ Env: OPENAI_API_KEY = ' sk-... '

• قم بزيارة دليل الأمثلة حول كيفية استخدام async-openai .
• قم بزيارة docs.rs/async-openai للمستندات.

API في الوقت الفعلي

يتم تنفيذ أنواع API في الوقت الفعلي فقط ، ويمكن تمكينها باستخدام Feather Flag realtime . قد تتغير هذه الأنواع إذا/عند إصدار Openai المواصفات الرسمية لهم.

مثال توليد الصور

 use async_openai :: {
    types :: { CreateImageRequestArgs , ImageSize , ImageResponseFormat } ,
    Client ,
} ;
use std :: error :: Error ;

# [ tokio :: main ]
async fn main ( ) -> Result < ( ) , Box < dyn Error > > {
    // create client, reads OPENAI_API_KEY environment variable for API key.
    let client = Client :: new ( ) ;

    let request = CreateImageRequestArgs :: default ( )
        . prompt ( "cats on sofa and carpet in living room" )
        . n ( 2 )
        . response_format ( ImageResponseFormat :: Url )
        . size ( ImageSize :: S256x256 )
        . user ( "async-openai" )
        . build ( ) ? ;

    let response = client . images ( ) . create ( request ) . await ? ;

    // Download and save images to ./data directory.
    // Each url is downloaded and saved in dedicated Tokio task.
    // Directory is created if it doesn't exist.
    let paths = response . save ( "./data" ) . await ? ;

    paths
        . iter ( )
        . for_each ( |path| println ! ( "Image file path: {}" , path.display ( ) ) ) ;

    Ok ( ( ) )
}

_{تم تحجيمها لـ README ، الحجم الفعلي 256x256}

المساهمة

شكرا لك على قضاء الوقت للمساهمة وتحسين المشروع. سأكون سعيدًا بوجودك!

جميع أشكال المساهمات ، مثل طلبات الميزات الجديدة ، وإصلاحات الأخطاء ، والمشكلات ، والوثائق ، والاختبار ، والتعليقات ، والأمثلة وما إلى ذلك.

تتمثل نقطة البداية الجيدة في النظر إلى القضايا المفتوحة الحالية.

للحفاظ على جودة المشروع ، فإن الحد الأدنى من ما يلي أمر لا بد منه لمساهمة الكود:

• الأسماء والوثائق : جميع أسماء الهياكل وأسماء الحقول وتعليقات DOC هي من OpenAPI Spec. الكائنات المتداخلة في المواصفات بدون أسماء تترك مساحة لصنع الاسم المناسب.
• تم اختباره : للتغييرات التي تدعم الاختبارات (الاختبارات) و/أو المثال مطلوب. يجب إجراء أمثلة موجودة واختبارات DOC واختبارات الوحدة واختبارات التكامل للعمل مع التغييرات إن أمكن.
• النطاق : حافظ على SCOPE يقتصر على واجهات برمجة التطبيقات المتاحة في المستندات الرسمية مثل مرجع API أو OpenAPI Spec. يقدم LLMs أو مقدمي الذكاء الاصطناعى الآخرين واجهات برمجة التطبيقات المتوافقة مع Openai ، ومع ذلك قد لا يكون لديهم دائمًا تكافؤ كامل. في مثل هذه الحالات ، فإن مواصفات Openai لها الأسبقية.
• الاتساق : حافظ على نمط الكود متسقًا عبر جميع "واجهات برمجة التطبيقات" التي تعرضها المكتبة ؛ يخلق تجربة مطور رائعة.

يلتزم هذا المشروع بقواعد سلوك الصدأ

الصناديق المجانية

• يوفر Openai-Func-Enums وحدات الماكرو الإجرائية التي تسهل استخدام هذه المكتبة مع ميزة استدعاء أداة Openai API. كما يوفر وحدات الماكرو المشتقة التي يمكنك إضافتها إلى مخصصات فرعية لتطبيق التصفيق الحالي للاستخدام اللغوي الطبيعي لأدوات سطر الأوامر. كما يدعم مكالمات الأدوات المتوازية من Openai وتتيح لك الاختيار بين تشغيل مكالمات الأدوات المتعددة بشكل متزامن أو امتلاك مؤشرات ترابط OS الخاصة بهم.
• يوفر Async-Openai-Wasm دعم WASM.

رخصة

هذا المشروع مرخص بموجب ترخيص معهد ماساتشوستس للتكنولوجيا.