功能介紹

ERNIE 3.0系列API可以廣泛應用于任何涉及自然語言理解或自然語言生成的任務中，我們預置了多種任務，您可以通過API的方式直接呼叫ERNIE 3.0大模型的“零樣本”能力，也可以自定義任務體驗大模型的強大能力，

應用場景

ERNIE 3.0系列API的應用場景包括幾乎所有自然語言處理的任務，我們預置了同義改寫、寫作文、寫文案、寫摘要、對對聯、寫小說、自由問答、文本補全等任務，您也可以根據自己業務需要自定義任務， 您使用API介面呼叫ERNIE 3.0的能力時，需要按照prompt的形式進行輸入，您可以參考以下prompt模板的輸入形式，更好地引導大模型完成特定任務，

• 注意：{input_text}為需要輸入的目標文本，\n為換行符，

API地址及引數說明

回傳引數

code回傳的錯誤碼解釋

服務說明

• ERNIE 3.0 API介面呼叫從同步預測升級為異步預測，支持未回傳結果前可同時提交多個任務請求
• 升級至API介面呼叫異步預測服務時，需在請求引數中新增引數：async，查看引數描述
• 重新安裝 wenxin-api 工具包即可自動升級為呼叫異步預測服務

• API介面呼叫同步預測服務已于【1月31號晚上20:00】下線，屆時線上API介面呼叫全部為異步預測服務，

引數描述

在呼叫介面時，您需要配置一下引數，您可以按照默認的引數配置進行呼叫，也可以參考以下引數描述修改某些引數的配置來滿足您的特定需求，

獲取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
}

 {
    "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
    }
}

• 引數：

• 回傳引數

異步查詢回傳圖片

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
    }
}

• 入參

• 回傳引數

資料來源：https://wenxin.baidu.com/

AI工具導航站：https://xiaohetao.fun/

標籤：其他

上一篇：全堆疊混合云綜合架構方案研究和落地

下一篇：《花雕學AI》17：關注提示工程—本世紀最重要的技能可能就是與AI人工智能對話