friendsofhyperf/openai-client

Hyperf 的 OpenAI 客户端组件。

v3.1.31 2024-06-17 01:41 UTC

README

Latest Test Latest Version on Packagist Total Downloads GitHub license

OpenAI PHP for Laravel 是一个强大的社区 PHP API 客户端,允许您与 Open AI API 进行交互。

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

开始使用

需要 PHP 8.1+

首先,通过 Composer 包管理器安装 OpenAI

composer require friendsofhyperf/openai-client

然后,发布配置文件

php bin/hyperf.php vendor:publish friendsofhyperf/openai-client

这将创建一个 config/autoload/openai.php 配置文件在您的项目中,您可以使用环境变量对其进行修改以满足您的需求

OPENAI_API_KEY=sk-...

最后,您可以从容器中使用 OpenAI\Client 实例访问 OpenAI API

use OpenAI\Client;

$result = di(OpenAI\Client::class)->completions()->create([
    'model' => 'text-davinci-003',
    'prompt' => 'PHP is',
]);

echo $result['choices'][0]['text']; // an open-source, widely-used, server-side scripting language.

Azure

为了使用 Azure OpenAI 服务,您需要使用工厂手动构建客户端。

$client = OpenAI::factory()
    ->withBaseUri('{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}')
    ->withHttpHeader('api-key', '{your-api-key}')
    ->withQueryParam('api-version', '{version}')
    ->make();

要使用 Azure,您必须部署一个模型,该模型通过 {deployment-id} 标识,已集成到 API 调用中。因此,在调用中您不需要提供模型,因为它已包含在 BaseUri 中。

因此,一个基本的完成调用示例将是

$result = $client->completions()->create([
    'prompt' => 'PHP is'
]);

用法

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

联系方式

许可

OpenAI PHP for Hyperf 是一个开源软件,根据 MIT 许可 许可。