精品女同亚洲欧美精品,亚洲精品中文子幕乱码,国产精品久久久久久久久久辛辛,亚洲欧美日韩国产综合一区二区

幫助與文檔 > 產(chǎn)品文檔 > 智慧學習服務 > API文檔 > 小P老師
小P老師

小P老師簡介

概念解釋

小P老師服務可以提供全科答疑能力，包含答案解析和思路指引，講解更加生動自然。

說明

Hi，您好，歡迎使用有道智云小P老師接口服務。

本文檔主要針對需要集成HTTP API的技術開發(fā)工程師，詳細描述小P老師能力相關的技術內容。

如果您有與我們商務合作的需求，可以通過以下方式聯(lián)系我們：

商務郵箱： AIcloud_Business@corp.youdao.com

如果您對文檔內容有任何疑問，可以通過以下幾種方式聯(lián)系我們：

客服QQ：1906538062

AIGC產(chǎn)品技術交流群 ：837394306

聯(lián)系郵箱： zhiyun@corp.youdao.com

溫馨提示：

  • 本文檔主要針對開發(fā)人員，接入測試前需要獲取應用ID和應用密鑰，并創(chuàng)建應用；如果您還沒有，請按照 新手指南 獲取。
  • 平臺向每個賬戶贈送50元的體驗金，供用戶集成前測試所用。

接口調用參數(shù)

請求地址

baseUrl: https://openapi.youdao.com/llmserver

通用對話

baseUrl + /ai/teacher/dialogue/chat

請求方式: POST

Content-Type: multipart/form-data

Accept: text/event-stream

接口參數(shù)

字段名含義示例必填
app_key應用標識（應用 ID）true
curtime時間戳(秒)true
salt隨機字符串，建議使用UUIDtrue
sign簽名信息：sha256(應用ID+curtime+salt+curtime+應用密鑰)true
sign_type簽名類型v3true
os_type系統(tǒng)類型apitrue
user_id用戶id，用來標識用戶，最多100個字符true
task_id任務id，用來標識用戶一次會話session（關聯(lián)一組對話歷史），由服務生成，首輪對話為空，非首輪對話以服務端返回的上一次對話為準false
task_name任務名稱，最多20個字符，首輪對話創(chuàng)建任務使用，為空時由系統(tǒng)生成false
parent_chat_id當前輸入的父對話id，首輪對話為空，非首輪對話以服務端返回的上一次對話為準false
chat_info輸入內容，格式為chat_item的列表（目前只支持一個chat_item），chat_item格式在后文中說明[{"type":"text","content":"你好！"}]true
template_idprompt模版id，實現(xiàn)業(yè)務定制promptfalse
subscribe訂閱事件。sse流固定返回begin、message、end、error事件。對于其他想要的事件，需要調用方主動傳遞此參數(shù)訂閱，多個訂閱事件傳值以英文逗號分隔，默認是空-無事件訂閱false

接口參數(shù)chat_info中chat_item的格式說明：

一、包含字段
type：輸入類型枚舉【text、image、image_url】
content：輸入內容，text文本/image圖片ocr識別的結果有 token 4096 長度限制

二、type詳細說明
text：文本輸入UTF-8
當 type = text 時，chat_info = [{"type":"text","content":"文本輸入內容"}]

image：圖片base64編碼：支持圖片格式：.bmp、.jpg、.png，圖片大小Base64后≤2M
當 type = image 時，chat_info = [{"type":"image","content":"圖片base64編碼"}]

image_url：整張圖片的URL（需要公網(wǎng)能訪問下載）
當 type = image_url 時，chat_info = [{"type":"image_url","content":"圖片的鏈接URL"}]

接口參數(shù)subscribe可訂閱事件說明：

query_suggestion :插件能力，訂閱才執(zhí)行——猜你想問

響應結果

一個成功的返回示例：

"id": "fb981fde-0080-4933-b87b-4a29eaba8d17"
"event":"begin"
"data":{
"request_id": "fb981fde-0080-4933-b87b-4a29eaba8d17",
"task_id": "046dba1a-7f47-4f96-91f2-be4676aa1347",
"chat_id": 1705045207475
}

"id": "fb981fde-0080-4933-b87b-4a29eaba8d17"
"event":"message"
"data":{
"content": "你好，",
"type": "text"
}

"id": "fb981fde-0080-4933-b87b-4a29eaba8d17"
"event":"message"
"data":{
"content": "有什么可以",
"type": "text"
}

"id": "fb981fde-0080-4933-b87b-4a29eaba8d17"
"event":"message"
"data":{
"content": "幫助你的嗎？",
"type": "text"
}

"id": "fb981fde-0080-4933-b87b-4a29eaba8d17"
"event":"end"
"data":{
"request_id": "fb981fde-0080-4933-b87b-4a29eaba8d17",
"usage":[
     {"type":"input_ocr_token","value":110},
     {"type":"output_text_token","value":253},
     {"type":"query","value":1}
]}

響應結果詳解

正常結果包含的事件 1個begin、1-N個 message、1個end

發(fā)生異常時包含的事件

  • 對話過程中的異常：1個begin、0-N個 message、1個error
  • 參數(shù)異常：1個error

事件說明

  • begin事件：[基礎事件類型——開始]
"id": "fb981fde-0080-4933-b87b-4a29eaba8d17" // 請求id
"event":"begin" // 事件類型
"data":{
"request_id": "fb981fde-0080-4933-b87b-4a29eaba8d17", // 請求id
"task_id": "046dba1a-7f47-4f96-91f2-be4676aa1347", // 任務id
"chat_id": 1705045207475 // 系統(tǒng)回復對話的id，下一輪對話的parent_chat_id
}
  • message事件：[基礎事件類型——消息]
"id": "fb981fde-0080-4933-b87b-4a29eaba8d17" // 請求id
"event":"message" // 事件類型
"data":{
"content": "你好，", // 模型回答
"type": "text"       // 回答類型
}
  • end事件：[基礎事件類型——結束 ]

end 事件中的 usage 可以認為是接口調用的賬單明細，明細列表從前到后依次包含三個部分：

  1. 輸入明細部分：和 chat_info 參數(shù)中的條目一一對應

(1) type為"input_text_token"的明細：對應chat_info中type為"text"的文本token數(shù)量

(2) type為"input_ocr_token"的明細：對應chat_info中type為"image"或“imageUrl”的OCR識別文本token數(shù)量

  1. 輸出明細部分：

type為"output_text_token"的明細：目前都是文本輸出（返回事件流中message的type為"text"）

  1. 插件使用明細部分：非必填，在訂閱插件能力并有正確的返回時，返回對應的明細

(1) type為"query_suggestion"的明細：訂閱猜你想問插件并有正確返回

"id":"e9141d83-e76a-4581-bfeb-0bd6569d8339"
"event":"end" // 事件類型
"data":{
"usage": // 賬單明細
[{
  "type": "input_text_token",   // chat_info中type為"text"的文本token數(shù)量
  "value": 80     // token數(shù)
  },{
  "type": "input_ocr_token",   // chat_info中type為"image"或“imageUrl”的OCR識別文本token數(shù)量
  "value": 110     // token數(shù)
  },{
  "type": "output_text_token", // 模型輸出token數(shù)量
  "value": 64      // token數(shù)
  },{
  "type": "query",     // 系統(tǒng)服務，按次計費
  "value": 1   // 次數(shù)
  },{
  "type": "query_suggestion",     // 訂閱猜你想問插件且成功，按次計費
  "value": 1   // 次數(shù)
}],
"request_id": "e9141d83-e76a-4581-bfeb-0bd6569d8339"
}
  • error事件：[基礎事件類型——結束]

error 事件中的 usage 格式同 end 事件，對于不收費異常返回空列表

"id":"e9141d83-e76a-4581-bfeb-0bd6569d8339" // 請求id
"event":"error" // 事件類型
"data":{
"code": 99,
"msg": "系統(tǒng)錯誤",
"request_id": "e9141d83-e76a-4581-bfeb-0bd6569d8339" // 請求id
"usage": []
}
  • 猜你想問事件：[插件能力事件類型——猜你想問]
"id":"e9141d83-e76a-4581-bfeb-0bd6569d8339"
"event":"query_suggestion" // 事件類型
"data":{
"suggestion":["微積分主要包括哪兩大部分？","微分學的主要研究對象是什么？","積分學的核心研究內容是什么？"],
"code":0,
"msg":"SUCCESS"
}

異常結果

業(yè)務異常（通過sse的error事件返回）

  • 缺少公共參數(shù)user_id：[100101-USER_LACK_USER_ID]
  • 缺少業(yè)務參數(shù)task_id：[100101-USER_LACK_TASK_ID]
  • 缺少業(yè)務參數(shù)parent_chat_id：[100101-USER_LACK_PARENT_CHAT_ID]
  • 對話內容為空或缺少對話內容：[100101-USER_LACK_CHAT_CONTENT]
  • 任務名稱為空串：[100102-USER_WRONG_TASK_NAME]
  • 對話內容參數(shù)格式錯誤：[100102-USER_WRONG_CHAT_INFO]
  • 圖片base64無法解析：[100102-USER_WRONG_IMAGE_PARAM]
  • chat_info的type類型不在枚舉范圍：[100102-USER_WRONG_CHAT_TYPE]
  • 沒有查到歷史對話：[100102-USER_WRONG_CHAT_HISTORY]
  • 用戶id超過100字符：[100103-USER_USER_ID_LENGTH_OVER]
  • 任務名超過20字符：[100103-USER_TASK_NAME_LENGTH_OVER]
  • 圖片base64編碼超過2M：[100103-USER_IMAGE_BASE64_LENGTH_OVER]
  • 輸入token超過4096：[100103-USER_INPUT_TOKEN_OVER]
  • 模板id參數(shù)錯誤取值：[100102-USER_WRONG_TEMPLATE_ID]
  • 模板id參數(shù)沒有權限：[100102-USER_TEMPLATE_ID_FORBID]
  • 訂閱事件參數(shù)錯誤取值：[100102-USER_WRONG_SUBSCRIBE]
  • 訂閱事件參數(shù)沒有權限：[100102-USER_SUBSCRIBE_FORBID]
  • 用戶輸入高度敏感：[100111-USER_INPUT_SENSITIVE_HIGH]
  • 用戶輸入中度敏感：[100112-USER_INPUT_SENSITIVE_NORMAL]
  • 用戶使用太頻繁：[100117-USER_RATE_LIMIT ]

其他異常（通過sse的error事件返回）

  • 模型回答內容高度敏感：[100201-CUR_ANSWER_SENSITIVE_HIGH]
  • 模型回答內容中度敏感：[100202-CUR_ANSWER_SENSITIVE_NORMAL]
  • 請求需要使用token超限：[100243-CUR_OVER_TOTAL_TOKEN]
  • 其他錯誤碼：[100299-CUR_SERVER_ERROR]，用于排查系統(tǒng)問題，可認為是系統(tǒng)錯誤碼

猜你想問

通過對話歷史，或者提供的問題和回答，推薦3個問題。

baseUrl + /plugin/suggest

請求方式: POST

Content-Type: multipart/form-data

接口參數(shù)

字段名含義示例必填
app_key應用標識（應用 ID）true
curtime時間戳(秒)TimeStamptrue
salt隨機字符串，建議使用UUIDtrue
sign簽名信息：sha256(應用ID+curtime+salt+curtime+應用密鑰)true
sign_type簽名類型v3true
os_type系統(tǒng)類型apitrue
user_id用戶id，用來標識用戶，當query/answer為空時必填false
task_id任務id，用來標識用戶一次會話session（關聯(lián)一組對話歷史），當query/answer為空時必填false
chat_idchat接口返回的begin事件中的chat_id，最近一次模型回答的id，當query/answer為空時必填false
query需要推薦問題的原始問題false
answer原始問題的回答false

響應結果

{
    "code": "0", //錯誤碼
    "msg": "ok", //詳細信息
    "requestId": "", //請求唯一id
    "data": { //結果對象
        "suggestion": [ //返回結果
            "推薦問題1","推薦問題2","推薦問題3"
        ],
        "requestId": "" //請求id，onetime接口時用于定位請求
    }
}

異常結果

業(yè)務異常

  • 缺少公共參數(shù)user_id：[100101-USER_LACK_USER_ID]
  • 缺少業(yè)務參數(shù)task_id：[100101-USER_LACK_TASK_ID]
  • 缺少業(yè)務參數(shù)chat_id：[100101-USER_LACK_CHAT_ID]
  • 錯誤業(yè)務參數(shù)task_id：[100102-USER_WRONG_TASK_ID]
  • 錯誤業(yè)務參數(shù)chat_id：[100102-USER_WRONG_CHAT_ID]
  • 查詢不到歷史對話：[100102-USER_WRONG_CHAT_HISTORY]
  • 沒有猜你想問的使用權限：[102601-SUGGESTION_FORBID]

其他異常

  • 系統(tǒng)內部異常：[100299-CUR_SERVER_ERROR]

常用語言 Demo

Java 示例

Xiaop Java demo

Python3 示例

Xiaop python3 demo

go示例

Xiaop go demo

錯誤碼列表

錯誤碼msg
101缺少必填的參數(shù)，首先確保必填參數(shù)齊全，然后，確認參數(shù)書寫是否正確。
104不支持的API類型
105不支持的簽名類型
106不支持的響應類型
110無相關服務的有效應用，應用沒有綁定服務，可以新建服務。注：某些服務的結果發(fā)音需要tts服務，需要在控制臺創(chuàng)建語音合成實例綁定應用后方能使用。
111開發(fā)者賬號無效
202簽名檢驗失敗，如果確認應用ID和應用密鑰的正確性，仍返回202，一般是編碼問題。請確保翻譯文本 q 為UTF-8編碼.
203訪問IP地址不在可訪問IP列表
205請求的接口與應用的平臺類型不一致，確保接入方式（Android SDK、IOS SDK、API）與創(chuàng)建的應用平臺類型一致。如有疑問請參考入門指南
206因為時間戳無效導致簽名校驗失敗
207重放請求
303服務端的其它異常
401賬戶已經(jīng)欠費停
405鑒權失敗
100101缺少必要參數(shù)
100102參數(shù)錯誤
100103參數(shù)長度超過限制
100111輸入內容高度敏感
100112輸入內容中度敏感
100117用戶使用太頻繁
100201模型回答內容高度敏感
100202模型回答內容中度敏感
100243請求需要使用的token超出限制
100299系統(tǒng)內部異常
102601沒有猜你想問插件的使用權限
洛扎县| 林甸县| 梅河口市| 柘荣县| 海伦市| 呼和浩特市| 襄汾县| 铜山县| 遂溪县| 简阳市| 四会市| 马尔康县| 呼玛县| 东平县| 安塞县| 灵石县| 蒙山县| 通化县| 微博| 宿松县| 墨脱县| 梨树县| 永昌县| 建瓯市| 玛曲县| 明星| 新巴尔虎右旗| 洪洞县| 福安市| 巢湖市| 沙坪坝区| 元谋县| 化德县| 黄石市| 定兴县| 汝阳县| 抚远县| 双辽市| 辽源市| 金堂县| 新竹市|