Cloud Speech V1 Client - Class SpeechClient (1.14.3)

Reference documentation and code samples for the Cloud Speech V1 Client class SpeechClient.

Service Description: Service that implements Google Cloud Speech API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$speechClient = new Google\Cloud\Speech\V1\SpeechClient();
try {
    $config = new Google\Cloud\Speech\V1\RecognitionConfig();
    $audio = new Google\Cloud\Speech\V1\RecognitionAudio();
    $operationResponse = $speechClient->longRunningRecognize($config, $audio);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $speechClient->longRunningRecognize($config, $audio);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $speechClient->resumeOperation($operationName, 'longRunningRecognize');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
        // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $speechClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ Speech \ V1

Methods

createRecognitionAudio

Helper method to create a RecognitionAudio object from audio data.

Parameter
Name	Description
`audio`	`resource\|string\|Google\Cloud\Speech\V1\RecognitionAudio` Required The audio data to be recognized. This can be a RecognitionAudio object, a Google Cloud Storage URI, a resource object, or a string of bytes.

Returns
Type	Description
`Google\Cloud\Speech\V1\RecognitionAudio`

createStreamingRequests

Helper method to create a stream of StreamingRecognizeRequest objects from audio data.

Parameter
Name	Description
`audio`	`Traversable\|resource\|string` Required The audio data to be converted into a stream of requests. This can be a resource, a string of bytes, or an iterable of StreamingRecognizeRequest[] or string[].

Returns
Type	Description
`array<Google\Cloud\Speech\V1\StreamingRecognizeRequest>`

recognizeAudioStream

Performs speech recognition on a stream of audio data. This method is only available via the gRPC API (not REST).

Example:

use Google\Cloud\Speech\V1\RecognitionConfig_AudioEncoding;
use Google\Cloud\Speech\V1\RecognitionConfig;
use Google\Cloud\Speech\V1\StreamingRecognitionConfig;

$recognitionConfig = new RecognitionConfig();
$recognitionConfig->setEncoding(RecognitionConfig_AudioEncoding::FLAC);
$recognitionConfig->setSampleRateHertz(44100);
$recognitionConfig->setLanguageCode('en-US');
$config = new StreamingRecognitionConfig();
$config->setConfig($recognitionConfig);

$audioResource = fopen('path/to/audio.flac', 'r');

$responses = $speechClient->recognizeAudioStream($config, $audioResource);

foreach ($responses as $element) {
    // doSomethingWith($element);
}

Parameters
Name	Description
`config`	`Google\Cloud\Speech\V1\StreamingRecognitionConfig` Required Provides information to the recognizer that specifies how to process the request.
`audio`	`Traversable\|resource\|string` Required Audio data to be streamed. Can be a resource, a string of bytes, or an iterable of StreamingRecognizeRequest[] or string[].
`optionalArgs`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`array<Google\Cloud\Speech\V1\StreamingRecognizeResponse>`

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

longRunningRecognize

Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an Operation.error or an Operation.response which contains a LongRunningRecognizeResponse message.

For more information on asynchronous speech recognition, see the how-to.

Parameters
Name	Description
`config`	`Google\Cloud\Speech\V1\RecognitionConfig` Required. Provides information to the recognizer that specifies how to process the request.
`audio`	`Google\Cloud\Speech\V1\RecognitionAudio` Required. The audio data to be recognized.
`optionalArgs`	`array` Optional.
`↳ outputConfig`	`TranscriptOutputConfig` Optional. Specifies an optional destination for the recognition results.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Speech\V1\LongRunningRecognizeResponse;
use Google\Cloud\Speech\V1\RecognitionAudio;
use Google\Cloud\Speech\V1\RecognitionConfig;
use Google\Cloud\Speech\V1\SpeechClient;
use Google\Rpc\Status;

/**
 * @param string $configLanguageCode The language of the supplied audio as a
 *                                   [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
 *                                   Example: "en-US".
 *                                   See [Language
 *                                   Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
 *                                   of the currently supported language codes.
 */
function long_running_recognize_sample(string $configLanguageCode): void
{
    // Create a client.
    $speechClient = new SpeechClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $config = (new RecognitionConfig())
        ->setLanguageCode($configLanguageCode);
    $audio = new RecognitionAudio();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $speechClient->longRunningRecognize($config, $audio);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var LongRunningRecognizeResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $configLanguageCode = '[LANGUAGE_CODE]';

    long_running_recognize_sample($configLanguageCode);
}

recognize

Performs synchronous speech recognition: receive results after all audio has been sent and processed.

Parameters
Name	Description
`config`	`Google\Cloud\Speech\V1\RecognitionConfig` Required. Provides information to the recognizer that specifies how to process the request.
`audio`	`Google\Cloud\Speech\V1\RecognitionAudio` Required. The audio data to be recognized.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Speech\V1\RecognizeResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Speech\V1\RecognitionAudio;
use Google\Cloud\Speech\V1\RecognitionConfig;
use Google\Cloud\Speech\V1\RecognizeResponse;
use Google\Cloud\Speech\V1\SpeechClient;

/**
 * @param string $configLanguageCode The language of the supplied audio as a
 *                                   [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
 *                                   Example: "en-US".
 *                                   See [Language
 *                                   Support](https://cloud.google.com/speech-to-text/docs/languages) for a list
 *                                   of the currently supported language codes.
 */
function recognize_sample(string $configLanguageCode): void
{
    // Create a client.
    $speechClient = new SpeechClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $config = (new RecognitionConfig())
        ->setLanguageCode($configLanguageCode);
    $audio = new RecognitionAudio();

    // Call the API and handle any network failures.
    try {
        /** @var RecognizeResponse $response */
        $response = $speechClient->recognize($config, $audio);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $configLanguageCode = '[LANGUAGE_CODE]';

    recognize_sample($configLanguageCode);
}

streamingRecognize

Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Speech\V1\SpeechClient;
use Google\Cloud\Speech\V1\StreamingRecognizeRequest;
use Google\Cloud\Speech\V1\StreamingRecognizeResponse;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function streaming_recognize_sample(): void
{
    // Create a client.
    $speechClient = new SpeechClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $request = new StreamingRecognizeRequest();

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $speechClient->streamingRecognize();
        $stream->writeAll([$request,]);

        /** @var StreamingRecognizeResponse $element */
        foreach ($stream->closeWriteAndReadAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::customClassName

Formats a string containing the fully-qualified path to represent a custom_class resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`customClass`	`string`

Returns
Type	Description
`string`	The formatted custom_class resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::phraseSetName

Formats a string containing the fully-qualified path to represent a phrase_set resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`phraseSet`	`string`

Returns
Type	Description
`string`	The formatted phrase_set resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

customClass: projects/{project}/locations/{location}/customClasses/{custom_class}
location: projects/{project}/locations/{location}
phraseSet: projects/{project}/locations/{location}/phraseSets/{phrase_set}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.speech.v1.Speech'

The name of the service.

SERVICE_ADDRESS

Value: 'speech.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.