Google Assistant Library

google.assistant.library paketi.

class google.assistant.library.Assistant(kimlik bilgileri, device_model_id)

Google Asistan Kitaplığı'nın istemcisi.

Google Asistan için temel kontrol işlevi ve yaşam döngüsü boyunca işlem sağlar. En iyi uygulama, Asistan'ın ContextManager olarak kullanılmasıdır:

with Assistant(credentials, device_model_id) as assistant:

Böylece temel yerel uygulama, bellek yönetimini doğru bir şekilde işleyebilir.

start() çağrıldıktan sonra Asistan, Asistan'ın şu anda bulunduğu çeşitli durumları geçiren bir etkinlik akışı oluşturur. Ö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}

Tüm etkinlikler ve bağımsız değişkenleriyle ilgili ayrıntılar için EventType sayfasına göz atın.

Sözlük:

  • Önemli kelime: Asistan, sesi kapalı değilken dinlediği ifade:

    "OK Google" OR "Hey Google"

  • Turn: Tek bir kullanıcı isteği ve ardından Asistan'dan bir yanıt gelir.

  • Görüşme: Asistan'dan istenen son sonuca ulaşılmasını sağlayan bir veya daha fazla dönüş:

    "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 Google OAuth2 kimlik bilgileri.
  • device_model_id (str) - Google'da projeniz için kayıtlı olan device_model_id. Bu boş bir dize olmamalıdır.
Artışlar:

ValueError: device_model_id Yok olarak veya boş bırakılır.
device_id

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

Bu değer, Google Device Actions gibi hizmetleri kullanırken cihazınızı sunucuya tanımlar. Bu özellik yalnızca start() arandıktan sonra doldurulur.

Dönen:Bir kez cihaz kimliği start() çağrılır, aksi takdirde boş dize olur.
İade türü:str
send_text_query(sorgu)ö

Asistan'a kullanıcı tarafından okunmuş gibi |query| gönderir.

Bu işlem, özel kelimeyi söyleyen ve sorgu yapan VEYA sonraki sorguya cevap veren bir kullanıcıyla aynı şekilde davranır.

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

Asistan'ın özel kelimeyi dinlemesini durdurur.

Asistan'ın özel kelimeyi dinlemesini devre dışı bırakır. Bu sayede, Google Home'un arkasındaki gizlilik düğmesine benzer işlevler sağlanır.

Asistan henüz başlatılmadıysa bu yöntemde herhangi bir işlem yapılmaz.

Parametreler:is_muted (bool) - Doğru, Asistan'ın dinlemesini durdurur ve Yanlış özelliği yeniden başlatılmasını sağlar.
start()ö

Özel kelime dinlemeyi içeren Asistan'ı başlatır.

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

Dönen:Asistan durumundaki değişiklikleri bildiren bir etkinlik sırası.
İade türü:google.assistant.event.IterableEventQueue
start_conversation()ö

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

Asistan özel kelimeyi duyduğunda olduğu gibi, kullanıcının konuşmasını kaydetmeye ve Google'a göndermeye başlar.

Asistan başlatılmadıysa veya sesi kapalıysa bu yöntem işlemsizdir.

stop_conversation()ö

Asistan'la tüm etkin görüşmeleri durdurur.

Asistan, kullanıcının sorgusunu dinliyor veya yanıt veriyor olabilir. Aktif bir görüşme yoksa bu durum bir işlem değildir.

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

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

class google.assistant.library.event.AlertTypeö

Uyarı türleri.

ON_ALERT_STARTED ve ON_ALERT_FINISHED etkinlikleriyle kullanılır.

ALARM = 0');

"Pazartesi 03:00" gibi mutlak bir zamana ayarlanmış bir etkinlik

TIMER = 1ö

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

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

Etkinlik değerini genişleterek "actions" özelliğini ekler.

actions

Mevcut cihaz için yürütülecek komutların oluşturma aracı.

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 anahtar/değer çiftleri.

statik New(event_type, args, **kwargs)ö

Gerektiğinde özel bir Etkinlik sınıfı kullanarak yeni etkinlik oluşturun.

Parametreler:
  • event_type (int) - google.assistant.event.EventType'taki bir etkinliğe karşılık gelen sayısal kimlik.
  • args (dikte): – Bu etkinlikle ilişkili bağımsız anahtar/değer çiftleri.
  • kwargs (dikte): Bir EventType için Etkinlik sınıfının uzmanlığına özgü isteğe bağlı anahtar/değer çiftleri.
class google.assistant.library.event.EventTypeö

Etkinlik türleri.

ON_ALERT_FINISHED = 11ö

alert_type uyarısının sesinin bittiğini gösterir.

Parametreler:alert_type (Uyarı Türü): Enum'un bitmiş uyarı türünü temsil eden kimliği.
ON_ALERT_STARTED = 10');

Bir uyarının ses çıkarmaya başladığını belirtir.

Bu uyarı, aynı alert_type değerine sahip olan ON_ALERT_FINISHED öğesi alana kadar devam eder. Herhangi bir zamanda yalnızca bir uyarı etkin olmalıdır.

Parametreler:alert_type (Uyarı Türü): Enum'un şu anda güçlü olan uyarı türünü temsil eden 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) değerine ayarlanırsa Asistan kurtarılamaz ve yeniden başlatılmalıdır.
ON_CONVERSATION_TURN_FINISHED = 9ö

Asistan geçerli dönüşü bitirdi.

Buna hem kullanıcı sorgusunun işlenmesi hem de varsa tam yanıtın söylenmesi dahildir.

Parametreler:with_follow_on_turn (bool): Doğru ise Asistan, kullanıcıdan takip etkileşimi bekler. Mikrofon, kullanıcının takip sorusuna yanıt verebilmesi için yeniden açılır.
ON_CONVERSATION_TURN_STARTED = 1ö

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

Asistan şu anda dinliyor, kullanıcı sorgusu bekliyor. Bu, özel kelimenin veya Asistan'daki start_conversation() çağrısının sonucunda olabilir.

ON_CONVERSATION_TURN_TIMEOUT = 2ö

Asistan fark edilebilir bir sorgu beklerken zaman aşımına uğradı.

Bunun nedeni, özel kelimenin yanlış tetiklenmesi veya Asistan'ın kullanıcının ne dediğini anlayamaması olabilir.

ON_DEVICE_ACTION = 14ö

Bir Cihaz İşlemi isteğinin cihaza gönderildiğini gösterir.

Cihaz tarafından desteklenen özellikler için herhangi bir Cihaz Dil Bilgisi tetiklenirse bu etiket gönderilir. Bu etkinlik türünde, bir iterasyon veya Cihaz İşlemi komutları ve bunlarla ilişkili parametreler (varsa) döndürecek özel bir "işlemler" özelliği bulunur.

Parametreler:dict – Bir cihaz işlemi isteğinin kod çözülmüş JSON yükü.
ON_END_OF_UTTERANCE = 3ö

Asistan, kullanıcı sorgusunu dinlemeyi durdurdu.

Asistan, kullanıcının söylediklerini anlamamış olabilir ancak daha fazla ses verisi için dinlemeyi durdurmuştur.

ON_MEDIA_STATE_ERROR = 20');

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

Yerleşik medya oynatıcı, bir sonraki parçaya atlamaya veya oynatacak hiçbir şey kalmadığında ON_MEDIA_STATE_IDLE öğesine dönmeye çalışır.

ON_MEDIA_STATE_IDLE = 16ö

Oynatılan ve oynatılmak üzere sıraya alınmış bir şey olmadığını belirtir.

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

ON_MEDIA_TRACK_LOAD = 17ö

Bir parçanın yüklendiğini ancak çalmaya başlamadığını belirtir.

Yeni meta veriler eşzamansız olarak yüklenirse bu içerik birden fazla kez gönderilebilir. Bunu genellikle etkinlik devam eder ON_MEDIA_TRACK_PLAY

Parametreler:
  • metadata (dikte) –

    Yüklenen parçanın meta verileri. Bu süre zarfında tüm alanlar doldurulmayacak. Bilinmeyen alanlar da dahil edilmeyecek. 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çı. duration_ms(çift): 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 ses çıkarttığını belirtir.

Bu durum yalnızca bir durumdan diğerine (ör. ON_MEDIA_TRACK_LOAD veya ON_MEDIA_TRACK_STOP) geçişi gerçekleştirdiğinde tetiklenir

Parametreler:
  • metadata (dikte) –

    Çalınan parçanın meta verileri. Bilinmeyen alanlar dahil edilmez. 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çı. duration_ms(çift): Bu parçanın milisaniye cinsinden uzunluğu.title(str): Parçanın başlığı.
  • position_ms (ikili): Baştan itibaren bir milisaniye içinde bir müzik parçasının mevcut konumu. "metadata.duration_ms" bilinmiyorsa (0 olarak ayarlanır) bu alan ayarlanmaz.
  • track_type (MediaTrackType) - Çalan parçanın türü.
ON_MEDIA_TRACK_STOP = 19ö

Önceden çalan bir parçanın durdurulduğunu belirtir.

Bu durum genellikle kullanıcının duraklatılmasından kaynaklanır. Kanal, kullanıcı tarafından devam ettirilirse ON_MEDIA_TRACK_PLAY bölümüne geri dönebilir.

Parametreler:
  • metadata (dikte) –

    Durdurulan parça için meta veriler. Bilinmeyen alanlar dahil edilmez. 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çı. duration_ms(çift): Bu parçanın milisaniye cinsinden uzunluğu.title(str): Parçanın başlığı.
  • position_ms (çift) - Durdurulan bir parçanın başlangıcından itibaren milisaniye cinsinden mevcut konum. "metadata.duration_ms" bilinmiyorsa (0 olarak ayarlanır) bu alan ayarlanmaz.
  • track_type (MediaTrackType) - Durdurulan parçanın türü.
ON_MUTED_CHANGED = 13ö

Asistan'ın şu anda dinlemede olup olmadığını belirtir.

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

Parametreler:is_muted (bool): True (Doğru) değerine ayarlanırsa Asistan şu anda özel kelimesini dinlemez ve kullanıcı sorgularına yanıt vermez.
ON_NO_RESPONSE = 8ö

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

ON_RECOGNIZING_SPEECH_FINISHED = 5ö

Asistan, tanınan son konuşmayı belirler.

Parametreler:text (str) - Bir kullanıcı sorgusunun nihai metin yorumu.
ON_RENDER_RESPONSE = 15ö

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

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

Asistan, sesle yanıt vermeyi bitirdi.

ON_RESPONDING_STARTED = 6ö

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

Asistan, ON_RESPONDING_FINISHED alınana kadar yanıt verir.

Parametreler:is_error_response (bool) - Doğru, TTS'nin oynatıldığı yerel bir hatadır, aksi takdirde Asistan bir sunucu yanıtı verir.
ON_START_FINISHED = 0');

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

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

Sırayı uzatır.__iter__ arayüzü eklemek için sıraya alınır.

offer(etkinlik)ö

Sıraya eklemek için bir etkinlik sunun.

Sıra doluysa etkinlik kaydedilir ancak eklenmez.

Parametreler:event (Etkinlik): Sıraya eklenmeye çalışılacak etkinlik.
class google.assistant.library.event.MediaStateChangeEvent(event_type, args, **_)

Etkinlik durumunu "eyalet" ayrıştırmasını eklemek için genişletir.

class google.assistant.library.event.MediaTrackTypeö

ON_MEDIA_TRACK_X etkinlikleri için parça türleri.

ON_MEDIA_TRACK_LOAD, ON_MEDIA_TRACK_PLAY ve ON_MEDIA_TRACK_STOP ile kullanılır

CONTENT = 2ö

Bir öğenin gerçek içeriği (haberler/podcast).

TTS = 1ö

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

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

Etkinliği genişleterek "response_type" ayrıştırmasını ekler.

class google.assistant.library.event.RenderResponseTypeö

Oluşturulacak içerik türleri.

ON_RENDER_RESPONSE ile kullanılır