Página Inicial>Código fonte PHP>Outras categorias
Baixar

Wrapper de API OpenAI para PHP

Esta biblioteca PHP fornece um wrapper simples para a API OpenAI, permitindo integrar facilmente a API OpenAI em seus projetos PHP.

Características

  • Fácil integração com API OpenAI
  • Suporta todos os endpoints da API OpenAI
  • Suporte de streaming para respostas em tempo real nas conclusões do chat
  • Utiliza clientes e fábricas HTTP compatíveis com PSR-17 e PSR-18 para fazer solicitações de API

Requisitos

  • PHP 8.1 ou superior
  • Uma implementação PSR-17 HTTP Factory (por exemplo, guzzle/psr7 ou nyholm/psr7)
  • Uma implementação de cliente HTTP PSR-18 (por exemplo, guzzlehttp/guzzle ou symfony/http-client)

Instalação

Você pode instalar a biblioteca via Composer: 

composer require softcreatr/php-openai-sdk

Uso

Primeiro, inclua a biblioteca em seu projeto: 

 <?php

require_once ' vendor/autoload.php ' ;

Em seguida, crie uma instância da classe OpenAI com sua chave de API, organização (opcional), um cliente HTTP, uma fábrica de solicitações HTTP e uma fábrica de fluxo HTTP: 

 use SoftCreatR  OpenAI  OpenAI ;

$ apiKey = ' your_api_key ' ;
$ organization = ' your_organization_id ' ; // optional

// Replace these lines with your chosen PSR-17 and PSR-18 compatible HTTP client and factories
$ httpClient = new YourChosenHttpClient ();
$ requestFactory = new YourChosenRequestFactory ();
$ streamFactory = new YourChosenStreamFactory ();
$ uriFactory = new YourChosenUriFactory ();

$ openAI = new OpenAI ( $ requestFactory , $ streamFactory , $ uriFactory , $ httpClient , $ apiKey , $ organization );

Agora você pode chamar qualquer endpoint de API OpenAI compatível usando o método mágico __call : 

 $ response = $ openAI -> createChatCompletion ([
    ' model ' => ' gpt-4 ' ,
    ' messages ' => [
        [ ' role ' => ' system ' , ' content ' => ' You are a helpful assistant. ' ],
        [ ' role ' => ' user ' , ' content ' => ' Hello! ' ],
    ],
]);

// Process the API response
if ( $ response -> getStatusCode () === 200 ) {
    $ responseObj = json_decode ( $ response -> getBody ()-> getContents (), true );

    print_r ( $ responseObj );
} else {
    echo " Error: " . $ response -> getStatusCode ();
}

Exemplo de streaming

Você pode ativar o streaming em tempo real para conclusões de bate-papo: 

 $ streamCallback = static function ( $ data ) {
    if ( isset ( $ data [ ' choices ' ][ 0 ][ ' delta ' ][ ' content ' ])) {
        echo $ data [ ' choices ' ][ 0 ][ ' delta ' ][ ' content ' ];
    }
};

$ openAI -> createChatCompletion (
    [
        ' model ' => ' gpt-4 ' ,
        ' messages ' => [
            [
                ' role ' => ' user ' ,
                ' content ' => ' Tell me a story about a brave knight. ' ,
            ],
        ],
        ' stream ' => true ,
    ],
    $ streamCallback
);

Para obter mais detalhes sobre como usar cada endpoint, consulte a documentação da API OpenAI e os exemplos fornecidos no repositório.

Métodos Suportados

Abaixo está uma lista de métodos suportados organizados por categoria. Cada método está vinculado à documentação correspondente da API OpenAI e inclui um link para um exemplo neste repositório.

Áudio

  • Criar transcrição – Referência de API – Exemplo
    • createTranscription(array $options = [])
  • Criar tradução - Referência de API - Exemplo
    • createTranslation(array $options = [])
  • Criar fala – Referência de API – Exemplo
    • createSpeech(array $options = [])

Bater papo

  • Criar conclusão de bate-papo - Referência de API - Exemplo
    • createChatCompletion(array $options = [])

Incorporações

  • Criar incorporação - Referência de API - Exemplo
    • createEmbedding(array $options = [])

Afinação

  • Criar trabalho de ajuste fino – Referência de API – Exemplo
    • createFineTuningJob(array $options = [])
  • Listar trabalhos de ajuste fino – Referência de API – Exemplo
    • listFineTuningJobs()
  • Recuperar trabalho de ajuste fino – Referência de API – Exemplo
    • retrieveFineTuningJob(array $parameters)
  • Cancelar trabalho de ajuste fino – Referência da API – Exemplo
    • cancelFineTuning(array $parameters)
  • Listar eventos de ajuste fino – Referência de API – Exemplo
    • listFineTuningEvents(array $parameters, array $options = [])

Lote

  • Criar lote – Referência de API – Exemplo
    • createBatch(array $options = [])
  • Recuperar lote - Referência de API - Exemplo
    • retrieveBatch(array $parameters)
  • Cancelar lote – Referência da API – Exemplo
    • cancelBatch(array $parameters)
  • Listar lotes - Referência de API - Exemplo
    • listBatches()

Arquivos

  • Listar arquivos – Referência de API – Exemplo
    • listFiles()
  • Carregar arquivo - Referência de API - Exemplo
    • uploadFile(array $options = [])
  • Excluir arquivo - Referência de API - Exemplo
    • deleteFile(array $parameters)
  • Recuperar arquivo - Referência de API - Exemplo
    • retrieveFile(array $parameters)
  • Baixar arquivo - Referência da API - Exemplo
    • retrieveFileContent(array $parameters)

Envios

  • Criar upload – Referência de API – Exemplo
    • createUpload(array $options = [])
  • Adicionar parte de upload – Referência de API – Exemplo
    • addUploadPart(array $parameters, array $options = [])
  • Upload completo – Referência da API – Exemplo
    • completeUpload(array $parameters)
  • Cancelar upload – Referência da API – Exemplo
    • cancelUpload(array $parameters)

Imagens

  • Criar imagem - Referência de API - Exemplo
    • createImage(array $options = [])
  • Criar edição de imagem - Referência de API - Exemplo
    • createImageEdit(array $options = [])
  • Criar variação de imagem - Referência de API - Exemplo
    • createImageVariation(array $options = [])

Modelos

  • Modelos de lista – Referência de API – Exemplo
    • listModels()
  • Recuperar modelo - Referência de API - Exemplo
    • retrieveModel(array $parameters)
  • Excluir modelo – Referência de API – Exemplo
    • deleteModel(array $parameters)

Moderações

  • Criar moderação – Referência de API – Exemplo
    • createModeration(array $options = [])

Assistentes

Assistentes

  • Criar Assistente - Referência de API - Exemplo
    • createAssistant(array $options = [])
  • Assistentes de lista – Referência de API – Exemplo
    • listAssistants()
  • Assistente de recuperação - Referência de API - Exemplo
    • retrieveAssistant(array $parameters)
  • Assistente de modificação – Referência de API – Exemplo
    • modifyAssistant(array $parameters, array $options = [])
  • Assistente de exclusão - Referência de API - Exemplo
    • deleteAssistant(array $parameters)

Tópicos

  • Criar Thread - Referência de API - Exemplo
    • createThread(array $options = [])
  • Recuperar Thread - Referência de API - Exemplo
    • retrieveThread(array $parameters)
  • Modificar Thread - Referência de API - Exemplo
    • modifyThread(array $parameters, array $options = [])
  • Excluir Thread - Referência de API - Exemplo
    • deleteThread(array $parameters)

Mensagens

  • Criar mensagem – Referência de API – Exemplo
    • createMessage(array $parameters, array $options = [])
  • Listar mensagens – Referência da API – Exemplo
    • listMessages(array $parameters)
  • Recuperar mensagem – Referência da API – Exemplo
    • retrieveMessage(array $parameters)
  • Modificar mensagem – Referência de API – Exemplo
    • modifyMessage(array $parameters, array $options = [])
  • Excluir mensagem – Referência da API – Exemplo
    • deleteMessage(array $parameters)

Corre

  • Criar execução – Referência de API – Exemplo
    • createRun(array $parameters, array $options = [])
  • Criar thread e executar – Referência de API – Exemplo
    • createThreadAndRun(array $options = [])
  • Execuções de lista – Referência de API – Exemplo
    • listRuns(array $parameters)
  • Recuperar execução - Referência de API - Exemplo
    • retrieveRun(array $parameters)
  • Modificar execução - Referência de API - Exemplo
    • modifyRun(array $parameters, array $options = [])
  • Enviar resultados da ferramenta para execução – Referência da API – Exemplo
    • submitToolOutputsToRun(array $parameters, array $options = [])
  • Cancelar execução – Referência da API – Exemplo
    • cancelRun(array $parameters)

Executar etapas

  • Listar etapas de execução – Referência da API – Exemplo
    • listRunSteps(array $parameters)
  • Etapa Recuperar Execução – Referência da API – Exemplo
    • retrieveRunStep(array $parameters)

Lojas de vetores

  • Criar armazenamento de vetores - Referência de API - Exemplo
    • createVectorStore(array $options = [])
  • Listar lojas de vetores - Referência de API - Exemplo
    • listVectorStores()
  • Recuperar armazenamento de vetores - referência de API - exemplo
    • retrieveVectorStore(array $parameters)
  • Modificar armazenamento de vetores - Referência de API - Exemplo
    • modifyVectorStore(array $parameters, array $options = [])
  • Excluir armazenamento de vetores – referência de API – exemplo
    • deleteVectorStore(array $parameters)

Arquivos de armazenamento de vetores

  • Criar arquivo de armazenamento de vetores - Referência de API - Exemplo
    • createVectorStoreFile(array $parameters, array $options = [])
  • Listar arquivos de armazenamento de vetores - Referência de API - Exemplo
    • listVectorStoreFiles(array $parameters)
  • Recuperar arquivo de armazenamento de vetores - Referência de API - Exemplo
    • retrieveVectorStoreFile(array $parameters)
  • Excluir arquivo de armazenamento de vetores - Referência da API - Exemplo
    • deleteVectorStoreFile(array $parameters)

Lotes de arquivos de armazenamento de vetores

  • Criar lote de arquivos de armazenamento de vetores - Referência de API - Exemplo
    • createVectorStoreFileBatch(array $parameters, array $options = [])
  • Recuperar lote de arquivos de armazenamento de vetores - Referência de API - Exemplo
    • retrieveVectorStoreFileBatch(array $parameters)
  • Cancelar lote de arquivos de armazenamento de vetores - Referência de API - Exemplo
    • cancelVectorStoreFileBatch(array $parameters)
  • Listar arquivos de armazenamento de vetores em lote - Referência de API - Exemplo
    • listVectorStoreFilesInBatch(array $parameters)

Administração

Convites

  • Listar convites – Referência de API – Exemplo
    • listInvites()
  • Criar convite – Referência de API – Exemplo
    • createInvite(array $options = [])
  • Recuperar convite – Referência da API – Exemplo
    • retrieveInvite(array $parameters)
  • Excluir convite – Referência da API – Exemplo
    • deleteInvite(array $parameters)

Usuários

  • Listar usuários – Referência da API – Exemplo
    • listUsers()
  • Modificar usuário – Referência de API – Exemplo
    • modifyUser(array $parameters, array $options = [])
  • Recuperar usuário - Referência de API - Exemplo
    • retrieveUser(array $parameters)
  • Excluir usuário – Referência da API – Exemplo
    • deleteUser(array $parameters)

Projetos

  • Listar projetos – Referência de API – Exemplo
    • listProjects()
  • Criar Projeto - Referência de API - Exemplo
    • createProject(array $options = [])
  • Recuperar Projeto - Referência de API - Exemplo
    • retrieveProject(array $parameters)
  • Modificar projeto – Referência de API – Exemplo
    • modifyProject(array $parameters, array $options = [])
  • Arquivar projeto - Referência de API - Exemplo
    • archiveProject(array $parameters)

Usuários do projeto

  • Listar usuários do projeto – Referência da API – Exemplo
    • listProjectUsers(array $parameters)
  • Criar usuário do projeto – Referência da API – Exemplo
    • createProjectUser(array $parameters, array $options = [])
  • Recuperar usuário do projeto – Referência da API – Exemplo
    • retrieveProjectUser(array $parameters)
  • Modificar usuário do projeto – Referência da API – Exemplo
    • modifyProjectUser(array $parameters, array $options = [])
  • Excluir usuário do projeto – Referência da API – Exemplo
    • deleteProjectUser(array $parameters)

Contas de serviço do projeto

  • Listar contas de serviço do projeto – Referência da API – Exemplo
    • listProjectServiceAccounts(array $parameters)
  • Criar conta de serviço do projeto – Referência de API – Exemplo
    • createProjectServiceAccount(array $parameters, array $options = [])
  • Recuperar conta de serviço do projeto – Referência de API – Exemplo
    • retrieveProjectServiceAccount(array $parameters)
  • Excluir conta de serviço do projeto – Referência de API – Exemplo
    • deleteProjectServiceAccount(array $parameters)

Chaves de API do projeto

  • Listar chaves de API do projeto – Referência de API – Exemplo
    • listProjectApiKeys(array $parameters)
  • Recuperar chave de API do projeto – Referência de API – Exemplo
    • retrieveProjectApiKey(array $parameters)
  • Excluir chave de API do projeto – Referência de API – Exemplo
    • deleteProjectApiKey(array $parameters)

Registros de auditoria

  • Listar registros de auditoria – Referência de API – Exemplo
    • listAuditLogs(array $options = [])

Registro de alterações

Para obter uma lista detalhada de alterações e atualizações, consulte o arquivo CHANGELOG.md. Aderimos ao controle de versão semântico e documentamos mudanças notáveis ​​para cada versão.

Problemas e Limitações Conhecidos

Suporte de streaming

O streaming agora é compatível com a geração de tokens em tempo real nas conclusões do chat. Certifique-se de lidar corretamente com os fluxos usando um retorno de chamada, conforme demonstrado nos exemplos.

Licença

Esta biblioteca está licenciada sob a licença ISC. Consulte o arquivo LICENSE para obter mais informações.

Mantenedores


Sascha Greuel

Colaboradores

Expandir
Informações adicionais
Aplicativos Relacionados
Recomendado para você
Informações Relacionadas Todos