async openai

Async-Openai

Async Rost Library für OpenAI

_{Logo, das von diesem Repo selbst erstellt wurde}

Überblick

async-openai ist eine inoffizielle Rostbibliothek für OpenAI.

• Es basiert auf OpenAI OpenAPI Spec
• Aktuelle Funktionen:
  • Assistenten (v2)
  • Audio
  • Charge
  • Chat
  • Abschluss (Vermächtnis)
  • Einbettungen
  • Dateien
  • Feinabstimmung
  • Bilder
  • Modelle
  • Moderationen
  • Organisationen | Verwaltung
  • Echtzeit -API -Typen (Beta)
  • Hochladen
• SSE -Streaming auf verfügbaren APIs
• Anfragen (mit Ausnahme von SSE -Streaming) einschließlich Formulareinreichungen werden mit exponentiellem Backoff wiederholt, wenn Rate begrenzt ist.
• Ergonomisches Builder -Muster für alle Anforderungsobjekte.
• Microsoft Azure OpenAI -Dienst (nur für APIs -Matching OpenAI Spec)

Verwendung

Die Bibliothek liest den API -Schlüssel aus der Umgebungsvariablen OPENAI_API_KEY .

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

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

• Besuchen Sie das Beispielverzeichnis zum Einsatz von async-openai .
• Besuchen Sie docs.rs/async-openai für docs.

Echtzeit -API

Es werden nur Typen für Echtzeit -API implementiert und können mit realtime der Feature Flag aktiviert werden. Diese Typen können sich ändern, wenn/wenn OpenAI offizielle Spezifikationen für sie veröffentlicht.

Beispiel für Bildgenerierung

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

_{Skaliert für Readme, tatsächliche Größe 256x256}

Beitragen

Vielen Dank, dass Sie sich die Zeit genommen haben, das Projekt beizutragen und zu verbessern. Ich würde mich freuen, dich zu haben!

Alle Formen von Beiträgen wie neue Funktionen, Fehlerbehebungen, Probleme, Dokumentation, Tests, Kommentare, Beispiele usw. sind willkommen.

Ein guter Ausgangspunkt wäre, vorhandene offene Probleme zu betrachten.

Um die Qualität des Projekts aufrechtzuerhalten, ist ein Minimum der folgenden Aussagen ein Muss für den Codebeitrag:

• Namen & Dokumentation : Alle Strukturnamen, Feldnamen und DOC -Kommentare stammen von OpenAPI Spec. Verschachtelte Objekte in Spezifikation ohne Namen lassen Raum, um angemessenen Namen zu machen.
• Getestet : Für Änderungen, die Tests und/oder Beispiele unterstützen, sind erforderlich. Vorhandene Beispiele, DOC -Tests, Unit -Tests und Integrationstests sollten gegebenenfalls mit den Änderungen arbeiten.
• Umfang : Halten Sie den Umfang begrenzt auf APIs in offiziellen Dokumenten wie API -Referenz oder OpenAPI -Spezifikation. Andere LLM- oder KI-Anbieter bieten OpenAI-kompatible APIs an, haben jedoch möglicherweise nicht immer die volle Parität. In solchen Fällen hat die OpenAI -Spezifikation Vorrang.
• Konsistenz : Halten Sie den Code -Stil über alle "APIs" konsistent, die die Bibliothek enthüllt; Es schafft eine großartige Entwicklererfahrung.

Dieses Projekt hält an Rost -Verhaltenskodex fest

Kostenlose Kisten

• OpenAI-Func-Enums bietet prozedurale Makros, mit denen diese Bibliothek mit dem Tool-Aufruf von OpenAI-API einfacher verwendet werden kann. Es bietet auch Ableitungsmakros, die Sie zu den vorhandenen Unterbefehlern von ClaP -Anwendungen hinzufügen können, um die natürliche Sprache der Verwendung von Befehlszeilen -Tools zu verwenden. Es unterstützt auch die Parallel -Tool -Anrufe von OpenAI und ermöglicht es Ihnen, zwischen mehreren Tool -Aufrufen gleichzeitig auszuführen oder ihre eigenen Betriebssystem -Threads zu besitzen.
• Async-Openai-WASM liefert WASM-Unterstützung.

Lizenz

Dieses Projekt ist unter MIT -Lizenz lizenziert.