README

在Laravel中永远不用担心电子邮件地址的拼写错误

此包提供了一种简单的方法，根据给定的电子邮件地址建议电子邮件地址。典型用例是当用户输入拼写错误的电子邮件地址时，例如：example@gmial.com。此包使用OpenAI建议可能正确的电子邮件地址。

安装

您可以通过composer安装此包

composer require sfolador/ai-email-suggest

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

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

这是发布配置文件的内容

return [
    'model' => 'text-davinci-003',
    'openai_key' => env('OPENAI_KEY'),
    'default_route' => 'ai-email-suggest',
    'use_cache' => true,
    // If you want to use the chatgpt API,
    // you need to set the following value to true:
    'use_chatgpt_api' => false,
    'throttle' => [
        'enabled' => false,
        'max_attempts' => 60,
        'prefix' => 'ai-email-suggest',
    ],
];

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

使用方法

$aiEmailSuggest = AiEmailSuggest::suggest('test@yaohh.com');
// $aiEmailSuggest = 'test@yahoo.com'

您可以通过通过POST调用路由："/ai-email-suggest"，传递电子邮件作为参数，从前端使用此包。响应将是一个包含建议电子邮件的JSON，例如

{
  "suggestion": "test@yahoo.com"
}

清除缓存

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

php artisan ai-email-suggest:clear-cache

ChatGPT

您可以通过将配置值use_ChatGPT_api设置为true来使用新的ChatGPT API。

测试

composer test

待办事项

添加缓存以避免对OpenAI进行过多的请求
添加节流以避免对OpenAI进行过多的请求
添加支持清除缓存

变更日志

请参阅CHANGELOG以获取有关最近更改的更多信息。

贡献

请参阅CONTRIBUTING以获取详细信息。

安全漏洞

请审查我们的安全策略了解如何报告安全漏洞。

鸣谢

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。

hiz-grup / ai-email-suggest

维护者

详细信息