接口詳情
鑒權(quán)
字段 | 傳參方式 | 類型 | 必傳 | 描述 | 示例值 |
Authorization | header | String | 是 | API-Key | Bearer d1**2a |
路由配置
備注：SDK已封裝好路由關(guān)系，通過SDK調(diào)用接口，無需設(shè)置接口路由配置。
字段 | 傳參方式 | 類型 | 必傳 | 描述 | 示例值 |
x-fag-appcode | header | String | 是 | 應(yīng)用表示，固定為 | |
x-fag-servicename | header | String | 是 | 請求路由標(biāo)識，不同接口值不一樣，映射管理參考 | aca-character-create |
x-fag-servicename 與接口映射關(guān)系
接口 | 路徑 | x-fag-appcode |
對話（流式） | /v2/api/chat/send | aca-chat-send-sse |
對話（非流式） | /v2/api/chat/send | aca-chat-send |
創(chuàng)建角色 | /v2/api/character/create | aca-character-create |
更新角色 | /v2/api/character/update | aca-character-update |
角色詳情 | /v2/api/character/details | aca-character-details |
刪除角色 | /v2/api/character/delete | aca-character-delete |
角色查詢 | /v2/api/character/search | aca-character-search |
對話消息查詢 | /v2/api/chat/message/histories | aca-message-history |
對話消息評價 | /v2/api/chat/rating | aca-message-rating |
系統(tǒng)消息推送 | /v2/api/chat/reminder | aca-chat-reminder |
重置對話 | /v2/api/chat/reset | aca-chat-reset |
萬相圖片獲取 | /v2/api/chat/polling/image | aca-message-history |
角色描述自動生成 | /v2/api/character/auto/desc | aca-polling-image |
kv對抽取 | /v2/api/extract/kv | aca-extract-memory-kv |
summary抽取 | /v2/api/extract/summary | aca-extract-memory-summary |
終止對話 | /v2/api/chat/stop | aca-chat-stop |
對話
注意：對話場景非為固定角色對話、非固定角色對話、和助手類對話，不用場景對話，入?yún)⒂兴煌敿?xì)差異請參考接口說明-必填。
接口
POST /v2/api/chat/send
入?yún)?/b>
請求頭參數(shù)
字段 | 傳參方式 | 類型 | 必傳 | 描述 |
X-AcA-SSE | header | String | 否 | 是否開啟流式對話 開啟 - 不開啟 - |
請求體參數(shù)
參數(shù) | 類型 | 必傳 | 說明 |
model | string | 否 | 模型，采用角色已配置的模型，也可傳入其他模型名稱進行路由 |
parameters | object | 否 | 模型設(shè)置 |
parameters.seed | double | 否 | **當(dāng)使用xingchen-plus-v2默認(rèn)模型時，每次調(diào)用的seed必須不同。**seed生成時，隨機數(shù)的種子，用于控制模型生成的隨機性。如果使用相同的種子，每次運行生成的結(jié)果都將相同；當(dāng)需要復(fù)現(xiàn)模型的生成結(jié)果時，可以使用相同的種子。seed參數(shù)支持無符號64位整數(shù)類型。默認(rèn)值 1683806810 |
parameters.incrementalOutput | boolean | 否 | 是否增量輸出，若為true，每次流式輸出不包含已輸出內(nèi)容，只對流式接口的輸出有效 |
input.messages | array | 是 | 對話歷史(時間順序正排)，固定角色可通過角色配置最大對話輪數(shù)。list中的每個元素形式為{"role":角色, "content": 內(nèi)容}。角色當(dāng)前可選值：system、user、assistant，function，其中，僅messages[0]中支持role為system，user、assistant、function需要交替出現(xiàn)，最后一條為用戶提問。 |
input.aca.botProfile | object | 是 | 角色設(shè)置 |
input.aca.botProfile.characterId | string | 是 | 固定角色必填 |
input.aca.userProfile | object | 是 | 用戶設(shè)置 |
input.aca.userProfile.userId | string | 是 | 業(yè)務(wù)系統(tǒng)用戶唯一標(biāo)識，同一用戶不能并行對話，必須待上次對話回復(fù)結(jié)束后才可發(fā)起下輪對話 |
input.aca.userProfile.userName | string | 否 | 對話用戶名稱 |
input.aca.userProfile.basicInfo | string | 否 | 用戶基本信息 |
input.aca.scenario | object | 否 | 角色場景設(shè)置 |
input.aca.scenario.description | string | 否 | 場景描述，如當(dāng)前對話時間為晚上 |
input.aca.context | object | 是 | 對話上下文設(shè)置 |
input.aca.context.useChatHistory | boolean | 是 | 必填，且必須為true |
input.aca.context.isRegenerate | boolean | 否 | 是否為重新生成 |
input.aca.context.queryId | string | 否 | 重新生成且使用平臺歷史時，該值必傳；不使用平臺歷史時，該值可以不傳 |
input.aca.context.answerId | string | 否 | 重新生成場景，若 answerId 不為空，認(rèn)為是重新生成后的新一輪對話，該 answerId 為最后一輪對話中多個回復(fù)中的一條回復(fù)消息ID，該條回復(fù)會被采納，該輪對話其他回復(fù)消息會被廢棄 |
input.aca.functionList | array | 否 | 函數(shù)列表 |
input.aca.function.name | string | 是 | 函數(shù)名稱，如weather |
input.aca.function.description | string | 是 | 函數(shù)描述，如通過調(diào)用天氣預(yù)報API獲取當(dāng)?shù)靥鞖忸A(yù)報信息 |
input.aca.function.parameters | object | 是 | 函數(shù)參數(shù)描述，如 |
注意：模型參數(shù)parameters優(yōu)先級從高到低可以通過接口傳入、角色屬性配置、和平臺默認(rèn)配置三個方式配置。
返回參數(shù)
流式調(diào)用返回
參數(shù) | 類型 | 說明 |
requestId | string | 系統(tǒng)生成的標(biāo)志本次調(diào)用的id。 |
success | boolean | 是否成功返回 |
errorCode | int | 錯誤碼 |
errorName | string | 錯誤名稱 |
httpStatusCode | int | http錯誤碼 |
errorMessage | string | 錯誤消息 |
usage | object | |
usage.userTokens | int | 用戶輸入的token數(shù) |
usage.inputTokens | int | 本次請求輸入內(nèi)容的 token 數(shù)目。在打開了搜索的情況下，輸入的 token 數(shù)目因為還需要添加搜索相關(guān)內(nèi)容支持，所以會超出客戶在請求中的輸入。 |
usage.outputTokens | int | 模型生成回復(fù)轉(zhuǎn)換為Token后的長度。 |
choices | array | 消息體 |
choices[i].stopReason | string | 完成標(biāo)識符，已完成為 stop，未完成為 “null” |
choices[i].messages | array | |
message.role | string | 模型role，固定為assistant |
message.content | string | 模型生成消息輸出 |
message.meta | object | 消息屬性 |
message.meta.hasRisk | boolean | 是否存在安全風(fēng)險， |
message.functionCall | object | 模型function調(diào)用結(jié)果 |
message.functionCall.tought | string | 模型規(guī)劃結(jié)果 |
message.functionCall.apiCallList | array | 模型生成的function接口調(diào)用信息 |
apiCall.apiName | string | 對應(yīng)的function名 |
apiCall.parameter | object | 調(diào)用該function時應(yīng)傳入的參數(shù) |
非流式調(diào)用返回
參數(shù) | 類型 | 說明 |
requestId | string | 系統(tǒng)生成的標(biāo)志本次調(diào)用的id。 |
success | boolean | 是否成功返回 |
errorCode | int | 錯誤碼 |
errorName | string | 錯誤名稱 |
httpStatusCode | int | http錯誤碼 |
errorMessage | string | 錯誤消息 |
data | object | |
data.usage | object | |
usage.userTokens | int | 用戶輸入的token數(shù) |
usage.inputTokens | int | 本次請求輸入內(nèi)容的 token 數(shù)目。在打開了搜索的情況下，輸入的 token 數(shù)目因為還需要添加搜索相關(guān)內(nèi)容支持，所以會超出客戶在請求中的輸入。 |
usage.outputTokens | int | 模型生成回復(fù)轉(zhuǎn)換為Token后的長度。 |
data.choices | array | 消息體 |
choices[i].stopReason | string | 完成標(biāo)識符，已完成為 stop，未完成為 null |
choices[i].messages | array | |
message.role | string | 模型role，固定為assistant |
message.content | string | 模型生成消息輸出 |
message.meta | object | 消息屬性 |
message.meta.hasRisk | boolean | 是否存在安全風(fēng)險，true/false |
message.functionCall | object | 模型function調(diào)用結(jié)果 |
message.functionCall.tought | string | 模型規(guī)劃結(jié)果 |
message.functionCall.apiCallList | array | 模型生成的function接口調(diào)用信息 |
apiCall.apiName | string | 對應(yīng)的function名 |
apiCall.parameter | object | 調(diào)用該function時應(yīng)傳入的參數(shù) |
角色管理
創(chuàng)建角色
接口
POST /v2/api/character/create
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
name | string | 是 | 角色名稱 |
avatar | object | 是 | 角色頭像 |
introduction | string | 是 | 角色摘要 |
basicInformation | string | 是 | 角色基本信息，包含人設(shè)、經(jīng)歷 |
openingLine | string | 是 | 開場白 |
traits | string | 否 | 強制要求 |
chatExample | string | 否 | 對話示例 |
permConfig | object | 否 | 權(quán)限配置 |
permConfig.isPublic | int | 是 | 是否開放角色屬性給其他星塵用戶查看（1:是，0:否） 說明：當(dāng)您接入自己的應(yīng)用使用時，無須打開該開關(guān)；請謹(jǐn)慎選擇 |
permConfig.allowChat | int | 是 | 開放角色與其他星塵用戶聊天（1:是，0:否） 說明：指開放角色與其他星塵web端用戶聊天，開啟后需申請關(guān)閉權(quán)限，請謹(jǐn)慎選擇 |
permConfig.allowApi | int | 是 | 開放角色API接口允許其他星塵用戶調(diào)用（1:是，0:否） 說明：如您需要使用其它賬號通過API接入該角色，請打開該開關(guān)； |
advancedConfig | object | 否 | 高級配置 |
advancedConfig.isRealInfo | boolean | 否 | 是否開啟web檢索 |
advancedConfig.searchKeyword | string | 否 | web檢索關(guān)鍵詞（開啟web檢索需添加該字段） |
advancedConfig.isRealTime | boolean | 否 | 是否使用真實時間 |
advancedConfig.shortTermMemoryRound | int | 否 | 短期記憶輪數(shù)，對話接口使用平臺歷史時有效（最大支持100輪歷史對話） |
advancedConfig.longTermMemories | list | 否 | 長期記憶設(shè)置 |
advancedConfig.platformPlugins | list | 否 | 插件列表 |
advancedConfig.knowledgeBases | list | 否 | 知識庫id列表 |
卡牌庫插件暫不支持API接入，創(chuàng)建角色時無需調(diào)用Function-call能力，在對話中使用
返回參數(shù)
名稱 | 類型 | 說明 |
code | int | 返回碼，正常返回200，異常返回空 |
success | bool | 正常返回 true，異常返回null |
requestId | string | 請求唯一標(biāo)識 |
data | object | 角色對象，CharacterKey |
data.characterId | string | 角色ID |
更新角色
接口
POST /api/character/update
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
characterId | string | 是 | 角色ID |
name | string | 否 | 角色名稱 |
avatar | string | 否 | 角色頭像 |
basicInformation | string | 否 | 角色基本信息，包含人設(shè)、經(jīng)歷 |
openingLine | string | 否 | 開場白 |
traits | string | 否 | 強制要求 |
chatExample | string | 否 | 對話示例 |
permConfig | object | 否 | 權(quán)限配置 |
advancedConfig | object | 否 | 高級配置 |
advancedConfig.longTermMemories | list | 否 | 長期記憶設(shè)置 |
advancedConfig.platformPlugins | list | 否 | 插件列表 |
advancedConfig.knowledgeBases | list | 否 | 知識庫id列表 |
返回
名稱 | 類型 | 說明 |
code | int | 返回碼，正常返回200，異常返回空 |
success | bool | 正常返回 true，異常返回null |
requestId | string | 請求唯一標(biāo)識 |
data | boolean | 是否成功 |
查詢角色
接口
POST /api/character/search
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
where | object | 是 | 搜索條件對象 |
where.scope | string | 是 | 查詢范圍- my - 只查詢我創(chuàng)建的角色- public - 查詢平臺開放的角色- pre_configured - 預(yù)制角色 |
where.characterName | string | 否 | 角色名稱，右匹配 |
pageNum | int | 是 | 頁碼 |
pageSize | int | 是 | 頁大小 |
orderBy | list | 否 | 排序 |
返回
名稱 | 類型 | 說明 |
code | int | 返回碼，正常返回200，異常返回空 |
success | bool | 正常返回 true，異常返回null |
requestId | string | 請求唯一標(biāo)識 |
data | object | |
data.list | object | 角色列表 |
data.page | int | 頁碼 |
data.pageSize | int | 分頁大小 |
data.total | int | 角色總數(shù) |
角色詳情
接口
GET /v2/api/character/details
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
characterId | string | 是 | 角色ID |
返回
角色對象CharacterDTO如下：
名稱 | 類型 | 說明 |
characterId | string | 角色ID |
name | string | 角色名稱 |
avatar | object | 角色頭像 |
introduction | string | 角色摘要 |
basicInformation | string | 角色基本信息，包含人設(shè)、經(jīng)歷 |
openingLine | string | 開場白 |
traits | string | 強制要求 |
chatExample | string | 對話示例 |
roleTypes | list | 角色類型 用于星塵網(wǎng)頁平臺上公開角色分類 |
auditStatus | string | 審核狀態(tài) 用于星塵平臺的角色公開 審核中無法更新角色 - review更新審核中 - update更新中 - succcess審核成功 - refuse審核失敗 |
configStatus | string | 上下架狀態(tài) 下架狀態(tài)的角色不能對話和更新 - out下架 - normal或null為上架狀態(tài) |
greenStatus | string | 綠網(wǎng)審核狀態(tài) 用于人工綠網(wǎng)審核 審核中無法更新角色 - review審核中 - update更新審核中 - succcess審核成功 - refuse審核失敗 |
permConfig | object | 權(quán)限配置 |
permConfig.isPublic | int | 是否開放角色屬性給其他用戶查看（1:是，0:否） |
permConfig.allowChat | int | 開放角色與其他用戶聊天（1:是，0:否） |
permConfig.allowApi | int | 開放角色API接口允許其他用戶調(diào)用（1:是，0:否） |
advancedConfig | object | 高級配置 |
advancedConfig.isRealInfo | boolean | 真實世界信息檢索 |
advancedConfig.searchKeyword | string | 搜索關(guān)鍵字 |
advancedConfig.knowledgeBases | list | 否 |
模型參數(shù)parameters優(yōu)先級從高到低可以通過接口傳入、角色屬性配置）、和平臺默認(rèn)配置三個方式配置。
返回示例
{
"code": 200,
"data": {
"characterId": "178cad6d92dc4fbc9d50abed64809e2b", // 相同角色
"name": "滿腔忠義的關(guān)云長",
"avatar": {
"fileSavePath": "oss-6400001-IAkXjMiqkajy9MCSywI4LD5K.png",
"filename": "關(guān)云長.png",
"fileUrl": "alifanyi-pixar-hz.oss-cn-hangzhou.aliyuncs.com/oss-6400001-IAkXjMiqkajy9MCSywI4LD5K.jpg?Expires=1688635588&OSSAccessKeyId=LTAIp4mkTgZD****&Signature=vitQVIB4GroVIZKbk%2BEWGL%2F6ifA%3D"
},
"basicInformation": "我們來玩一個角色扮演的游戲， 你是「滿腔忠義的關(guān)云長」。",
"openingLine": "我是「關(guān)云長」，很高心與你玩游戲",
"traits": "請在對話時盡可能的展現(xiàn)你的性格、感情， 用文言文回答， 并使用古人的語氣和用詞。",
"chatExample": "{{user}}:敢問閣下尊姓大名。\n{{char}}:吾姓關(guān)名羽，字長生，后改云長，河?xùn)|解良人也。",
"gmtCreate": "2023-07-14T02:02:19.000+00:00",
"gmtModified": "2023-07-14T02:04:05.000+00:00",
"userId": "abc",
"bizUserId": "xyz",
"manageable": true,
"permConfig": {
"isPublic": 0,
"allowApi": 0,
"allowChat": 0
}
"advancedConfig": {
"knowledgeBases":["d89f6dbb32c645688b01e976cf7ec08e"],
"isRealInfo": true,
"searchKeyword":"關(guān)云長"
}
},
"success": true
}對話歷史
對話歷史查詢
接口
POST /v2/api/chat/message/histories
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
where | object | 是 | 查詢條件對象角色參考下表 |
where.characterId | string | 是 | 角色ID |
where.userId | string | 是 | 對話用戶ID |
where.sessionId | string | 否 | 會話ID |
where.startTime | long | 否 | 開始時間戳精確到毫秒 |
where.endTime | long | 否 | 結(jié)束時間戳 |
where.messageIds | list | 否 | 消息ID列表 |
pageNum | int | 否（默認(rèn)1） | 分頁頁碼 |
pageSize | int | 否（默認(rèn)10） | 分頁大小 |
orderBy | list | 否（默認(rèn)創(chuàng)建時間倒排） | 歷史消息排序 |
返回
名稱 | 類型 | 說明 |
messageId | string | 消息ID |
sessionId | string | 會話ID |
chatId | string | 一次對話ID，一問多答 chatId 相同 |
messageIssuer | object | 不同userType, userId 和 userName表示不同含義，userType 取值：- user - 用戶，userId 和 userName 分別表示用戶ID和用戶名- character - 角色，userId 和 userName 分別表示角色ID和角色名 |
messageType | string | opening_remarks - 開場白sys_greetings - 系統(tǒng)問候user - 用戶提問character - 角色回復(fù)chat_description - 對話提示 |
status | string | 歷史消息狀態(tài)normal：正常reset：被重置 |
content | string | json string |
對話歷史評價
接口
POST /v2/api/chat/message/rating
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
messageId | string | 是 | 消息ID |
rating | int | 是 | 評分 0為差評 5為好評 |
返回
名稱 | 類型 | 說明 |
content | boolean | true成功、false失敗 |
系統(tǒng)推薦
接口
POST /v2/api/chat/message/reminder
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
characterId | string | 是 | 角色的id 角色給用戶主動發(fā)消息 |
bizUserId | string | 是 | 接收消息的用戶bizUserId |
content | string | 是 | 提示消息 |
返回
名稱 | 類型 | 說明 |
content | boolean | true成功、false失敗 |
重置對話（清除上下文）
在使用平臺對話歷史的場景下，每次對話會自動將對話歷史作為記憶送給大模型，若要抹去這段記憶，可以通過該接口清除歷史對話，開啟新會話。
接口
POST /v2/api/chat/reset
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
characterId | string | 是 | 角色的id |
userId | string | 是 | 接收消息的用戶bizUserId |
返回
名稱 | 類型 | 說明 |
data | boolean | true成功、false失敗 |
其他
萬相圖片輪詢
接口
GET /v2/api/chat/polling/image
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
messageId | String | 是 | 帶有圖片任務(wù)id的消息ID |
userId | String | 是 | paas端用戶id |
返回
名稱 | 類型 | 說明 |
taskId | string | 圖片任務(wù)ID |
fileUrls | list | 圖片鏈接列表 |
status | string | 圖片生成狀態(tài)，success，running，failure |
返回示例
{
"requestId": "210f470117126410644908058e6315",
"code": 200,
"data": {
"taskId": "342a02b4-2cb7-4219-a3d4-c7de90ab1ff8",
"fileUrls": [
"https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/1d/2d/20240409/723609ee/19311d8c-e3c2-4533-9a10-a7cb99865d98-1.png?Expires=1712727324&OSSAccessKeyId=LTAI5tQZd8AEcZX6KZV4****&Signature=fh4ix8VrpoUpSb3qOo67xGO9L6M%3D"
],
"status": "success"
},
"success": true
}角色描述自動生成
接口
POST /v2/api/character/auto/desc
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
type | String | 是 | file或者text |
fileUrl | String | 否 | 外部文件鏈接 |
text | String | 否 | 文本內(nèi)容 |
fileName | String | 否 | type是file時必填，帶有文件類型后綴的文件名 |
返回
名稱 | 類型 | 說明 |
content | string | 自動生成的內(nèi)容 |
usage | object | token用量 |
usage.outputTokens | int | token輸出用量 |
usage.inputTokens | int | token輸入用量 |
返回示例
{
"requestId": "d8e90bd07474fd7d46c16e07408d5802",
"code": 200,
"data": {
"content": "【基本信息】\n關(guān)羽(?-220)，本字長生，后改字云長，漢族，出生于并州河?xùn)|解（今山西運城）。\n\n【生平經(jīng)歷】\n關(guān)羽是中國東漢末年著名的將領(lǐng)。他從劉備于鄉(xiāng)里聚眾起兵開始便追隨劉備，成為劉備最為信任的將領(lǐng)之一。\n\n【死后影響及地位】\n關(guān)羽去世后，其形象逐漸被后人神化，一直是歷來民間祭祀的對象，被尊稱為“關(guān)公”。又經(jīng)歷代朝廷褒封，清代時被奉為“忠義神武靈佑仁勇威顯關(guān)圣大帝”，崇為“武圣”，與“文圣”孔子齊名。\n\n【文學(xué)作品中的形象】\n長篇歷史小說《三國演義》對關(guān)羽的事跡多有描寫和夸大，在《演義》中，關(guān)羽被描寫為“五虎大將”之首。\n\n【其他相關(guān)】\n古代有地名關(guān)羽，但其確切位置不明。",
"usage": {
"outputTokens": 213,
"inputTokens": 230
}
},
"success": true
}kv對抽取
接口
POST /v2/api/extract/kv
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
messages | list | 是 | 消息集合 |
messages[i].role | string | 是 | assistant或者user |
message[i].content | string | 是 | 消息內(nèi)容 |
kvMemoryConfigs | list | 是 | 抽取條件設(shè)置集合 |
kvMemoryConfigs[i].kvMemoryConfig | object | 是 | 抽取條件設(shè)置 |
kvMemoryConfig.enabled | boolean | 是 | 是否啟用 |
kvMemoryConfig.memoryText | String | 是 | 記憶文本 |
返回
名稱 | 類型 | 說明 |
schemas | list | 抽取的內(nèi)容集合 |
schemas[i].schema | object | 抽取的內(nèi)容 |
schema.role | string | assistant或者user |
schema.key | string | 記憶文本 |
schema.value | list | 抽取的文本內(nèi)容 |
usage | object | token用量 |
usage.outputTokens | int | token輸出用量 |
usage.inputTokens | int | token輸入用量 |
返回示例
{
"requestId": "cefaf145993be9e24fa5830fdf88aef2",
"code": 200,
"data": {
"schemas": [
{
"role": "user",
"key": "職業(yè)",
"value": [
"武術(shù)愛好者"
]
},
{
"role": "user",
"key": "喜歡",
"value": [
"武術(shù)"
]
}
],
"usage": {
"outputTokens": 74,
"inputTokens": 627
}
},
"success": true
}summary抽取
接口
POST /v2/api/extract/summary
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
messages | list | 是 | 消息集合 |
messages[i].role | string | 是 | assistant或者user |
message[i].content | string | 是 | 消息內(nèi)容 |
返回
名稱 | 類型 | 說明 |
memoryResults | list | 抽取的內(nèi)容集合 |
memoryResults[i].memoryResult | object | 抽取的內(nèi)容 |
memoryResult.content | string | 抽取的文本內(nèi)容 |
usage | object | token用量 |
usage.outputTokens | int | token輸出用量 |
usage.inputTokens | int | token輸入用量 |
返回示例
{
"requestId": "ca61f80aa865a2575863b8246dddd51f",
"code": 200,
"data": {
"memoryResults": [
{
"content": "user提議一起去打籃球"
},
{
"content": "assistant同意一起去打籃球"
},
{
"content": "user和assistant計劃一起去打籃球，然后去吃火鍋"
}
],
"usage": {
"outputTokens": 45,
"inputTokens": 590
}
},
"success": true
}excel轉(zhuǎn)docx（文件上傳接口）
接口
POST /v2/api/common/file/asyn/upload
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
sourceUrl | string | 是 | 公網(wǎng)可訪問的文件url鏈接 注：文件類型要和type類型一致 |
type | string | 是 | 文件轉(zhuǎn)換類型 excelToDocx（excel轉(zhuǎn)doc） |
返回
名稱 | 類型 | 說明 |
id | Long | 任務(wù)id 上傳成功后生成 請記住此任務(wù)id 方便后續(xù)調(diào)用結(jié)果查詢接口查詢結(jié)果 |
status | String | 任務(wù)狀態(tài)init初始化 success成功 failed失敗 error異常 |
url | String | 轉(zhuǎn)換后的結(jié)果文件url 此處為空 |
excel轉(zhuǎn)docx（結(jié)果查詢接口）
接口
GET /v2/api/common/file/asyn/download
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
taskId | Long | 是 | 任務(wù)id |
返回
名稱 | 類型 | 說明 |
id | Long | 任務(wù)id |
status | String | 任務(wù)狀態(tài)init初始化 success成功 failed失敗 error異常 |
url | String | 任務(wù)處理成功后 此處是轉(zhuǎn)換后的結(jié)果文件url 復(fù)制到瀏覽器即可下載結(jié)果文件 |
終止對話
接口
POST /v2/api/chat/stop
入?yún)?/b>
名稱 | 類型 | 是否必傳 | 說明 |
requestId | string | 是 | 正在生成的請求唯一標(biāo)識，流式對話可以response.requestId，非流式對話因不能在請求結(jié)束前獲取requestId，無法終止對話 |
content | string | 否 | 終止前保存的內(nèi)容 |
返回
名稱 | 類型 | 說明 |
data | Boolean | 是否終止成功 |
返回示例
{
"requestId": "2c29e19178aadfcb2f99c764134748d8",
"code": 200,
"data": true,
"success": true
}