Skip to main content

Samples and bindings for the Google Assistant API

Project description

This repository contains a Python sample for the Google Assistant API.

See Getting Started with the Raspberry Pi 3 for instructions on how to run the sample on supported hardware.

Prerequisites

  • Python (3.x prefered)

  • Google API Console Project w/ Google Assistant API enabled.

  • OAuth client ID credentials with application type Other.

  • Use a new virtualenv (recommended):

    # python3 (recommended)
    sudo apt-get update
    sudo apt-get install python3-dev python3-venv
    python3 -m venv env
    env/bin/python -m pip install --upgrade pip setuptools
    source env/bin/activate
    
    # python2
    sudo apt-get update
    sudo apt-get install python-dev python-virtualenv
    virtualenv env --no-site-packages
    env/bin/python -m pip install --upgrade pip setuptools
    source env/bin/activate

Setup

  • Install the sample dependencies:

    sudo apt-get install portaudio19-dev libffi-dev libssl-dev
  • Install the latest Google Assistant SDK and samples package from PyPI:

    python -m pip install --upgrade google-assistant-sdk[samples]
    • Or if working from this repository’s sources, run:

      python -m pip install --upgrade -e ".[samples]"
  • Authorize access to the Google Assistant API:

    python -m googlesamples.assistant.auth_helpers --client-secrets client_secret_XXXX.json
    Please go to this URL: ...
    Enter the authorization code:
  • Verify audio setup:

    # Record a 5 sec sample and play it back
    python -m googlesamples.assistant.audio_helpers

Run the Sample

  • Record a voice query and the program should play back the Google Assistant’s answer:

    python -m googlesamples.assistant
  • Record and send pre-recorded audio to the Assistant:

    python -m googlesamples.assistant -i in.wav
  • Save Assistant response to a file:

    python -m googlesamples.assistant -o out.wav

Troubleshooting

  • Verify ALSA setup:

    # Play a test sound
    speaker-test -t wav
    
    # Record and play back some audio using ALSA command-line tools
    arecord --format=S16_LE --duration=5 --rate=16k --file-type=raw out.raw
    aplay --format=S16_LE --rate=16k --file-type=raw out.raw
  • Run the sample with verbose logging enabled:

    python -m googlesamples.assistant --verbose

For Maintainers

See MAINTAINER.md for more documentation on the development, maintainance and release of the Python package itself.

Contributing

Contributions to this repository are always welcome and highly encouraged.

See CONTRIBUTING.md for more information on how to get started.

License

Copyright (C) 2017 Google Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

google-assistant-sdk-0.2.1.tar.gz (55.6 kB view details)

Uploaded Source

Built Distribution

google_assistant_sdk-0.2.1-py2.py3-none-any.whl (27.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file google-assistant-sdk-0.2.1.tar.gz.

File metadata

File hashes

Hashes for google-assistant-sdk-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1c3ec343d7a610dd0b79cbf6f97cf27c319cb50e476109d74dfeb011a17c3238
MD5 38d344b749b1b3022f9532d198f54a60
BLAKE2b-256 1d6bfb117deb3875a601e324cbc9d2e7c53e94c87bc5a9a696ca5637f034f1a7

See more details on using hashes here.

Provenance

File details

Details for the file google_assistant_sdk-0.2.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for google_assistant_sdk-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 291151093f769c4f372cc2e0e0e69b02f2730255586901662ca3eaa4d482f86c
MD5 2614b1ae744e3ef7068b03ca92e7ccac
BLAKE2b-256 f15fe9f7f75dcad713ffee0ad9de21dc62faf96238cb5fdb3a3a6117ce7cec9b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page