功能介紹
ERNIE 3.0系列API可以廣泛應用於任何涉及自然語言理解或自然語言生成的任務中。我們預置了多種任務,您可以透過API的方式直接呼叫ERNIE 3.0大模型的“零樣本”能力,也可以自定義任務體驗大模型的強大能力。
應用場景
ERNIE 3.0系列API的應用場景包括幾乎所有自然語言處理的任務,我們預置了同義改寫、寫作文、寫文案、寫摘要、對對聯、寫小說、自由問答、文字補全等任務,您也可以根據自己業務需要自定義任務。 您使用API介面呼叫ERNIE 3.0的能力時,需要按照prompt的形式進行輸入,您可以參考以下prompt模板的輸入形式,更好地引導大模型完成特定任務。
- 注意:{input_text}為需要輸入的目標文字,\n為換行符。
| 模型選擇-選項 | 輸入示例 | 更多prompt式輸入參考 |
---|---|---|---|
同義改寫 | 選項一:ERNIE 3.0 Zeus 同義改寫精調模型 | 選項一示例: 1.這個問題蔡瑁也一直在考慮,就他所知,襄陽軍中某些將領,就在暗中串連煽動,只是他不敢過於緊逼,怕火併起來兩敗俱傷,那時劉琮未至,城內先亂,還拿什麼去對付劉琮? 2.無論在日常生活還是電視節目中,英語的風頭 似乎一直蓋過漢語。《漢聽大會》能持續走紅,說明人們對母語的情感是共通的。關鍵詞:《漢聽大會》 |
輸入(普通): {text} 輸入(關鍵詞): {text} 關鍵詞:{key_words} # 拼接關鍵詞序列的輸入, 確保模型生成結果的一致性。 後端需要將 key_words 提取出來, key_words 應該是以中文逗號分割的字串 |
寫作文 | 選項一:ERNIE 3.0 Zeus 中學記敘文增強包 選項二:ERNIE 3.0 Zeus 中學議論文增強包 選項三:ERNIE 3.0 Zeus 通用文章增強包 |
選項一的示例: 1. 從未走遠\n高中記敘文: 2. 人間煙雨,感謝有你\n高中記敘文: 3. 生命的思考\n高中記敘文: 選項二的示例: 1. 中國女足奪冠後對中國足球的影響\n高中議論文: 2. 幸福需要奮鬥,新時代需要奮鬥\n高中議論文: 3. 青年理想\n高中議論文: 選項三的示例: 1. 可塑性記憶 2. 一個有趣的實驗 3. 我的“話癆”老媽 |
作文題目:{title}\n高中記敘文: 作文題目:{title}\n高中議論文: 作文題目:{title}\n其它作文: |
寫文案 | 選項一:ERNIE 3.0 百億 社交短文案精調模型 選項二:ERNIE 3.0 Zeus 商品營銷文案增強包 |
產品標題:清揚去屑洗髮水 屬性:薄荷清涼 屬性:無矽油 產品文案: 選項一示例: 輸入:讚美母親的短句\n回答: 選項二示例: 輸入:髒髒包 輸出:這款髒髒包,可以說是網紅界的鼻祖了。吃起來滿嘴都是巧克力粉,但又不會太甜膩。一口咬下去,酥脆的外皮和柔軟的內心完美結合在一起,讓人根本停不下來! |
選項一: 問題:{query}\n回答: 選項二: 輸入Prompt: 標題:{text}\n文案: |
寫摘要 | 選項一:ERNIE 3.0 Zeus 寫摘要 選項二:ERNIE 3.0 Zeus 寫標題 選項三:ERNIE 3.0 百億 寫標題 |
選項一示例: 不知從何時起,自拍杆變成了人手一件“必備”附件,最便宜的時候幾塊錢就能拿下,而我們今天要介紹的可不是什麼地攤貨。它身價高貴,是新娘子們在大喜之日的自拍利器。紐約時裝品牌ReemAcra最近推出了一款價值500美元的自拍杆,上面鑲嵌了施華洛世奇水晶和白玫瑰。《紐約郵報》評論它是一款“自戀杆。作為一款低科技產品,500美元的價格委實不便宜,但當它被擺上ReemAcra第五大道旗艦店後,很快就被準新娘們搶購一空。Acra表示,新娘自拍杆和耳機是表達幸福心聲、增加歡樂的好工具。正式照片看起來嚴肅正經,而自。拍照則能讓每個人都舒心一笑。 選項二、三示例: 拍賣金額最終定格在262萬美元(和訊新聞配圖) 最後半小時競價飆升(和訊新聞配圖) 中國經濟網6月12日電 北京時間6月12日10點30分訊息(美國時間6月11日19點30分),經過9位出價人77次激烈角逐,2010年度巴菲特午餐價最終落槌在262萬零6311美元,超過2008年創造的211萬美元最高拍賣紀錄。 本次拍賣與往年一樣,在最初幾天標價不多,在拍賣截止前的最後半小時出價迅速飆升,決出了最後的贏家。2008年香港投資人趙丹陽報出的211萬100美元,創下了“天價午餐”的最高紀錄。 巴菲特拍賣午餐的所得將捐給設在舊金山的非盈利機構:Glide基金會。該基金會專門向窮人和無家可歸者提供食品、健康和兒童護理、住所和就業培訓等服務。自2000年巴菲特開始第一次拍賣午餐,迄今已經在九年裡為該基金籌到590多萬美元。 |
標題生成 文章:"{input_text}"\n標題: 摘要生成 一句話寫出下面段落的大意。{input_text}\n回答: |
對對聯 | 選項一:ERNIE 3.0 Zeus 對對聯 選項二:ERNIE 3.0 百億 對對聯 |
選項一、二示例: 上聯: 天地和順家添財 下聯: |
1.上聯:{input_text}\n下聯: 2.對對聯:{input_text} 3.{input_text} \n下一句: |
自由問答 | 選項一:ERNIE 3.0 Zeus 自由問答增強包 選項二:ERNIE 3.0 百億 自由問答 |
選項一、二示例: 問題:8月去臺灣旅遊要帶什麼? 回答: |
1. 問題:{input_text}\n回答: 2. {input_text}\n請回答上面的問題: 3. 問題"{input_text}"的答案是: 4. 閱讀文章:{input_text}問題:{input_text} 回答: 5. {input_text}\n閱讀上面的文章,回答問題。問題:{input_text}\n回答: |
寫小說 | 選項一:ERNIE 3.0百億 寫小說精調模型 | 選項一示例: 崑崙山可以說是天下龍脈的根源,所有的山脈都可以看作是崑崙的分支。這些分出來的枝枝杈杈,都可以看作是一條條獨立的龍脈。 |
直接續寫,無模板 |
文字補全 | 選項一:ERNIE 3.0 Zeus 詞補全增強包 選項二:ERNIE 3.0 Zeus 句補全增強包 選項三:ERNIE 3.0 Zeus 段落補全增強包 |
選項一示例: 她有一頭[MASK]的秀髮。 選項二示例: 希望民眾齊心協力、團結一致逐漸認清方向深刻領悟兩制,讓它給古老的中華大地帶來昌盛、騰飛。我堅信在中央正確領導下.[MASK] 選項三示例: 相約德蘭小講堂空氣炮[MASK] |
文字中間需要生成內容的部分插入[MASK]即可,可生成詞、句子、段落 |
問答對抽取 | 文字:高職地理教學存在著教學方式落後、教學內容與學生實際脫節、教師隊伍水平不高等問題,嚴重影響了教學效果,為了改進高職地理教學存在的弊端,各大高職院校都採取了相關措施對高職地理進行教學改革,其中鄉土地理教學以期獨特的優勢成為高職地理教改的重要途徑之一。因此,研究高職地理教改中鄉土地理教學的措施和方法對高職地理教學效果的提高具有十分重要的意義...... [MASK] |
文字:{text}\n[MASK] |
API地址及引數說明
內容 | 說明 |
---|---|
傳輸方式 | https (為提高安全性,強烈推薦https) |
請求地址 | 每個技能對應一個請求地址,請您按場景選擇對應的請求地址 同義改寫: https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.20/zeus 寫作文: https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.21/zeus 寫文案: https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.22/zeus 寫摘要: https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.23/zeus 對對聯: https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.24/zeus 自由問答: https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.25/zeus 寫小說 https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.26/zeus 補全文字: https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.27/zeus 自定義: https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.28/zeus 問答對抽取:https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.30/zeus |
字元編碼 | UTF-8 |
響應格式 | 統一採用JSON格式 |
開發語言 | 任意,只要可以向服務發起HTTP請求的均可 |
適用範圍 | 任意作業系統,但因不支援跨域不適用於瀏覽器,請在後端呼叫介面 |
請求行 | POST |
請求QPS限制 | 2 |
平均響應時間 | 生成512需要16.3s,生成256需要8.1s,生成128需要4.1s |
返回引數
引數名 | 型別 | 描述 |
---|---|---|
code | int | 錯誤碼 |
msg | string | 錯誤資訊 |
data | object | 結果物件 |
code返回的錯誤碼解釋
錯誤碼 | 錯誤描述 |
---|---|
0 | 正常返回 |
6101 | 請求引數格式錯誤,不是標準的JSON格式 |
6102 | API服務內部錯誤,缺少模型源 |
6103 | API服務內部錯誤,請求中指定的model錯誤 |
6104 | API服務內部錯誤,模型獲取失敗 |
6105 | API服務內部錯誤,模型刪除失敗 |
6106 | 請求引數錯誤,請檢查必傳引數是否齊全,引數型別等 |
6107 | prompt模式下的報錯,embedding 沒有提前部署 |
6108 | prompt模式下的報錯,embedding shape錯誤 |
6109 | 總控服務command傳參錯誤 |
6110 | API服務內部錯誤 |
6111 | 請求超時 |
6112 | 輸入的text文字長度超長 |
6113 | 輸入的資料格式錯誤 |
服務說明
- ERNIE 3.0 API介面呼叫從同步預測升級為非同步預測,支援未返回結果前可同時提交多個任務請求
- 升級至API介面呼叫非同步預測服務時,需在請求引數中新增引數:async,檢視引數描述
- 重新安裝 wenxin-api 工具包即可自動升級為呼叫非同步預測服務
-
API介面呼叫同步預測服務已於【1月31號晚上20:00】下線,屆時線上API介面呼叫全部為非同步預測服務。
引數描述
在呼叫介面時,您需要配置一下引數。您可以按照預設的引數配置進行呼叫,也可以參考以下引數描述修改某些引數的配置來滿足您的特定需求。
|
| |||||
---|---|---|---|---|---|---|
非同步標識 | int | 1 | 非同步標識,現階段必傳且傳1 | |||
使用者輸入文字 | string | 空 | 模型的輸入文字,為prompt形式的輸入。 | |||
最小生成長度 | int | 1 | 輸出結果的最小長度,避免因模型生成END導致生成長度過短的情況,與seq_len結合使用來設定生成文字的長度範圍。 | |||
最大生成長度 | int | 128 | 輸出結果的最大長度,因模型生成END或者遇到使用者指定的stop_token,實際返回結果可能會小於這個長度,與min_dec_len結合使用來控制生成文字的長度範圍。 | |||
多樣性 | float | 1.0 | 影響輸出文字的多樣性,取值越大,生成文字的多樣性越強。 | |||
重複懲罰 | float | 1.0 | 透過對已生成的token增加懲罰,減少重複生成的現象。值越大表示懲罰越大。設定過大會導致長文字生成效果變差。 | |||
提前結束符 | string | 空 | 預測結果解析時使用的結束字串,碰到對應字串則直接截斷並返回。可以透過設定該值,可以過濾掉few-shot等場景下模型重複的cases。 | |||
任務型別 | string | 空 | PARAGRAPH, SENT, ENTITY, Summarization, MT, Text2Annotation, Misc, Correction, QA_MRC, Dialogue, QA_Closed_book, QA_Multi_Choice, QuestionGeneration, Paraphrasing, NLI, SemanticMatching, Text2SQL, TextClassification, SentimentClassification, zuowen, adtext, couplet,novel, cloze |
指定預置的任務模板,效果更好。 PARAGRAPH:引導模型生成一段文章; SENT:引導模型生成一句話; ENTITY:引導模型生成片語; Summarization:摘要; MT:翻譯; Text2Annotation:抽取; Correction:糾錯; QA_MRC:閱讀理解; Dialogue:對話; QA_Closed_book: 閉卷問答; QA_Multi_Choice:多選問答; QuestionGeneration:問題生成; Paraphrasing:複述; NLI:文字蘊含識別; SemanticMatching:匹配; Text2SQL:文字描述轉SQL;TextClassification:文字分類; SentimentClassification:情感分析; zuowen:寫作文; adtext:寫文案; couplet:對對聯; novel:寫小說; cloze:文字補全; Misc:其它任務。 | ||
模型型別 | int | 1 | 1 | 通用: 1 ERNIE 3.0 Zeus 通用 2 ERNIE 3.0 Zeus instruct模型 同義改寫 1 ERNIE 3.0 Zeus 同義改寫精調模型 寫作文: 1 ERNIE 3.0 Zeus 記敘文增強包 2 ERNIE 3.0 Zeus 議論文增強包 3 ERNIE 3.0 Zeus 小學作文增強包 寫文案: 1 ERNIE 3.0 百億 社交短文案精調模型 2 ERNIE 3.0 Zeus 商品營銷文案增強包 寫摘要: 1 ERNIE 3.0 Zeus 寫摘要 2 ERNIE 3.0 Zeus 寫標題 3 ERNIE 3.0 百億 寫標題 對對聯: 1 ERNIE 3.0 Zeus 對對聯 2 ERNIE 3.0 百億 對對聯 自由問答: 1 ERNIE 3.0 Zeus 自由問答增強包 2 ERNIE 3.0 百億 自由問答 3 ERNIE 3.0 Zeus instruct模型 寫小說 1 ERNIE 3.0百億 寫小說精調模型 補全文字 1 ERNIE 3.0 Zeus 詞補全增強包 2 ERNIE 3.0 Zeus 句補全增強包 3 ERNIE 3.0 Zeus 段落補全增強包 |
||
懲罰文字 | string | 空 | 模型會懲罰該字串中的token。透過設定該值,可以減少某些冗餘與異常字元的生成。 | |||
候選文字 | string | 空 | 模型只能生成該字串中的token的組合。透過設定該值,可以對某些抽取式任務進行定向調優。 | |||
單雙向控制開關 | int | 0 | 0表示模型為雙向生成,1表示模型為單向生成。建議續寫與few-shot等通用場景建議採用單向生成方式,而完型填空等任務相關場景建議採用雙向生成方式。 | |||
最小懲罰樣本 | string | 空 | 與最小生成長度搭配使用,可以在min_dec_len步前不讓模型生成該字串中的tokens。 | |||
遮蔽懲罰 | float | -10000 | 配合penalty_text使用,對給定的penalty_text中的token增加一個logits_bias,可以透過設定該值遮蔽某些token生成的機率。 | |||
生成粒度 | string | word | 設定該值可以控制模型生成粒度。 |
獲取API Key
您可以登入文心大模型API服務平臺個人中心獲取您的專屬API Key(AK)和Secret Key(SK),或者檢視您的AK/SK。請注意保護您的金鑰資訊,避免洩露。您可以透過刪除已洩露的金鑰來保護您的賬戶安全。
https://wenxin.baidu.com/user/key
步驟一:獲取access_token
-
向授權服務地址 https://wenxin.baidu.com/moduleApi/portal/api/oauth/token 傳送請求(使用POST),並在URL中帶上以下引數:
- grant_type: 必須引數,固定為client_credentials;
- client_id: 必須引數,應用的API Key(AK) 從連結專區申請;
- client_secret: 必須引數,應用的Secret Key(SK) 從連結專區申請;
- Content-Type:application/x-www-form-urlencoded
- 需要將{your_ak}、{your_sk}替換成您的AK、SK(注意:連同花括號也一起替換)
- token有效期為24小時
GET https://wenxin.baidu.com/moduleApi/portal/api/oauth/token?grant_type=client_credentials&client_id={your_ak}&client_secret={your_sk}
{
"code": 0,
"msg": "success",
"data": "24.f8629f539d6ba631c834d258a95b264f.86400000.1681357928791.595bc075a111acad1d5a21dea5ef7060-173836"
}
步驟二:非同步預測
- 每個技能對應一個請求地址,請求地址如下方“獲取結果-請求地址”表格
- 需要將{accessToken}替換成上一步得到的data值(注意:連同花括號也一起替換)
POST https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/3.0.25/zeus
{
"access_token": "24.f8629f539d6ba631c834d258a95b264f.86400000.1681357928791.595bc075a111acad1d5a21dea5ef7060-173836",
"async": 1,
"typeId":1,
"text": "你好",
"seq_len": 256,
"task_prompt": "qa",
"penalty_score":1.2,
"dataset_prompt": "qa",
"is_unidirectional": 0,
"min_dec_len": 2,
"min_dec_penalty_text": "。?:![<S>]",
"mask_type":"word",
"topp": 0.8
}
返回JSON
{
"code":0,
"msg":"success",
"data":{
"taskId": 1229202,
"requestId":"7fad28872989e274914ee1687b8f2a13"
}
}
步驟三:獲取結果
- 需要將{accessToken}替換成上一步得到的data值(注意:連同花括號也一起替換)
- 將第二步(非同步預測)的返回結果中的taskId 作為引數傳入
POST https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernie/v1/getResult
{
"access_token": "24.f8629f539d6ba631c834d258a95b264f.86400000.1681357928791.595bc075a111acad1d5a21dea5ef7060-173836",
"taskId": 15346824
}
{
"code": 0,
"msg": "success",
"data": {
"result": "因為我們有個好心情",
"createTime": "2022-12-16 16:02:10",
"requestId": "71a6efb46acbd64394374f44579a01eb",
"text": "天為什麼這麼藍",
"taskId": 1000000,
"status": 1 # 0表示生成中,1表示生成成功
}
}
作畫大模型介面說明
ERNIE-ViLG AI作畫大模型:文心ERNIE-ViLG2.0 是基於使用者輸入文字、或文字加圖片生成影像及影像編輯功能的技術,主要為使用者提供跨模態的文字生成影像的大模型技術服務。
其中,參考圖功能是需要使用者上傳一張符合要求的圖片,再輸入prompt文字,選擇相應的引數設定,即可生成新的影像。
POST https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernievilg/v1/txt2img
{
"access_token":"24.f8629f539d6ba631c834d258a95b264f.86400000.1681357928791.595bc075a111acad1d5a21dea5ef7060-173836",
"text":"鋼鐵俠",
"style":"油畫",
"resolution":"1024*1024",
"num":4
}
返回值
{
"code": 0,
"msg": "success",
"data": {
"requestId": "78dbc09ab549d9ab48f88619448c391f",
"taskId": 15348972
}
}
- 引數:
引數名 | 型別 | 是否必傳 | 描述 |
---|---|---|---|
access_token | string | 是 | |
text | string | 是 | 輸入內容,長度不超過100個字 |
style | string | 是 | 圖片風格,目前支援風格有:古風、二次元、寫實風格、浮世繪、low poly 、未來主義、畫素風格、概念藝術、賽博朋克、洛麗塔風格、巴洛克風格、超現實主義、水彩畫、蒸汽波藝術、油畫、卡通畫 |
resolution | string | 是 | 圖片尺寸,目前支援的有:1024*1024 方圖、1024*1536 長圖、1536*1024 橫圖 |
num | int | 是 | 圖片數量,目前支援可選1到6張 |
image | file | 否 | 用該欄位時 請將訪問型別設定為: Content-Type 設定為 application/form-data |
- 返回引數
引數名 | 型別 | 描述 |
---|---|---|
code | int | 錯誤碼 |
msg | string | 錯誤資訊 |
data | object | 結果物件,返回 task id。任務完成後,作為獲取圖片的依據 |
taskId | int | 圖片生成任務id,作為查詢介面的入參 |
非同步查詢返回圖片
POST https://wenxin.baidu.com/moduleApi/portal/api/rest/1.0/ernievilg/v1/getImg
{
"access_token":"24.f8629f539d6ba631c834d258a95b264f.86400000.1681357928791.595bc075a111acad1d5a21dea5ef7060-173836",
"taskId": 15346973
}
返回值
{
"code": 0,
"msg": "success",
"data": {
"img": "https://wenxin.baidu.com/younger/file/ERNIE-ViLG/82e45bea071d565fdf808aee0a907d8ai4",
"waiting": "0",
"imgUrls": [
{
"image": "https://wenxin.baidu.com/younger/file/ERNIE-ViLG/82e45bea071d565fdf808aee0a907d8ai4",
"score": null
},
{
"image": "https://wenxin.baidu.com/younger/file/ERNIE-ViLG/82e45bea071d565fdf808aee0a907d8a30",
"score": null
},
{
"image": "https://wenxin.baidu.com/younger/file/ERNIE-ViLG/82e45bea071d565fdf808aee0a907d8aex",
"score": null
},
{
"image": "https://wenxin.baidu.com/younger/file/ERNIE-ViLG/82e45bea071d565fdf808aee0a907d8a5q",
"score": null
}
],
"createTime": "2023-04-12 16:23:13",
"requestId": "6f1edf3b23e13fa39252abc33ffb7d36",
"style": "油畫",
"text": "鋼鐵俠",
"resolution": "1024*1024",
"taskId": 15346973,
"status": 1
}
}
- 入參
引數名 | 型別 | 是否必傳 | 描述 |
---|---|---|---|
access_token | string | 是 | 與上述獲取方式一致 |
taskId | string | 是 | 從上一章節的提交介面的返回值中獲取 |
- 返回引數
引數名 | 型別 | 描述 |
---|---|---|
code | int | 錯誤碼 |
msg | string | 錯誤資訊 |
data | object | task_id對應請求的任務狀態和生成結果 |
img | string | 生成結果地址 後期去掉 使用 imgUrls |
imgUrls | array | 生成結果陣列 目前預設生成10張圖 |
waiting | string | 預計等待時間 |
createTime | string | 任務建立時間 |
style | string | 請求內容中的圖片風格 |
text | string | 請求內容中的文字 |
taskId | int | 對應任務的id |
status | int | 0或1。"1"表示已生成完成,"0"表示任務排隊中或正在處理。 |
resolution | string | 請求內容的圖片尺寸 |
num | int | 請求生成圖片的數量 |
image | file | 上傳參考圖的圖片 |
資料來源:https://wenxin.baidu.com/