提交工单
咨询集成、功能及报价等问题
调用本接口,即可基于聊天消息上下文生成文案。
以下请求参数列表仅列出了接口请求参数,公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Message |
Array of Object |
是 |
聊天上下文信息:
|
Role |
String |
是 |
成员角色,当前支持以下角色:
|
Content |
String |
是 |
对话内容,长度不能超过 3000 token。 token 数 = 汉字数 + 单词数 * 1.3(仅为估算逻辑)。 |
Stream |
Bool |
是 |
是否以流式接口的形式返回数据,当前必填为 true。 |
请求 URL
https://aigc-api.zegotech.cn/?Action=GenerateAiText
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0
请求消息体
{
"Message": [
{
"Role": "user",
"Content": "请介绍一下深圳这座城市"
}
],
"Stream": true
}
此时响应参数的 Content-Type 为 text/event-stream。响应参数为流式返回,格式为 data: {以下响应参数的 json 包}。
参数 | 类型 | 描述 |
---|---|---|
Id |
String |
本轮会话的 ID。 |
Object |
String |
回包类型。chat.completion:多轮对话返回。 |
CreateTime |
Int |
Unix 时间戳,单位为秒。 |
SentenceId |
Int |
表示当前子句的序号。只有在流式接口模式下会返回该字段。 |
IsEnd |
Bool |
表示当前子句是否是最后一句。只有在流式接口模式下会返回该字段。 |
Content |
String |
对话返回结果。 |
Usage |
Object |
token 统计信息。 |
PromptTokens |
Int |
问题 token 数。 |
CompletionTokens |
Int |
回答 token 数。 |
TotalTokens |
Int |
token 总数。 |
此时响应参数的 Content-Type 为 application/json,说明如下
参数 | 类型 | 描述 |
---|---|---|
Code | Int | 错误码。 |
Message | String | 错误描述。 |
以下为请求成功的响应示例:
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188135,"SentenceId":0,"IsEnd":false,"Content":"深圳是位于中国华南","Usage":{"PromptTokens":11,"CompletionTokens":9,"TotalTokens":20}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188135,"SentenceId":1,"IsEnd":false,"Content":"地区的一座地级市,简称“深”,别称鹏城。","Usage":{"PromptTokens":11,"CompletionTokens":15,"TotalTokens":35}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188136,"SentenceId":2,"IsEnd":false,"Content":"它是广东省副省级市,国家计划单列市,超大城市,也是中国经济特区、全国性经济中心城市和国际化城市。","Usage":{"PromptTokens":11,"CompletionTokens":43,"TotalTokens":78}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188137,"SentenceId":3,"IsEnd":false,"Content":"深圳下辖9个区,总面积1997.47平方千米,建成区面积927.96平方千米。","Usage":{"PromptTokens":11,"CompletionTokens":28,"TotalTokens":106}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188137,"SentenceId":4,"IsEnd":false,"Content":"\n\n深圳地处珠江口东岸,东临大亚湾和大鹏湾,南隔深圳河与香港相连。","Usage":{"PromptTokens":11,"CompletionTokens":28,"TotalTokens":134}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188138,"SentenceId":5,"IsEnd":false,"Content":"它是粤港澳大湾区四大中心城市之一,也是国家物流枢纽、国际性综合交通枢纽和国际科技产业创新中心。","Usage":{"PromptTokens":11,"CompletionTokens":44,"TotalTokens":178}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188139,"SentenceId":6,"IsEnd":false,"Content":"深圳还是中国三大全国性金融中心之一,并正在全力建设中国特色社会主义先行示范区和综合性国家科学中心。","Usage":{"PromptTokens":11,"CompletionTokens":47,"TotalTokens":225}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188140,"SentenceId":7,"IsEnd":false,"Content":"\n\n深圳水陆空铁口岸俱全,是中国拥有口岸数量最多、出入境人员最多、车流量最大的口岸城市。","Usage":{"PromptTokens":11,"CompletionTokens":38,"TotalTokens":263}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188142,"SentenceId":8,"IsEnd":false,"Content":"深圳最早的前身为广州宝安县,1979年成立深圳市,1980年成为中国设立的第一个经济特区。","Usage":{"PromptTokens":11,"CompletionTokens":36,"TotalTokens":299}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188145,"SentenceId":9,"IsEnd":false,"Content":"深圳也是中国改革开放的窗口和新兴移民城市,创造了举世瞩目的“深圳速度”,被誉为“中国硅谷”。\n\n根据第七次人口普查数据,截至2020年11月1日零时,深圳市常住人口","Usage":{"PromptTokens":11,"CompletionTokens":67,"TotalTokens":366}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188145,"SentenceId":10,"IsEnd":false,"Content":"为17560061人。","Usage":{"PromptTokens":11,"CompletionTokens":3,"TotalTokens":369}}
data: {"Id":"3dbce1c5-7d55-4b75-9c02-1365f62ca880","Object":"chat.completion","CreateTime":1697188146,"SentenceId":11,"IsEnd":true,"Content":"","Usage":{"PromptTokens":11,"CompletionTokens":0,"TotalTokens":369}}
以下仅列出了常见的接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
0 | 成功。 | - |
100000004 | 签名过期。 | 请重新生成签名。 |
100000005 | 签名错误。 | 请确认生成签名的参数是否正确。 |
400000001 | 输入参数无效。 | 请根据 Message 提示,调整对应参数的取值。 |
400000002 | 数字人 PaaS 服务权限未开通。 | 请联系 ZEGO 技术支持开通服务权限。 |
400000011 | AI 文案生成错误。 | 请根据 Message 提示,调整对应参数的取值。 |
400010000 | 系统错误。 | 请联系 ZEGO 技术支持处理。 |
联系我们
文档反馈