package google.assistant.embedded.v1alpha1
Get desktop application:
View/edit binary Protocol Buffers messages
Service that implements Google Assistant API.
rpc Converse (stream , stream )
embedded_assistant.proto:70Initiates or continues a conversation with the embedded assistant service. Each call performs one round-trip, sending an audio request to the service and receiving the audio response. Uses bidirectional streaming to receive results, such as the `END_OF_UTTERANCE` event, while sending audio. A conversation is one or more gRPC connections, each consisting of several streamed requests and responses. For example, the user says *Add to my shopping list* and the assistant responds *What do you want to add?*. The sequence of streamed requests and responses in the first gRPC message could be: * ConverseRequest.config * ConverseRequest.audio_in * ConverseRequest.audio_in * ConverseRequest.audio_in * ConverseRequest.audio_in * ConverseResponse.event_type.END_OF_UTTERANCE * ConverseResponse.result.microphone_mode.DIALOG_FOLLOW_ON * ConverseResponse.audio_out * ConverseResponse.audio_out * ConverseResponse.audio_out The user then says *bagels* and the assistant responds *OK, I've added bagels to your shopping list*. This is sent as another gRPC connection call to the `Converse` method, again with streamed requests and responses, such as: * ConverseRequest.config * ConverseRequest.audio_in * ConverseRequest.audio_in * ConverseRequest.audio_in * ConverseResponse.event_type.END_OF_UTTERANCE * ConverseResponse.result.microphone_mode.CLOSE_MICROPHONE * ConverseResponse.audio_out * ConverseResponse.audio_out * ConverseResponse.audio_out * ConverseResponse.audio_out Although the precise order of responses is not guaranteed, sequential ConverseResponse.audio_out messages will always contain sequential portions of audio.
message
embedded_assistant.proto:227The top-level message sent by the client. Clients must send at least two, and typically numerous `ConverseRequest` messages. The first message must contain a `config` message and must not contain `audio_in` data. All subsequent messages must contain `audio_in` data and must not contain a `config` message.
oneof converse_request
Exactly one of these fields must be specified in each `ConverseRequest`.
config = 1
The `config` message provides information to the recognizer that specifies how to process the request. The first `ConverseRequest` message must contain a `config` message.
bytes audio_in = 2
The audio data to be recognized. Sequential chunks of audio data are sent in sequential `ConverseRequest` messages. The first `ConverseRequest` message must not contain `audio_in` data and all subsequent `ConverseRequest` messages must contain `audio_in` data. The audio bytes must be encoded as specified in `AudioInConfig`. Audio must be sent at approximately real-time (16000 samples per second). An error will be returned if audio is sent significantly faster or slower.
message
embedded_assistant.proto:249The top-level message received by the client. A series of one or more `ConverseResponse` messages are streamed back to the client.
oneof converse_response
Exactly one of these fields will be populated in each `ConverseResponse`.
error = 1
*Output-only* If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation. If an error occurs during processing, this message will be set and there will be no further messages sent.
ConverseResponse.EventType event_type = 2
*Output-only* Indicates the type of event.
audio_out = 3
*Output-only* The audio containing the assistant's response to the query.
result = 5
*Output-only* The semantic result for the user's spoken query.
message
embedded_assistant.proto:89Specifies how to process the `audio_in` data that will be provided in subsequent requests. For recommended settings, see the Google Assistant SDK [best practices](https://developers.google.com/assistant/sdk/develop/grpc/best-practices/audio).
Used in:
AudioInConfig.Encoding encoding = 1
*Required* Encoding of audio data sent in all `audio_in` messages.
int32 sample_rate_hertz = 2
*Required* Sample rate (in Hertz) of the audio data sent in all `audio_in` messages. Valid values are from 16000-24000, but 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling).
Audio encoding of the data sent in the audio message. Audio must be one-channel (mono). The only language supported is "en-US".
Used in:
ENCODING_UNSPECIFIED = 0
Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][].
LINEAR16 = 1
Uncompressed 16-bit signed little-endian samples (Linear PCM). This encoding includes no header, only the raw audio bytes.
FLAC = 2
[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless--therefore recognition is not compromised--and requires only about half the bandwidth of `LINEAR16`. This encoding includes the `FLAC` stream header followed by audio data. It supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.
message
embedded_assistant.proto:168The audio containing the assistant's response to the query. Sequential chunks of audio data are received in sequential `ConverseResponse` messages.
Used in:
bytes audio_data = 1
*Output-only* The audio data containing the assistant's response to the query. Sequential chunks of audio data are received in sequential `ConverseResponse` messages.
message
embedded_assistant.proto:123Specifies the desired format for the server to use when it returns `audio_out` messages.
Used in:
AudioOutConfig.Encoding encoding = 1
*Required* The encoding of audio data to be returned in all `audio_out` messages.
int32 sample_rate_hertz = 2
*Required* The sample rate in Hertz of the audio data returned in `audio_out` messages. Valid values are: 16000-24000.
int32 volume_percentage = 3
*Required* Current volume setting of the device's audio output. Valid values are 1 to 100 (corresponding to 1% to 100%).
Audio encoding of the data returned in the audio message. All encodings are raw audio bytes with no header, except as indicated below.
Used in:
ENCODING_UNSPECIFIED = 0
Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][].
LINEAR16 = 1
Uncompressed 16-bit signed little-endian samples (Linear PCM).
MP3 = 2
MP3 audio encoding. The sample rate is encoded in the payload.
OPUS_IN_OGG = 3
Opus-encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android and in some browsers (such as Chrome). The quality of the encoding is considerably higher than MP3 while using the same bitrate. The sample rate is encoded in the payload.
message
embedded_assistant.proto:74Specifies how to process the `ConverseRequest` messages.
Used in:
optional audio_in_config = 1
*Required* Specifies how to process the subsequent incoming audio.
optional audio_out_config = 2
*Required* Specifies how to format the audio that will be returned.
optional converse_state = 3
*Required* Represents the current dialog state.
Indicates the type of event.
Used in:
EVENT_TYPE_UNSPECIFIED = 0
No event specified.
END_OF_UTTERANCE = 1
This event indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection.
message
embedded_assistant.proto:176The semantic result for the user's spoken query.
Used in:
string spoken_request_text = 1
*Output-only* The recognized transcript of what the user said.
string spoken_response_text = 2
*Output-only* The text of the assistant's spoken response. This is only returned for an IFTTT action.
bytes conversation_state = 3
*Output-only* State information for subsequent `ConverseRequest`. This value should be saved in the client and returned in the `conversation_state` with the next `ConverseRequest`. (The client does not need to interpret or otherwise use this value.) There is no need to save this information across device restarts.
ConverseResult.MicrophoneMode microphone_mode = 4
*Output-only* Specifies the mode of the microphone after this `Converse` RPC is processed.
int32 volume_percentage = 5
*Output-only* Updated volume level. The value will be 0 or omitted (indicating no change) unless a voice command such as "Increase the volume" or "Set volume level 4" was recognized, in which case the value will be between 1 and 100 (corresponding to the new volume level of 1% to 100%). Typically, a client should use this volume level when playing the `audio_out` data, and retain this value as the current volume level and supply it in the `AudioOutConfig` of the next `ConverseRequest`. (Some clients may also implement other ways to allow the current volume level to be changed, for example, by providing a knob that the user can turn.)
Possible states of the microphone after a `Converse` RPC completes.
Used in:
MICROPHONE_MODE_UNSPECIFIED = 0
No mode specified.
CLOSE_MICROPHONE = 1
The service is not expecting a follow-on question from the user. The microphone should remain off until the user re-activates it.
DIALOG_FOLLOW_ON = 2
The service is expecting a follow-on question from the user. The microphone should be re-opened when the `AudioOut` playback completes (by starting a new `Converse` RPC call to send the new audio).
message
embedded_assistant.proto:157Provides information about the current dialog state.
Used in:
bytes conversation_state = 1
*Required* The `conversation_state` value returned in the prior `ConverseResponse`. Omit (do not set the field) if there was no prior `ConverseResponse`. If there was a prior `ConverseResponse`, do not omit this field; doing so will end that conversation (and this new request will start a new conversation).