इंटरैक्टिव Canvas API का रेफ़रंस

इंटरैक्टिव कैनवस एपीआई एक JavaScript लाइब्रेरी है, जिसका इस्तेमाल आप इंटरफ़ेस (यूआई) के लिए करते हैं आपके वेब ऐप्लिकेशन में interactiveCanvas ऑब्जेक्ट का इस्तेमाल करके, बातचीत वाली कार्रवाई के साथ सेट अप किया जा सकता है.

इंटरैक्टिव कैनवस ऐप्लिकेशन के बारे में ज़्यादा जानकारी पाने के लिए, इंटरैक्टिव कैनवस पर जाएं दस्तावेज़ में दिया गया है.

तरीके

तैयार

ready(callbacks) returns undefined

कॉलबैक रजिस्टर करने के लिए लोड होने के बाद, Interactive Canvas वेब ऐप्लिकेशन कॉल करता है.

पैरामीटर
callbacks	InteractiveCanvasCallbacks एक ऑब्जेक्ट जिसमें तरीके के कॉलबैक शामिल हैं.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

बातचीत वाली कार्रवाई के लिए टेक्स्ट क्वेरी भेजता है.

पैरामीटर
textQuery	string बातचीत वाली कार्रवाई पर भेजने के लिए क्वेरी.
state	string निम्न में से एक: READY: प्लैटफ़ॉर्म, अनुरोध स्वीकार कर सकता है. BLOCKED: फ़्लाइट में कोई क्वेरी है और नई क्वेरी को छोड़ दिया जाएगा. UNKNOWN: क्वेरी की मौजूदा स्थिति का पता नहीं लगाया जा सका.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

डिसप्ले में सबसे ऊपर मौजूद हेडर की ऊंचाई तय करता है.

पैरामीटर
height	number पिक्सल में ऊंचाई.

outputTts

outputTts(text, openMic) returns undefined;

SSML टेक्स्ट चलाता है.

पैरामीटर
text	string चलाई जाने वाली SSML स्ट्रिंग.
openMic	boolean टीटीएस के चलने के बाद माइक चालू करना है या नहीं.

createIntentHandler

createIntentHandler(intentId, callback) returns IntentHandler

एनएलयू कस्टम इंटेंट के लिए इंटेंट हैंडलर बनाता है.

पैरामीटर
intentId	string ऐक्शन बिल्डर में तय किए गए इंटेंट का नाम.
callback	function(MatchedIntent) इंटेंट के मेल खाने पर, एक्ज़ीक्यूट किया जाने वाला फ़ंक्शन.
IntentHandler	object इंटेंट हैंडलर ऑब्जेक्ट, जिसे expect() का इस्तेमाल करके रजिस्टर किया जा सकता है.

IntentHandler

इंटेंट हैंडलर को दिखाने वाला ऑब्जेक्ट. इसे expect() या prompt() का इस्तेमाल करके रजिस्टर किया जा सकता है.

MatchedIntent

एक ऑब्जेक्ट, जिसमें मैच होने वाले इंटेंट का डेटा होता है.

तरीके
getIntentArg(parameterName)	function(string) मैच होने वाले इंटेंट का इंटेंट पैरामीटर पाने का तरीका.

createNumberSlot

createNumberSlot(callback, hints?) returns Slot<number>

टाइप नंबर का स्लॉट बनाता है.

पैरामीटर
callback	function(FilledSlot) स्लॉट भर जाने पर एक्ज़ीक्यूट किया जाने वाला फ़ंक्शन.
hints	Hints छोटे शब्द जो उपयोगकर्ता स्लॉट भरते समय कह सकते हैं. hints अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इससे एनएलयू सिस्टम को यह तय करने में मदद मिलती है कि कौनसा स्लॉट भरना है.
Slot	object prompt() का इस्तेमाल करके रजिस्टर किया जा सकने वाला स्लॉट ऑब्जेक्ट.

createTextSlot

createTextSlot(callback, hints?) returns Slot<string>

स्ट्रिंग टाइप का एक स्लॉट बनाता है.

पैरामीटर
callback	function(FilledSlot) स्लॉट भर जाने पर एक्ज़ीक्यूट किया जाने वाला फ़ंक्शन.
hints	Hints छोटे शब्द जो उपयोगकर्ता स्लॉट भरते समय कह सकते हैं. hints अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इससे एनएलयू सिस्टम को यह तय करने में मदद मिलती है कि कौनसा स्लॉट भरना है.
Slot	object prompt() का इस्तेमाल करके रजिस्टर किया जा सकने वाला स्लॉट ऑब्जेक्ट.

createConfirmationSlot

createConfirmationSlot(callback, hints?) returns Slot<boolean>

बूलियन टाइप का एक स्लॉट बनाता है.

पैरामीटर
callback	function(FilledSlot) स्लॉट भर जाने पर एक्ज़ीक्यूट किया जाने वाला फ़ंक्शन.
hints	Hints छोटे शब्द जो उपयोगकर्ता स्लॉट भरते समय कह सकते हैं. hints अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इससे एनएलयू सिस्टम को यह तय करने में मदद मिलती है कि कौनसा स्लॉट भरना है.
Slot	object prompt() का इस्तेमाल करके रजिस्टर किया जा सकने वाला स्लॉट ऑब्जेक्ट.

createOptionsSlot

createOptionsSlot(options, callback, hints?) returns Slot<string>

विकल्पों की पहले से तय सूची से एक स्लॉट बनाता है.

पैरामीटर
options	array<Option> स्लॉट भर जाने पर एक्ज़ीक्यूट किया जाने वाला फ़ंक्शन.
callback	function(FilledSlot) स्लॉट भर जाने पर एक्ज़ीक्यूट किया जाने वाला फ़ंक्शन.
hints	Hints छोटे शब्द जो उपयोगकर्ता स्लॉट भरते समय कह सकते हैं. hints अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इससे एनएलयू सिस्टम को यह तय करने में मदद मिलती है कि कौनसा स्लॉट भरना है.
Slot	object prompt() का इस्तेमाल करके रजिस्टर किया जा सकने वाला स्लॉट ऑब्जेक्ट.

स्लॉट

भरे जाने वाले स्लॉट को दिखाने वाला ऑब्जेक्ट. इसे expect() या prompt() का इस्तेमाल करके रजिस्टर किया जा सकता है.

FilledSlot<T>

भरे हुए स्लॉट को दिखाने वाला ऑब्जेक्ट.

पैरामीटर
T	boolean|number|string स्लॉट का टाइप.

विकल्प

स्लॉट टाइप की एंट्री को दिखाने वाला ऑब्जेक्ट.

फ़ील्ड
key	string स्लॉट टाइप की एंट्री के लिए यूनीक आइडेंटिफ़ायर.
synonyms	array<string> स्लॉट विकल्प को चुनने के लिए इस्तेमाल किए गए शब्दों की सूची.

संकेत

स्लॉट के लिए संकेत दिखाने वाला ऑब्जेक्ट.

फ़ील्ड
associatedWords	array<string> ऐसे शब्दों की सूची जिनका इस्तेमाल करके NLU सिस्टम यह तय करता है कि कौनसा स्लॉट भरना है.

मुझे यह सुनना है

expect(expectation) returns HandlerRegistration

क्लाइंट पर उम्मीद को रजिस्टर करता है. इंटेंट हैंडलर और स्लॉट पर कॉल किए जा सकते हैं.

पैरामीटर
expectation	IntentHandler|Slot रजिस्टर किया जाने वाला इंटेंट हैंडलर या स्लॉट.
HandlerRegistration	object रजिस्टर किया गया इंटेंट हैंडलर या स्लॉट.

HandlerRegistration

रजिस्टर किए गए इंटेंट हैंडलर को दिखाने वाला ऑब्जेक्ट.

तरीके
deleteHandler()	function अनुमानित इंटेंट हैंडलर का रजिस्ट्रेशन रद्द करता है.

clearExpectations

clearExpectations() returns undefined;

पहले से रजिस्टर किए गए इंटेंट हैंडलर और स्लॉट मिटाकर, सभी उम्मीदें हटा देता है.

मैसेज

prompt(tts, expectation) returns Promise<Answer<T>>

यह उपयोगकर्ता को दी गई टीटीएस स्ट्रिंग के बारे में बताता है. साथ ही, क्लाइंट पर उम्मीद के बारे में रजिस्टर करता है. इंटेंट हैंडलर और स्लॉट पर कॉल किए जा सकते हैं.

पैरामीटर
tts	string टीटीएस स्ट्रिंग का इस्तेमाल, उपयोगकर्ता को उसके बारे में बताने के लिए किया जाता है.
expectation	IntentHandler|Slot रजिस्टर किया जाने वाला इंटेंट हैंडलर या स्लॉट.
Answer<T>	object उपयोगकर्ता से मिला जवाब.

जवाब<T>

एक ऑब्जेक्ट, जो प्रॉम्प्ट के लिए उपयोगकर्ता से मिला जवाब दिखाता है.

फ़ील्ड
value	boolean|number|string उपयोगकर्ता से मिले जवाब की वैल्यू.
status	string जवाब की स्थिति. निम्न में से एक: ANSWERED: उपयोगकर्ता ने सवाल का जवाब देकर उसका जवाब दिया. NO_MATCH: उपयोगकर्ता को जवाब देने के लिए कहा गया. साथ ही, ऐसा जवाब दिया गया जो अनुमानित जवाब या किसी भी दूसरी उम्मीद के मुताबिक नहीं था. YIELD: उपयोगकर्ता ने अलग इंटेंट के साथ प्रॉम्प्ट का जवाब दिया.

triggerScene

triggerScene(sceneName) returns Promise<TriggerSceneStatus>

किसी सीन को ट्रिगर करता है.

पैरामीटर
sceneName	string ट्रिगर किए जाने वाले सीन का नाम.
TriggerSceneStatus	string इसके लिए ट्रिगर किए जाने वाले कॉल की स्थिति. निम्न में से एक: SUCCESS: सर्वर ने अनुरोध को प्रोसेस कर दिया. BLOCKED: फ़्लाइट में पहले से मौजूद किसी क्वेरी की वजह से, अनुरोध को ब्लॉक कर दिया गया है. UNKNOWN: अनुरोध के स्टेटस की जानकारी नहीं है.

setUserParam

setUserParam(key, value) returns Promise<undefined>;

यह की-वैल्यू पेयर को सेट करता है, जो कि बातचीत के बीच में पास किया जाता है और एक जगह पर बना रहता है.

पैरामीटर
key	string पैरामीटर कुंजी.
value	object|array|boolean|number|string पैरामीटर की वैल्यू.

getUserParam

getUserParam(key) returns Promise<object|array|boolean|number|string>;

अगर दी गई कुंजी मौजूद है, तो उसके लिए पैरामीटर मान और शुरू करने की स्थिति की जानकारी मिलती है.

पैरामीटर
key	string पैरामीटर कुंजी.

resetUserParam

resetUserParam() returns Promise<void>;

सभी उपयोगकर्ता पैरामीटर हटाता है.

setHomeParam

setHomeParam(key, value) returns Promise<undefined>;

यह की-वैल्यू पेयर को सेट करता है, जो कि बातचीत के बीच में पास किया जाता है और एक जगह पर बना रहता है.

पैरामीटर
key	string पैरामीटर कुंजी.
value	object|array|boolean|number|string पैरामीटर की वैल्यू.

getHomeParam

getHomeParam(key) returns Promise<object|array|boolean|number|string>;

अगर दी गई कुंजी मौजूद है, तो उसके लिए पैरामीटर मान और शुरू करने की स्थिति की जानकारी मिलती है.

पैरामीटर
key	string पैरामीटर कुंजी.

resetHomeParam

resetHomeParam() returns Promise<void>;

सभी उपयोगकर्ता पैरामीटर हटाता है.

setCanvasState

setCanvasState(state) returns undefined

Assistant को सूचना देता है कि कैनवस वेब ऐप्लिकेशन की स्थिति अपडेट हो गई है. कॉन्टेंट बनाने setCanvasState तरीका कोई मान नहीं दिखाता है. स्टेट पेलोड को conv.context.canvas.state प्रॉपर्टी.

पैरामीटर
state	Object JSON ऑब्जेक्ट के तौर पर, कैनवस ऐप्लिकेशन की अपडेट की गई स्थिति.

InteractiveCanvasCallbacks

इन कॉलबैक से, आपको जानकारी या अनुरोधों का जवाब देने का तरीका मिलता है 'बातचीत की सुविधा' वाली कार्रवाई से आपकी बातचीत की कार्रवाई के लिए जानकारी या अनुरोध शामिल हैं.

onUpdate

onUpdate(data) returns Promise|undefined

यह तब कॉल किया जाता है, जब बातचीत वाली कार्रवाई से Canvas का जवाब भेजा जाता है. टीटीएस तब शुरू होगा, जब इस प्रॉमिस का समाधान हो जाता है या 10 सेकंड बाद टाइम आउट हो जाता है.

पैरामीटर
data	Object वेबहुक से भेजा गया अपडेट किया गया डेटा.

onTtsMark

onTtsMark(markName) returns undefined

वह कॉलबैक जो टीटीएस प्लेबैक के दौरान शुरू होता है.

हमेशा ट्रिगर होने वाले विशेष चिह्न:

• START, टीटीएस की शुरुआत को दिखाता है.
• END बताता है कि टीटीएस खत्म हो चुका है.
• ERROR, TTS चलाने में गड़बड़ी दिखाता है.

SSML और <mark> टैग का इस्तेमाल करके भी कस्टम मार्क तय किए जा सकते हैं. जैसे, <mark name="custom"/>.

पैरामीटर
markName	string टीटीएस प्लेबैक के दौरान नाम शुरू किया गया मार्क करें.

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

कैनवस ऐप्लिकेशन को सूचना देता है कि Assistant के इनपुट का स्टेटस बदल गया है.

पैरामीटर
inputStatus	Enum डिवाइस पर आवाज़ और/या टेक्स्ट इनपुट प्रोसेस होने की स्थिति. कैन इनमें से कोई नहीं होना चाहिए: LISTENING : माइक्रोफ़ोन खुला है. IDLE : माइक्रोफ़ोन बंद है. PROCESSING : Assistant फ़िलहाल, क्वेरी (माइक्रोफ़ोन बंद है).