Talk Analytics API, gRPC: TalkService
Written by
Updated at April 11, 2024
Call | Description |
---|---|
UploadAsStream | rpc for streaming talk documents. |
Upload | rpc for uploading talk document as single message |
UploadText | rpc for uploading text talk document |
Calls TalkService
UploadAsStream
rpc for streaming talk documents. First message should contain Talk related metadata, second - audio metadata, others should contain audio bytes in chunks
rpc UploadAsStream (stream StreamTalkRequest) returns (UploadTalkResponse)
StreamTalkRequest
Field | Description |
---|---|
Event | oneof: metadata or audio |
metadata | TalkMetadata talk document metadata containing channel id and channel field values |
audio | AudioStreamingRequest audio metadata or chunk |
TalkMetadata
Field | Description |
---|---|
connection_id | string id of connection this talk belongs too |
fields | map<string,string> channel defined fields |
AudioStreamingRequest
Field | Description |
---|---|
AudioEvent | oneof: audio_metadata or chunk |
audio_metadata | AudioMetadata Session options. Should be the first message from user. |
chunk | AudioChunk Chunk with audio data. |
AudioMetadata
Field | Description |
---|---|
AudioFormat | oneof: raw_audio or container_audio |
raw_audio | RawAudio Audio without container. |
container_audio | ContainerAudio Audio is wrapped in container. |
RawAudio
Field | Description |
---|---|
audio_encoding | enum AudioEncoding Type of audio encoding
|
sample_rate_hertz | int64 PCM sample rate |
audio_channel_count | int64 PCM channel count. |
ContainerAudio
Field | Description |
---|---|
container_audio_type | enum ContainerAudioType Type of audio container.
|
AudioChunk
Field | Description |
---|---|
data | bytes Bytes with audio data. |
UploadTalkResponse
Field | Description |
---|---|
talk_id | string id of created talk document |
Upload
rpc for uploading talk document as single message
rpc Upload (UploadTalkRequest) returns (UploadTalkResponse)
UploadTalkRequest
Field | Description |
---|---|
metadata | TalkMetadata |
audio | AudioRequest audio payload |
TalkMetadata
Field | Description |
---|---|
connection_id | string id of connection this talk belongs too |
fields | map<string,string> channel defined fields |
AudioRequest
Field | Description |
---|---|
audio_metadata | AudioMetadata audio metadata |
audio_data | AudioChunk Bytes with audio data. |
AudioMetadata
Field | Description |
---|---|
AudioFormat | oneof: raw_audio or container_audio |
raw_audio | RawAudio Audio without container. |
container_audio | ContainerAudio Audio is wrapped in container. |
RawAudio
Field | Description |
---|---|
audio_encoding | enum AudioEncoding Type of audio encoding
|
sample_rate_hertz | int64 PCM sample rate |
audio_channel_count | int64 PCM channel count. |
ContainerAudio
Field | Description |
---|---|
container_audio_type | enum ContainerAudioType Type of audio container.
|
AudioChunk
Field | Description |
---|---|
data | bytes Bytes with audio data. |
UploadTalkResponse
Field | Description |
---|---|
talk_id | string id of created talk document |
UploadText
rpc for uploading text talk document
rpc UploadText (UploadTextRequest) returns (UploadTextResponse)
UploadTextRequest
Field | Description |
---|---|
metadata | TalkMetadata |
text_content | TextContent |
TalkMetadata
Field | Description |
---|---|
connection_id | string id of connection this talk belongs too |
fields | map<string,string> channel defined fields |
TextContent
Field | Description |
---|---|
messages[] | Message |
Message
Field | Description |
---|---|
user_id | string |
timestamp | google.protobuf.Timestamp |
payload | oneof: text |
text | TextPayload |
TextPayload
Field | Description |
---|---|
text | string |
UploadTextResponse
Field | Description |
---|---|
talk_id | string id of created talk document |