google-assistant-grpc

Google Assistant gRPC API Bindings for Python

This package contains the generated Python bindings for the Google Assistant gRPC API. It is part of the Google Assistant SDK.

This package should be compatible with POSIX platforms supporting gRPC and Python.

Installing

• You can install using pip.:

  pip install --upgrade google-assistant-grpc
  

Authorization

• Follow the steps to configure a Google API Console Project and a Google account to use with the Google Assistant SDK.

• Download the client_secret_XXXXX.json file from the Google API Console Project credentials section and generate credentials using google-oauth-tool.:

  pip install --upgrade google-auth-oauthlib[tool]
  google-oauthlib-tool --client-secrets path/to/client_secret_XXXXX.json --scope https://www.googleapis.com/auth/assistant-sdk-prototype --save --headless
  

• Load the credentials using google.oauth2.credentials.:

  import io
  import google.oauth2.credentials
  
  with io.open('/path/to/credentials.json', 'r') as f:
      credentials = google.oauth2.credentials.Credentials(token=None,
                                                          **json.load(f))
  

• Initialize the gRPC channel using google.auth.transport.grpc.

Usage

• Initialize the gRPC stubs using google.assistant.embedded.v1alpha1.embedded_assistant_pb2_grpc.:

  import google.assistant.embedded.v1alpha1.embedded_assistant_pb2_grpc
  assistant = embedded_assistant_pb2.EmbeddedAssistantStub(channel)
  

• Call the Converse streaming method. It takes a generator of ConverseRequest and returns a generator of ConverseResponse.:

  converse_responses_generator = assistant.Converse(converse_requests_generator)
  start_acquiring_audio()
  

• Send a ConverseRequest message with audio configuration parameters followed by multiple outgoing ConverseRequest messages containing the audio data of the Assistant request.:

  import google.assistant.embedded.v1alpha1.embedded_assistant_pb2
  
  def generate_converse_requests():
      yield embedded_assistant_pb2.ConverseConfig(
          audio_in_config=embedded_assistant_pb2.AudioInConfig(
              encoding='LINEAR16',
              sample_rate_hertz=16000,
          ),
          audio_out_config=embedded_assistant_pb2.AudioOutConfig(
              encoding='LINEAR16',
              sample_rate_hertz=16000,
          ),
      )
      for data in acquire_audio_data():
          yield embedded_assistant_pb2.ConverseRequest(audio_in=data)
  

• Handle the incoming stream of ConverseResponse messages:

  • Stop recording when receiving a ConverseResponse with the EventType message set to END_OF_UTTERANCE.
  • Get conversation metadata from the stream of ConverseResponse messages. (with the ConverseResult field set).
  • Extract the audio data of the Assistant response from the stream of ConverseResponse messages (with the AudioOut field set).

for converse_response in converse_response_generator:
    if resp.event_type == END_OF_UTTERANCE:
       stop_acquiring_audio()
    if resp.result.spoken_request_text:
       print(resp.result.spoken_request_text)
    if len(resp.audio_out.audio_data) > 0:
       playback_audio_data(resp.audio_out.audio_data)

Reference

• gRPC reference sample.
• Google Assistant gRPC API reference.

For Maintainers

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

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.