在流程管理中配置各個節點時,其中涉及相關API的調用,可以在API插件頁面進行配置和管理。
新建API插件
進入機器人空間或業務空間,選擇知識庫>API插件,單擊新建API,打開新建API彈窗。
說明業務空間:業務空間可以理解為管理機器人的地方,業務空間包含了許多的機器人。
機器人空間:機器人空間是指進入到具體某一個機器人的操作空間中。
業務空間API插件列表包含所有已經創建的插件,而機器人空間下的API插件列表只會展示綁定在該機器人下的插件,機器人空間創建的API插件也會在業務空間中插件列表展示。
服務名稱:需要遵守變量名規范,包括單詞+下劃線和連續單詞大寫字母間隔兩種方式,如 get_weather,注意只能使用英文。
服務描述:主要描述清楚API的功能,可以包含少量出入參的信息,如根據XX查詢XX,查詢天氣等,如果對API有一些特殊要求也可以寫到服務描述,如 XX 和 XX參數都是非必選,但是必須要有一個。
超長提示:主要描述清楚API的功能,可以包含少量出入參的信息,如根據XX查詢XX,查詢天氣等,如果對API有一些特殊要求也可以寫到服務描述,如 XX 和 XX參數兩個均為非必選,但是必須要有一個。
API配置:
接口配置:API調用的鏈接和token信息,都可以定義在API配置中。
入參:
參數:跟上述參數名規范一樣,按照變量名規范來定義,僅支持英文。
類型:文本內容選擇string,Number表示數字、Boolean表示true or false的布爾值。
取值來源:包括模型識別和隨路參數,其中隨路參數不會傳輸給模型去識別。
是否必填:當前參數是否為必填參數,建議一個API至少包含一個必填參數,對于選填參數,機器人不會主動詢問,但是有表達對應內容時也會識別。
參數解釋:類似于上述參數說明,包括中文名、格式化描述和示例三部分。
出參:
Mock值:在沒有真實的URL進行請求時,可以通過該字段設置API的固定返回,注意該部分需要在對話調試窗打開開關,一旦打開則優先級高于URL請求。
單擊確定,即可創建成功。
流程API插件
進入機器人空間,選擇知識庫>API插件>流程API插件
流程API插件是指流程中使用的API插件,是在機器人空間或者業務空間已經創建好的API插件,當某一個流程中節點使用API插件保存后,流程API插件列表就會展示出來。