openai_ex

Readme

OpenaiEx es una biblioteca de elixir que proporciona a un cliente API de OpenAI mantenido por la comunidad.

Las partes de este proyecto se desarrollaron con la asistencia de ChatGPT 3.5 y 4, así como Claude 3 Opus y Claude 3.5 Sonnet. Sin embargo, cada línea de código está curada humana (¿por mí?).

Se admiten todos los puntos finales y características de la API (a partir del 1 de mayo de 2024), incluidos los asistentes API Beta 2 con transmisión de ejecución , Dall-E-3, texto a voz, las herramientas admiten en las completaciones de chat y la versión de transmisión del punto final de finalización de chat. La cancelación de la solicitud de transmisión también es compatible.

Se admite la configuración de los grupos de pinzas y la URL base de la API.

Hay algunas diferencias en comparación con otros envoltorios Elixir OpenAi.

• Traté de reflejar fielmente el nombre/estructura de la API oficial de Python. Por ejemplo, el contenido que ya está en la memoria se puede cargar como parte de una solicitud, no tiene que leerse desde un archivo en una ruta local.
• Estaba desarrollando para un caso de uso de LiveBook, por lo que no tengo ninguna configuración, solo variables de entorno.
• Se admiten las versiones de la API de transmisión, con cancelación de solicitudes.
• El transporte subyacente es pintch, en lugar de httpoison
• Terceros (incluido el local) LLMS con un proxy de Operai, así como la Azure OpenAi API , se consideran casos de uso legítimos.

La discusión y los anuncios están en este hilo en el foro de elixir

Instalación y uso

Para obtener instrucciones de instalación y ejemplos de uso detallados, mire la guía del usuario en hexdocs. La guía es un LiveBook, y puede ejecutar todo el código en él sin crear un nuevo proyecto. Prácticamente cada llamada API tiene un ejemplo en ejecución en la guía del usuario.

También hay ejemplos de LiveBook para

• Transmisión de ordenbot Un ejemplo de cómo usar la transmisión de Completion de chat en un chatbot. Esta es una versión de transmisión del próximo LiveBook en esta lista.
• The Deeplearning.ai Orderbot. Este cuaderno es una traducción de elixir / kino del cuaderno de Python en la Lección 8, de Deeplearning.Ai's Curpe Chatgpt Ingeniería rápida para desarrolladores.
• Un chatbot de finalización que se puede implementar como una aplicación LiveBook. La aplicación implementada muestra 2 formularios, uno para finalizaciones normales y otra para completar la transmisión.
• Una interfaz de usuario de generación de imágenes

Estos están alojados en hexdocs y pueden usarse como inspiración / iniciadores para sus propios proyectos.

Desarrollo

La siguiente sección es solo para desarrolladores que desean contribuir a este repositorio.

Esta biblioteca se desarrolló utilizando una imagen de Docker LiveBook que se ejecuta dentro de un código VS DevContainer. La carpeta .devcontainer contiene todos los archivos relevantes.

Para comenzar, clone el repositorio a su máquina local y ábralo en el código VS. Siga las indicaciones para abrirlo en un contenedor.

Después de que el contenedor esté en funcionamiento en el código VS, puede acceder a LiveBook en http: // localhost: 8080. Sin embargo, deberá ingresar una contraseña almacenada en la variable de entorno LIVEBOOK_PASSWORD . Esta variable debe definirse en el archivo .devcontainer/.env , que se explica a continuación.

Variables y secretos de entorno

Para establecer variables de entorno para el desarrollo de DevContainer, puede crear un archivo .env en la carpeta .devcontainer . Cualquier secreto, como OPENAI_API_KEY y LIVEBOOK_PASSWORD , se puede definir en este archivo como variables de entorno. Tenga en cuenta que este archivo .env no debe incluirse en el control de versiones, y ya está incluido en el archivo .gitignore por este motivo.

Puede encontrar un archivo env de muestra en la misma carpeta, que puede usar como plantilla para su propio archivo .env . Estas variables se pasarán a LiveBook a través de docker-compose.yml .