PAI-RAG提供豐富的API介面,用於服務管理、對話等功能。本文為您介紹使用低於v0.3.0版本鏡像部署的RAG服務所支援的介面類型及調用方式。
使用限制
該文檔僅適用於使用低於v0.3.0版本鏡像部署的RAG服務。
您可以前往模型線上服務(EAS)頁面,單擊RAG服務名稱,然後在概覽頁面的環境資訊地區,查看鏡像版本。
擷取服務訪問地址和Token
通過API介面調用RAG服務前,您需擷取RAG服務的訪問地址和Token:
登入PAI控制台,在頁面上方選擇目標地區,並在右側選擇目標工作空間,然後單擊進入EAS。
單擊目標服務名稱,然後在基本資料地區,單擊查看調用資訊。
在調用資訊對話方塊中擷取服務訪問地址(EAS_SERVICE_URL)和Token(EAS_Token)。
重要請將EAS_SERVICE_URL末尾的斜杠(/)刪除。
使用公網地址調用:調用用戶端支援訪問公網。
使用VPC地址調用:調用用戶端必須與RAG服務位於同一個專用網路內。

Chat API(對話介面)
通過OpenAI-Compatiable API調用服務。調用服務前,您需根據使用的功能,提前在RAG服務的WebUI頁面完成相應配置。
支援功能
web search:連網搜尋。需配置網路搜尋參數。
chat knowledgebase:知識庫查詢。需上傳知識庫檔案。
chat llm:使用LLM回答。需配置LLM服務。
chat agent:智能體工具調用。需在WebUI頁面配置Agent相關代碼。
chat db:資料庫/表格式查詢。需在WebUI頁面配置DBChat相關參數。
調用方式 | |
調用地址 |
|
請求方式 | POST |
請求HEADERS |
|
HTTP Body範例 | 重要
|
Management API(管理介面)
上傳知識庫檔案
調用方式 | |
調用地址 |
|
請求方式 | POST |
請求HEADERS |
|
請求參數 |
|
檢查上傳任務狀態
調用方式 | |
調用地址 |
|
請求方式 | GET |
請求HEADERS |
|
知識庫檢索
調用方式 | |
調用地址 |
|
請求方式 | POST |
請求HEADERS |
|
請求參數 |
|
上傳Excel/CSV檔案用於Chat_DB的表格內容查詢
調用方式 | |
調用地址 |
|
請求方式 | POST |
請求HEADERS |
|
請求參數 | Excel或CSV檔案。 |
上傳JSON檔案用於Chat_DB的資料庫資訊補充-問答對
調用方式 | |
調用地址 |
|
請求方式 | POST |
請求HEADERS |
|
請求參數 |
|
載入資料庫資訊
調用方式 | |
調用地址 |
|
請求方式 | POST |
請求HEADERS |
|
擷取當前所有知識庫索引
調用方式 | |
調用地址 |
|
請求方式 | GET |
請求HEADERS |
|
建立知識庫索引
調用方式 | |
調用地址 |
|
請求方式 | POST |
請求HEADERS |
|
請求參數 |
|
更新知識庫索引
調用方式 | |
調用地址 |
|
請求方式 | PATCH |
請求HEADERS |
|
請求參數 |
|
刪除知識庫索引
調用方式 | |
調用地址 |
|
請求方式 | DELETE |
請求HEADERS |
|
請求參數 | index_name:索引名稱 |
擷取RAG服務配置
調用方式 | |
調用地址 |
|
請求方式 | GET |
請求HEADERS |
|
更新RAG服務配置
調用方式 | |
調用地址 |
|
請求方式 | PATCH |
請求HEADERS |
|
請求參數 | new_config:更新的配置資訊 |