1. 接口描述
接口请求域名: nlp.tencentcloudapi.com 。
诗词生成接口利用现代的自然语言处理和深度学习技术,模仿了古代著名诗人的风格,为用户产生独特的诗词。用户只需输入的命题关键词,接口就能自动生成一首七言律诗或五言律诗。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ComposePoetry。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Text | 是 | String | 生成诗词的关键词。 示例值:阳光 |
PoetryType | 否 | Integer | 生成诗词的类型。0:藏头或藏身;1:藏头;2:藏身。默认为0。 示例值:0 |
Genre | 否 | Integer | 诗的体裁。0:五言律诗或七言律诗;5:五言律诗;7:七言律诗。默认为0。 示例值:7 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Title | String | 诗题,即输入的生成诗词的关键词。 示例值:阳光 |
Content | Array of String | 诗的内容。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 诗词生成调用示例
诗词生成。
输入示例
POST / HTTP/1.1
Host: nlp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ComposePoetry
<公共请求参数>
{
"Text": "阳光",
"PoetryType": 2,
"Genre": 5
}
输出示例
{
"Response": {
"Content": [
"洛阳无人见",
"江城日光流",
"月明山上路",
"柳暗水中洲"
],
"RequestId": "a4878a27-7a5c-4cd4-b17d-6a1ff403f626",
"Title": "阳光"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.BalanceInsufficient | 余额不足,开通失败,请充值后再开通。 |
FailedOperation.NoPoetry | 暂无诗词生成,请更换关键词重试。 |
FailedOperation.NotFoundData | 未查询到结果。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
FailedOperation.UnKnowError | 内部错误。 |
InternalError | 内部错误。 |
InternalError.ServiceCallError | 内部服务调用错误。 |
InternalError.ServiceError | 内部服务调用失败。 |
InvalidParameterValue.Genre | Genre非法,请参考Genre参数说明。 |
InvalidParameterValue.InvalidParameter | 参数不合法。 |
InvalidParameterValue.PoetryType | PoetryType非法,请参考PoetryType参数说明。 |
InvalidParameterValue.SensitiveText | Text输入含有敏感信息。 |
LimitExceeded.ResourceReachedLimit | 资源用量达到上限。 |
ResourceInsufficient.QuotaRunOut | 额度用尽,请充值后重试 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.Freeze | 账号已被冻结。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.IsOpening | 服务正在开通中,请稍等。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |
ResourceUnavailable.Recover | 资源已被回收。 |
ResourceUnavailable.ServiceNotOpenedError | 您的账号尚未开通NLP服务,请登录腾讯云NLP控制台进行服务开通后再使用 |
ResourceUnavailable.StopUsing | 账号已停服。 |
UnsupportedOperation.PkgExhausted | 资源包余量已用尽。 |