README

OpenAI PHP for Laravel 是一个社区维护的 PHP API 客户端，允许您与 Open AI API 进行交互。如果您或您的业务依赖于此包，支持为此有价值工具投入时间和精力的开发者很重要

• Nuno Maduro: github.com/sponsors/nunomaduro
• Sandro Gehri: github.com/sponsors/gehrisandro

注意：此仓库包含 OpenAI PHP for Laravel 的集成代码。如果您想以框架无关的方式使用 OpenAI PHP 客户端，请查看 openai-php/client 仓库。

开始使用

需要 PHP 8.1+

首先，使用 Composer 包管理器安装 OpenAI

composer require openai-php/laravel

然后，执行安装命令

php artisan openai:install

这将在您的项目中创建一个 config/openai.php 配置文件，您可以使用环境变量根据需要修改它。OpenAI API 密钥和组织 ID 的空白环境变量已添加到您的 .env 文件中。

OPENAI_API_KEY=sk-...
OPENAI_ORGANIZATION=org-...

最后，您可以使用 OpenAI 门面来访问 OpenAI API

use OpenAI\Laravel\Facades\OpenAI;

$result = OpenAI::chat()->create([
    'model' => 'gpt-3.5-turbo',
    'messages' => [
        ['role' => 'user', 'content' => 'Hello!'],
    ],
]);

echo $result->choices[0]->message->content; // Hello! How can I assist you today?

配置

配置通过环境变量或直接在配置文件（config/openai.php）中完成。

OpenAI API 密钥和组织

指定您的 OpenAI API 密钥和组织。这将用于与 OpenAI API 进行身份验证 - 您可以在 OpenAI 控制台（https://openai.com）中找到您的 API 密钥和组织。

OPENAI_API_KEY=
OPENAI_ORGANIZATION=

请求超时

超时可以用来指定等待响应的最大秒数。默认情况下，客户端将在 30 秒后超时。

OPENAI_REQUEST_TIMEOUT=

自定义 API 端点

如果您想使用与 openai-api 兼容的本地模型，可以设置基本 URL

OPENAI_BASE_URL=localhost:1234/v1/

用法

有关用法示例，请参阅 openai-php/client 仓库。

测试

OpenAI 门面提供了一个 fake() 方法，允许您模拟 API 响应。

模拟响应按顺序返回给 fake() 方法。

所有响应都有一个 fake() 方法，允许您通过仅提供对您的测试案例相关的参数来轻松创建响应对象。

use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Responses\Completions\CreateResponse;

OpenAI::fake([
    CreateResponse::fake([
        'choices' => [
            [
                'text' => 'awesome!',
            ],
        ],
    ]),
]);

$completion = OpenAI::completions()->create([
    'model' => 'gpt-3.5-turbo-instruct',
    'prompt' => 'PHP is ',
]);

expect($completion['choices'][0]['text'])->toBe('awesome!');

请求发送后，有各种方法可以确保发送了预期的请求

// assert completion create request was sent
OpenAI::assertSent(Completions::class, function (string $method, array $parameters): bool {
    return $method === 'create' &&
        $parameters['model'] === 'gpt-3.5-turbo-instruct' &&
        $parameters['prompt'] === 'PHP is ';
});

有关更多测试示例，请参阅 openai-php/client 仓库。

OpenAI PHP for Laravel 是一个开源软件，许可协议为 MIT 许可证。