คู่มือ
SDK
SDK ที่เผยแพร่มีเพียงวิดเจ็ต Flutter หนึ่งตัว พร้อม REST API และข้อกำหนด OpenAPI ที่เรียกใช้ได้จากทุกภาษา
AskAIs ใช้แนวทางโปรโตคอลมาก่อน: ข้อกำหนด OpenAPI 3.1 เพียงชุดเดียว โปรโตคอล WebSocket เพียงชุดเดียว และ webhook ที่ลงนามด้วย HMAC คุณสามารถเรียกใช้ API จากภาษาใดก็ได้และเรนเดอร์ UI ของคุณเอง ปัจจุบันเราเผยแพร่ UI SDK ที่แพ็กมาแล้วเพียงชุดเดียว คือวิดเจ็ต Flutter เนทีฟ
SDK ที่เผยแพร่: วิดเจ็ต Flutter
SDK ชุดเดียวที่เราส่งมอบในวันนี้อยู่ใน sdks/flutter-widget/ เป็น UI แชทที่สมบูรณ์และปรับธีมได้ ซึ่งจะติดต่อกับ REST API และ WebSocket ให้คุณ เพิ่มลงใน pubspec.yaml ของคุณในรูปแบบแพ็กเกจภายในเครื่อง:
# pubspec.yaml
dependencies:
singchat_widget:
path: ../sdks/flutter-widgetiOS และ Android
ไม่มี SDK เนทีฟแยกต่างหากสำหรับ iOS หรือ Android มีสองเส้นทางที่รองรับ:
- WebView (แนะนำ), โหลดวิดเจ็ตเว็บจาก
/api/widget-embedเป็นวิดเจ็ตแบบเต็มความสามารถและอัปเดตอัตโนมัติ คุณจึงไม่ต้องปล่อยแอปเวอร์ชันใหม่เพียงเพื่อให้ได้ฟีเจอร์แชทใหม่ - REST API, เรียกใช้ API โดยตรงและเรนเดอร์ UI เนทีฟของคุณเอง
ไม่มีมุมมองแชทสำเร็จรูปใน SwiftUI หรือ Jetpack Compose คุณต้องฝัง WebView หรือสร้าง UI ด้วยตัวเองบน API
ภาษาอื่นใดก็ตาม: เรียกใช้ REST API
เราไม่ได้จัดเตรียมไคลเอนต์สำเร็จรูปสำหรับ Python, Go, Rust, C#, Java, PHP, Ruby หรือที่คล้ายกัน และไม่มี SDK อย่างเป็นทางการสำหรับ React Native, Unity หรือ Unreal แต่มี REST API สาธารณะพร้อมข้อกำหนด OpenAPI 3.1 แทน คุณจึงเรียกใช้ผ่าน HTTP ล้วนหรือสร้างไคลเอนต์ของคุณเองได้:
- OpenAPI:
GET /api/v1/openapi.json - WebSocket: ดูเอกสาร Web widget สำหรับ JSON ของอีเวนต์
สร้างไคลเอนต์สำหรับภาษาที่คุณต้องการด้วย openapi-generator:
# generate a client from the public spec
npx @openapitools/openapi-generator-cli generate \
-i https://singchat.org/api/v1/openapi.json \
-g python \
-o ./singchat-clientสิ่งที่ AskAIs มีให้
นอกจากวิดเจ็ตแล้ว ความสามารถของผลิตภัณฑ์เหล่านี้พร้อมใช้งานแล้ววันนี้:
- กล่องข้อความรวม ครอบคลุมวิดเจ็ตเว็บ, Telegram และ WhatsApp พร้อมช่อง X (Twitter) ที่เตรียมไว้แล้ว
- AI ที่โฮสต์บนแพลตฟอร์ม: ไม่ต้องใช้คีย์ API, คิดค่าใช้จ่ายตามโทเคนพร้อมเติมเงินอัตโนมัติและส่งต่อให้เจ้าหน้าที่ หรือใช้คีย์ของคุณเอง
- ศูนย์ฝึก AI: รวบรวมข้อมูลจากเว็บไซต์ของคุณ, อัปโหลดไฟล์ PDF, Word หรือ DOCX, เพิ่มคู่ถามตอบจาก CSV และซ้อมใน Playground ก่อนเปิดใช้งาน
- ศูนย์ช่วยเหลือ 50 ภาษา สำหรับบทความบริการตนเองและคำถามที่พบบ่อย
- ไวต์เลเบลเต็มรูปแบบ ครอบคลุมทุกหน้าจอที่ลูกค้าเห็น
- การส่งมอบหลายโดเมนแบบกันการบล็อก สำหรับวิดเจ็ต
ตัวอย่างด่วน
Flutter widget
import 'package:singchat_widget/singchat_widget.dart';
// mount the themeable chat UI
SingChatWidget(
appId: 'ws_abc123',
user: SingChatUser(
externalId: 'user_42',
email: 'ada@example.com',
),
)iOS WebView
import WebKit
let webView = WKWebView(frame: view.bounds)
let url = URL(string: "https://singchat.org/api/widget-embed?appId=ws_abc123")!
webView.load(URLRequest(url: url))
view.addSubview(webView)Android WebView
val webView = WebView(this)
webView.settings.javaScriptEnabled = true
webView.loadUrl("https://singchat.org/api/widget-embed?appId=ws_abc123")
setContentView(webView)curl ดิบ
# identify against the REST API (any language, no library)
curl https://singchat.org/api/v1/auth/identify \
-H "Content-Type: application/json" \
-d '{ "appId": "ws_abc123", "email": "ada@example.com" }'