PHP 中的 OpenAI API 客户端

如果您希望确保该项目持续发展并不断改进，请务必考虑给予支持。您的帮助对我们意义重大。感谢！

• 请我喝杯咖啡
• Patreon

目前已支持 ChatGPT API，有关实现的介绍，请点击此处。

来自创建者的一则信息：
感谢您访问 @orhanerday/open-ai 仓库！如果您觉得这个仓库对您有帮助或有用，我们鼓励您在 GitHub 上为它*加星标。给仓库加星标是表达您对项目支持的一种方式。同时，这也能够提高项目的可见度，并让社区知道它具有价值。再次感谢您的支持，希望您能从这个仓库中受益！

Orhan*

被以下媒体推荐

与其他包的比较

项目名称	所需 PHP 版本（越低越好）	描述	类型（官方 / 社区）	支持
orhanerday/open-ai	PHP 7.4+	下载量最多、被大量 fork 和贡献、拥有庞大社区支持，是用于访问 OpenAI GPT-3 和 DALL-E 的 PHP SDK。同时也支持类似 ChatGPT 的流式响应。	社区	提供支持，(社区驱动的 Discord 服务器 或个人邮件 orhann@duck.com)
openai-** /c***t	PHP 8.1+	OpenAI 的 PHP API 客户端。	社区	-

关于本包

完全开源且安全的社区维护版 PHP SDK，用于访问 OpenAI GPT-3 API。

欲了解更多信息，可阅读 Laravel News 的 博客文章。

提供免费支持。加入我们的 Discord 服务器

要开始使用本包，您首先需要熟悉 OpenAI API 文档 和 示例。此外，您也可以通过名为 #api-support 的 Discord 频道获得帮助。

最新消息

• orhanerday/open-ai 已被添加到 OpenAI 平台的 PHP 社区库 部分。
• orhanerday/open-ai 被 PHPStorm 博客文章 推荐，感谢 JetBrains！

需要 PHP 7.4+

加入我们的 Discord 服务器

点击此处加入 Discord 服务器

支持本项目

正如您所知，OpenAI PHP 是一个用于封装 OpenAI API 的开源项目。我们依靠社区的支持来继续开发和维护该项目，而您可以通过捐款来提供帮助。

捐款使我们能够支付诸如托管费用（用于测试）、开发工具以及其他维持项目顺利运行所需的资源。无论金额大小，每一份贡献都有助于我们不断改进 OpenAI PHP，使其惠及更多人。

如果您曾受益于使用 OpenAI PHP，并希望支持其持续发展，我们将非常感激您捐赠任意金额。您可以通过以下方式捐款：

• 请我喝杯咖啡
• Patreon

感谢您考虑向 Orhanerday/OpenAI PHP SDK 捐款。您的支持备受珍视，并有助于确保该项目能够持续成长与进步。

此致，

Orhan Erday / 创建者。

文档

请访问 https://orhanerday.gitbook.io/openai-php-api-1/

终端支持

• 聊天
  • ChatGPT API
• 模型
  • 列出模型
  • 获取模型
• 完成
  • 创建完成
• 编辑
  • 创建编辑
• 图片
  • 创建图片
  • 创建图片编辑
  • 创建图片变体
• 嵌入
  • 创建嵌入
• 音频
  • 文本转语音 (TTS)
  • 创建转录
  • 创建翻译
• 文件
  • 列出文件
  • 上传文件
  • 删除文件
  • 获取文件
  • 获取文件内容
• 微调
  • 创建微调（测试版）
  • 列出微调（测试版）
  • 获取微调（测试版）
  • 取消微调（测试版）
  • 列出微调事件（测试版）
  • 删除微调模型（测试版）
• 内容审核
  • 创建内容审核
• 引擎 (已弃用)
  • 列出引擎
  • 获取引擎
• 助手（测试版）
  • 创建助手
  • 获取助手
  • 修改助手
  • 删除助手
  • 列出助手
  • 创建助手文件
  • 获取助手文件
  • 删除助手文件
  • 列出助手文件
• 线程（测试版）
  • 创建线程
  • 获取线程
  • 修改线程
  • 删除线程
• 消息（测试版）
  • 创建消息
  • 获取消息
  • 修改消息
  • 列出消息
  • 获取消息文件
  • 列出消息文件
• 运行（测试版）
  • 创建运行
  • 获取运行
  • 修改运行
  • 列出运行
  • 提交工具输出
  • 取消运行
  • 创建线程和运行
  • 获取运行步骤
  • 列出运行步骤

安装

您可以通过 Composer 安装该包：

composer require orhanerday/open-ai

快速入门 ⚡

在开始之前，您需要将 OPENAI_API_KEY 设置为环境变量，并使用以下命令将其值设置为您的 OpenAI API 密钥：

PowerShell

$Env:OPENAI_API_KEY = "sk-gjtv....."

Cmd

set OPENAI_API_KEY=sk-gjtv.....

Linux 或 macOS

export OPENAI_API_KEY=sk-gjtv.....

在设置环境变量时遇到问题？请阅读 这篇文章，或者您可以查看 我的 StackOverflow 回答，了解 Windows® 环境变量的设置方法。

创建您的 index.php 文件，并将以下代码粘贴到文件中。

<?php

require __DIR__ . '/vendor/autoload.php'; // 如果您使用 PHP 框架，请移除此行。

use Orhanerday\OpenAi\OpenAi;

$open_ai_key = getenv('OPENAI_API_KEY');
$open_ai = new OpenAi($open_ai_key);

$chat = $open_ai->chat([
   'model' => 'gpt-3.5-turbo',
   'messages' => [
       [
           "role" => "system",
           "content" => "You are a helpful assistant."
       ],
       [
           "role" => "user",
           "content" => "Who won the world series in 2020?"
       ],
       [
           "role" => "assistant",
           "content" => "The Los Angeles Dodgers won the World Series in 2020."
       ],
       [
           "role" => "user",
           "content" => "Where was it played?"
       ],
   ],
   'temperature' => 1.0,
   'max_tokens' => 4000,
   'frequency_penalty' => 0,
   'presence_penalty' => 0,
]);


var_dump($chat);
echo "<br>";
echo "<br>";
echo "<br>";
// 解码响应
$d = json_decode($chat);
// 获取内容
echo($d->choices[0]->message->content);

使用以下命令运行服务器

php -S localhost:8000 -t .

NVIDIA NIM 集成

orhanerday/open-ai 支持 NVIDIA NIM。以下示例使用的是 MixtralAI。更多示例请访问 https://build.nvidia.com/explore/discover。

<?php

require __DIR__ . '/vendor/autoload.php'; // 如果您使用 PHP 框架，请移除此行。

use Orhanerday\OpenAi\OpenAi;

$nvidia_ai_key = getenv('NVIDIA_AI_API_KEY');
error_log($nvidia_ai_key);
$open_ai = new OpenAi($nvidia_ai_key);
$open_ai->setBaseURL("https://integrate.api.nvidia.com");
$chat = $open_ai->chat([
    'model' => 'mistralai/mixtral-8x7b-instruct-v0.1',
    'messages' => [["role" => "user", "content" => "Write a limmerick about the wonders of GPU computing."]],
    'temperature' => 0.5,
    'max_tokens' => 1024,
    'top_p' => 1,
]);

var_dump($chat);
echo "<br>";
echo "<br>";
echo "<br>";
// 解码响应
$d = json_decode($chat);
// 获取内容
echo ($d->choices[0]->message->content);

使用方法

从环境变量加载您的密钥。

根据以下代码，$open_ai 是所有 OpenAI 操作的基础变量。

use Orhanerday\OpenAi\OpenAi;

$open_ai = new OpenAi(env('OPEN_AI_API_KEY'));

请求组织

对于属于多个组织的用户，您可以传递一个头部来指定用于 API 请求的组织。 这些 API 请求的使用量将计入指定组织的订阅配额。

$open_ai_key = getenv('OPENAI_API_KEY');
$open_ai = new OpenAi($open_ai_key);
$open_ai->setORG("org-IKN2E1nI3kFYU8ywaqgFRKqi");

基础 URL

您可以通过 setBaseURL() 方法指定基础 URL；

$open_ai_key = getenv('OPENAI_API_KEY');
$open_ai = new OpenAi($open_ai_key, $originURL);
$open_ai->setBaseURL("https://ai.example.com/");

使用代理

您可以为您的 API 请求使用一些代理服务器；

$open_ai->setProxy("http://127.0.0.1:1086");

设置头部

$open_ai->setHeader(["Connection"=>"keep-alive"]);

获取 cURL 请求信息

!!! 警告：如果您将此方法添加到您的代码中，您的 API 密钥将会暴露，因此请在部署前移除此方法。请务必小心！

您可以在请求之后获取 cURL 信息。

$open_ai = new OpenAi($open_ai_key);
echo $open_ai->listModels(); // 您必须先执行请求！
var_dump($open_ai->getCURLInfo()); // 您可以调用该请求

聊天（也称为 ChatGPT API）

给定一段聊天对话，模型会返回一个聊天完成的响应。

$complete = $open_ai->chat([
   'model' => 'gpt-3.5-turbo',
   'messages' => [
       [
           "role" => "system",
           "content" => "You are a helpful assistant."
       ],
       [
           "role" => "user",
           "content" => "Who won the world series in 2020?"
       ],
       [
           "role" => "assistant",
           "content" => "The Los Angeles Dodgers won the World Series in 2020."
       ],
       [
           "role" => "user",
           "content" => "Where was it played?"
       ],
   ],
   'temperature' => 1.0,
   'max_tokens' => 4000,
   'frequency_penalty' => 0,
   'presence_penalty' => 0,
]);

访问元素

<?php
// 聊天 API 的模拟响应
$j = '
{
   "id":"chatcmpl-*****",
   "object":"chat.completion",
   "created":1679748856,
   "model":"gpt-3.5-turbo-0301",
   "usage":{
      "prompt_tokens":9,
      "completion_tokens":10,
      "total_tokens":19
   },
   "choices":[
      {
         "message":{
            "role":"assistant",
            "content":"This is a test of the AI language model."
         },
         "finish_reason":"length",
         "index":0
      }
   ]
}
';

// 解码响应
$d = json_decode($j);

// 获取内容
echo($d->choices[0]->message->content);

相关：ChatGPT 克隆项目

完成

给定一个提示，模型会返回一个或多个预测的完成结果，同时也可以返回每个位置上替代标记的概率。

$complete = $open_ai->completion([
   'model' => 'gpt-3.5-turbo-instruct',
   'prompt' => 'Hello',
   'temperature' => 0.9,
   'max_tokens' => 150,
   'frequency_penalty' => 0,
   'presence_penalty' => 0.6,
]);

流式示例

此功能听起来可能与 ChatGPT 中的功能相似。

---

ChatGPT 克隆项目

演示视频：

https://user-images.githubusercontent.com/22305274/219878695-c76a58c0-5081-402c-a1b5-2b1fd971735a.mp4

ChatGPT 克隆是一个简单的 Web 应用程序，由 OpenAI 库提供支持，并使用 PHP 构建。它允许用户与一个实时响应的 AI 语言模型进行对话。聊天历史通过 Cookie 保存，该项目需要使用 API 密钥和启用 SQLite3。

ChatGPT 克隆仓库地址：https://github.com/orhanerday/ChatGPT

---

是否流式返回部分进度。如果设置为 true，当标记可用时，它们将作为仅包含数据的 服务器发送事件 发送，流将以 data: [DONE] 消息终止。

$open_ai = new OpenAi(env('OPEN_AI_API_KEY'));

$opts = [
   'prompt' => "Hello",
   'temperature' => 0.9,
   "max_tokens" => 150,
   "frequency_penalty" => 0,
   "presence_penalty" => 0.6,
   "stream" => true,
];

header('Content-type: text/event-stream');
header('Cache-Control: no-cache');

$open_ai->completion($opts, function ($curl_info, $data) {
   echo $data . "<br><br>";
   echo PHP_EOL;
   ob_flush();
   flush();
   return strlen($data);
});

将这部分添加到 HTML 的 <body> 内

<div id="divID">Hello</div>
<script>
   var eventSource = new EventSource("/");
   var div = document.getElementById('divID');


   eventSource.onmessage = function (e) {
      if(e.data == "[DONE]")
      {
          div.innerHTML += "<br><br>Hello";
      }
       div.innerHTML += JSON.parse(e.data).choices[0].text;
   };
   eventSource.onerror = function (e) {
       console.log(e);
   };
</script>

你应该会看到像视频中那样的响应；

https://user-images.githubusercontent.com/22305274/209847128-f72c9345-dd34-46f0-bbc5-daf1d7b6121f.mp4

编辑

根据提供的输入、指令和参数创建新的编辑内容

   $result = $open_ai->createEdit([
       "model" => "text-davinci-edit-001",
       "input" => "What day of the wek is it?",
       "instruction" => "Fix the spelling mistakes",
   ]);

图片（DALL·E）

所有 DALL·E 示例都可在该 仓库 中找到。

给定一个提示，该模型将返回一个或多个生成的图片，以 URL 或 Base64 编码的形式呈现。

创建图片

根据提示创建一张图片。

$complete = $open_ai->image([
   "prompt" => "A cat drinking milk",
   "n" => 1,
   "size" => "256x256",
   "response_format" => "url",
]);

创建图片编辑

根据原始图片和提示创建编辑或扩展后的图片。

需要用于图片编辑或变体的 HTML 上传吗？请查看 DALL·E 示例

$otter = curl_file_create(__DIR__ . './files/otter.png');
$mask = curl_file_create(__DIR__ . './files/mask.jpg');

$result = $open_ai->imageEdit([
    "image" => $otter,
    "mask" => $mask,
    "prompt" => "A cute baby sea otter wearing a beret",
    "n" => 2,
    "size" => "1024x1024",
]);

创建图片变体

创建给定图片的变体。

$otter = curl_file_create(__DIR__ . './files/otter.png');

$result = $open_ai->createImageVariation([
    "image" => $otter,
    "n" => 2,
    "size" => "256x256",
]);

搜索

(已弃用)

此端点已弃用，将于 2022 年 12 月 3 日删除 OpenAI 已开发出性能更好的新方法。了解更多信息。

给定一个查询和一组文档或标签，该模型会根据其语义相似性对每个文档进行排名。

$search = $open_ai->search([
    'engine' => 'ada',
    'documents' => ['White House', 'hospital', 'school'],
    'query' => 'the president',
]);

嵌入

获取给定输入的向量表示，该表示可以被机器学习模型和算法轻松消费。

相关指南：嵌入

创建嵌入

$result = $open_ai->embeddings([
    "model" => "text-similarity-babbage-001",
    "input" => "The food was delicious and the waiter..."
]);

回答

(已弃用)

此端点已弃用，将于 2022 年 12 月 3 日删除 我们已经开发出性能更好的新方法。了解更多信息。

给定一个问题、一组文档和一些示例，API 会根据文档中的信息生成问题的答案。这对于基于事实来源（如公司文档或知识库）的问题回答应用非常有用。

$answer = $open_ai->answer([
  'documents' => ['Puppy A is happy.', 'Puppy B is sad.'],
  'question' => 'which puppy is happy?',
  'search_model' => 'ada',
  'model' => 'curie',
  'examples_context' => 'In 2017, U.S. life expectancy was 78.6 years.',
  'examples' => [['What is human life expectancy in the United States?', '78 years.']],
  'max_tokens' => 5,
  'stop' => ["\n", '<|endoftext|>'],
]);

分类

(已弃用)

此端点已弃用，将于 2022 年 12 月 3 日删除 OpenAI 已开发出性能更好的新方法。了解更多信息。

给定一个查询和一组带标签的示例，模型将预测查询最可能的标签。这可以用作任何 ML 分类或文本到标签任务的直接替代品。

$classification = $open_ai->classification([
   'examples' => [
       ['A happy moment', 'Positive'],
       ['I am sad.', 'Negative'],
       ['I am feeling awesome', 'Positive'],
   ],
   'labels' => ['Positive', 'Negative', 'Neutral'],
   'query' => 'It is a raining day =>(',
   'search_model' => 'ada',
   'model' => 'curie',
]);

内容审核

给定一段文本输入，输出该模型是否将其分类为违反 OpenAI 的内容政策。

$flags = $open_ai->moderation([
    'input' => 'I want to kill them.'
]);

有关内容审核的更多信息，请参阅：OpenAI 审核

列举引擎

(已弃用)

引擎端点已弃用。 请改用其替代方案，模型。

列出当前可用的引擎，并提供关于每个引擎的基本信息，例如所有者和可用性。

$engines = $open_ai->engines();

音频

文本转语音 (TTS)

$result = $open_ai->tts([
    "model" => "tts-1", // tts-1-hd
    "input" => "我要再次使用无限宝石。嘿，那样我们人手就不够了，你知道的",
    "voice" => "alloy", // echo, fable, onyx, nova, 和 shimmer
]);

// 保存音频文件
file_put_contents('tts-result.mp3', $result);

创建转录

将音频转录为输入语言。

$c_file = curl_file_create(__DIR__ . '/files/en-marvel-endgame.m4a');

$result = $open_ai->transcribe([
    "model" => "whisper-1",
    "file" => $c_file,
]);

响应

{
  "text": "我要再次使用无限宝石。嘿，那样我们人手就不够了，你知道的。你看，他手里还有那些宝石呢，所以……所以我们去把它们拿回来吧。用它们把所有人都救回来。就这么简单吗？是的，就这么简单。就算只有一线希望可以挽回这一切，我觉得我们也应该为那些不在这个房间里的所有人试一试。如果我们这么做，怎么知道结果会和之前不一样呢？因为以前你可没有我啊。喂，小姑娘，这屋子里的人都在追求超级英雄的生活呢。不过冒昧问一句，你这段时间到底跑哪儿去了？宇宙里还有很多其他的星球。可惜那些地方都没有你们这些人。我就喜欢这里。走，咱们去收拾那个混蛋吧。"
}

创建翻译

将音频翻译成英语。

我使用土耳其语语音进行翻译，感谢著名科学博主 Barış Özcan

$c_file = curl_file_create(__DIR__ . '/files/tr-baris-ozcan-youtuber.m4a');

$result = $open_ai->translate([
    "model" => "whisper-1",
    "file" => $c_file,
]);

响应

{
  "text": "GPT-3。上个月，人工智能领域近年来最大的飞跃悄然发生。也许是有史以来最大的一次飞跃。OpenAI发布了GPT-3的测试版。听到这样的消息，你可能会想：这到底是什么样的飞跃呢？但请相信，这是目前最先进的语言模型，拥有最强大的语言能力。它可以回答关于人工智能的问题，还能进行翻译，甚至写诗。那些已经获得GPT-3 API访问权限的人，已经开始做一些非常有趣的实验了。让我们一起来看看几个例子。先从格言警句开始。这个网站能生成一些很美的句子，你可以直接发到推特上。与其只是空想，不如真正行动起来，用你的语言去做点什么吧。"
}

需要通过 HTML 上传音频文件吗？请查看此处的部分，并修改 API 引用。示例：

...
    echo $open_ai->translate(
        [
            "purpose" => "answers",
            "file" => $c_file,
        ]
    );
...
// 或者
...
    echo $open_ai->transcribe(
        [
            "purpose" => "answers",
            "file" => $c_file,
        ]
    );
...

文件

文件用于上传可在“答案”、“搜索”和“分类”等功能中使用的文档。

列出文件

返回属于用户所在组织的文件列表。

$files = $open_ai->listFiles();

上传文件

上传包含文档的文件，以便在各个端点/功能中使用。目前，一个组织上传的所有文件总大小不得超过 1 GB。如需提高存储限制，请联系 OpenAI。

$c_file = curl_file_create(__DIR__ . 'files/sample_file_1.jsonl');
$result = $open_ai->uploadFile([
            "purpose" => "answers",
            "file" => $c_file,
]);

使用 HTML 表单上传文件

<form action="index.php" method="post" enctype="multipart/form-data">
    选择要上传的文件：
    <input type="file" name="fileToUpload" id="fileToUpload">
    <input type="submit" value="上传文件" name="submit">
</form>
<?php
require __DIR__ . '/vendor/autoload.php';

use Orhanerday\OpenAi\OpenAi;

if ($_SERVER['REQUEST_METHOD'] == 'POST') {
    ob_clean();
    $open_ai = new OpenAi(env('OPEN_AI_API_KEY'));
    $tmp_file = $_FILES['fileToUpload']['tmp_name'];
    $file_name = basename($_FILES['fileToUpload']['name']);
    $c_file = curl_file_create($tmp_file, $_FILES['fileToUpload']['type'], $file_name);

    echo "[";
    echo $open_ai->uploadFile(
        [
            "purpose" => "answers",
            "file" => $c_file,
        ]
    );
    echo ",";
    echo $open_ai->listFiles();
    echo "]";

}

删除文件

$result = $open_ai->deleteFile('file-xxxxxxxx');

获取文件

$file = $open_ai->retrieveFile('file-xxxxxxxx');

获取文件内容

$file = $open_ai->retrieveFileContent('file-xxxxxxxx');

微调

管理微调任务，以根据您的特定训练数据定制模型。

创建微调

$result = $open_ai->createFineTune([
       "model" => "gpt-3.5-turbo-1106",
       "training_file" => "file-U3KoAAtGsjUKSPXwEUDdtw86",
]);

列举微调

$fine_tunes = $open_ai->listFineTunes();

获取微调

$fine_tune = $open_ai->retrieveFineTune('ft-AF1WoRqd3aJAHsqc9NY7iL8F');

取消微调

$result = $open_ai->cancelFineTune('ft-AF1WoRqd3aJAHsqc9NY7iL8F');

列举微调事件

$fine_tune_events = $open_ai->listFineTuneEvents('ft-AF1WoRqd3aJAHsqc9NY7iL8F');

删除微调模型

$result = $open_ai->deleteFineTune('curie:ft-acmeco-2021-03-03-21-44-20');

获取引擎

(已弃用)

获取引擎实例，提供有关引擎的基本信息，例如所有者和可用性。

$engine = $open_ai->engine('davinci');

模型

列出并描述 API 中可用的各种模型。

列出模型

列出当前可用的模型，并提供每个模型的基本信息，例如所有者和可用性。

$result = $open_ai->listModels();

获取模型

获取模型实例，提供有关模型的基本信息，例如所有者和权限设置。

$result = $open_ai->retrieveModel("text-ada-001");

打印结果 即 $search

echo $search;

助手（测试版）

允许您在自己的应用程序中构建 AI 助手。

创建助手

使用模型和指令创建助手。

$data = [
    'model' => 'gpt-3.5-turbo',
    'name' => '我的助手',
    'description' => '我的助手描述',
    'instructions' => '你应该热情地帮助我',
    'tools' => [],
    'file_ids' => [],
];

$assistant = $open_ai->createAssistant($data);

获取助手

$assistantId = 'asst_zT1LLZ8dWnuFCrMFzqxFOhzz';

$assistant = $open_ai->retrieveAssistant($assistantId);

修改助手

$assistantId = 'asst_zT1LLZ8dWnuFCrMFzqxFOhzz';
$data = [
    'name' => '我的修改后的助手',
    'instructions' => '你应该再次热情地帮助我',
];

$assistant = $open_ai->modifyAssistant($assistantId, $data);

删除助手

$assistantId = 'asst_DgiOnXK7nRfyvqoXWpFlwESc';

$assistant = $open_ai->deleteAssistant($assistantId);

列出助手

返回助手列表。

$query = ['limit' => 10];

$assistants = $open_ai->listAssistants($query);

创建助手文件

通过将文件附加到助手来创建助手文件。

$assistantId = 'asst_zT1LLZ8dWnuFCrMFzqxFOhzz';
$fileId = 'file-jrNZZZBAPGnhYUKma7CblGoR';

$file = $open_ai->createAssistantFile($assistantId, $fileId);

获取助手文件

$assistantId = 'asst_zT1LLZ8dWnuFCrMFzqxFOhzz';
$fileId = 'file-jrNZZZBAPGnhYUKma7CblGoR';

$file = $open_ai->retrieveAssistantFile($assistantId, $fileId);

删除助手文件

$assistantId = 'asst_zT1LLZ8dWnuFCrMFzqxFOhzz';
$fileId = 'file-jrNZZZBAPGnhYUKma7CblGoR';

$file = $open_ai->deleteAssistantFile($assistantId, $fileId);

列出助手文件

返回助手文件列表。

$assistantId = 'asst_zT1LLZ8dWnuFCrMFzqxFOhzz';
$query = ['limit' => 10];

$files = $open_ai->listAssistantFiles($assistantId, $query);

线程（测试版）

创建助手可以与之交互的线程。

创建线程

$data = [
    'messages' => [
        [
            'role' => 'user',
            'content' => '你好，什么是AI？',
            'file_ids' => [],
        ],
    ],
];

$thread = $open_ai->createThread($data);

获取线程

$threadId = 'thread_YKDArENVWFDO2Xz3POifFYlp';

$thread = $open_ai->retrieveThread($threadId);

修改线程

$threadId = 'thread_YKDArENVWFDO2Xz3POifFYlp';
$data = [
    'metadata' => ['test' => '1234abcd'],
];

$thread = $open_ai->modifyThread($threadId, $data);

删除线程

$threadId = 'thread_YKDArENVWFDO2Xz3POifFYlp';

$thread = $open_ai->deleteThread($threadId);

消息（测试版）

在线程中创建消息。

创建消息

$threadId = 'thread_YKDArENVWFDO2Xz3POifFYlp';
$data = [
    'role' => 'user',
    'content' => 'AI是如何工作的？用简单的语言解释一下。',
];

$message = $open_ai->createThreadMessage($threadId, $data);

获取消息

$threadId = 'thread_d86alfR2rfF7rASyV4V7hicz';
$messageId = 'msg_d37P5XgREsm6BItOcppnBO1b';

$message = $open_ai->retrieveThreadMessage($threadId, $messageId);

修改消息

$threadId = 'thread_d86alfR2rfF7rASyV4V7hicz';
,messageId = 'msg_d37P5XgREsm6BItOcppnBO1b';
,data = [
    'metadata' => ['test' => '1234abcd'],
];

,message = $open_ai->modifyThreadMessage($threadId, $messageId, $data);

列出消息

返回给定线程的消息列表。

$threadId = 'thread_d86alfR2rfF7rASyV4V7hicz';
,query = ['limit' => 10];

$messages = $open_ai->listThreadMessages($threadId, $query);

获取消息文件

$threadId = 'thread_d86alfR2rfF7rASyV4V7hicz';
,messageId = 'msg_CZ47kAGZugAfeHMX6bmJIukP';
,fileId = 'file-CRLcY63DiHphWuBrmDWZVCgA';

,file = $open_ai->retrieveMessageFile($threadId, $messageId, $fileId);

列出消息文件

返回消息文件列表。

$threadId = 'thread_d86alfR2rfF7rASyV4V7hicz';
,messageId = 'msg_CZ47kAGZugAfeHMX6bmJIukP';
,query = ['limit' => 10];

$files = $open_ai->listMessageFiles($threadId, $messageId, $query);

运行（测试版）

表示在线程上执行的一次运行。

创建运行

$threadId = 'thread_d86alfR2rfF7rASyV4V7hicz';
,data = ['assistant_id' => 'asst_zT1LLZ8dWnuFCrMFzqxFOhzz'];

$run = $open_ai->createRun($threadId, $data);

获取运行

$threadId = 'thread_JZbzCYpYgpNb79FNeneO3cGI';
,runId = 'run_xBKYFcD2Jg3gnfrje6fhiyXj';

$run = $open_ai->retrieveRun($threadId, $runId);

修改运行

$threadId = 'thread_JZbzCYpYgpNb79FNeneO3cGI';
,runId = 'run_xBKYFcD2Jg3gnfrje6fhiyXj';
,data = [
    'metadata' => ['test' => 'abcd1234'],
];

$run = $open_ai->modifyRun($threadId, $runId, $data);

列出运行

返回属于某个线程的运行列表。

$threadId = 'thread_JZbzCYpYgpNb79FNeneO3cGI';
,query = ['limit' => 10];

$runs = $open_ai->listRuns($threadId, $query);

提交工具输出

当运行状态为“requires_action”且required_action.type为submit_tool_outputs时，可以在所有工具调用完成后使用此端点提交工具输出。所有输出必须在单个请求中提交。

$threadId = 'thread_JZbzCYpYgpNb79FNeneO3cGI';
,runId = 'run_xBKYFcD2Jg3gnfrje6fhiyXj';
,outputss = [
    'tool_outputs' => [
        ['tool_call_id' => 'call_abc123', 'output' => '28C'],
    ],
];

$run = $open_ai->submitToolOutputs($threadId, $runId, $outputs);

取消运行

取消正在“in_progress”中的运行。

$threadId = 'thread_JZbzCYpYgpNb79FNeneO3cGI';
,runId = 'run_xBKYFcD2Jg3gnfrje6fhiyXj';

$run = $open_ai->cancelRun($threadId, $runId);

创建线程并运行

在一个请求中创建线程并运行它。

$data = [
    'assistant_id' => 'asst_zT1LLZ8dWnuFCrMFzqxFOhzz',
    'thread' => [
        'messages' => [
            [
                'role' => 'user',
                'content' => '你好，什么是AI？',
                'file_ids' => [],
            ],
        ],
    ],
];

$run = $open_ai->createThreadAndRun($data);

获取运行步骤

获取运行执行过程中的一个步骤。

$threadId = 'thread_JZbzCYpYgpNb79FNeneO3cGI';
,runId = 'run_xBKYFcD2Jg3gnfrje6fhiyXj';
,stepId = 'step_kwLG0vPQjqVyQHVoL7GVK3aG';

$step = $open_ai->retrieveRunStep($threadId, $runId, $stepId);

列出运行步骤

返回属于某个运行的运行步骤列表。

$threadId = 'thread_JZbzCYpYgpNb79FNeneO3cGI';
,runId = 'run_xBKYFcD2Jg3gnfrje6fhiyXj';
,query = ['limit' => 10];

$steps = $open_ai->listRunSteps($threadId, $runId, $query);

测试

运行所有测试：

composer test

仅运行对大多数用户有效的测试（排除那些需要缺失文件夹或调用已弃用且大多数用户不再可用的端点的测试）：

./vendor/bin/pest --group=working

更改记录

请参阅 CHANGELOG 以了解最近的更改内容。

贡献

详情请参阅 .github/CONTRIBUTING.md。

安全漏洞

如有安全漏洞，请向 orhanerday@gmail.com 报告。

致谢

• Orhan Erday
• 所有贡献者

许可证

MIT 许可证 (MIT)。更多信息请参阅 许可证文件。

捐赠

星标历史

OpenAI PHP SDK 快速上手指南

本指南帮助中国开发者快速集成 orhanerday/open-ai，这是一个社区维护的、功能全面的 OpenAI API PHP 客户端。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• PHP 版本：PHP 7.4 或更高版本（推荐 PHP 8.0+）。
• 包管理器：已安装 Composer。
• API 密钥：拥有有效的 OpenAI API Key (sk-...)。
• 网络环境：由于 OpenAI 服务在中国大陆无法直接访问，请确保您的服务器或开发环境已配置好代理（HTTP_PROXY/HTTPS_PROXY），或使用能够访问 OpenAI 接口的网络环境。

安装步骤

使用 Composer 将包安装到您的项目中。

1. 基础安装

在项目根目录下运行以下命令：

composer require orhanerday/open-ai

2. 国内加速安装（推荐）

如果您在国内遇到下载速度慢或超时的问题，建议先配置阿里云或腾讯云镜像源，然后再执行安装：

# 配置阿里云 Composer 全量镜像
composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

# 执行安装
composer require orhanerday/open-ai

基本使用

1. 配置 API Key

在使用 SDK 之前，您需要将 OpenAI API Key 设置为环境变量。根据您的操作系统选择对应的命令：

Linux / macOS:

export OPENAI_API_KEY="sk-gjtv....."

Windows (PowerShell):

$Env:OPENAI_API_KEY = "sk-gjtv....."

Windows (CMD):

set OPENAI_API_KEY=sk-gjtv.....

注意：如果在生产环境中，建议将 Key 写入 .env 文件并通过框架（如 Laravel）读取，或在代码初始化时直接传入。

2. 代码示例

以下是一个最简单的调用示例，用于发送消息给 ChatGPT 并获取回复：

<?php

require 'vendor/autoload.php';

use Orhanerday\OpenAi\OpenAi;

// 初始化客户端
// 如果已设置环境变量 OPENAI_API_KEY，可以不传参数；否则请在构造函数中传入 key
$open_ai = new OpenAi(); 

// 或者显式传入 Key
// $open_ai = new OpenAi('sk-gjtv.....');

// 构建请求数据
$data = [
    "model" => "gpt-3.5-turbo",
    "messages" => [
        [
            "role" => "user",
            "content" => "你好，请用中文介绍一下什么是人工智能？"
        ]
    ],
    "temperature" => 0.9,
    "max_tokens" => 150,
    "frequency_penalty" => 0,
    "presence_penalty" => 0,
];

// 发送请求
$response = $open_ai->chat($data);

// 处理响应
$result = json_decode($response, true);

if (isset($result['choices'][0]['message']['content'])) {
    echo "AI 回复：" . $result['choices'][0]['message']['content'];
} else {
    echo "请求失败或返回格式异常：" . $response;
}

3. 流式输出（Stream）示例

该 SDK 支持类似 ChatGPT 网页版的流式输出效果：

<?php

require 'vendor/autoload.php';

use Orhanerday\OpenAi\OpenAi;

$open_ai = new OpenAi();

$data = [
    "model" => "gpt-3.5-turbo",
    "messages" => [["role" => "user", "content" => "讲一个短笑话"]],
    "stream" => true, // 开启流式模式
];

// 第二个参数为回调函数，实时处理返回的数据块
$open_ai->chat($data, function ($curl_info, $data) {
    echo $data; // 直接输出增量内容
    return strlen($data);
});

更多高级用法（如图片生成、语音转录、Fine-tuning 等）请参考官方文档或 SDK 源码中的方法列表。