通過註冊方式，將大模型的服務註冊到服務平台統一管理，可統計不同應用對模型的調用量，並可對模型API進行限流、監控和查看調用日誌。本文為您介紹如何基於模型建立API。
步驟一：選擇產生API的方式
在Dataphin首頁的頂部功能表列，選擇服務 > API開發。
在左上方選擇服務專案，單擊左側導覽列的API服務。在API頁面，單擊+建立API按鈕。
在建立API對話方塊中，選擇模型API。
步驟二：配置模型API的參數資訊
在建立API頁面配置參數。
參數
描述
基礎資訊配置
API名稱
填寫API的名稱。命名規則如下：
只能包含中文、字母、數字或底線（_）。
長度為4~100個字元。
以字母開頭。
全域唯一。
模型
填寫模型的名稱，不超過256個字元。
協議類型
選擇API的介面協議，支援OpenAI相容和DashScope。
操作類型
預設為GET，不可修改。
GET：請求伺服器擷取指定的某個資源。
API分組
選擇當前專案下配置的API分組，如需建立，請參見建立服務分組。
描述
填寫對API的簡單描述。128個字元以內。
協議
資料產生API的介面協議，支援HTTP、HTTPS協議。
HTTP：即超文字傳輸通訊協定 (HTTP)HTTP（HyperText Transfer Protocol），是應用最為廣泛的網路通訊協定。
HTTPS：若網關配置為阿里公用雲端API Gateway（專享執行個體或共用執行個體）時，支援選中HTTPS協議，請確保獨立網域名稱的SSL認證有效，避免無法正常調用。請通過選擇平台管理網路設定，在網路設定頁面，進行SSL認證配置。
調用模式
用於用戶端和伺服器之間的通訊，以擷取或處理資料。支援選擇同步調用和非同步呼叫，預設為同步調用。
同步調用：用戶端發送請求後，必須等伺服器返回結果後才能繼續執行其他請求，針對複雜查詢語句，回應時間較長且在等待過程中會佔用伺服器串連數，造成伺服器壓力。適用於即時性要求高、處理時間短的情境。
非同步呼叫：用戶端發送請求後，無需等待伺服器響應，可繼續執行其他請求，伺服器處理完成後再通知用戶端，在批量擷取資料時，可降低資料庫查詢結果的重複率，用資料服務API進行資料擷取。適用於處理時間長、即時性要求不高的情境，如批量處理等。
執行逾時時間
當調用模式為非同步呼叫時支援配置。用於監控SQL執行的時間長度。預設為60秒，支援設定的時間範圍為1到7200秒（2小時）的正整數。
逾時時間
用於監控API調用的最大時間長度。當調用模式為同步調用時，預設為30秒，支援設定的時間範圍為3到60秒的正整數；當調用模式為非同步呼叫時，預設為600秒，支援設定的時間範圍為3到7200秒（2小時）的正整數。
調用API過程中如果超過了設定的逾時時間，則調用API時會報錯，便於您及時發現並處理調用API的異常情況。關於異常情況的查看，詳情請參見查看及管理營運監控API。
版本號碼
請填寫API的版本號碼，每份配置資訊會有所屬版本號碼，以便於和上個版本資訊對比。64個字元以內。該API下版本號碼唯一。
傳回型別
預設JSON。
後端服務配置
模式
支援Basic或Dev_Prod兩種模式。
Basic模式下開發時、提交及發布線上均讀取生產庫。
Dev-Prod模式下開發及提交讀取開發庫，發布線上讀取生產庫。
請求方式
用於配置轉寄調用後端服務的要求方法，僅支援POST。
POST：若要求方法選擇POST，則請求參數支援選擇BODY。
API資料來源
請選擇註冊API的資料來源，如需建立，請參見建立API資料來源。
服務逾時
於監控轉寄調用後端服務的時間長度。調用後端服務過程中如果超過了設定的服務逾時時間，則調用API時會由於後端服務調用逾時報錯，便於您及時發現並處理調用API的異常情況。異常情況查看，詳情請參見查看及管理營運監控API。
服務path
根據協議類型和模型類型決定服務的路徑，當協議類型為OpenAI相容，模型類型支援對話和自訂；當協議類型DashScope，模型類型支援對話、映像產生和自訂。選擇不同的模型類型，系統為您展示對應的服務路徑。
例如：API資料來源的URL地址為：
http://dashscope.aliyuncs.com:*****/api/example，服務Path為：/compatible-mode/v1/chat/completions，則後端服務的完整URL為：http://dashscope.aliyuncs.com:*****/api/example/compatible-mode/v1/chat/completions。當選擇自訂服務路徑時，路徑需以正斜線（/）開頭，且字元個數不超過128個。
請求參數
參數名稱
對外開放的參數，即使用者訪問API時直接使用的參數，128個字元以內。
參數位置
支援選擇Headers、Parameters、Body。
Headers：在解析請求參數時會添加到參數的頭部位置。
Parameters：在解析請求參數時會拼接資料來源的URL。
Body：在解析請求參數時如果有多個參數，則會封裝成一個Body。
參數類型
當參數位置為Headers、Parameters時，參數類型支援DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL，需選擇參數名對應的綁定欄位的參數類型。
當參數位置為Body時，除上述參數類型外，還支援Array(int)、Array(string)、Object、Array(double)、Array(float)、Array(Date(yyyy-MM-dd HH:mm:ss))、Array(boolean)、Array(long)、Array(short)、Array(BigDecimal)、Array(Object)。
預設值
後端服務調用時，若無傳值，則以預設值傳入。支援輸入不超過1000個字元，若參數類型為STRING，無字元輸入限制。
樣本
填寫請求參數值的樣本，便於開發人員理解。支援輸入不超過1000個字元。
描述
填寫對請求參數的簡單描述。支援輸入不超過1000個字元。
是否必填
必填參數，若在調用API時不傳參數值，則API調用失敗。
測試
您可通過測試判斷大模型返回的響應內容是否符合預期。
請求參數配置完成後，單擊測試按鈕，在測試請求發送對話方塊中，根據請求參數輸入試運行值，單擊開始測試按鈕，系統將請求參數進行封裝，發送請求體給大模型，並返迴響應內容。
智能添加
當操作類型為GET，且已對請求參數進行測試，支援操作。單擊智能添加按鈕，系統將自動提取返迴響應結果的第一層參數填充至返回參數列表，包括參數名稱、返回參數取值路徑和參數類型。
返回參數
參數名稱
必填，對外開放的參數，API返回時最終展示給使用者的參數名稱，128個字元以內。
返回參數取值路徑
僅支援JSON格式，當返回資料多層嵌套，需要配置對應的返回參數路徑。可單擊查看配置說明， 參照樣本配置返回參數的取值路徑，或直接輸入關鍵字搜尋匹配路徑。
參數類型
若返回參數取值路徑已進行測試，系統根據測試結果，自動檢測資料類型，您可以選擇參數名對應的綁定欄位的參數類型，包括DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL、Array(int)、Array(string)、Object、Array(double)、Array(float)、Array(Date(yyyy-MM-dd HH:mm:ss))、Array(boolean)、Array(long)、Array(short)、Array(BigDecimal)、Array(Object)。
樣本
填寫返回參數值的樣本，便於開發人員理解。支援輸入不超過1000個字元。
描述
填寫對返回參數的簡單描述。支援輸入不超過1000個字元。
單擊提交，即可完成API的建立。