feat: added a profanity filter sample (GoogleCloudPlatform#1236)

Author: b-loved-dreamer

speech/src/profanity_filter.php

@@ -0,0 +1,67 @@
+
+# Copyright 2020 Google LLC
+# 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.
+
+# [START profanity_filter]
+
+# Includes the autoloader for libraries installed with composer
+require __DIR__ . '/../vendor/autoload.php';
+
+if (count($argv) != 2) {
+    return print("Usage: php profanity_filter.php AUDIO_FILE\n");
+}
+list($_, $audioFile) = $argv;
+
+use Google\Cloud\Speech\V1\SpeechClient;
+use Google\Cloud\Speech\V1\RecognitionAudio;
+use Google\Cloud\Speech\V1\RecognitionConfig;
+use Google\Cloud\Speech\V1\RecognitionConfig\AudioEncoding;
+
+/** Uncomment and populate these variables in your code */
+// $audioFile = 'path to an audio file';
+
+// change these variables if necessary
+$encoding = AudioEncoding::LINEAR16;
+$sampleRateHertz = 32000;
+$languageCode = 'en-US';
+$profanityFilter = true;
+
+// get contents of a file into a string
+$content = file_get_contents($audioFile);
+
+// set string as audio content
+$audio = (new RecognitionAudio())
+    ->setContent($content);
+
+// set config
+$config = (new RecognitionConfig())
+    ->setEncoding($encoding)
+    ->setSampleRateHertz($sampleRateHertz)
+    ->setLanguageCode($languageCode)
+    ->setProfanityFilter($profanityFilter);
+
+// create the speech client
+$client = new SpeechClient();
+
+# Detects speech in the audio file
+$response = $client->recognize($config, $audio);
+
+# Print most likely transcription
+foreach ($response->getResults() as $result) {
+    $transcript = $result->getAlternatives()[0]->getTranscript();
+    printf('Transcript: %s' . PHP_EOL, $transcript);
+}
+
+$client->close();
+
+# [END profanity_filter]

speech/src/profanity_filter_gcs.php

@@ -0,0 +1,66 @@
+
+# Copyright 2020 Google LLC
+# 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.
+
+# [START profanity_filter_gcs]
+# Includes the autoloader for libraries installed with composer
+require __DIR__ . '/../vendor/autoload.php';
+
+// Include Google Cloud dependendencies using Composer
+require_once __DIR__ . '/../vendor/autoload.php';
+
+if (count($argv) != 2) {
+    return print("Usage: php profanity_filter_gcs.php AUDIO_FILE\n");
+}
+list($_, $audioFile) = $argv;
+
+use Google\Cloud\Speech\V1\SpeechClient;
+use Google\Cloud\Speech\V1\RecognitionAudio;
+use Google\Cloud\Speech\V1\RecognitionConfig;
+use Google\Cloud\Speech\V1\RecognitionConfig\AudioEncoding;
+
+/** The Cloud Storage object to transcribe */
+// $uri = 'The Cloud Storage object to transcribe (gs://your-bucket-name/your-object-name)';
+
+// change these variables if necessary
+$encoding = AudioEncoding::LINEAR16;
+$sampleRateHertz = 32000;
+$languageCode = 'en-US';
+$profanityFilter = true;
+
+// set string as audio content
+$audio = (new RecognitionAudio())
+    ->setUri($audioFile);
+
+// set config
+$config = (new RecognitionConfig())
+    ->setEncoding($encoding)
+    ->setSampleRateHertz($sampleRateHertz)
+    ->setLanguageCode($languageCode)
+    ->setProfanityFilter($profanityFilter);
+
+// create the speech client
+$client = new SpeechClient();
+
+# Detects speech in the audio file
+$response = $client->recognize($config, $audio);
+
+# Print most likely transcription
+foreach ($response->getResults() as $result) {
+    $transcript = $result->getAlternatives()[0]->getTranscript();
+    printf('Transcript: %s' . PHP_EOL, $transcript);
+}
+
+$client->close();
+
+# [END profanity_filter_gcs]

speech/test/speechTest.php

@@ -76,7 +76,7 @@ public function testTranscribe($command, $audioFile, $requireGrpc = false)
         if ($requireGrpc && !extension_loaded('grpc')) {
             self::markTestSkipped('Must enable grpc extension.');
         }
-        if (!self::$bucketName && in_array($command, ['transcribe_gcs', 'transcribe_async_gcs'])) {
+        if (!self::$bucketName && in_array($command, ['transcribe_gcs', 'transcribe_async_gcs', 'profanity_filter_gcs'])) {
             $this->requireEnv('GOOGLE_STORAGE_BUCKET');
         }
         $output = $this->runSnippet($command, [$audioFile]);
@@ -98,6 +98,8 @@ public function provideTranscribe()
             ['transcribe_async', __DIR__ . '/data/audio32KHz.raw'],
             ['transcribe_async_gcs', 'gs://' . self::$bucketName . '/speech/audio32KHz.raw'],
             ['transcribe_async_words', __DIR__ . '/data/audio32KHz.raw'],
+            ['profanity_filter_gcs', 'gs://' . self::$bucketName . '/speech/audio32KHz.raw'],
+            ['profanity_filter', __DIR__ . '/data/audio32KHz.raw'],
             ['streaming_recognize', __DIR__ . '/data/audio32KHz.raw', true],
         ];
     }