Guide to Techmo ASR API usage

Introduction

This guide provides tutorials for how to compile and use the APIs from Techmo ASR API. Knowledge of Protocols Buffers and gRPC may be beneficial, but is not required.

If you do not know what Techmo ASR API is for, please refer to the overall guide first.

Quick start navigation

  • Want to learn how to generate code from .proto files?

Go to the language guides section.

  • Need a list of .proto files associated with a specific API release?

Go to the proto selection section.

Language guides

For now, there is a dedicated tutorial for:

It does not mean that this is the only possible language to work, however. Others can be treated similarly as long as there is a dedicated Protocol Buffers compiler and a gRPC plugin for it. For lists of all languages officially supported by Protocol Buffers and gRPC, see the official Protocol Buffers and gRPC tutorials.

Proto selection

It is not obligatory to compile all the .proto files included. When working with a specific API release, it is even better to generate code from a suitable subset listed below. This repository aims to be self-contained so that all imports across its .proto files can be resolved within its structure, excluding files available through the Protocol Buffers library as the google.protobuf package.

There are two lists available for each API version. One with all associated .proto files, the other with specific files that need to be compiled additionally with a gRPC plugin. Compiling non-gRPC protos with a plugin like this is not entirely bad, but it does create unnecessary artifacts.

techmo.asr.api.v1 protos

  • protos

    • techmo/api/status.proto

    • techmo/asr/api/v1/asr.proto

  • protos for the gRPC plugin

    • techmo/asr/api/v1/asr.proto

techmo.asr.api.v1p1 protos

  • protos

    • techmo/api/status.proto

    • techmo/asr/api/v1p1/asr.proto

  • protos for the gRPC plugin

    • techmo/asr/api/v1p1/asr.proto