गाइड
SDK
एक प्रकाशित Flutter विजेट SDK, साथ ही एक REST API और OpenAPI स्पेसिफ़िकेशन जिसे किसी भी भाषा से कॉल किया जा सकता है।
AskAIs एक प्रोटोकॉल-फ़र्स्ट दृष्टिकोण अपनाता है: एक OpenAPI 3.1 स्पेसिफ़िकेशन, एक WebSocket प्रोटोकॉल, और HMAC से हस्ताक्षरित webhooks। आप 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
iOS या Android के लिए कोई अलग नेटिव SDK नहीं है। दो समर्थित रास्ते हैं:
- WebView (अनुशंसित), वेब विजेट को
/api/widget-embedसे लोड करें। यह पूर्ण-सुविधा वाला विजेट है और स्वतः अपडेट होता है, इसलिए नई चैट सुविधाएँ पाने के लिए आपको कभी ऐप का नया रिलीज़ प्रकाशित नहीं करना पड़ता। - REST API, API को सीधे कॉल करें और अपना नेटिव UI स्वयं रेंडर करें।
SwiftUI या Jetpack Compose में कोई तैयार चैट व्यू नहीं है। आप या तो WebView एम्बेड करते हैं या API के ऊपर UI स्वयं बनाते हैं।
कोई भी अन्य भाषा: REST API को कॉल करें
हम Python, Go, Rust, C#, Java, PHP, Ruby या इनके जैसे किसी के लिए पहले से बने क्लाइंट नहीं देते, और React Native, Unity या Unreal के लिए कोई आधिकारिक SDK नहीं है। इसके बजाय OpenAPI 3.1 स्पेसिफ़िकेशन के साथ एक सार्वजनिक REST API है, जिसे आप सादे HTTP से कॉल कर सकते हैं या जिसके लिए अपना क्लाइंट स्वयं जनरेट कर सकते हैं:
- OpenAPI:
GET /api/v1/openapi.json - WebSocket: इवेंट JSON के लिए Web widget दस्तावेज़ देखें
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-clientAskAIs क्या प्रदान करता है
विजेट के अलावा, ये उत्पाद क्षमताएँ आज उपलब्ध हैं:
- एकीकृत इनबॉक्स, वेब विजेट, Telegram और WhatsApp में फैला, जिसमें X (Twitter) के लिए स्लॉट तैयार है।
- प्लेटफ़ॉर्म-होस्टेड AI: कोई API कुंजी आवश्यक नहीं, टोकन के हिसाब से बिलिंग, ऑटो-टॉपअप और मानव फ़ॉलबैक के साथ, या अपनी कुंजी लाएँ।
- AI ट्रेनिंग सेंटर: अपनी साइट को क्रॉल करें, PDF, Word या DOCX फ़ाइलें अपलोड करें, CSV से प्रश्न-उत्तर जोड़े जोड़ें, और लॉन्च से पहले Playground में अभ्यास करें।
- 13-भाषा सहायता केंद्र, स्व-सेवा लेखों और FAQ के लिए।
- पूर्ण व्हाइट-लेबल, हर ग्राहक-सामना करने वाली सतह पर।
- ब्लॉक-रोधी मल्टी-डोमेन डिलीवरी, विजेट के लिए।
त्वरित उदाहरण
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" }'