Google Assistant Library

google.assistant.library पैकेज.

क्लास google.assistant.library.Assistant(क्रेडेंशियल, 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 का जवाब.

  • बातचीत: एक या उससे ज़्यादा बार में, आपकी पसंद का नतीजा मिलता है के लिए:

    "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!"
पैरामीटर:
  • क्रेडेंशियल (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’ को पार्स करने के लिए, इवेंट को बड़ा किया गया.

क्लास 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 – इस इवेंट से जुड़े आर्ग्युमेंट की-वैल्यू पेयर.

स्टैटिक New(event_type, आर्ग, **kwrcs)

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

पैरामीटर:
  • event_type (int) – यह एक अंकों वाला आईडी है, जो google.assistant.event.EventType में मौजूद किसी इवेंट से जुड़ा होता है.
  • args (dict) – इस इवेंट से जुड़े आर्ग्युमेंट की कुंजी/वैल्यू पेयर.
  • kworgs (dict) – किसी खास क्वेरी के लिए वैकल्पिक आर्ग्युमेंट कुंजी/वैल्यू पेयर एक EventType के लिए इवेंट क्लास की विशेषज्ञता.
क्लास 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) – अगर सही है, तो 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, उपयोगकर्ता की बात को समझ न पाई हो.

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) –

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

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

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

ऐसा आम तौर पर उपयोगकर्ता के रुकने की वजह से होता है; ट्रैक वापस आ सकता है ON_MEDIA_TRACK_PLAY अगर यह है उपयोगकर्ता ने फिर से शुरू कर दिया.

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

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

    एल्बम(str): उस एल्बम का नाम, जिससे ट्रैक संबंधित है. एल्बम_art(str): एल्बम आर्ट के लिए एक यूआरएल. Artist(str): वह कलाकार जिसने इस ट्रैक को बनाया था. अवधि_ms(दोगुना): इस ट्रैक की लंबाई मिलीसेकंड में. 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 की लाइब्रेरी बनने की प्रोसेस पूरी हो गई है.

क्लास google.assistant.library.event.IterableEventQueue(समय खत्म=3600)

__iter__ इंटरफ़ेस जोड़ने के लिए सूची को बड़ा करें.

offer(इवेंट)

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

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

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

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

क्लास google.assistant.library.event.RenderResponseEvent(event_type, आर्ग, **_)

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

क्लास google.assistant.library.event.RenderResponseType

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

इनके साथ इस्तेमाल किया जाता है ON_RENDER_RESPONSE