async openai

Async-Openai

Perpustakaan Rust Async untuk Openai

_{Logo yang dibuat oleh repo ini sendiri}

Ringkasan

async-openai adalah perpustakaan karat tidak resmi untuk Openai.

• Itu didasarkan pada spesifikasi openai openapi
• Fitur Saat Ini:
  • Asisten (V2)
  • Audio
  • Kelompok
  • Mengobrol
  • Penyelesaian (warisan)
  • Embeddings
  • File
  • Fine-tuning
  • Gambar
  • Model
  • Moderasi
  • Organisasi | Administrasi
  • Jenis API Realtime (beta)
  • Mengunggah
• SSE Streaming di API yang tersedia
• Permintaan (kecuali streaming SSE) termasuk pengajuan formulir diulang dengan backoff eksponensial saat tingkat terbatas.
• Pola pembangun ergonomis untuk semua objek permintaan.
• Layanan Openai Microsoft Azure (hanya untuk API yang cocok dengan Spec OpenAI)

Penggunaan

Perpustakaan membaca kunci API dari variabel lingkungan OPENAI_API_KEY .

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

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

• Kunjungi Direktori Contoh tentang Cara Menggunakan async-openai .
• Kunjungi docs.rs/async-openai untuk dokumen.

API Realtime

Satu -satunya jenis untuk API realtime yang diimplementasikan, dan dapat diaktifkan dengan fitur Bendera realtime . Jenis -jenis ini dapat berubah jika/ketika OpenAI merilis spesifikasi resmi untuk mereka.

Contoh pembuatan gambar

 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 ( ( ) )
}

_{Diskalakan untuk readme, ukuran aktual 256x256}

Berkontribusi

Terima kasih telah meluangkan waktu untuk berkontribusi dan meningkatkan proyek. Aku akan senang memilikimu!

Semua bentuk kontribusi, seperti permintaan fitur baru, perbaikan bug, masalah, dokumentasi, pengujian, komentar, contoh dll. Dibawakan.

Titik awal yang baik adalah melihat masalah terbuka yang ada.

Untuk mempertahankan kualitas proyek, minimal dari berikut ini adalah suatu keharusan untuk kontribusi kode:

• Nama & Dokumentasi : Semua nama struktur, nama bidang, dan komentar dokumen berasal dari OpenAPI Spec. Objek bersarang di spec tanpa nama meninggalkan ruang untuk membuat nama yang sesuai.
• Diperlukan Tes : Untuk perubahan tes pendukung dan/atau contoh diperlukan. Contoh yang ada, tes DOC, tes unit, dan tes integrasi harus dilakukan untuk bekerja dengan perubahan jika berlaku.
• Lingkup : Tetap terbatas pada API yang tersedia dalam dokumen resmi seperti Referensi API atau OpenAPI Spec. Penyedia LLM atau AI lainnya menawarkan API yang kompatibel dengan openai, namun mereka mungkin tidak selalu memiliki paritas penuh. Dalam kasus seperti itu, spesifikasi openai diutamakan.
• Konsistensi : Jaga agar gaya kode konsisten di semua "API" yang diekspos perpustakaan; Ini menciptakan pengalaman pengembang yang hebat.

Proyek ini mematuhi kode perilaku karat

Peti gratis

• Openai-Func-enums menyediakan makro prosedural yang membuatnya lebih mudah untuk menggunakan pustaka ini dengan fitur panggilan alat OpenAI API. Ini juga menyediakan makro turunan yang dapat Anda tambahkan ke sub -perintah aplikasi clap yang ada untuk penggunaan bahasa alami alat baris perintah. Ini juga mendukung panggilan alat paralel OpenAI dan memungkinkan Anda untuk memilih antara menjalankan beberapa panggilan alat secara bersamaan atau memiliki utas OS mereka sendiri.
• Async-Openai-Wasm memberikan dukungan WASM.

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT.