async openai

Async-Openai

Biblioteca de ferrugem assíncrona para o OpenAi

_{Logotipo criado por este próprio repo}

Visão geral

async-openai é uma biblioteca de ferrugem não oficial do OpenAI.

• É baseado na especificação do Openai OpenApi
• Recursos atuais:
  • Assistentes (V2)
  • Áudio
  • Lote
  • Bater papo
  • Conclusões (legado)
  • Incorporação
  • Arquivos
  • Afinação
  • Imagens
  • Modelos
  • Moderações
  • Organizações | Administração
  • Tipos de API em tempo real (beta)
  • Uploads
• SSE Streaming nas APIs disponíveis
• As solicitações (exceto o streaming SSE), incluindo os envios de formulário, são tentadas com o retorno exponencial quando a taxa limitada.
• Padrão de construtor ergonômico para todos os objetos de solicitação.
• Serviço do Microsoft Azure OpenAi (apenas para APIs Combining OpenAi Spec)

Uso

A biblioteca lê a tecla API da variável de ambiente OPENAI_API_KEY .

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

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

• Visite Exemplos Directory sobre como usar async-openai .
• Visite docs.rs/async-openai para documentos.

API em tempo real

Somente tipos de API em tempo real são implementados e podem ser ativados com o sinalizador de recursos realtime . Esses tipos podem mudar se/quando o OpenAI libera especificações oficiais para eles.

Exemplo de geração de imagens

 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 o ReadMe, tamanho real 256x256}

Contribuindo

Obrigado por reservar um tempo para contribuir e melhorar o projeto. Eu ficaria feliz em ter você!

Todas as formas de contribuições, como novas solicitações de recursos, correções de bugs, problemas, documentação, teste, comentários, exemplos etc. são bem -vindos.

Um bom ponto de partida seria analisar os problemas abertos existentes.

Para manter a qualidade do projeto, um mínimo do seguinte é uma obrigação para a contribuição do código:

• Nomes e documentação : todos os nomes de estruturas, nomes de campo e comentários do documento são da OpenAPI Spec. Objetos aninhados em especificações sem nomes deixam espaço para criar o nome apropriado.
• Testado : Para alterações, é necessário alterações de suporte (s) e/ou exemplo. Exemplos existentes, testes de documentos, testes de unidade e testes de integração devem ser feitos para trabalhar com as alterações, se aplicável.
• Escopo : mantenha o escopo limitado às APIs disponíveis em documentos oficiais, como referência da API ou especificação OpenAPI. Outros provedores de LLMs ou IA oferecem APIs compatíveis com o OpenAI, mas nem sempre podem ter total paridade. Nesses casos, a especificação do Openai tem precedência.
• Consistência : mantenha o estilo de código consistente em todas as "APIs" que a biblioteca expõe; Isso cria uma ótima experiência de desenvolvedor.

Este projeto segue o código de conduta de ferrugem

Crates de cortesia

• O OpenAI-Func-ENums fornece macros processuais que facilitam o uso desta biblioteca com o recurso de chamada de ferramentas da API do OpenAI. Ele também fornece macros derivadas que você pode adicionar aos subcomandos de aplicativos de palito existentes para o uso da linguagem natural das ferramentas de linha de comando. Ele também suporta chamadas de ferramentas paralelas do OpenAI e permite que você escolha entre a execução de várias chamadas de ferramentas simultaneamente ou possui seus próprios threads do sistema operacional.
• Async-Openai-wasm fornece suporte a WASM.

Licença

Este projeto está licenciado sob licença do MIT.