文档首页 > > API参考> API> 语言生成服务接口说明> 文本生成

文本生成

分享
更新时间:2020/07/13 GMT+08:00

功能介绍

根据用户选择的生成文档以及输入数据,进行文本生成。

在使用文本生成接口之前,请先定制相关文档。详细操作请参见《用户指南》中文本生成章节。

URI

  • URI格式
    POST /v1/{project_id}/nlg/data2doc/document/generation
  • 参数说明
    表1 URI参数说明

    名称

    是否必选

    说明

    project_id

    项目编号。获取方法,请参见获取项目ID

请求消息

请求参数如表2 请求参数所示。

表2 请求参数

名称

是否必选

参数类型

说明

group_name

String

项目组名称。名称由大小写字母、数字、汉字及符号(“_”、“-”)组成,长度为2-50位。

项目组必须是文本生成平台上包含有效文档的项目。

document_name

String

项目组中的文档名称。名称由大小写字母、数字、汉字及符号(“_”、“-”)组成,长度为2-50位。

文档必须是通过文本生成平台定制的有效文档。

data

Json

进行文本生成的输入数据,必须为Json格式。该数据必须与定制文档中的数据项保持一致。

响应消息

响应参数如表3所示。

表3 响应参数

名称

参数类型

说明

title

String

生成内容的标题。

content

String

文本生成内容。

error_code

String

调用失败时的错误码,具体参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

示例

生成文本。

  • 请求示例
    POST https://{endpoint}/v1/{project_id}/nlg/data2doc/document/generation
    
    Request Header:
        Content-Type: application/json
        X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
    
    Request Body:
        {
            "group_name": "项目组01",
            "document_name": "文档01",
            "data": {
                "date": "2019-12-1",
                "max_temperature": "16°",
                "min_temperatrue": "3°"
            }
        }
  • 响应示例
    • 成功响应示例
      {
          "title": "天气预报",
          "content": "今天是2019年12月1日,最高温度16°,最低温度3°。今日温度适宜,适合出游。"
      }
    • 失败响应示例
      {
          "error_code": "NLP.3201",
          "error_msg": "group 项目组01 does not exist."
      }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问