结构化数据写作

更新时间：2022-03-24

结构化数据写作

接口描述

自动创作模块下，根据数据源中的变量编辑模板，生成文章后，即可通过下方的接口进行调用来生成文章。当项目中有多个已生效的模板时，会随机选择一个模板生成文章。

注：请使用方注意接口使用的合规性，不得利用该接口从事不合规场景的应用；如有违规使用，一经发现，AI开放平台有权立即停止提供服务

请求说明

请求示例

HTTP方法: POST

请求URL: https://aip.baidubce.com/rest/2.0/nlp/v1/gen_article

URL参数：

参数	值
access_token	通过API Key和Secret Key获取的access_token,参考“Access Token获取”

Header如下：

参数	值
Content-Type	application/x-www-form-urlencoded

Body请求参数:

参数	是否必选	类型	描述
project_id	是	int	项目ID，可在我的项目页面下“生成记录”内获取
数据源参数	否	...	其他参数，即作为系统调用预置或用户提供的数据源的参数。UTF-8编码，没有参数可不传。例如预置天气数据源，请求接口生成文章时传入的参数为：project_id=111&city=北京，就会返回北京的天气数据。

**注：预置或自定义数据源，如天气、股市、足球、篮球等，所需参数名详见下方数据源参数说明

说明：结构化数据写作API要求使用form格式封装请求数据，文本为UTF-8编码。

返回说明

返回参数

参数	类型	描述
result	array	成功时，返回的结果数组
+title	string	文章标题
+summary	string	文章摘要
+texts	array	文章正文数组，每个数组元素代表一个段落，顺序为文章模板的段落顺序
error_code	int	错误码，0代表成功，其他代表失败
error_msg	string	错误信息，成功时为空，失败返回错误原因

返回示例

成功返回示例

{  "error_code": 0,
    "error_msg": "",
    "result": {
        "texts": ["<p>今天的温度范围是-4 ~ 6℃。<\/p>", "<p>天气较好，但考虑天气寒冷，风力较强，推荐您进行室内运动，若户外运动请注意保暖并做好准备活动。<\/p>", "<p>各项气象条件适宜，无明显降温过程，发生感冒机率较低<\/p>"],
        "summary": "北京周四天气预报",
        "title": "<p>北京天气<\/p>"
    }  
}

失败返回示例

{
    "error_code": 110,
    "error_msg": "Access token invalid or no longer valid",
    "result": []
}

数据源参数说明

天气

参数名	类型	说明
city	string	中文城市名称，如“北京”

城市代码附录：下载链接]

美股

参数名	类型	说明
stock_code	string	股票代码，如“BIDU”

股票代码附录：下载链接备注：第一列为股票代码。第二列为对应的股票名称，不需作为参数。

港股

参数名	类型	说明
stock_code	string	股票代码，如“01088”对应中国神华

股票代码附录：下载链接备注：第一列为股票代码。第二列为对应的股票名称，不需作为参数。

沪深

参数名	类型	说明
stock_code	string	股票代码，如“300146”对应汤臣倍健

股票代码附录：下载链接备注：第一列为股票代码。第二列为对应的股票名称，不需作为参数。

提示： 附录中为静态的参数列表，想实时获取参数列表，请查看下方的『预置数据参数列表』接口

足球

参数名	类型	说明
league_name	string	中文联赛简称，目前支持：中超、英超、德甲、法甲、西甲、意甲
start_date	string	比赛开始的北京时间，格式为：yyyy-mm-dd，如"2019-01-03"
home_team	string	中文主队名称，如"广州恒大"，务必使用附录中球队名称
guest_team	string	中文客队名称，如"上海上港"，务必使用附录中的球队名称

队伍名称附录：下载链接（以上包含球队名单，请求时需按当日存在的赛事，以正确的主队、客队名称请求）

篮球

参数名	类型	说明
league_name	string	联赛简称，目前支持：NBA、CBA
start_date	string	比赛开始的北京时间，格式为：yyyy-mm-dd，如"2019-01-03"
home_team	string	中文主队名称，如"骑士"，务必使用附录中的球队名称
guest_team	string	中文客队名称，如"火箭"，务必使用附录中的球队名称

队伍名称附录：下载链接（以上包含球队名单，请求时需按当日存在的赛事，以正确的主队、客队名称请求）

基金

参数名	类型	说明
symbol	string	基金代码

基金代码名称附录：下载链接 ] 备注：第一列为基金代码。第二列为对应的基金简称，不需作为参数。

提示： 附录中为静态的参数列表，想实时获取参数列表，请查看下方的『预置数据参数列表』接口

债劵

参数名	类型	说明
symbol	string	债劵代码

债劵代码名称附录：[下载链接 ] 备注：第一列为债券代码。第二列为对应的债券简称，不需作为参数。

提示： 附录中为静态的参数列表，想实时获取参数列表，请查看下方的『预置数据参数列表』接口

自定义

参数名	类型	说明
yourpara1	string	您的自定义参数为1的值
yourpara2	string	您的自定义参数为2的值
yourpara3	string	您的自定义参数3的值

提示： 我们需要您提供的参数和值，获取数据用于生成文章。

预置数据参数列表接口

接口描述

使用自动创作的预置模板，在生成文章时，用于获取可用的参数列表。例如预置篮球模板，可获取到NBA/CBA赛事中某一天的比赛队伍列表，然后使用主客队名称，便可调用结构化数据写作接口，生成文章。

请求示例

请求说明

请求示例

HTTP方法: POST

请求URL: https://aip.baidubce.com/rest/2.0/nlp/v1/query_preset_param

URL参数：

参数	值
access_token	通过API Key和Secret Key获取的access_token,参考“Access Token获取”

Header如下：

参数	值
Content-Type	application/x-www-form-urlencoded

Body请求参数:

参数	是否必选	类型	描述
project_id	是	int	项目ID，可在我的项目页面下“生成记录”内获取
league_name	否	string	对于篮球和足球模板，传入联赛名称，UTF-8编码。支持的联赛名称如下：篮球：CBA
date	否	string	体育比赛日期，北京时间，格式为：yyyy-mm-dd，如"2019-01-03"

返回参数

参数	类型	描述
error_code	Int	错误码，0代表成功，其他代表失败
error_msg	string	错误信息，成功时为空，失败返回错误原因
result	Array	成功时，返回的结果数组
esult[].city	String	每个元素中的字段：天气模板为city和province；体育模板为home_team和guest_team；股票基金和债券为code和name；
result[].province	String	每个元素中的字段

成功返回示例

{   "error_code": 0,
    "error_msg": "",
    "result": [
        {
            "city":"北京",
            "province":"北京"
        },
         {
            "city":"哈尔滨",
            "province":"黑龙江"
        },
    ]
}

失败返回示例

{
    "error_code": 110,
    "error_msg": "Access token invalid or no longer valid",
    "content": []
}

错误码

错误码	错误信息	描述
83049	获取参数列表失败, 请稍后重试!	可重试。当项目不为预置模板时，返回“该项目无法获取参数列表”