sfolador/ai-avatar-suggest

使用openai为用户创建头像

1.2 2023-02-22 20:02 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

使用此库通过让用户插入关于自己的简短描述来生成用户头像。

安装

您可以通过composer安装此包

composer require sfolador/ai-avatar-suggest

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="ai-avatar-suggest-config"

这是发布配置文件的内容

return [
    'openai_key' => env('OPENAI_KEY'),
    'default_size' => '256x256',
    'default_route' => 'ai-avatar-suggest',
    'use_cache' => true,
    'throttle' => [
        'enabled' => false,
        'max_attempts' => 60,
        'prefix' => 'ai-avatar-suggest',
    ],
];

请记住在您的.env文件中设置您的OpenAI密钥。

如果将use_cache选项设置为true,则包将使用默认缓存驱动程序以防止对OpenAI API进行不必要的调用。您可以在您的config/cache.php文件中更改缓存驱动程序。

用法

$aiAvatarSuggest = new Sfolador\AiAvatarSuggest();
echo $aiAvatarSuggest->suggest('A developer with a red beard and a cool hat');

//or if you want to use the facade

echo AiAvatarSuggest::suggest('A developer with a red beard and a cool hat');

您还可以通过调用具有prompt参数的路由ai-avatar-suggest来调用生成。响应将为包含建议电子邮件的JSON,例如

{
  "suggestion": "https://www.example.com/link/to/avatar"
}

清除缓存

如果您使用支持标签的缓存驱动程序,您可以通过调用命令来清除缓存

php artisan ai-avatar-suggest:clear-cache

测试

composer test

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

有关详细信息,请参阅贡献指南

安全漏洞

请参阅我们的安全策略以了解如何报告安全漏洞。

鸣谢

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件