文本润色

最近更新时间:2024-03-12 01:42:27

我的收藏

1. 接口描述

接口请求域名: nlp.tencentcloudapi.com 。

运用先进的自然语言处理技术,对原始文本进行优化润色,提升文本的通顺性、表达力和语言质量。

默认接口请求频率限制:1次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TextEmbellish。
Version String 公共参数,本接口取值:2019-04-08。
Region String 公共参数,本接口不需要传递此参数。
Text String 待润色的文本。中文文本长度需<=50字符;英文文本长度需<=30个单词。
示例值:中国奥运健儿击败强敌,勇夺冬奥会首金
SourceLang String 待润色文本的语言类型,支持语言如下:
zh:中文
en:英文
示例值:zh
Number Integer 返回润色结果的个数。数量需>=1且<=5。
(注意实际结果可能小于指定个数)
示例值:1
Style String 控制润色类型,类型如下:
both:同时返回改写和扩写
expansion:扩写
rewriting:改写
m2a:从现代文改写为古文
a2m:从古文改写为现代文
默认为both。
示例值:both

3. 输出参数

参数名称 类型 描述
EmbellishList Array of Embellish 润色结果列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 文本润色调用示例

对中文文本进行扩写。

输入示例

POST / HTTP/1.1
Host: nlp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action:TextEmbellish
<公共请求参数>

{
    "Text": "中国奥运健儿击败强敌,勇夺冬奥会首金",
    "SourceLang": "zh",
    "Number": 2,
    "Style": "expansion"
}

输出示例

{
    "Response": {
        "EmbellishList": [
            {
                "EmbellishType": "expansion",
                "Text": "现在的中国跳水奥运健儿一路高歌猛进击败强敌,不负众望的勇夺温哥华冬奥会单板滑雪首金"
            },
            {
                "EmbellishType": "expansion",
                "Text": "年轻的中国冰雪奥运健儿一次次击败强敌,历史性的勇夺温哥华冬奥会史无前例的首金"
            }
        ],
        "RequestId": "fd345650-b62b-4949-bdd7-d774152dba9a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.BalanceInsufficient 余额不足,开通失败,请充值后再开通。
FailedOperation.InnerError 服务内部错误,请重试。
FailedOperation.NoResults 暂无结果,请更换文本重试。
FailedOperation.NotFoundData 未查询到结果。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.ResourceBusy 服务器繁忙,请稍后再试。
FailedOperation.RpcFail RPC请求失败,一般为算法微服务故障。
FailedOperation.Unknown 未知错误。
InternalError 内部错误。
InternalError.ServiceCallError 内部服务调用错误。
InternalError.ServiceError 内部服务调用失败。
InvalidParameterValue.InvalidParameter 参数不合法。
InvalidParameterValue.SensitiveText Text输入含有敏感信息。
InvalidParameterValue.TextTooLong 输入文本超出长度限制
LimitExceeded.ResourceReachedLimit 资源用量达到上限。
ResourceNotFound 资源不存在。
ResourceUnavailable.Freeze 账号已被冻结。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.IsOpening 服务正在开通中,请稍等。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.Recover 资源已被回收。
ResourceUnavailable.StopUsing 账号已停服。