rafazingano/openai

Package OpenAI API

1.0.0 2023-07-31 17:39 UTC

Requires

• guzzlehttp/guzzle: ^7.2

MIT

• Rafael Zingano

• openai
• rafazingano

README

Este pacote é uma biblioteca PHP para acessar a API da OpenAI, feito com o objetivo de facilitar a integração de aplicações PHP com a API da OpenAI.

Instalação

Para instalar este pacote, você precisa ter o Composer instalado em sua máquina. Em seguida, execute o seguinte comando no terminal:

composer require rafazingano/openai

Utilização

Para utilizar este pacote, basta incluir o autoload do Composer em seu arquivo PHP e iniciar a utilização das classes do pacote.

require_once 'vendor/autoload.php';

use RafaZingano\OpenAi\OpenAi;

$openai = new OpenAi();

Classes disponíveis

Atualmente, este pacote conta com as seguintes classes:

• OpenAi: classe principal para acesso à API da OpenAI.

Documentação

A documentação completa deste pacote está disponível na Wiki deste repositório no GitHub.

Classe AudioOpenAIService

Esta classe é responsável pelas operações de transcrição e tradução de áudios com a API da OpenAI.

Métodos disponíveis

Atualmente, esta classe conta com os seguintes métodos:

createTranscribe($file, $model, $options = [])

Este método é responsável por realizar a transcrição de um arquivo de áudio.

Parâmetros

• $file: caminho para o arquivo de áudio a ser transcrito.
• $model: modelo a ser utilizado para a transcrição.
• $options: (opcional) um array de opções adicionais para a transcrição. As opções disponíveis são:
  • prompt: texto de apresentação para o áudio.
  • response_format: formato da resposta da transcrição.
  • temperature: temperatura a ser utilizada pelo modelo.
  • language: idioma a ser utilizado na transcrição.

Retorno

Este método retorna a resposta da transcrição.

createTranslation($file, $model, $options = [])

Este método é responsável por realizar a tradução de um arquivo de áudio.

Parâmetros

• $file: caminho para o arquivo de áudio a ser traduzido.
• $model: modelo a ser utilizado para a tradução.
• $options: (opcional) um array de opções adicionais para a tradução. As opções disponíveis são:
  • prompt: texto de apresentação para o áudio.
  • response_format: formato da resposta da tradução.
  • temperature: temperatura a ser utilizada pelo modelo.

Retorno

Este método retorna a resposta da tradução.

Contribuições

Este pacote é de código aberto e aceita contribuições. Se você tiver alguma sugestão ou encontrar algum bug, por favor, abra uma issue ou envie um pull request.

Licença

Este pacote está disponível sob a licença MIT. Veja o arquivo LICENSE para mais informações.