openai_ex

Readme

OpenaiEx é uma biblioteca Elixir que fornece um cliente de API do OpenAI mantido comunitário.

Partes deste projeto foram desenvolvidas com a assistência do ChatGPT 3.5 e 4, bem como Claude 3 Opus e Claude 3,5 sonetos. No entanto, todas as linhas de código são curadoras humanas (por mim?).

Todos os pontos de extremidade e recursos da API (em 1º de maio de 2024) são suportados, incluindo a API BETA 2 ASSISTANTS com streaming de execução , Dall-E-3, Texto-discurso, as ferramentas suportam as conclusões do bate-papo e a versão de streaming do terminal de conclusão do bate-papo. A solicitação de streaming de cancelamento também é suportada.

A configuração dos pools de tentilhões e URL base da API são suportados.

Existem algumas diferenças em comparação com outros invólucros do Elixir Openai.

• Tentei refletir fielmente o nome/estrutura da API oficial do Python. Por exemplo, o conteúdo que já está na memória pode ser carregado como parte de uma solicitação, ele não precisa ser lido em um arquivo em um caminho local.
• Eu estava desenvolvendo para um caixa de uso do Livebook, então não tenho nenhuma configuração, apenas variáveis ​​de ambiente.
• As versões da API de streaming, com cancelamento de solicitação, são suportadas.
• O transporte subjacente é Finch, em vez de httpoison
• O terceiro partido (incluindo o Local) LLMS com um proxy OpenAI, bem como a API do Azure Openai , são considerados casos de uso legítimo.

Discussão e anúncios estão neste tópico no fórum Elixir

Instalação e uso

Para instruções de instalação e exemplos detalhados de uso, consulte o Guia do Usuário em HexDocs. O guia é um livro de vida e você pode executar todo o código nele sem criar um novo projeto. Praticamente todas as chamadas da API têm um exemplo em execução no guia do usuário.

Também existem exemplos de livebook para

• Streaming OrderBot Um exemplo de como usar o streaming de chatCompletion em um chatbot. Esta é uma versão de streaming do próximo livro de vida nesta lista.
• O deeplearning.ai orderbot. Este notebook é uma tradução Elixir / Kino do notebook Python na lição 8, do curso de deeplearning.ai Chatgpt Prompit Engineering for Developers.
• Um chatbot de conclusão que pode ser implantado como um aplicativo Livebook. O aplicativo implantado exibe 2 formulários, um para conclusões normais e outro para conclusões de streaming.
• Um interface de geração de imagem

Eles são hospedados em hexdocs e podem ser usados ​​como inspiração / partida para seus próprios projetos.

Desenvolvimento

A seção a seguir é apenas para desenvolvedores que desejam contribuir para este repositório.

Esta biblioteca foi desenvolvida usando uma imagem do Docker LiveBook que é executada dentro de um Code DevContainer. A pasta .devcontainer contém todos os arquivos relevantes.

Para começar, clone o repositório para sua máquina local e abra -a no código VS. Siga os avisos para abri -lo em um contêiner.

Depois que o contêiner está em funcionamento e em funcionamento em código VS, você pode acessar o Livebook em http: // localhost: 8080. No entanto, você precisará inserir uma senha armazenada no ambiente variável LIVEBOOK_PASSWORD . Essa variável precisa ser definida no arquivo .devcontainer/.env , que é explicado abaixo.

Variáveis ​​e segredos do ambiente

Para definir variáveis ​​de ambiente para o desenvolvimento do DevContainer, você pode criar um arquivo .env na pasta .devcontainer . Quaisquer segredos, como OPENAI_API_KEY e LIVEBOOK_PASSWORD , podem ser definidos neste arquivo como variáveis ​​de ambiente. Observe que este arquivo .env não deve ser incluído no controle da versão e já está incluído no arquivo .gitignore por esse motivo.

Você pode encontrar um exemplo de arquivo env na mesma pasta, que você pode usar como modelo para o seu próprio arquivo .env . Essas variáveis ​​serão passadas para o LiveBook via docker-compose.yml .