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

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

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

तरीके

तैयार

ready(callbacks) returns undefined

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

पैरामीटर
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

इंटेंट का नाम, जैसा कि Actions Builder में बताया गया है.

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>

शब्दों की इस सूची से एनएलयू सिस्टम को यह तय करने में मदद मिलती है कि किस स्लॉट को भरना है.

expect

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

ट्रिगरScene() को किए गए कॉल की स्थिति.

इनमें से कोई एक:

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 का मतलब है कि टीटीएस चलाने में कोई गड़बड़ी हुई है.

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

पैरामीटर
markName string

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

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

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

पैरामीटर
inputStatus Enum

डिवाइस पर आवाज़ और/या टेक्स्ट इनपुट प्रोसेसिंग की स्थिति. इनमें ये शामिल हो सकते हैं:

  • LISTENING : माइक्रोफ़ोन खुला है.
  • IDLE : माइक्रोफ़ोन बंद है.
  • PROCESSING : Assistant फ़िलहाल एक क्वेरी चला रही है (माइक्रोफ़ोन बंद है).