ogrre/laravel-ChatGPT

为 openai 客户端添加聊天管理的库

1.0.6 2024-01-04 10:58 UTC

This package is auto-updated.

Last update: 2024-09-29 15:05:36 UTC


README

Packagist Version GitHub License Packagist Downloads

文档

此库需要 openai PHP 客户端,所以请不要忘记在 .env 文件中添加以下变量

# .env

OPENAI_API_KEY=
OPENAI_API_ORGANIZATION=
OPENAI_MODEL=gpt-4

安装

要安装 Laravel Chat for ChatGPT 库,请运行以下命令

composer require ogrre/laravel-chatgpt

安装后,通过执行以下命令发布供应商文件

php artisan vendor:publish --provider="Ogrre\ChatGPT\ChatServiceProvider"

默认情况下,服务提供者将自动在 app.php 文件中注册。但是,如果需要,您可以在 config/app.php 文件中手动添加服务提供者

# config/app.php

'providers' => [
    // ...
    Ogrre\ChatGPT\ChatServiceProvider,
];

最后,运行迁移命令以创建必要的数据库表

php artisan migrate

使用说明

要将聊天与模型关联,该模型必须使用 hasChat 特性。例如,在 User 模型中

class User extends Authenticatable
{
    use HasFactory, HasChat;
    // ...
}

一旦模型设置了 hasChat 特性,您可以使用以下命令创建一个新的聊天

$optional_title = "Translate this word";
$optional_role = "You're a helpful assistant";

$user_chat = $user->newChat($optional_title, $optional_role);

创建新的聊天或检索现有的聊天后,您有两种与之交互的选项

直接使用聊天对象

$chat->gpt("say hello in French");

直接使用模型(在此示例中为 User 模型)

$user->chatgpt("say hello in French", $chat);

Chat 模型是一个标准的 Laravel 模型,因此您可以使用所有常用功能,包括删除等。

此外,此库提供了一个 ChatResource,用于在 API 中显示聊天,允许轻松集成 API 端点。

贡献

欢迎贡献,并将得到充分认可。我通过 Github 的拉取请求接受贡献。

支持我

Buy Me A Coffee