-
Notifications
You must be signed in to change notification settings - Fork 2.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Speech API quickstart sample. #497
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Getting Started with Google Cloud Speech API and the Google Cloud Client libraries | ||
|
||
[Google Cloud Speech API][speech] enables easy integration of Google speech | ||
recognition technologies into developer applications. | ||
|
||
These sample Java applications demonstrate how to access the Cloud Speech API | ||
using the [Google Cloud Client Library for Java][google-cloud-java]. | ||
|
||
[speech]: https://cloud.google.com/speech/docs/ | ||
[google-cloud-java]: https://github.com/GoogleCloudPlatform/google-cloud-java | ||
|
||
## Quickstart | ||
|
||
Install [Maven](http://maven.apache.org/). | ||
|
||
Build your project with: | ||
|
||
mvn clean package -DskipTests | ||
|
||
You can then run a given `ClassName` via: | ||
|
||
mvn exec:java -Dexec.mainClass=com.example.speech.ClassName | ||
|
||
### Transcribe a local audio file (using the quickstart sample) | ||
|
||
mvn exec:java -Dexec.mainClass=com.example.speech.QuickstartSample |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
<!-- | ||
Copyright 2017, Google Inc. | ||
|
||
Licensed 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. | ||
--> | ||
<project> | ||
<modelVersion>4.0.0</modelVersion> | ||
<groupId>com.example.speech</groupId> | ||
<artifactId>speech-google-cloud-samples</artifactId> | ||
<packaging>jar</packaging> | ||
|
||
<!-- Parent defines config for testing & linting. --> | ||
<parent> | ||
<artifactId>doc-samples</artifactId> | ||
<groupId>com.google.cloud</groupId> | ||
<version>1.0.0</version> | ||
<relativePath>../..</relativePath> | ||
</parent> | ||
|
||
<properties> | ||
<maven.compiler.target>1.8</maven.compiler.target> | ||
<maven.compiler.source>1.8</maven.compiler.source> | ||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
</properties> | ||
|
||
<dependencies> | ||
<!-- [START dependencies] --> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-speech</artifactId> | ||
<version>0.8.1-alpha</version> | ||
</dependency> | ||
<!-- [END dependencies] --> | ||
|
||
<!-- Test dependencies --> | ||
<dependency> | ||
<groupId>junit</groupId> | ||
<artifactId>junit</artifactId> | ||
<version>4.12</version> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.google.truth</groupId> | ||
<artifactId>truth</artifactId> | ||
<version>0.31</version> | ||
<scope>test</scope> | ||
</dependency> | ||
</dependencies> | ||
</project> |
Binary file not shown.
69 changes: 69 additions & 0 deletions
69
speech/cloud-client/src/main/java/com/example/speech/QuickstartSample.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
/* | ||
Copyright 2017, Google Inc. | ||
|
||
Licensed 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. | ||
*/ | ||
|
||
package com.example.speech; | ||
|
||
// [START speech_quickstart] | ||
// Imports the Google Cloud client library | ||
import com.google.cloud.speech.spi.v1beta1.SpeechClient; | ||
import com.google.cloud.speech.v1beta1.RecognitionAudio; | ||
import com.google.cloud.speech.v1beta1.RecognitionConfig; | ||
import com.google.cloud.speech.v1beta1.RecognitionConfig.AudioEncoding; | ||
import com.google.cloud.speech.v1beta1.SpeechRecognitionAlternative; | ||
import com.google.cloud.speech.v1beta1.SpeechRecognitionResult; | ||
import com.google.cloud.speech.v1beta1.SyncRecognizeResponse; | ||
import com.google.protobuf.ByteString; | ||
|
||
import java.nio.file.Files; | ||
import java.nio.file.Path; | ||
import java.nio.file.Paths; | ||
import java.util.List; | ||
|
||
public class QuickstartSample { | ||
public static void main(String... args) throws Exception { | ||
// Instantiates a client | ||
SpeechClient speech = SpeechClient.create(); | ||
|
||
// The path to the audio file to transcribe | ||
String fileName = "./resources/audio.raw"; | ||
|
||
// Reads the audio file into memory | ||
Path path = Paths.get(fileName); | ||
byte[] data = Files.readAllBytes(path); | ||
ByteString audioBytes = ByteString.copyFrom(data); | ||
|
||
// Builds the sync recognize request | ||
RecognitionConfig config = RecognitionConfig.newBuilder() | ||
.setEncoding(AudioEncoding.LINEAR16) | ||
.setSampleRate(16000) | ||
.build(); | ||
RecognitionAudio audio = RecognitionAudio.newBuilder() | ||
.setContent(audioBytes) | ||
.build(); | ||
|
||
// Performs speech recognition on the audio file | ||
SyncRecognizeResponse response = speech.syncRecognize(config, audio); | ||
List<SpeechRecognitionResult> results = response.getResultsList(); | ||
|
||
for (SpeechRecognitionResult result: results) { | ||
List<SpeechRecognitionAlternative> alternatives = result.getAlternativesList(); | ||
for (SpeechRecognitionAlternative alternative: alternatives) { | ||
System.out.printf("Transcription: %s%n", alternative.getTranscript()); | ||
} | ||
} | ||
} | ||
} | ||
// [END speech_quickstart] |
60 changes: 60 additions & 0 deletions
60
speech/cloud-client/src/test/java/com/example/speech/QuickstartSampleIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
/* | ||
Copyright 2017, Google, Inc. | ||
|
||
Licensed 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. | ||
*/ | ||
|
||
package com.example.speech; | ||
|
||
import static com.google.common.truth.Truth.assertThat; | ||
|
||
import org.junit.After; | ||
import org.junit.Before; | ||
import org.junit.Test; | ||
import org.junit.runner.RunWith; | ||
import org.junit.runners.JUnit4; | ||
|
||
import java.io.ByteArrayOutputStream; | ||
import java.io.PrintStream; | ||
|
||
/** | ||
* Tests for quickstart sample. | ||
*/ | ||
@RunWith(JUnit4.class) | ||
@SuppressWarnings("checkstyle:abbreviationaswordinname") | ||
public class QuickstartSampleIT { | ||
private ByteArrayOutputStream bout; | ||
private PrintStream out; | ||
|
||
@Before | ||
public void setUp() { | ||
bout = new ByteArrayOutputStream(); | ||
out = new PrintStream(bout); | ||
System.setOut(out); | ||
} | ||
|
||
@After | ||
public void tearDown() { | ||
System.setOut(null); | ||
} | ||
|
||
@Test | ||
public void testQuickstart() throws Exception { | ||
// Act | ||
QuickstartSample.main(); | ||
|
||
// Assert | ||
String got = bout.toString(); | ||
assertThat(got).contains("how old is the Brooklyn Bridge"); | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to add this to the top-level pom.xml in order for the tests to run
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really? The test definitely ran during the travis build, or are you refereing to something else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Huh.
...okay, yeah - it's a quirk of how we run travis builds. ie for PRs, we don't run the full suite of tests - we see what files have changed, then cd into that directory before running tests. So for the PR, it'll run the right tests, but when running the full suite, it won't know about these tests without being in the parent pom.