首页>PHP源码>其他类别
下载

PHP 的 OpenAI API 包装器

该 PHP 库为 OpenAI API 提供了一个简单的包装器，使您可以轻松地将 OpenAI API 集成到您的 PHP 项目中。

特征

  • 与 OpenAI API 轻松集成
  • 支持所有 OpenAI API 端点
  • 聊天完成时实时响应的流支持
  • 利用符合 PSR-17 和 PSR-18 的 HTTP 客户端和工厂来发出 API 请求

要求

  • PHP 8.1 或更高版本
  • PSR-17 HTTP Factory 实现（例如 guzzle/psr7 或 nyholm/psr7）
  • PSR-18 HTTP 客户端实现（例如，guzzlehttp/guzzle 或 symfony/http-client）

安装

您可以通过 Composer 安装该库： 

composer require softcreatr/php-openai-sdk

用法

首先，将库包含在您的项目中： 

 <?php

require_once ' vendor/autoload.php ' ;

然后，使用您的 API 密钥、组织（可选）、HTTP 客户端、HTTP 请求工厂和 HTTP 流工厂创建OpenAI类的实例： 

 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 );

现在您可以使用神奇方法__call调用任何支持的 OpenAI API 端点： 

 $ 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 ();
}

流媒体示例

您可以启用实时流式传输以完成聊天： 

 $ 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
);

有关如何使用每个端点的更多详细信息，请参阅 OpenAI API 文档以及存储库中提供的示例。

支持的方法

以下是按类别组织的受支持方法的列表。每个方法都链接到其相应的 OpenAI API 文档，并包含指向此存储库中示例的链接。

声音的

  • 创建转录- API 参考 - 示例
    • createTranscription(array $options = [])
  • 创建翻译- API 参考 - 示例
    • createTranslation(array $options = [])
  • 创建语音- API 参考 - 示例
    • createSpeech(array $options = [])

聊天

  • 创建聊天完成- API 参考 - 示例
    • createChatCompletion(array $options = [])

嵌入

  • 创建嵌入- API 参考 - 示例
    • createEmbedding(array $options = [])

微调

  • 创建微调作业- API 参考 - 示例
    • createFineTuningJob(array $options = [])
  • 列出微调作业- API 参考 - 示例
    • listFineTuningJobs()
  • 检索微调作业- API 参考 - 示例
    • retrieveFineTuningJob(array $parameters)
  • 取消微调作业- API 参考 - 示例
    • cancelFineTuning(array $parameters)
  • 列出微调事件- API 参考 - 示例
    • listFineTuningEvents(array $parameters, array $options = [])

批

  • 创建批次- API 参考 - 示例
    • createBatch(array $options = [])
  • 检索批次- API 参考 - 示例
    • retrieveBatch(array $parameters)
  • 取消批次- API 参考 - 示例
    • cancelBatch(array $parameters)
  • 列出批次- API 参考 - 示例
    • listBatches()

文件

  • 列出文件- API 参考 - 示例
    • listFiles()
  • 上传文件- API 参考 - 示例
    • uploadFile(array $options = [])
  • 删除文件- API 参考 - 示例
    • deleteFile(array $parameters)
  • 检索文件- API 参考 - 示例
    • retrieveFile(array $parameters)
  • 下载文件- API 参考 - 示例
    • retrieveFileContent(array $parameters)

上传

  • 创建上传- API 参考 - 示例
    • createUpload(array $options = [])
  • 添加上传部分- API 参考 - 示例
    • addUploadPart(array $parameters, array $options = [])
  • 完整上传- API 参考 - 示例
    • completeUpload(array $parameters)
  • 取消上传- API 参考 - 示例
    • cancelUpload(array $parameters)

图片

  • 创建图像- API 参考 - 示例
    • createImage(array $options = [])
  • 创建图像编辑- API 参考 - 示例
    • createImageEdit(array $options = [])
  • 创建图像变体- API 参考 - 示例
    • createImageVariation(array $options = [])

型号

  • 列出模型- API 参考 - 示例
    • listModels()
  • 检索模型- API 参考 - 示例
    • retrieveModel(array $parameters)
  • 删除模型- API 参考 - 示例
    • deleteModel(array $parameters)

节制

  • 创建审核- API 参考 - 示例
    • createModeration(array $options = [])

助理

助理

  • 创建助手- API 参考 - 示例
    • createAssistant(array $options = [])
  • 列表助手- API 参考 - 示例
    • listAssistants()
  • 检索助手- API 参考 - 示例
    • retrieveAssistant(array $parameters)
  • 修改助手- API 参考 - 示例
    • modifyAssistant(array $parameters, array $options = [])
  • 删除助手- API 参考 - 示例
    • deleteAssistant(array $parameters)

线程数

  • 创建线程- API 参考 - 示例
    • createThread(array $options = [])
  • 检索线程- API 参考 - 示例
    • retrieveThread(array $parameters)
  • 修改线程- API 参考 - 示例
    • modifyThread(array $parameters, array $options = [])
  • 删除线程- API 参考 - 示例
    • deleteThread(array $parameters)

留言

  • 创建消息- API 参考 - 示例
    • createMessage(array $parameters, array $options = [])
  • 列表消息- API 参考 - 示例
    • listMessages(array $parameters)
  • 检索消息- API 参考 - 示例
    • retrieveMessage(array $parameters)
  • 修改消息- API 参考 - 示例
    • modifyMessage(array $parameters, array $options = [])
  • 删除消息- API 参考 - 示例
    • deleteMessage(array $parameters)

跑步

  • 创建运行- API 参考 - 示例
    • createRun(array $parameters, array $options = [])
  • 创建线程并运行- API 参考 - 示例
    • createThreadAndRun(array $options = [])
  • 列出运行- API 参考 - 示例
    • listRuns(array $parameters)
  • 检索运行- API 参考 - 示例
    • retrieveRun(array $parameters)
  • 修改运行- API 参考 - 示例
    • modifyRun(array $parameters, array $options = [])
  • 提交工具输出以运行- API 参考 - 示例
    • submitToolOutputsToRun(array $parameters, array $options = [])
  • 取消运行- API 参考 - 示例
    • cancelRun(array $parameters)

运行步骤

  • 列出运行步骤- API 参考 - 示例
    • listRunSteps(array $parameters)
  • 检索运行步骤- API 参考 - 示例
    • retrieveRunStep(array $parameters)

矢量商店

  • 创建矢量存储- API 参考 - 示例
    • createVectorStore(array $options = [])
  • 列出向量存储- API 参考 - 示例
    • listVectorStores()
  • 检索矢量存储- API 参考 - 示例
    • retrieveVectorStore(array $parameters)
  • 修改矢量存储- API 参考 - 示例
    • modifyVectorStore(array $parameters, array $options = [])
  • 删除矢量存储- API 参考 - 示例
    • deleteVectorStore(array $parameters)

矢量存储文件

  • 创建矢量存储文件- API 参考 - 示例
    • createVectorStoreFile(array $parameters, array $options = [])
  • 列出矢量存储文件- API 参考 - 示例
    • listVectorStoreFiles(array $parameters)
  • 检索矢量存储文件- API 参考 - 示例
    • retrieveVectorStoreFile(array $parameters)
  • 删除矢量存储文件- API 参考 - 示例
    • deleteVectorStoreFile(array $parameters)

矢量存储文件批次

  • 创建矢量存储文件批次- API 参考 - 示例
    • createVectorStoreFileBatch(array $parameters, array $options = [])
  • 批量检索矢量存储文件- API 参考 - 示例
    • retrieveVectorStoreFileBatch(array $parameters)
  • 取消矢量存储文件批次- API 参考 - 示例
    • cancelVectorStoreFileBatch(array $parameters)
  • 批量列出矢量存储文件- API 参考 - 示例
    • listVectorStoreFilesInBatch(array $parameters)

行政

邀请

  • 列出邀请- API 参考 - 示例
    • listInvites()
  • 创建邀请- API 参考 - 示例
    • createInvite(array $options = [])
  • 检索邀请- API 参考 - 示例
    • retrieveInvite(array $parameters)
  • 删除邀请- API 参考 - 示例
    • deleteInvite(array $parameters)

用户

  • 列出用户- API 参考 - 示例
    • listUsers()
  • 修改用户- API 参考 - 示例
    • modifyUser(array $parameters, array $options = [])
  • 检索用户- API 参考 - 示例
    • retrieveUser(array $parameters)
  • 删除用户- API 参考 - 示例
    • deleteUser(array $parameters)

项目

  • 列出项目- API 参考 - 示例
    • listProjects()
  • 创建项目- API 参考 - 示例
    • createProject(array $options = [])
  • 检索项目- API 参考 - 示例
    • retrieveProject(array $parameters)
  • 修改项目- API 参考 - 示例
    • modifyProject(array $parameters, array $options = [])
  • 存档项目- API 参考 - 示例
    • archiveProject(array $parameters)

项目用户

  • 列出项目用户- API 参考 - 示例
    • listProjectUsers(array $parameters)
  • 创建项目用户- API 参考 - 示例
    • createProjectUser(array $parameters, array $options = [])
  • 检索项目用户- API 参考 - 示例
    • retrieveProjectUser(array $parameters)
  • 修改项目用户- API 参考 - 示例
    • modifyProjectUser(array $parameters, array $options = [])
  • 删除项目用户- API 参考 - 示例
    • deleteProjectUser(array $parameters)

项目服务账户

  • 列出项目服务帐户- API 参考 - 示例
    • listProjectServiceAccounts(array $parameters)
  • 创建项目服务帐户- API 参考 - 示例
    • createProjectServiceAccount(array $parameters, array $options = [])
  • 检索项目服务帐户- API 参考 - 示例
    • retrieveProjectServiceAccount(array $parameters)
  • 删除项目服务帐户- API 参考 - 示例
    • deleteProjectServiceAccount(array $parameters)

项目 API 密钥

  • 列出项目 API 密钥- API 参考 - 示例
    • listProjectApiKeys(array $parameters)
  • 检索项目 API 密钥- API 参考 - 示例
    • retrieveProjectApiKey(array $parameters)
  • 删除项目 API 密钥- API 参考 - 示例
    • deleteProjectApiKey(array $parameters)

审核日志

  • 列出审核日志- API 参考 - 示例
    • listAuditLogs(array $options = [])

变更日志

有关更改和更新的详细列表，请参阅 CHANGELOG.md 文件。我们坚持语义版本控制并记录每个版本的显着变化。

已知问题和限制

流媒体支持

现在支持流式传输，以便在聊天完成时实时生成令牌。请确保您使用回调正确处理流，如示例中所示。

执照

该库根据 ISC 许可证获得许可。有关详细信息，请参阅许可证文件。

维护者


萨莎·格鲁埃尔

贡献者
展开
附加信息
相关应用
为您推荐
相关资讯 全部