ইন্টারেক্টিভ ক্যানভাস API রেফারেন্স

ইন্টারেক্টিভ ক্যানভাস এপিআই হল একটি জাভাস্ক্রিপ্ট লাইব্রেরি যা আপনি আপনার ওয়েব অ্যাপে 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

TTS বাজানোর পর মাইক খুলতে হবে কিনা।

CreateIntentHandler

createIntentHandler(intentId, callback) returns IntentHandler

একটি NLU কাস্টম অভিপ্রায়ের জন্য একটি অভিপ্রায় হ্যান্ডলার তৈরি করে।

পরামিতি
intentId string

অ্যাকশন বিল্ডারে সংজ্ঞায়িত অভিপ্রায়ের নাম।

callback function( MatchedIntent )

উদ্দেশ্য মিলে গেলে কার্য সম্পাদন করা হবে।

IntentHandler object

ইন্টেন্ট হ্যান্ডলার অবজেক্ট যা expect() ব্যবহার করে নিবন্ধিত হতে পারে।

ইন্টেন্টহ্যান্ডলার

একটি উদ্দেশ্য হ্যান্ডলার প্রতিনিধিত্ব করে একটি বস্তু. expect() বা prompt() ব্যবহার করে নিবন্ধিত হতে পারে।

ম্যাচডইন্টেন্ট

একটি মিলিত অভিপ্রায়ের জন্য ডেটা ধারণকারী একটি বস্তু।

পদ্ধতি
getIntentArg(parameterName) function(string)

একটি মিলে যাওয়া অভিপ্রায়ের উদ্দেশ্য প্যারামিটার পাওয়ার পদ্ধতি।

নম্বর স্লট তৈরি করুন

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

টাইপ নম্বরের একটি স্লট তৈরি করে।

পরামিতি
callback function( FilledSlot )

স্লট পূর্ণ হলে কার্য সম্পাদন করা হবে।

hints Hints

ছোট শব্দ যা ব্যবহারকারী একটি স্লট পূরণ করার সময় বলতে পারে। hints NLU সিস্টেমকে কোন স্লটটি পূরণ করতে হবে তা সিদ্ধান্ত নিতে সাহায্য করে।

Slot object

স্লট অবজেক্ট যা prompt() ব্যবহার করে নিবন্ধিত হতে পারে।

টেক্সটস্লট তৈরি করুন

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

টাইপ স্ট্রিং একটি স্লট তৈরি করে.

পরামিতি
callback function( FilledSlot )

স্লট পূর্ণ হলে কার্য সম্পাদন করা হবে।

hints Hints

ছোট শব্দ যা ব্যবহারকারী একটি স্লট পূরণ করার সময় বলতে পারে। hints NLU সিস্টেমকে কোন স্লটটি পূরণ করতে হবে তা সিদ্ধান্ত নিতে সাহায্য করে।

Slot object

স্লট অবজেক্ট যা prompt() ব্যবহার করে নিবন্ধিত হতে পারে।

কনফার্মেশন স্লট তৈরি করুন

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

বুলিয়ান টাইপের একটি স্লট তৈরি করে।

পরামিতি
callback function( FilledSlot )

স্লট পূর্ণ হলে কার্য সম্পাদন করা হবে।

hints Hints

ছোট শব্দ যা ব্যবহারকারী একটি স্লট পূরণ করার সময় বলতে পারে। hints NLU সিস্টেমকে কোন স্লটটি পূরণ করতে হবে তা সিদ্ধান্ত নিতে সাহায্য করে।

Slot object

স্লট অবজেক্ট যা prompt() ব্যবহার করে নিবন্ধিত হতে পারে।

createOptionsSlot

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

বিকল্পগুলির একটি পূর্ব-নির্ধারিত তালিকা থেকে একটি স্লট তৈরি করে।

পরামিতি
options array< Option >

স্লট পূর্ণ হলে কার্য সম্পাদন করা হবে।

callback function( FilledSlot )

স্লট পূর্ণ হলে কার্য সম্পাদন করা হবে।

hints Hints

ছোট শব্দ যা ব্যবহারকারী একটি স্লট পূরণ করার সময় বলতে পারে। hints NLU সিস্টেমকে কোন স্লটটি পূরণ করতে হবে তা সিদ্ধান্ত নিতে সাহায্য করে।

Slot object

স্লট অবজেক্ট যা prompt() ব্যবহার করে নিবন্ধিত হতে পারে।

স্লট

একটি স্লট পূরণ করার জন্য একটি বস্তু প্রতিনিধিত্ব করে৷ expect() বা prompt() ব্যবহার করে নিবন্ধিত হতে পারে।

ভরাট স্লট<T>

একটি ভরাট স্লট প্রতিনিধিত্বকারী একটি বস্তু।

প্যারামিটার
T boolean|number|string

স্লট টাইপ.

অপশন

একটি বস্তু একটি স্লট টাইপ এন্ট্রি প্রতিনিধিত্ব করে.

ক্ষেত্র
key string

স্লট টাইপ এন্ট্রির জন্য অনন্য শনাক্তকারী।

synonyms array<string>

স্লট বিকল্প নির্বাচন করতে ব্যবহৃত শব্দের একটি তালিকা।

ইঙ্গিত

একটি স্লটের জন্য ইঙ্গিত প্রতিনিধিত্বকারী একটি বস্তু।

ক্ষেত্র
associatedWords array<string>

কোন স্লট পূরণ করতে হবে তা নির্ধারণ করতে NLU সিস্টেমকে সাহায্য করতে ব্যবহৃত শব্দের একটি তালিকা।

আশা করা

expect(expectation) returns HandlerRegistration

ক্লায়েন্টের উপর প্রত্যাশা নিবন্ধন করে। অভিপ্রায় হ্যান্ডলার এবং স্লটে কল করা যেতে পারে।

পরামিতি
expectation IntentHandler | Slot

অভিপ্রায় হ্যান্ডলার বা স্লট নিবন্ধিত করা হবে.

HandlerRegistration object

নিবন্ধিত অভিপ্রায় হ্যান্ডলার বা স্লট।

হ্যান্ডলার নিবন্ধন

একটি বস্তু নিবন্ধিত অভিপ্রায় হ্যান্ডলার প্রতিনিধিত্ব করে.

পদ্ধতি
deleteHandler() function

প্রত্যাশিত অভিপ্রায় হ্যান্ডলারকে নিবন্ধনমুক্ত করে।

স্পষ্ট প্রত্যাশা

clearExpectations() returns undefined;

সমস্ত পূর্বে নিবন্ধিত অভিপ্রায় হ্যান্ডলার এবং স্লটগুলি মুছে ফেলার মাধ্যমে সমস্ত প্রত্যাশা সরিয়ে দেয়৷

প্রম্পট

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

প্রদত্ত TTS স্ট্রিং সহ ব্যবহারকারীকে অনুরোধ করে এবং ক্লায়েন্টের উপর প্রত্যাশা নিবন্ধন করে। অভিপ্রায় হ্যান্ডলার এবং স্লটে কল করা যেতে পারে।

পরামিতি
tts string

TTS স্ট্রিং ব্যবহারকারীকে প্রদত্ত প্রত্যাশার জন্য অনুরোধ করতে ব্যবহৃত হয়।

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

triggerScene() এ কলের স্থিতি।

নিম্নলিখিতগুলির মধ্যে একটি:

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() returns Promise<void>;

সমস্ত ব্যবহারকারীর পরামিতি সাফ করে।

সেটহোমপরাম

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() returns Promise<void>;

সমস্ত ব্যবহারকারীর পরামিতি সাফ করে।

সেট ক্যানভাসস্টেট

setCanvasState(state) returns undefined

অ্যাসিস্ট্যান্টকে জানিয়ে দেয় যে ক্যানভাস ওয়েব অ্যাপ তার অবস্থা আপডেট করেছে। setCanvasState পদ্ধতি একটি মান প্রদান করে না। রাজ্যের পেলোড conv.context.canvas.state সম্পত্তির মাধ্যমে অ্যাক্সেস করা যেতে পারে।

পরামিতি
state Object

JSON অবজেক্ট হিসেবে ক্যানভাস অ্যাপের আপডেট করা অবস্থা।

ইন্টারেক্টিভ ক্যানভাস কলব্যাক

এই কলব্যাকগুলি আপনাকে আপনার কথোপকথনমূলক অ্যাকশন থেকে তথ্য বা অনুরোধগুলির প্রতিক্রিয়া জানাতে একটি উপায় প্রদান করে যখন পদ্ধতিগুলি আপনার কথোপকথনমূলক অ্যাকশনে তথ্য বা অনুরোধ পাঠানোর একটি উপায় প্রদান করে।

on Update

onUpdate(data) returns Promise|undefined

কথোপকথনমূলক অ্যাকশন থেকে একটি Canvas প্রতিক্রিয়া পাঠানো হলে কল করা হয়। প্রত্যাবর্তিত প্রতিশ্রুতির সমাধান হলে TTS শুরু হবে, বা 10 সেকেন্ড পরে সময় শেষ হবে।

পরামিতি
data Object

ওয়েবহুক দ্বারা পাঠানো ডেটা আপডেট করা হয়েছে৷

onTtsMark

onTtsMark(markName) returns undefined

TTS প্লেব্যাকের সময় কলব্যাক করা হয়।

বিশেষ চিহ্ন যা সর্বদা ট্রিগার হয়:

  • START টিটিএসের শুরু নির্দেশ করে।
  • END TTS এর শেষ নির্দেশ করে।
  • ERROR TTS বাজানো একটি ত্রুটি নির্দেশ করে।

আপনি SSML এবং <mark> ট্যাগ ব্যবহার করেও কাস্টম চিহ্ন নির্ধারণ করতে পারেন, যেমন <mark name="custom"/> ।

পরামিতি
markName string

TTS প্লেব্যাকের সময় মার্ক নাম আহ্বান করা হয়েছে।

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

ক্যানভাস অ্যাপকে বিজ্ঞপ্তি দেয় যে অ্যাসিস্ট্যান্ট ইনপুট স্ট্যাটাস পরিবর্তিত হয়েছে।

পরামিতি
inputStatus Enum

ডিভাইসে ভয়েস এবং/অথবা টেক্সট ইনপুট প্রক্রিয়াকরণের স্থিতি। নিম্নলিখিত হতে পারে:

  • LISTENING : মাইক্রোফোন খোলা আছে।
  • IDLE : মাইক্রোফোন বন্ধ।
  • PROCESSING : অ্যাসিস্ট্যান্ট বর্তমানে একটি কোয়েরি চালাচ্ছে (মাইক্রোফোন বন্ধ)।