Google Assistant Library

google.assistant.library पैकेज.

class google.assistant.library.Assistant(credentials, device_model_id)

Google Assistant लाइब्रेरी के लिए क्लाइंट.

Google Assistant के लिए, बुनियादी कंट्रोल फ़ंक्शन और लाइफ़साइकल मैनेज करने की सुविधा उपलब्ध कराता है. Assistant को ContextManager के तौर पर इस्तेमाल करने का सबसे सही तरीका:

with Assistant(credentials, device_model_id) as assistant:

इससे, नेटिव तरीके से लागू किए गए टूल, मेमोरी मैनेजमेंट को सही तरीके से मैनेज कर पाते हैं.

start() को कॉल करने के बाद, Assistant इवेंट की एक स्ट्रीम जनरेट करती है. इस स्ट्रीम में, Assistant की मौजूदा स्थितियों की जानकारी होती है. उदाहरण के लिए:

ON_CONVERSATION_TURN_STARTED
ON_END_OF_UTTERANCE
ON_RECOGNIZING_SPEECH_FINISHED:
    {'text': 'what time is it'}
ON_RESPONDING_STARTED:
    {'is_error_response': False}
ON_RESPONDING_FINISHED
ON_CONVERSATION_TURN_FINISHED:
    {'with_follow_on_turn': False}

सभी इवेंट और उनके आर्ग्युमेंट के बारे में जानकारी पाने के लिए, EventType देखें.

shabadawalee

  • हॉटवर्ड: यह वह वाक्यांश होता है जिसे Assistant, म्यूट न होने पर सुनती है:

    "OK Google" OR "Hey Google"

  • टर्न: उपयोगकर्ता का एक अनुरोध, जिसके बाद Assistant का जवाब.

  • बातचीत: एक या उससे ज़्यादा चरणों में, Assistant से मनमुताबिक नतीजा पाने के लिए की गई बातचीत:

    "What time is it?" -> "The time is 6:24 PM" OR
"Set a timer" -> "Okay, for how long?" ->
"5 minutes" -> "Sure, 5 minutes, starting now!"
पैरामीटर:
  • credentials (google.oauth2.credentials.Credentials) – उपयोगकर्ता के Google OAuth2 क्रेडेंशियल.
  • device_model_id (str) – वह device_model_id जो Google के साथ आपके प्रोजेक्ट के लिए रजिस्टर किया गया था. यह खाली स्ट्रिंग नहीं होनी चाहिए.
इनमें ये चीज़ें शामिल हैं:

ValueError – अगर device_model_id को 'कोई नहीं' या खाली के तौर पर छोड़ा गया था.
device_id

Assistant से जनरेट किया गया डिवाइस आईडी दिखाता है.

Google डिवाइस ऐक्शन जैसी सेवाओं का इस्तेमाल करते समय, यह वैल्यू सर्वर को आपके डिवाइस की पहचान बताती है. यह प्रॉपर्टी सिर्फ़ start() को कॉल करने के बाद भरी जाती है.

वापसी:डिवाइस आईडी को एक बार start() बुलाए जाने के बाद, खाली स्ट्रिंग.
रिटर्न टाइप:str
send_text_query(query)

Assistant को |query| भेजता है, जैसे कि उपयोगकर्ता ने बोला हो.

यह उसी तरह काम करेगा जैसे कोई उपयोगकर्ता हॉटवर्ड बोलकर क्वेरी पूछता है या किसी फ़ॉलो-अप क्वेरी का जवाब बोलता है.

पैरामीटर:query (str) – Assistant को भेजी जाने वाली टेक्स्ट क्वेरी.
set_mic_mute(is_muted)

इससे Assistant, हॉटवर्ड सुनना बंद कर देती है.

Assistant को हॉटवर्ड सुनने से रोकने की अनुमति देता है. यह सुविधा, Google Home के पीछे मौजूद निजता बटन जैसी ही है.

अगर Assistant अभी तक चालू नहीं हुई है, तो यह तरीका काम नहीं करेगा.

पैरामीटर:is_muted (bool) – True से Assistant को सुनने से रोका जाता है और False से उसे फिर से सुनने की अनुमति दी जाती है.
start()

Assistant को चालू करता है. इसमें हॉटवर्ड सुनना भी शामिल है.

start() को कॉल करने के बाद, Assistant 'डिफ़ॉल्ट' ALSA ऑडियो सोर्स से डेटा प्रोसेस करना शुरू कर देगी. साथ ही, वह हॉटवर्ड सुनने लगेगी. इससे, Assistant की अन्य सेवाएं भी शुरू हो जाएंगी. जैसे, टाइमर/अलार्म. इस तरीके को सिर्फ़ एक बार कॉल किया जा सकता है. Assistant को एक बार बोलने के बाद, वह तब तक चलती रहेगी, जब तक __exit__ को बोला नहीं जाता.

वापसी:Assistant के स्टेटस में हुए बदलावों की सूचना देने वाले इवेंट की सूची.
रिटर्न टाइप:google.assistant.event.IterableEventQueue
start_conversation()

Assistant के साथ मैन्युअल तरीके से नई बातचीत शुरू करता है.

उपयोगकर्ता की बातचीत को रिकॉर्ड करना और उसे Google को भेजना शुरू करता है. यह ठीक वैसा ही होता है जैसे Assistant को हॉटवर्ड सुनाई देने पर होता है.

अगर Assistant चालू नहीं है या उसे म्यूट किया गया है, तो यह तरीका काम नहीं करेगा.

stop_conversation()

Assistant के साथ चल रही किसी भी बातचीत को रोकता है.

Assistant, उपयोगकर्ता की क्वेरी सुन रही हो या जवाब दे रही हो. अगर कोई बातचीत नहीं हो रही है, तो यह सुविधा काम नहीं करेगी.

class google.assistant.library.event.AlertEvent(event_type, args, **_)

‘alert_type’ को पार्स करने के लिए, इवेंट को बड़ा किया गया.

class google.assistant.library.event.AlertType

चेतावनी के टाइप.

इसका इस्तेमाल ON_ALERT_STARTED और ON_ALERT_FINISHED इवेंट के साथ किया जाता है.

ALARM = 0

किसी खास समय के लिए सेट किया गया इवेंट, जैसे कि ‘सोमवार को सुबह 3 बजे’

TIMER = 1

किसी खास समय के लिए सेट किया गया इवेंट, जैसे कि ‘अभी से 30 सेकंड बाद’

class google.assistant.library.event.DeviceActionEvent(event_type, args, **kwargs)

'कार्रवाइयां' प्रॉपर्टी जोड़ने के लिए, इवेंट को बड़ा करता है.

actions

मौजूदा डिवाइस के लिए निर्देश जनरेट करने वाला टूल.

class google.assistant.library.event.Event(event_type, args, **_)

Assistant से जनरेट किया गया इवेंट.

type

EventType – जनरेट किए गए इवेंट का टाइप.

args

dict – इस इवेंट से जुड़े आर्ग्युमेंट की-वैल्यू पेयर.

static New(event_type, args, **kwargs)

ज़रूरत पड़ने पर, खास इवेंट क्लास का इस्तेमाल करके नया इवेंट बनाएं.

पैरामीटर:
  • event_type (int) – यह एक अंकों वाला आईडी है, जो google.assistant.event.EventType में मौजूद किसी इवेंट से जुड़ा होता है.
  • args (dict) – इस इवेंट से जुड़े आर्ग्युमेंट की कुंजी/वैल्यू पेयर.
  • kwargs (dict) – किसी EventType के लिए, इवेंट क्लास के खास वर्शन के लिए, वैकल्पिक आर्ग्युमेंट कीवर्ड/वैल्यू पेयर.
class google.assistant.library.event.EventType

इवेंट के टाइप.

ON_ALERT_FINISHED = 11

इससे पता चलता है कि alert_type की सूचना बंद हो गई है.

पैरामीटर:alert_type (AlertType) – यह एनम का आईडी होता है, जो अभी खत्म हुई सूचना के टाइप के बारे में बताता है.
ON_ALERT_STARTED = 10

इससे पता चलता है कि कोई सूचना बजने लगी है.

यह सूचना तब तक दिखती रहेगी, जब तक उसी alert_type के साथ ON_ALERT_FINISHED नहीं मिलता. एक समय में सिर्फ़ एक सूचना चालू होनी चाहिए.

पैरामीटर:alert_type (AlertType) – यह Enum का आईडी होता है, जो फ़िलहाल मिलने वाली चेतावनी के टाइप के बारे में बताता है.
ON_ASSISTANT_ERROR = 12

इससे पता चलता है कि Assistant लाइब्रेरी में कोई गड़बड़ी हुई है या नहीं.

पैरामीटर:is_fatal (bool) – अगर यह True है, तो Assistant को ठीक नहीं किया जा सकेगा और उसे फिर से चालू करना होगा.
ON_CONVERSATION_TURN_FINISHED = 9

Assistant ने मौजूदा मोड़ पूरा कर लिया है.

इसमें उपयोगकर्ता की क्वेरी को प्रोसेस करने के साथ-साथ, पूरा जवाब बोलना भी शामिल है.

पैरामीटर:with_follow_on_turn (bool) – अगर यह True है, तो Assistant को उपयोगकर्ता से फ़ॉलो अप इंटरैक्शन की उम्मीद है. उपयोगकर्ता को फ़ॉलो-अप सवाल का जवाब देने के लिए, माइक्रोफ़ोन फिर से चालू हो जाएगा.
ON_CONVERSATION_TURN_STARTED = 1

इससे पता चलता है कि नया मोड़ शुरू हो गया है.

फ़िलहाल, Assistant सुन रही है और उपयोगकर्ता की क्वेरी का इंतज़ार कर रही है. ऐसा हॉटवर्ड सुनने या Assistant को start_conversation() कहने पर हो सकता है.

ON_CONVERSATION_TURN_TIMEOUT = 2

Assistant को कोई ऐसी क्वेरी नहीं मिली जिसे समझा जा सके.

ऐसा हो सकता है कि हॉटवर्ड गलत तरीके से ट्रिगर हो गया हो या Assistant, उपयोगकर्ता की बात को समझ न पाई हो.

ON_DEVICE_ACTION = 14

इससे पता चलता है कि डिवाइस पर डिवाइस ऐक्शन का अनुरोध भेजा गया था.

यह तब भेजा जाता है, जब डिवाइस पर काम करने वाले ट्रेट्स के लिए, कोई डिवाइस ग्रामर ट्रिगर होता है. इस इवेंट टाइप में एक खास 'कार्रवाइयां' प्रॉपर्टी होती है, जो एक इटरेटटर या डिवाइस ऐक्शन कमांड और उनसे जुड़े पैरामीटर (अगर लागू हो) दिखाती है.

पैरामीटर:dict – डिवाइस ऐक्शन अनुरोध का डिकोड किया गया JSON पेलोड.
ON_END_OF_UTTERANCE = 3

Assistant ने उपयोगकर्ता की क्वेरी सुनना बंद कर दिया है.

ऐसा हो सकता है कि Assistant को उपयोगकर्ता की बात समझने में ज़्यादा समय लग रहा हो, लेकिन वह ऑडियो डेटा सुनना बंद कर दे.

ON_MEDIA_STATE_ERROR = 20

इससे पता चलता है कि ट्रैक चलाने में कोई गड़बड़ी हुई है.

अगर कोई मीडिया नहीं चल रहा है, तो डिवाइस में पहले से मौजूद मीडिया प्लेयर अगले ट्रैक पर जाने की कोशिश करेगा या ON_MEDIA_STATE_IDLE पर वापस आ जाएगा.

ON_MEDIA_STATE_IDLE = 16

इससे पता चलता है कि कोई मीडिया फ़ाइल (गाने, ऑडियो क्लिप वगैरह) नहीं चल रही है और न ही कोई मीडिया फ़ाइल चलाने के लिए कतार में है.

यह इवेंट, Google Assistant लाइब्रेरी के पहले से मौजूद मीडिया प्लेयर से ब्रॉडकास्ट किया जाता है. यह इवेंट, खबरों/पॉडकास्ट के लिए स्टार्ट-अप पर और जब भी प्लेयर के आइडल होने पर ब्रॉडकास्ट किया जाता है. ऐसा तब होता है, जब कोई उपयोगकर्ता मीडिया को रोकता है या उसे रोक देता है और स्ट्रीम का टाइम आउट हो जाता है.

ON_MEDIA_TRACK_LOAD = 17

इससे पता चलता है कि ट्रैक लोड हो रहा है, लेकिन वह नहीं चल रहा है.

अगर नया मेटाडेटा अलग-अलग समय पर लोड होता है, तो इसे कई बार डिस्पैच किया जा सकता है. आम तौर पर, इसके बाद इवेंट ON_MEDIA_TRACK_PLAY होता है

पैरामीटर:
  • मेटाडेटा (dict) –

    लोड किए गए ट्रैक का मेटाडेटा. इस समय तक सभी फ़ील्ड भरे नहीं होंगे – अगर कोई फ़ील्ड अज्ञात है, तो उसे शामिल नहीं किया जाएगा. मेटाडेटा फ़ील्ड में ये शामिल हैं:

    album(str): वह एल्बम जिससे ट्रैक जुड़ा है उसका नाम. album_art(str): एल्बम आर्ट का यूआरएल. artist(str): वह कलाकार जिसने यह ट्रैक बनाया है. duration_ms(double): इस ट्रैक की अवधि मिलीसेकंड में. title(str): ट्रैक का टाइटल.
  • track_type (MediaTrackType) – लोड किए गए ट्रैक का टाइप.
ON_MEDIA_TRACK_PLAY = 18

इससे पता चलता है कि कोई ट्रैक फ़िलहाल ऑडियो आउटपुट कर रहा है.

यह सिर्फ़ तब ट्रिगर होगा, जब हम एक स्टेटस से दूसरे स्टेटस पर ट्रांज़िशन करेंगे. जैसे, ON_MEDIA_TRACK_LOAD या ON_MEDIA_TRACK_STOP से

पैरामीटर:
  • मेटाडेटा (dict) –

    चल रहे ट्रैक का मेटाडेटा. अगर कोई फ़ील्ड अज्ञात है, तो उसे शामिल नहीं किया जाएगा. मेटाडेटा फ़ील्ड में ये शामिल हैं:

    album(str): वह एल्बम जिससे ट्रैक जुड़ा है उसका नाम. album_art(str): एल्बम आर्ट का यूआरएल. artist(str): वह कलाकार जिसने यह ट्रैक बनाया है. duration_ms(double): इस ट्रैक की अवधि मिलीसेकंड में. title(str): ट्रैक का टाइटल.
  • position_ms (डबल) – किसी चल रहे ट्रैक की शुरुआत से लेकर अब तक की मौजूदा पोज़िशन, मिलीसेकंड में. अगर “metadata.duration_ms” की वैल्यू ज्ञात नहीं है (0 पर सेट है), तो यह फ़ील्ड सेट नहीं किया जाएगा.
  • track_type (MediaTrackType) – चल रहे ट्रैक का टाइप.
ON_MEDIA_TRACK_STOP = 19

इससे पता चलता है कि पहले चल रहा ट्रैक बंद कर दिया गया है.

आम तौर पर, ऐसा तब होता है, जब उपयोगकर्ता ट्रैक को रोक देता है. अगर उपयोगकर्ता ट्रैक को फिर से चलाता है, तो ट्रैक की स्थिति ON_MEDIA_TRACK_PLAY पर वापस आ सकती है.

पैरामीटर:
  • मेटाडेटा (dict) –

    रोके गए ट्रैक का मेटाडेटा. अगर कोई फ़ील्ड अज्ञात है, तो उसे शामिल नहीं किया जाएगा. मेटाडेटा फ़ील्ड में ये शामिल हैं:

    album(str): वह एल्बम जिससे ट्रैक जुड़ा है उसका नाम. album_art(str): एल्बम आर्ट का यूआरएल. artist(str): वह कलाकार जिसने यह ट्रैक बनाया है. duration_ms(double): इस ट्रैक की अवधि मिलीसेकंड में. title(str): ट्रैक का टाइटल.
  • position_ms (डबल) – ट्रैक के शुरू होने से लेकर अब तक की मौजूदा पोज़िशन, मिलीसेकंड में. अगर “metadata.duration_ms” की वैल्यू ज्ञात नहीं है (0 पर सेट है), तो यह फ़ील्ड सेट नहीं किया जाएगा.
  • track_type (MediaTrackType) – रोके गए ट्रैक का टाइप.
ON_MUTED_CHANGED = 13

इससे पता चलता है कि Assistant फ़िलहाल सुन रही है या नहीं.

शुरुआती वैल्यू की रिपोर्ट करने के लिए, start() हमेशा एक ON_MUTED_CHANGED जनरेट करेगा.

पैरामीटर:is_muted (bool) – अगर इसकी वैल्यू 'सही' है, तो इसका मतलब है कि फ़िलहाल Assistant, अपने हॉटवर्ड को सुन नहीं रही है. साथ ही, वह उपयोगकर्ता की क्वेरी का जवाब भी नहीं देगी.
ON_NO_RESPONSE = 8

Assistant ने अपनी बारी पूरी कर ली है, लेकिन उसे कुछ नहीं कहना है.

ON_RECOGNIZING_SPEECH_FINISHED = 5

Assistant ने बोली को पहचान लिया है.

पैरामीटर:text (str) – उपयोगकर्ता की क्वेरी का आखिरी टेक्स्ट वर्शन.
ON_RENDER_RESPONSE = 15

इससे पता चलता है कि Assistant के पास जवाब के लिए रेंडर करने के लिए टेक्स्ट आउटपुट है.

पैरामीटर:
  • type (RenderResponseType) – रेंडर किए जाने वाले रिस्पॉन्स का टाइप.
  • text (str) – RenderResponseType.TEXT के लिए रेंडर की जाने वाली स्ट्रिंग.
ON_RESPONDING_FINISHED = 7

Assistant ने बोलकर जवाब देना बंद कर दिया है.

ON_RESPONDING_STARTED = 6

Assistant, बोलकर जवाब देना शुरू कर रही है.

Assistant तब तक जवाब देती रहेगी, जब तक ON_RESPONDING_FINISHED नहीं मिल जाता.

पैरामीटर:is_error_response (bool) – अगर इसकी वैल्यू 'सही' है, तो इसका मतलब है कि कोई स्थानीय गड़बड़ी की जानकारी देने वाला टीटीएस चलाया जा रहा है. अगर इसकी वैल्यू 'गलत' है, तो इसका मतलब है कि Assistant ने सर्वर के जवाब के साथ जवाब दिया है.
ON_START_FINISHED = 0

Assistant की लाइब्रेरी बनने की प्रोसेस पूरी हो गई है.

class google.assistant.library.event.IterableEventQueue(timeout=3600)

__iter__ इंटरफ़ेस जोड़ने के लिए, queue.Queue को बड़ा करता है.

offer(event)

सूची में शामिल करने के लिए कोई इवेंट ऑफ़र करें.

अगर कतार फ़िलहाल पूरी है, तो इवेंट को लॉग कर दिया जाएगा, लेकिन उसे नहीं जोड़ा जाएगा.

पैरामीटर:event (Event) – वह इवेंट जिसे सूची में जोड़ने की कोशिश की जा रही है.
class google.assistant.library.event.MediaStateChangeEvent(event_type, args, **_)

'स्टेटस' को पार्स करने के लिए, इवेंट को बड़ा करता है.

class google.assistant.library.event.MediaTrackType

ON_MEDIA_TRACK_X इवेंट के लिए ट्रैक के टाइप.

ON_MEDIA_TRACK_LOAD, ON_MEDIA_TRACK_PLAY, & ON_MEDIA_TRACK_STOP के साथ इस्तेमाल किया जाता है

CONTENT = 2

किसी आइटम (खबर/पॉडकास्ट) का असल कॉन्टेंट.

TTS = 1

किसी आइटम से जुड़ा टीटीएस (टेक्स्ट-टू-स्पीच) इंट्रो या इंटरस्टीशियल ट्रैक.

class google.assistant.library.event.RenderResponseEvent(event_type, args, **_)

‘response_type’ को पार्स करने के लिए, इवेंट को बड़ा किया गया.

class google.assistant.library.event.RenderResponseType

रेंडर किए जाने वाले कॉन्टेंट के टाइप.

ON_RENDER_RESPONSE के साथ इस्तेमाल किया गया