Google Assistant Library

google.assistant.library paketi.

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

Google Asistan Kitaplığı için istemci.

Bu hizmetler için temel kontrol işlevleri ve yaşam döngüsü işleme Google Asistan. Asistan'ı farklı bir web sitesi için ContextManager:

with Assistant(credentials, device_model_id) as assistant:

Bu, temel yerel uygulamanın doğru şekilde işleyebiliyor.

start() çağrıldığında, Asistan, çeşitli etkinlikleri aktararak belirtir. Örneğin:

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}

Ayrıntılar için EventType sayfasını ziyaret edin. ve argümanları üzerine konuşacağız.

Sözlük:

  • Özel kelime: Asistan, sesi kapalı değilken dinlediği ifadedir:

    "OK Google" OR "Hey Google"

  • Dönüşüm: Tek bir kullanıcı isteği ve ardından Asistan'dan gelen yanıt.

  • Sohbet: Asistan'dan istenen nihai sonuçla sonuçlanan bir veya daha fazla tur:

    "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!"
Parametreler:
  • credentials (google.oauth2.credentials.Credentials): Kullanıcının kimliği Google OAuth2 kimlik bilgileri.
  • device_model_id (str) – Kaydolan device_model_id değeri Google ile paylaşın. Bu, boş bir dize olmamalıdır.
Artışlar:

ValueError - device_model_id, Yok olarak veya boş bırakıldıysa.
device_id

Asistan tarafından oluşturulan cihaz kimliğini döndürür.

Bu değer, hizmetleri kullanırken cihazınızı sunucuya tanımlar Google Cihaz İşlemleri gibi. Bu özellik yalnızca start() çağrıldıktan SONRA doldurulur.

Şunu döndürür:Cihaz kimliği bir kez start() çağrılır, aksi takdirde boş dize kullanılır.
Dönüş türü:str
send_text_query(sorgu)

|query| değerini, kullanıcı tarafından söylenmiş gibi Asistan'a gönderir.

Bu, kullanıcının özel kelimeyi söyleyip sorgu yapması VEYA bir takip sorgusunun yanıtını söylemesi gibi davranır.

Parametreler:query (str) – Asistan'a gönderilecek metin sorgusudur.
set_mic_mute(is_muted)

Asistan'ın özel kelimeyi dinlemesini durdurur.

Asistan'ın özel kelimeyi dinlemesini devre dışı bırakmanıza olanak tanır. Bu, arkadaki gizlilik düğmesine benzer bir işlev sağlar hoş geldiniz.

Asistan henüz başlatılmadıysa bu yöntem kullanılamaz.

Parametreler:is_muted (bool): True (doğru) değerine ayarlanırsa Asistan'ın dinlemesi durdurulur, Yanlış değerine ayarlanırsa tekrar başlamasına olanak tanır.
start()

Asistan'ı başlatır. Buna özel kelime dinleme de dahildir.

start() çağrıldıktan sonra Asistan, "varsayılan" ALSA ses kaynağından gelen verileri işlemeye başlar ve özel kelimeyi dinlemeye başlar. Bu işlem, zamanlayıcılar/alarmlar gibi Asistan tarafından sağlanan diğer hizmetleri de başlatır. Bu yöntem yalnızca bir kez çağrılabilir. Asistan, çağrıldıktan sonra __exit__ çağrılana kadar çalışmaya devam eder.

Şunu döndürür:Asistan'da yapılan değişiklikleri bildiren etkinlikler sırası durumu.
Dönüş türü:google.assistant.event.IterableEventQueue
start_conversation()

Asistan ile manuel olarak yeni bir görüşme başlatır.

Hem kullanıcının konuşmasını kaydetmeye hem de Google'a göndermeye başlar, Asistan özel kelimeyi duyduğunda olanlara benzer.

Asistan başlatılmadıysa veya daha önce başlatılmışsa bu yöntem kullanılamaz ses kapatıldı.

stop_conversation()

Asistan ile etkin olan tüm görüşmeleri durdurur.

Asistan, kullanıcının sorgusunu dinliyor VEYA yanıt veriyor olabilir. Eğer etkin bir görüşme yok, bu bir işlem değil.

class google.assistant.library.event.AlertEvent(event_type, bağımsız değişkenler, **_)

Etkinliği, "alert_type" ayrıştırılmasını içerecek şekilde genişletir.

sınıf google.assistant.library.event.AlertType

Uyarı türleri.

Kullanıldığı cihazlar ON_ALERT_STARTED ve ON_ALERT_FINISHED etkinlikler.

ALARM = 0

Mutlak bir zamana ayarlanmış etkinlik (ör. "Pazartesi günü 03:00")

TIMER = 1

"30 saniye sonra" gibi göreli bir süre için ayarlanmış bir etkinlik

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

"actions" özelliğini eklemek için Event'i genişletir.

actions

Mevcut cihaz için çalıştırılacak komutları üreten bir araç.

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

Asistan tarafından oluşturulan bir etkinlik.

type

EventType: Oluşturulan etkinliğin türü.

args

dict: Bu etkinlikle ilişkili bağımsız değişken anahtar/değer çiftleri.

static New(event_type, args, **kwargs)

Gerekirse özel bir etkinlik sınıfı kullanarak yeni etkinlik oluşturun.

Parametreler:
  • event_type (int) – Şuradaki bir etkinliğe karşılık gelen sayısal bir kimlik: google.assistant.event.EventType.
  • bağımsız değişkenler (dict) – Bu etkinlikle ilişkili bağımsız değişken anahtar/değer çiftleri.
  • kwargs (dict) – Belirli bir konuma özgü isteğe bağlı bağımsız değişken anahtar/değer çiftleri uzmanlık alanı.
sınıf google.assistant.library.event.EventType

Etkinlik türleri.

ON_ALERT_FINISHED = 11

alert_type uyarısının çalmasının sona erdiğini gösterir.

Parametreler:alert_type (AlertType) – Türü temsil eden Enum kimliği. bir uyarı mesajı görürsünüz.
ON_ALERT_STARTED = 10

Bir uyarının çalmaya başladığını gösterir.

Bu uyarı şu zamana kadar devam edecek: ON_ALERT_FINISHED aynı alert_type alındığında. Herhangi bir zamanda yalnızca bir uyarı etkin olmalıdır.

Parametreler:alert_type (AlertType): Şu anda çalan uyarı türünü temsil eden Enum kimliği.
ON_ASSISTANT_ERROR = 12

Asistan kitaplığının bir hatayla karşılaşıp karşılaşmadığını belirtir.

Parametreler:is_fatal (bool): True (doğru) ise Asistan kurtarma yapamaz ve yeniden başlatılması gerekir.
ON_CONVERSATION_TURN_FINISHED = 9

Asistan mevcut hamleyi tamamladı.

Buna hem kullanıcı sorgusunun işlenmesi hem de (varsa) yanıt verin.

Parametreler:with_follow_on_turn (bool) – Doğru ise Asistan, kullanıcıdan takip eden bir etkileşim bekler. Kullanıcının takip sorularını yanıtlayabilmesi için mikrofon yeniden açılır.
ON_CONVERSATION_TURN_STARTED = 1

Yeni bir dönüşün başladığını gösterir.

Asistan şu anda dinliyor ve bir kullanıcı bekliyor emin olun. Bu durum, özel kelimenin duyulması veya Asistan'da start_conversation() çağrılmanın sonucu olabilir.

ON_CONVERSATION_TURN_TIMEOUT = 2

Asistan, anlaşılır bir sorgu beklerken zaman aşımına uğradı.

Bu durum, Akıllı Kelime'nin yanlış tetiklenmesinden veya Asistan'ın kullanıcının ne dediğini anlamamasından kaynaklanabilir.

ON_DEVICE_ACTION = 14

Cihaza bir Cihaz İşlemi isteğinin gönderildiğini belirtir.

Bu öğe, özellikler cihaz tarafından desteklendiğini unutmayın. Bu etkinlik türünde, bir iteratör veya cihaz işlemi komutlarını ve bunlarla ilişkili parametreleri (varsa) döndürecek özel bir "actions" mülkü bulunur.

Parametreler:dict: Cihaz İşlemi isteğinin kodu çözülmüş JSON yükü.
ON_END_OF_UTTERANCE = 3

Asistan, kullanıcı sorgusunu dinlemeyi durdurdu.

Asistan kullanıcının ne dediğini tam olarak anlamamış olabilir ancak cihaz daha fazla ses verisi dinlemeyi durdurdu.

ON_MEDIA_STATE_ERROR = 20

Parça çalınırken bir hata oluştuğunu belirtir.

Yerleşik medya oynatıcı, oynatılacak başka bir parça yoksa sonraki parçaya atlamaya veya ON_MEDIA_STATE_IDLE simgesine dönmeye çalışır.

ON_MEDIA_STATE_IDLE = 16

Hiçbir şeyin oynatılmadığını ve oynatılacak bir şeyin sıraya eklenmediğini gösterir.

Bu etkinlik, Google Asistan Kitaplığı'nın haber/podcast için yerleşik medya oynatıcısından açılışta ve kullanıcı medyayı durdurduğu veya duraklattığı ve aktarımın zaman aşımına uğradığı için oynatıcı boşta kaldığında yayınlanır.

ON_MEDIA_TRACK_LOAD = 17

Parçanın yüklenmekte olduğunu ancak oynatılmaya başlamadığını gösterir.

Yeni meta veriler eşzamansız olarak yüklenirse bu işlem birden çok kez gönderilebilir. Bunu genellikle etkinlik izler. ON_MEDIA_TRACK_PLAY

Parametreler:
  • meta veriler (dict) –

    Yüklenen parçanın meta verileri. Tüm alanlar bu kez doldurulacaktır. Bir alan bilinmiyorsa, otomatik olarak dahil edilir. Meta veri alanları şunları içerir:

    albüm(str): Parçanın ait olduğu albümün adı. albüm_art(str): Albüm kapağının URL'si. Artist(str): Bu parçayı oluşturan sanatçı. süre_ms(double): Bu parçanın milisaniye cinsinden uzunluğu. title(str): Parçanın başlığı.
  • track_type (MediaTrackType): Yüklenen parçanın türü.
ON_MEDIA_TRACK_PLAY = 18

Bir parçanın şu anda ses çıkışını sağladığını belirtir.

Bu yalnızca bir durumdan diğerine geçiş yaptığımızda (ör. ON_MEDIA_TRACK_LOAD veya ON_MEDIA_TRACK_STOP) tetiklenir.

Parametreler:
  • metadata (dict) –

    Çalınan parçanın meta verileri. Bilinmeyen alanlar dahil edilmez. Meta veri alanları şunlardır:

    albüm(str): Parçanın ait olduğu albümün adı. albüm_art(str): Albüm kapağının URL'si. Artist(str): Bu parçayı oluşturan sanatçı. süre_ms(double): Bu parçanın milisaniye cinsinden uzunluğu. title(str): Parçanın başlığı.
  • position_ms (double): Oynatılan parçanın başlangıcından itibaren milisaniye cinsinden mevcut konumu. "metadata.duration_ms" değeri bilinmiyor (0'a ayarlanırsa) bu alan ayarlanmaz.
  • track_type (MediaTrackType): Çalınan parçanın türü.
ON_MEDIA_TRACK_STOP = 19

Daha önce çalınan bir parçanın durdurulduğunu gösterir.

Bu durum genellikle kullanıcının duraklatmasından kaynaklanır. Parça, kullanıcı tarafından devam ettirilirse ON_MEDIA_TRACK_PLAY durumuna geri dönebilir.

Parametreler:
  • meta veriler (dict) –

    Durdurulan parçanın meta verileri. Bir alan bilinmiyorsa hiçbir ek belgeye dahil edilmeyecektir. Meta veri alanları şunları içerir:

    albüm(str): Parçanın ait olduğu albümün adı. albüm_art(str): Albüm kapağının URL'si. Artist(str): Bu parçayı oluşturan sanatçı. süre_ms(double): Bu parçanın milisaniye cinsinden uzunluğu. title(str): Parçanın başlığı.
  • position_ms (çift) – Durdurulan bir parçadaki geçerli konum milisaniye cinsinden eder. "metadata.duration_ms" değeri bilinmiyor (0'a ayarlanırsa) bu alan ayarlanmaz.
  • track_type (MediaTrackType) – Durdurulan parça türü.
ON_MUTED_CHANGED = 13

Asistan'ın o anda dinleyip dinlemediğini gösterir.

start(), ilk değeri bildirmek için her zaman bir ON_MUTED_CHANGED oluşturur.

Parametreler:is_muted (bool): True (Doğru) ise Asistan o anda dinlemiyordur kullanıcı sorgularına yanıt vermez.
ON_NO_RESPONSE = 8

Asistan sırasını başarıyla tamamladı, ancak söyleyecek bir şey yok.

ON_RECOGNIZING_SPEECH_FINISHED = 5

Asistan, tanınan nihai konuşmayı belirledi.

Parametreler:text (str) – Bir kullanıcı sorgusunun nihai metin yorumudur.
ON_RENDER_RESPONSE = 15

Asistan'ın bir yanıt için oluşturulacak metin çıkışı olduğunu belirtir.

Parametreler:
  • type (RenderResponseType): Oluşturulacak yanıtın türü.
  • text (str) – RenderResponseType.TEXT için oluşturulacak dize.
ON_RESPONDING_FINISHED = 7

Asistan, sesle yanıt vermeyi tamamladı.

ON_RESPONDING_STARTED = 6

Asistan sesle yanıt vermeye başlıyor.

Asistan, şu zamana kadar yanıt verecek: ON_RESPONDING_FINISHED alındı.

Parametreler:is_error_response (bool): Doğru değerinin döndürülmesi, yerel bir hata TTS'sinin çalındığı anlamına gelir. Aksi takdirde Asistan, sunucu yanıtıyla yanıt verir.
ON_START_FINISHED = 0

Asistan kitaplığı başlatıldı.

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

__iter__ arayüzü eklemek için queue.Queue öğesini genişletir.

offer(etkinlik)

Sıraya eklenecek bir etkinlik önerin.

Sıra şu anda doluysa etkinlik günlüğe kaydedilir ancak eklenmez.

Parametreler:event (Etkinlik) – Sıraya eklenmeye çalışılacak etkinlik.
class google.assistant.library.event.MediaStateChangeEvent(event_type, bağımsız değişkenler, **_)

"Durum"un ayrıştırılmasını eklemek için Etkinlik'i genişletir.

sınıf google.assistant.library.event.MediaTrackType

ON_MEDIA_Track_X etkinliği için parça türleri.

Kullanıldığı cihazlar ON_MEDIA_TRACK_LOAD, ON_MEDIA_TRACK_PLAY, ve ON_MEDIA_TRACK_STOP

CONTENT = 2

Bir öğenin asıl içeriği (haber/podcast).

TTS = 1

Bir öğeyle ilgili TTS tanıtımı veya geçiş parçası.

class google.assistant.library.event.RenderResponseEvent(event_type, bağımsız değişkenler, **_)

Etkinliği, "response_type" ayrıştırmasını eklemek için genişletir.

sınıf google.assistant.library.event.RenderResponseType

Oluşturulacak içerik türleri.

Kullanıldığı cihazlar ON_RENDER_RESPONSE