文本补全

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

我的收藏

1. 接口描述

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

通过自动补全文本片段,帮助用户快速生成高质量、连贯的完整文本,提高创作效率。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TextWriting。
Version String 公共参数,本接口取值:2019-04-08。
Region String 公共参数,本接口不需要传递此参数。
Text String 待续写的句子,文本统一使用utf-8格式编码,长度不超过200字符。
示例值:今天天气不错
SourceLang String 待续写文本的语言类型,支持语言如下:
zh:中文
en:英文
示例值:zh
Number Integer 返回续写结果的个数。数量需>=1且<=5。
(注意实际结果可能小于指定个数)
示例值:2
Domain String 指定续写领域,支持领域如下:
general:通用领域,支持中英文补全
academic:学术领域,仅支持英文补全
默认为general(通用领域)。
示例值:general
Style String 指定续写风格,支持风格如下:
science_fiction:科幻
military_history:军事
xuanhuan_wuxia:武侠
urban_officialdom:职场
默认为xuanhuan_wuxia(武侠)。
示例值:xuanhuan_wuxia

3. 输出参数

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

4. 示例

示例1 文本续写调用示例

对中文文本进行续写。

输入示例

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

{
    "Text": "今天天气不错",
    "SourceLang": "zh",
    "Number": 2,
    "Domain": "general",
    "Style": "xuanhuan_wuxia"
}

输出示例

{
    "Response": {
        "RequestId": "40abc589-8603-458b-82a7-fe174e799085",
        "WritingList": [
            {
                "PrefixText": "此事还得从这说起,",
                "TargetText": "此事还得从这说起,他一路行来,不知不觉已到了洛阳城,这一日,他来到一处客栈,打听一下萧月生的消息。“师父,他来了!”江南云忽然开口,声音清脆悦耳,仿"
            },
            {
                "PrefixText": "此事还得从这说起,",
                "TargetText": "此事还得从这说起,那日在山东大会上,萧月生一眼看出,这个赵小四是武林中人,心中不由一动,觉得此人极有可能是华山派的弟子。“师父,他的轻功如何?”江南"
            }
        ]
    }
}

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.UnKnowError 内部错误。
FailedOperation.Unknown 未知错误。
InternalError 内部错误。
InternalError.ServiceCallError 内部服务调用错误。
InternalError.ServiceError 内部服务调用失败。
InvalidParameterValue.InvalidParameter 参数不合法。
InvalidParameterValue.SensitiveText Text输入含有敏感信息。
InvalidParameterValue.TextNumTooMuch 输入文本超出数量限制
InvalidParameterValue.TextTooLong 输入文本超出长度限制
LimitExceeded.ResourceReachedLimit 资源用量达到上限。
ResourceInsufficient.QuotaRunOut 额度用尽,请充值后重试
ResourceNotFound 资源不存在。
ResourceUnavailable.Freeze 账号已被冻结。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.IsOpening 服务正在开通中,请稍等。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.Recover 资源已被回收。
ResourceUnavailable.StopUsing 账号已停服。