इंडेक्स
EmbeddedAssistant
(इंटरफ़ेस)AssistConfig
(मैसेज)AssistRequest
(मैसेज)AssistResponse
(मैसेज)AssistResponse.EventType
(enum)AudioInConfig
(मैसेज)AudioInConfig.Encoding
(enum)AudioOut
(मैसेज)AudioOutConfig
(मैसेज)AudioOutConfig.Encoding
(enum)DebugConfig
(मैसेज)DebugInfo
(मैसेज)DeviceAction
(मैसेज)DeviceConfig
(मैसेज)DeviceLocation
(मैसेज)DialogStateIn
(मैसेज)DialogStateOut
(मैसेज)DialogStateOut.MicrophoneMode
(enum)ScreenOut
(मैसेज)ScreenOut.Format
(enum)ScreenOutConfig
(मैसेज)ScreenOutConfig.ScreenMode
(enum)SpeechRecognitionResult
(मैसेज)
EmbeddedAssistant
ऐसी सेवा जो Google Assistant API को लागू करती है.
असिस्ट | |
---|---|
जोड़ी गई Assistant सेवा से बातचीत शुरू करता है या उसे जारी रखता है. हर कॉल एक दोतरफ़ा यात्रा करता है, जिसमें सेवा को ऑडियो अनुरोध भेजा जाता है और ऑडियो जवाब मिलता है. नतीजे पाने के लिए, ऑडियो भेजने के दौरान बातचीत एक या इससे ज़्यादा gRPC कनेक्शन होते हैं. हर कनेक्शन में, स्ट्रीम किए गए कई अनुरोध और जवाब शामिल होते हैं. उदाहरण के लिए, उपयोगकर्ता मेरी ख़रीदारी की सूची में जोड़ो कहता है और Assistant जवाब देती है कि तुम क्या जोड़ना चाहती हो?. पहले gRPC मैसेज में, स्ट्रीम किए गए अनुरोधों और जवाबों का क्रम यह हो सकता है:
इसके बाद, उपयोगकर्ता बैगल कहता है और Assistant जवाब देती है, ठीक है, मैंने आपकी ख़रीदारी की सूची में बैगल जोड़ दिए हैं. इसे स्ट्रीम किए गए अनुरोधों और जवाबों के साथ, फिर से
हालांकि, जवाबों के सटीक क्रम की कोई गारंटी नहीं है, लेकिन क्रम में चलने वाले
|
AssistConfig
AssistRequest
मैसेज को प्रोसेस करने का तरीका बताता है.
फ़ील्ड | ||
---|---|---|
audio_out_config |
ज़रूरी है: इससे पता चलता है कि किस ऑडियो को फ़ॉर्मैट किया जाएगा. |
|
screen_out_config |
ज़रूरी नहीं: जब सर्वर विज़ुअल स्क्रीन रिस्पॉन्स दिखाता है, तो यह उस फ़ॉर्मैट के बारे में बताता है जिसका इस्तेमाल करना है. |
|
dialog_state_in |
ज़रूरी है यह डायलॉग बॉक्स की मौजूदा स्थिति दिखाता है. |
|
device_config |
डिवाइस कॉन्फ़िगरेशन, जो किसी खास डिवाइस की पहचान करता है. |
|
debug_config |
पूरे |
|
यूनियन फ़ील्ड
|
||
audio_in_config |
इस ऐप्लिकेशन से आने वाले अगले ऑडियो को प्रोसेस करने का तरीका बताया जाता है. अगर बाद के अनुरोधों में |
|
text_query |
Assistant को भेजा जाने वाला टेक्स्ट इनपुट. ऑडियो इनपुट उपलब्ध न होने पर, टेक्स्ट इंटरफ़ेस से अपने-आप जानकारी भरी जा सकती है. |
AssistRequest
क्लाइंट से मिला टॉप लेवल मैसेज. क्लाइंट को कम से कम दो और आम तौर पर कई AssistRequest
मैसेज भेजने होंगे. पहले मैसेज में config
मैसेज होना चाहिए और इसमें audio_in
डेटा नहीं होना चाहिए. बाद के सभी मैसेज में audio_in
डेटा होना चाहिए और config
मैसेज नहीं होना चाहिए.
फ़ील्ड | ||
---|---|---|
यूनियन फ़ील्ड type . हर AssistRequest में, इनमें से कोई एक फ़ील्ड दिया जाना चाहिए. type इनमें से सिर्फ़ एक हो सकता है: |
||
config |
|
|
audio_in |
पहचाना जाने वाला ऑडियो डेटा. ऑडियो डेटा के कई हिस्से, क्रम में चलने वाले |
AssistResponse
क्लाइंट को मिला टॉप लेवल मैसेज. एक या उससे ज़्यादा AssistResponse
मैसेज की सीरीज़, क्लाइंट को वापस स्ट्रीम की जाती है.
फ़ील्ड | |
---|---|
event_type |
आउटपुट-ओनली, इवेंट टाइप के बारे में बताता है. |
audio_out |
आउटपुट-ओनली वह ऑडियो जिसमें क्वेरी के लिए Assistant का जवाब दिया गया हो. |
screen_out |
आउटपुट-ओनली में, क्वेरी के लिए Assistant का विज़ुअल रिस्पॉन्स शामिल होता है. |
device_action |
आउटपुट-ओनली में, सही पेलोड और सिमैंटिक पार्सिंग के साथ, क्वेरी से ट्रिगर की गई कार्रवाई शामिल होती है. |
speech_results[] |
सिर्फ़ आउटपुट के लिए इस दोहराई गई सूची में बोली पहचानने के नतीजे शून्य या इससे ज़्यादा हैं. ये नतीजे प्रोसेस किए जा रहे ऑडियो के लगातार वाले हिस्सों से शुरू होते हैं. सबसे पहले वाले ऑडियो (और सबसे स्थिर हिस्से) से मिलते-जुलते हिस्से से सबसे हाल के ऑडियो का गाना शुरू होता है. स्ट्रिंग को जोड़ा जा सकता है, ताकि पूरा रिस्पॉन्स देखा जा सके. बोली पहचान पूरी हो जाने पर, इस सूची में |
dialog_state_out |
आउटपुट-ओनली में, उपयोगकर्ता की क्वेरी से जुड़ा आउटपुट शामिल होता है. |
debug_info |
डेवलपर के लिए, डीबग करने की जानकारी सिर्फ़ आउटपुट के लिए. अनुरोध सिर्फ़ तब वापस किया जाता है, जब |
EventType
यह बताता है कि इवेंट किस तरह का है.
Enums | |
---|---|
EVENT_TYPE_UNSPECIFIED |
कोई इवेंट मौजूद नहीं है. |
END_OF_UTTERANCE |
इस इवेंट से पता चलता है कि सर्वर ने उपयोगकर्ता की बोली की बातचीत के खत्म हो जाने का पता लगा लिया है. इसलिए, सर्वर को कोई और आवाज़ नहीं सुनाई देगी. इसलिए, सर्वर अतिरिक्त ऑडियो को प्रोसेस नहीं करेगा. हालांकि, हो सकता है कि बाद में सर्वर अन्य ऑडियो को भी प्रोसेस करे. क्लाइंट को अतिरिक्त ऑडियो डेटा भेजना बंद कर देना चाहिए, gRPC कनेक्शन को आधा बंद करना चाहिए, और सर्वर के gRPC कनेक्शन को बंद करने तक किसी भी अतिरिक्त नतीजे का इंतज़ार करना चाहिए. |
AudioInConfig
इस नीति से, audio_in
के उस डेटा को प्रोसेस करने का तरीका बताया जाता है जो बाद के अनुरोधों में दिया जाएगा. सुझाई गई सेटिंग के लिए, Google Assistant SDK से जुड़े सबसे सही तरीके देखें.
फ़ील्ड | |
---|---|
encoding |
सभी |
sample_rate_hertz |
सभी |
एन्कोडिंग
ऑडियो मैसेज में भेजे गए डेटा की ऑडियो एन्कोडिंग. ऑडियो एक-चैनल (मोनो) का होना चाहिए.
Enums | |
---|---|
ENCODING_UNSPECIFIED |
जानकारी नहीं दी गई. google.rpc.Code.INVALID_ARGUMENT नतीजा दिखाएगा. |
LINEAR16 |
बिना कंप्रेस किए 16-बिट साइन किए हुए लिटिल-एंडियन सैंपल (लीनियर PCM). इस एन्कोडिंग में कोई हेडर नहीं होता, सिर्फ़ रॉ ऑडियो बाइट शामिल होती हैं. |
FLAC |
FLAC (मुफ़्त लॉसलेस ऑडियो कोडेक) एन्कोडिंग का सुझाव दिया जाता है, क्योंकि इससे कोई नुकसान नहीं होता--इसलिए, पहचान से छेड़छाड़ नहीं की जाती--और इसमें LINEAR16 की करीब आधी बैंडविथ होनी चाहिए. इस एन्कोडिंग में FLAC स्ट्रीम हेडर के बाद ऑडियो डेटा शामिल होता है. यह 16-बिट और 24-बिट वाले सैंपल के साथ काम करता है. हालांकि, STREAMINFO के सभी फ़ील्ड काम नहीं करते. |
AudioOut
वह ऑडियो जिसमें क्वेरी के लिए Assistant का जवाब शामिल है. ऑडियो डेटा के कई हिस्से, क्रम में चलने वाले AssistResponse
मैसेज में मिलते हैं.
फ़ील्ड | |
---|---|
audio_data |
आउटपुट-ओनली ऑडियो डेटा, जिसमें क्वेरी के लिए Assistant का जवाब शामिल होता है. ऑडियो डेटा के कई हिस्से, क्रम में चलने वाले |
AudioOutConfig
यह नीति audio_out
मैसेज दिखाने के लिए, सर्वर को इस्तेमाल करने के लिए पसंदीदा फ़ॉर्मैट बताती है.
फ़ील्ड | |
---|---|
encoding |
ज़रूरी है सभी |
sample_rate_hertz |
ज़रूरी है |
volume_percentage |
ज़रूरी है डिवाइस के ऑडियो आउटपुट की मौजूदा वॉल्यूम सेटिंग. वैल्यू 1 से 100 के बीच की होती हैं, जो 1% से 100% के बीच होती हैं. |
एन्कोडिंग
ऑडियो मैसेज में दिखाए गए डेटा की ऑडियो एन्कोडिंग. सभी एन्कोडिंग रॉ ऑडियो बाइट होती हैं, जिनमें कोई हेडर नहीं होता. हालांकि, यहां बताया गया है कि डेटा को कोड में बदलने के लिए कौनसे तरीके इस्तेमाल किए जाते हैं.
Enums | |
---|---|
ENCODING_UNSPECIFIED |
जानकारी नहीं दी गई. google.rpc.Code.INVALID_ARGUMENT नतीजा दिखाएगा. |
LINEAR16 |
बिना कंप्रेस किए 16-बिट साइन किए हुए लिटिल-एंडियन सैंपल (लीनियर PCM). |
MP3 |
MP3 ऑडियो एन्कोडिंग. सैंपल रेट को पेलोड में एन्कोड किया जाता है. |
OPUS_IN_OGG |
ओजीजी कंटेनर में रैप किया गया Opus-एन्कोडेड ऑडियो. इससे एक ऐसी फ़ाइल बनेगी जिसे मूल रूप से Android पर और कुछ ब्राउज़र (जैसे Chrome) में चलाया जा सकता है. समान बिटरेट का इस्तेमाल करने पर, कोड में बदलने के तरीके की क्वालिटी MP3 से काफ़ी बेहतर होती है. सैंपल रेट को पेलोड में एन्कोड किया जाता है. |
DebugConfig
मौजूदा अनुरोध के लिए पैरामीटर डीबग करना.
फ़ील्ड | |
---|---|
return_debug_info |
अगर इस फ़ील्ड को 'सही है' पर सेट किया जाता है, तो |
DebugInfo
डेवलपर के लिए डीबग की जानकारी. अनुरोध सिर्फ़ तब वापस किया जाता है, जब return_debug_info
को 'सही' पर सेट किया जाता है.
फ़ील्ड | |
---|---|
aog_agent_to_assistant_json |
Google सर्वर पर ऐक्शन-ऑन-Google एजेंट से मिला मूल JSON रिस्पॉन्स. AppResponse देखें. यह जानकारी सिर्फ़ तब अपने-आप भरी जाएगी, जब अनुरोध करने वाले के पास AoG प्रोजेक्ट का मालिकाना हक हो और AoG प्रोजेक्ट 'झलक देखें' मोड में हो. |
DeviceAction
अगर उपयोगकर्ता ने डिवाइस पर की गई कार्रवाई को ट्रिगर किया है, तो डिवाइस को रिस्पॉन्स मिलता है. उदाहरण के लिए, लाइट चालू करें क्वेरी के साथ काम करने वाले डिवाइस को, अनुरोध के सिमैंटिक वाले JSON पेलोड के साथ DeviceAction
मिलेगा.
फ़ील्ड | |
---|---|
device_request_json |
वह JSON जिसमें, डिवाइस के लिए ट्रिगर की गई कार्रवाई के व्याकरण से जनरेट किए गए डिवाइस के निर्देश का इस्तेमाल किया गया है. यह फ़ॉर्मैट, दिए गए trait के लिए |
DeviceConfig
ज़रूरी फ़ील्ड, जो Assistant को डिवाइस की पहचान करते हैं.
यह भी देखें:
फ़ील्ड | |
---|---|
device_id |
डिवाइस के लिए यूनीक आइडेंटिफ़ायर ज़रूरी है. आईडी में 128 या उससे कम वर्ण होने चाहिए. उदाहरण के लिए: DBCDW098234. यह डिवाइस रजिस्ट्रेशन से लौटाए गए device_id से मेल खाना चाहिए. इस device_id का इस्तेमाल, उपयोगकर्ता के रजिस्टर किए गए डिवाइसों से मिलान करने के लिए किया जाता है, ताकि इस डिवाइस पर काम करने वाली विशेषताओं और क्षमताओं को देखा जा सके. यह जानकारी सभी डिवाइस फिर चालू होने पर नहीं बदलनी चाहिए. हालांकि, इसे फ़ैक्ट्री डिफ़ॉल्ट रीसेट करने पर सेव नहीं किया जाना चाहिए. |
device_model_id |
डिवाइस मॉडल के लिए ज़रूरी है. device_model_id और device_id का कॉम्बिनेशन, पहले से ही डिवाइस रजिस्ट्रेशन के ज़रिए जुड़ा होना चाहिए. |
DeviceLocation
जगहों के तीन सोर्स होते हैं. इन्हें इस प्राथमिकता के साथ इस्तेमाल किया जाता है:
- यह
DeviceLocation
, मुख्य रूप से जीपीएस वाले मोबाइल डिवाइसों के लिए इस्तेमाल किया जाता है . - डिवाइस सेटअप के दौरान उपयोगकर्ता की ओर से तय की गई जगह; यह हर उपयोगकर्ता के लिए हर डिवाइस के हिसाब से है. अगर
DeviceLocation
के बारे में नहीं बताया गया है, तो इस जगह की जानकारी का इस्तेमाल किया जाता है. - आईपी पते के आधार पर अनुमानित जगह. इसका इस्तेमाल सिर्फ़ तब किया जाता है, जब ऊपर दी गई शर्तों में से किसी के बारे में न बताया गया हो.
फ़ील्ड | |
---|---|
coordinates |
डिवाइस का अक्षांश और देशांतर. |
DialogStateIn
डायलॉग बॉक्स की मौजूदा स्थिति के बारे में जानकारी देता है.
फ़ील्ड | |
---|---|
conversation_state |
ज़रूरी है इस फ़ील्ड को हमेशा |
language_code |
आईईटीएफ़ BCP 47 सिंटैक्स में अनुरोध की ज़रूरी भाषा. उदाहरण के लिए, "en-US". ज़्यादा जानकारी के लिए भाषा से जुड़ी सहायता देखें. अगर आपने अपने फ़ोन के Google Assistant ऐप्लिकेशन के सेटिंग मेन्यू का इस्तेमाल करके, इस |
device_location |
ज़रूरी नहीं डिवाइस की जगह की जानकारी जहां से क्वेरी की गई है. |
is_new_conversation |
ज़रूरी नहीं सही होने पर, सर्वर, अनुरोध को नई बातचीत के तौर पर मानेगा और पिछले अनुरोध की स्थिति का इस्तेमाल नहीं करेगा. जब बातचीत फिर से शुरू की जाए, तब इस फ़ील्ड को 'सही' पर सेट करें. उदाहरण के लिए, डिवाइस को फिर से चालू करने के बाद या पिछली क्वेरी के काफ़ी समय बाद. |
DialogStateOut
उपयोगकर्ता की क्वेरी से मिलने वाली डायलॉग की स्थिति. इनमें से कई मैसेज मिल सकते हैं.
फ़ील्ड | |
---|---|
supplemental_display_text |
आउटपुट-ओनली, Assistant की मदद से दिखने वाला पूरक टेक्स्ट. यह वही बात हो सकती है जो |
conversation_state |
बाद के |
microphone_mode |
आउटपुट-ओनली, इस |
volume_percentage |
आउटपुट-ओनली आवाज़ के लेवल को अपडेट किया गया. जब तक आवाज़ बढ़ाएं या आवाज़ का लेवल 4 सेट करें जैसा कोई बोला गया निर्देश नहीं मिलता, तब तक वैल्यू को 0 या उसमें कोई बदलाव नहीं किया जाएगा. इस स्थिति में, वैल्यू 1 से 100 (1% से 100% के नए वॉल्यूम लेवल के हिसाब से) के बीच होगी. आम तौर पर, क्लाइंट को |
MicrophoneMode
Assist
RPC पूरा होने के बाद माइक्रोफ़ोन की संभावित स्थितियां.
Enums | |
---|---|
MICROPHONE_MODE_UNSPECIFIED |
कोई मोड दर्ज नहीं है. |
CLOSE_MICROPHONE |
इस सेवा को उपयोगकर्ता से फ़ॉलो-ऑन सवाल की उम्मीद नहीं होनी चाहिए. माइक्रोफ़ोन तब तक बंद रहना चाहिए, जब तक उपयोगकर्ता उसे फिर से चालू न कर दे. |
DIALOG_FOLLOW_ON |
इस सेवा को उपयोगकर्ता से फ़ॉलो-ऑन सवाल की उम्मीद होती है. AudioOut प्लेबैक पूरा होने पर माइक्रोफ़ोन फिर से चालू होना चाहिए (नया ऑडियो भेजने के लिए, नया Assist RPC कॉल शुरू करके). |
ScreenOut
क्वेरी के लिए Assistant का विज़ुअल आउटपुट जवाब. screen_out_config
ने चालू किया.
फ़ील्ड | |
---|---|
format |
आउटपुट-ओनली, स्क्रीन के दिए गए डेटा का फ़ॉर्मैट. |
data |
आउटपुट-ओनली, स्क्रीन का रॉ डेटा, जिसे Assistant से जुड़ी क्वेरी के नतीजे के तौर पर दिखाया जाता है. |
फ़ॉर्मैट
स्क्रीन डेटा के संभावित फ़ॉर्मैट.
Enums | |
---|---|
FORMAT_UNSPECIFIED |
कोई फ़ॉर्मैट नहीं दिया गया है. |
HTML |
डेटा में पूरी तरह से तैयार HTML5 लेआउट शामिल होगा, जिसे UTF-8 से एन्कोड किया गया होगा, जैसे कि <html><body><div>...</div></body></html> . इसे ऑडियो रिस्पॉन्स के साथ रेंडर किया जाना है. ध्यान दें कि HTML5 doctype को असल एचटीएमएल डेटा में शामिल किया जाना चाहिए. |
ScreenOutConfig
यह नीति screen_out
रिस्पॉन्स दिखाने के दौरान, सर्वर को इस्तेमाल करने के लिए अपनी पसंद के फ़ॉर्मैट के बारे में बताती है.
फ़ील्ड | |
---|---|
screen_mode |
क्वेरी जारी करते समय, डिवाइस के लिए मौजूदा विज़ुअल स्क्रीन-मोड. |
ScreenMode
डिवाइस पर विज़ुअल स्क्रीन-आउटपुट के संभावित मोड.
Enums | |
---|---|
SCREEN_MODE_UNSPECIFIED |
कोई वीडियो मोड दर्ज नहीं है. Assistant OFF मोड में जवाब दे सकती है. |
OFF |
स्क्रीन बंद है (या स्क्रीन की रोशनी या अन्य सेटिंग को इतनी कम सेट किया गया है कि वह नहीं दिखती). आम तौर पर, Assistant इस मोड में स्क्रीन पर जवाब नहीं देगी. |
PLAYING |
आम तौर पर, इस मोड में Assistant सिर्फ़ स्क्रीन के कुछ हिस्से पर ही जवाब देती है. |
SpeechRecognitionResult
उपयोगकर्ता के बोले गए वाक्यांश का अनुमानित ट्रांसक्रिप्शन. यह एक सेगमेंट हो सकता है या उपयोगकर्ता की बोली गई क्वेरी का पूरा अनुमान हो सकता है.
फ़ील्ड | |
---|---|
transcript |
सिर्फ़ आउटपुट के लिए ट्रांसक्रिप्ट टेक्स्ट, जो उपयोगकर्ता के बोले गए शब्दों को दिखाता है. |
stability |
आउटपुट-ओनली: इस बात की संभावना का अनुमान कि Assistant इस नतीजे के बारे में अपना अनुमान नहीं बदलेगी. वैल्यू की रेंज 0.0 (पूरी तरह से अस्थिर) से लेकर 1.0 (पूरी तरह से स्थिर और आखिरी) तक है. 0.0 की डिफ़ॉल्ट वैल्यू एक सेंटिनल वैल्यू है, जिससे पता चलता है कि |