README

RytrPhp 是 Rytr API 的简单 SDK 实现。它以面向对象的方式帮助访问 API。

官方 Rytr-me 页面： https://rytr.me/

官方 Rytr-me Git 文档： https://github.com/rytr-me/documentation

获取 API 密钥

请注册账户并在 Rytr 上请求 API 密钥。

请查看教程部分获取更多信息

• 查找您的 API 密钥

安装

您可以通过 composer 安装此包

composer require devkind/rytr-php

用法

初始化

use Devkind\RytrPhp;

/** @var \Devkind\RytrPhp */
$rytr  =  new RytrPhp(API_KEY);

或者我们可以静态初始化对象

/** @var \Devkind\RytrPhp */
$rytr  =  \Devkind\RytrPhp::make(API_KEY);

端点

端点基本上是 Rytr 支持的内容类型。

每个端点都需要一个 $tone 和 $language 参数来从 Rytr 查询。

默认值

protected $language = '607adac76f8fe5000c1e636d'; //英语

language="🇺🇸 English" - 文本生成的语言 - 使用 setLanguage() 更改

protected $language = '607adac76f8fe5000c1e636d'; //英语

tone="Casual" - 文本的语调 - 使用 setTone() 更改

protected int $variations = 1;

variations = 1 - 响应中的文本数量 - 使用 setVariation() 更改

protected string $format = 'text';

formats='html' - html 或 text - ** 使用 setFormat() 更改**

protected string $creativityLevel = 'default';

creativity_level='default' - fault | none | low | medium | high | max - 使用 setCreativityLevel() 更改

user_id='USER1' - "对于 userId，您需要提供数据库中的用户 ID，例如：用户数据库表的键。" - 使用 setUserId() 更改

要更改语言或语调，我们可以调用所有端点上的设置方法。

设置语言

/** @var \Devkind\RytrPhp\Endpoints\Usercases\BrandName */
$endpoint = $rytr->BrandName->setLanguage('english');

设置语调

/** @var \Devkind\RytrPhp\Endpoints\Usercases\BrandName */
$endpoint = $rytr->BrandName->setTone('candid');

或者

/** @var \Devkind\RytrPhp\Endpoints\Usercases\BrandName */
$endpoint = $rytr->BrandName->setTone('candid')->setLanguage('english')->setVariation(10);

所有端点可以通过三种不同的方式调用

通过 get 方法

/** @var \Devkind\RytrPhp\Endpoints\UseCases\BrandName */
$endpoint = $object->BrandName;

$endpoint = $endpoint->get(['brandDescription' => "google"]);

通过设置方法

/** @var \Devkind\RytrPhp\Endpoints\UseCases\BrandName */
$endpoint = $object->BrandName;

$endpoint = $endpoint
    ->setBrandDescription("google")
    ->setVariations(10)
    ->setUserId(100)
    ->setFormat('html')
    ->setCreativityLevel('medium')
    ->get();

通过 generate 方法

/** @var \Devkind\RytrPhp\Endpoints\UseCases\BrandName */
$endpoint = $object->BrandName;

$endpoint = $endpoint->generate("google");

支持的对象/端点

点击这里 查看支持端点的完整文档

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件 backend@devkind.com.au 而不是使用问题跟踪器。

致谢

• Devkind 开发者
• Devkind 开发者
• 所有贡献者

许可

MIT 许可证 (MIT)。请参阅 许可文件 了解更多信息。