REFERENCE
開發者參考
認證、API、SDK、Flow Agent 處理節點與參數取值的完整參考。
SDK 總覽
Asgard SDK 安裝、設定與快速開始
Asgard 提供官方 JavaScript 與 React SDK,讓開發者能快速整合聊天機器人功能,無需自行處理底層 API 細節。
SDK 提供什麼
- 簡化 API 存取:封裝 REST API 請求,統一管理驗證與端點設定
- SSE 串流處理:自動處理 Server-Sent Events,即時接收機器人回應
- Channel 管理:內建 session 持久化,支援多輪對話
- React 元件:
@asgard-js/react提供現成的聊天室 UI 元件與 Hook
快速開始
以下範例展示如何使用
@asgard-js/core底層 API 送出訊息並接收串流回應:import { AsgardServiceClient, Channel, Conversation } from '@asgard-js/core';
const client = new AsgardServiceClient({
botProviderEndpoint:
'https://api.asgard-ai.com/ns/{namespace}/bot-provider/{botProviderId}',
});
const conversation = new Conversation({ messages: new Map() });
const channel = await Channel.reset({
client,
customChannelId: 'channel-123',
conversation,
statesObserver: (states) => {
console.log('Messages:', Array.from(states.conversation.messages.values()));
},
});
await channel.sendMessage({ text: '你好,請介紹一下你自己' });如果使用 React,推薦直接用
<Chatbot>元件:import { Chatbot } from '@asgard-js/react';
import '@asgard-js/react/style';
export default function App() {
return (
<div style={{ height: '100vh' }}>
<Chatbot
title="我的 AI 助理"
customChannelId="user-123"
config={{
botProviderEndpoint:
'https://api.asgard-ai.com/ns/{namespace}/bot-provider/{botProviderId}',
}}
/>
</div>
);
}SDK 與直接呼叫 REST API 比較
功能 SDK REST API SSE 串流處理 自動處理 需自行實作 驗證設定 初始化一次,自動帶入 每次請求需手動加入 header Channel 管理 內建 session 持久化 需自行維護 channelIdReact 整合 提供 Hook 與元件 需自行封裝 錯誤處理 統一錯誤介面 需自行解析各類錯誤 TypeScript 支援 完整型別定義 需自行定義型別 延伸閱讀
- JavaScript SDK 參考文件 —
@asgard-js/core完整 API 說明 - React SDK 參考文件 —
@asgard-js/react元件與 Hook 說明 - SDK Demo — 每個 SDK 功能的可實際操作範例(訊息模板、主題、認證、headless 用法等)
- SDK Demo - 整合總覽 — 從建立 Bot 到前端上線的完整路徑導覽
- JavaScript SDK 參考文件 —
GitHub
原始碼與最新版本:asgard-ai-platform/asgard-js-sdk