Skip to content

Latest commit

 

History

History
137 lines (103 loc) · 6.24 KB

README.md

File metadata and controls

137 lines (103 loc) · 6.24 KB
Raw

Google Cloud Java Client for Speech

Java idiomatic client for Google Cloud Speech.

Kokoro CI Maven Codacy Badge

Note: This client is a work-in-progress, and may occasionally make backwards-incompatible changes.

Quickstart

If you are using Maven, add this to your pom.xml file

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-speech</artifactId>
  <version>0.74.0-beta</version>
</dependency>

If you are using Gradle, add this to your dependencies

compile 'com.google.cloud:google-cloud-speech:0.74.0-beta'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-speech" % "0.74.0-beta"

Authentication

See the Authentication section in the base directory's README.

About Google Cloud Speech

Google Cloud Speech API enables easy integration of Google speech recognition technologies into developer applications. Send audio and receive a text transcription from the Cloud Speech API service.

See the Speech client library docs to learn how to use this Cloud Speech API Client Library.

Getting Started

Prerequisites

You will need a Google Developers Console project with the Speech API enabled. Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google Cloud SDK and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].

Installation and setup

You'll need to obtain the google-cloud-speech library. See the Quickstart section to add google-cloud-speech as a dependency in your code.

Recognizing speech

The following code sample shows how to recognize speech using an audio file from a Cloud Storage bucket as input. First, add the following imports at the top of your file:

import com.google.cloud.speech.v1.SpeechClient;
import com.google.cloud.speech.v1.RecognitionAudio;
import com.google.cloud.speech.v1.RecognitionConfig;
import com.google.cloud.speech.v1.RecognitionConfig.AudioEncoding;
import com.google.cloud.speech.v1.RecognizeResponse;

Then add the following code to do the speech recognization:

 try (SpeechClient speechClient = SpeechClient.create()) {
   RecognitionConfig.AudioEncoding encoding = RecognitionConfig.AudioEncoding.FLAC;
   int sampleRateHertz = 44100;
   String languageCode = "en-US";
   RecognitionConfig config = RecognitionConfig.newBuilder()
     .setEncoding(encoding)
     .setSampleRateHertz(sampleRateHertz)
     .setLanguageCode(languageCode)
     .build();
   String uri = "gs://bucket_name/file_name.flac";
   RecognitionAudio audio = RecognitionAudio.newBuilder()
     .setUri(uri)
     .build();
   RecognizeResponse response = speechClient.recognize(config, audio);
 }

Complete source code

In RecognizeSpeech.java we put a quick start example, which shows how you can use Google Speech API to automatically recognize speech based on a local file.

For an example audio file, you can use the audio.raw file from the samples repository. Note, to play the file on Unix-like system you may use the following command: play -t raw -r 16k -e signed -b 16 -c 1 audio.raw

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Transport

Speech uses gRPC for the transport layer.

Java Versions

Java 7 or above is required for using this client.

Versioning

This library follows Semantic Versioning.

It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.

Contributing

Contributions to this library are always welcome and highly encouraged.

See google-cloud's CONTRIBUTING documentation and the shared documentation for more information on how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

Apache 2.0 - See LICENSE for more information.