async openai

asíncrono-openai

Biblioteca Async Rust para OpenAi

_{Logotipo creado por este repositorio en sí}

Descripción general

async-openai es una biblioteca de óxido no oficial para OpenAi.

• Se basa en la especificación de OpenAi Openapi
• Características actuales:
  • Asistentes (V2)
  • Audio
  • Lote
  • Charlar
  • Finalizaciones (legado)
  • Incrustaciones
  • Archivos
  • Sintonia FINA
  • Imágenes
  • Modelos
  • Moderaciones
  • Organizaciones | Administración
  • Tipos de API en tiempo real (beta)
  • Cargas
• Transmisión de SSE en API disponibles
• Las solicitudes (excepto la transmisión de SSE), incluidas las presentaciones del formulario, se vuelven a contactar con un retroceso exponencial cuando la tasa limitada.
• Patrón de constructor ergonómico para todos los objetos de solicitud.
• Servicio Microsoft Azure OpenAI (solo para las API coincidiendo con la especificación de OpenAI)

Uso

La biblioteca lee la tecla API de la variable de entorno OPENAI_API_KEY .

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

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

• Visite el directorio de ejemplos sobre cómo usar async-openai .
• Visite docs.rs/async-openai para documentos.

API en tiempo real

Solo se implementan tipos para API en tiempo real y se pueden habilitar con la bandera de funciones realtime . Estos tipos pueden cambiar si/cuando OpenAI emite especificaciones oficiales para ellos.

Ejemplo de generación de imágenes

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

_{Escalado para readMe, tamaño real 256x256}

Que contribuye

Gracias por tomarse el tiempo para contribuir y mejorar el proyecto. ¡Estaría feliz de tenerte!

Todas las formas de contribuciones, como nuevas solicitudes de características, correcciones de errores, problemas, documentación, pruebas, comentarios, ejemplos, etc.

Un buen punto de partida sería mirar los problemas abiertos existentes.

Para mantener la calidad del proyecto, un mínimo de lo siguiente es imprescindible para la contribución del código:

• Nombres y documentación : Todos los nombres de estructura, nombres de campo y comentarios de DOC son de OpenApi Spec. Los objetos anidados en especificaciones sin nombres dejan espacio para hacer el nombre apropiado.
• Probado : para los cambios que se requieren pruebas y/o ejemplo. Se deben realizar ejemplos existentes, pruebas de documento, pruebas unitarias y pruebas de integración para que funcionen con los cambios si corresponde.
• Alcance : Mantenga el alcance limitado a las API disponibles en documentos oficiales como la referencia de API o la especificación de OpenAPI. Otros proveedores de LLM o IA ofrecen API compatibles con OpenAI, sin embargo, es posible que no siempre tengan paridad completa. En tales casos, la especificación de OpenAI tiene prioridad.
• Consistencia : mantenga el estilo del código consistente en todas las "API" que expone la biblioteca; Crea una gran experiencia de desarrollador.

Este proyecto se adhiere al código de conducta de oxidación

Cajas de cortesía

• Operai-Func-Enums proporciona macros de procedimiento que facilitan el uso de esta biblioteca con la función de llamadas de herramientas de OpenAI API. También proporciona macros Derive que puede agregar a los subcomandos de aplicación Clap existentes para el uso del lenguaje natural de las herramientas de línea de comandos. También admite las llamadas de herramientas paralelas de OpenAI y le permite elegir entre ejecutar múltiples llamadas de herramienta al mismo tiempo o poseer sus propios hilos de sistema operativo.
• Async-Openai-Wasm proporciona soporte WASM.

Licencia

Este proyecto tiene licencia bajo la licencia MIT.