README

uberduck

Uberduck 的 PHP Rest API。关于 Uberduck API 的完整文档，请参阅官方文档。

文档

安装
使用

安装

首先，您需要在您的 composer.json 中添加组件

composer require littlefish/uberduck

添加组件后，使用 composer update 更新您的包，或使用 composer install 安装它们。

环境变量

此库需要您在环境变量中设置以下设置

UBERDUCK_KEY=<your-uberduck-key>
UBERDUCK_SECRET=<your-uberduck-secret-key>
UBERDUCK_HOST=<uberduck-api-host> # optional

Laravel 配置（可选）

您可以直接在安装后使用此包与您的 Laravel 项目。如果需要修改默认配置，可以添加一个 uberduck 配置密钥

'uberduck' => [
    'api_key' => 'your-uberduck-key',
    'api_secret' => 'your-uberduck-secret-key',
    'api_host' => 'uberduck-api-host'
]

使用

以下 API 方法大多遵循官方 Uberduck 文档。通过阅读文档可以找到更详细的用法。对于有效载荷（参数），请参阅官方文档中的详细描述。

列出声音

获取可用声音的信息。

示例

$response = uberduck->listVoices($payload);

列出声音样本

从指定的 VoiceModel 返回示例输出。

示例

$response = uberduck->listVoiceSamples($voiceModelUuid);

列出背景音乐

列出背景音乐。

示例

$response = uberduck->listBackingTracks();
// or
$response = uberduck->listBackingTracks($payload);

生成歌词

示例

$response = uberduck->generateLyrics($payload);

生成即兴创作

示例

$response = uberduck->generateFreestyle($payload);

提示构建器

可以通过 Uberduck 控制台的 提示构建器 选项卡创建自定义提示。

示例

/*
  $payload should be the variables you want to POST to your prompt, not including the `variables` key.
  $payload = [
    'parameter' => 'value'
  ];

  The function will stringify your $payload with following php object structure in the POST body:
  ['variables' => $payload]
*/
$response = uberduck->customPrompt($key, $payload);

littlefish / uberduck

维护者

详情