Reference documentation and code samples for the Cloud Speech V2 Client class SpeechClient.
Service Description: Enables speech transcription and resource management.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Speech \ V2 \ ClientMethods
__construct
Constructor.
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.
batchRecognize
Performs batch asynchronous speech recognition: send a request with N audio files and receive a long running operation that can be polled to see when the transcriptions are finished.
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::batchRecognizeAsync() .
request
callOptions
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.
createCustomClass
Creates a CustomClass .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::createCustomClassAsync() .
request
callOptions
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.
createPhraseSet
Creates a PhraseSet .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::createPhraseSetAsync() .
request
callOptions
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.
createRecognizer
Creates a Recognizer .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::createRecognizerAsync() .
request
callOptions
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.
deleteCustomClass
Deletes the CustomClass .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::deleteCustomClassAsync() .
request
callOptions
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.
deletePhraseSet
Deletes the PhraseSet .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::deletePhraseSetAsync() .
request
callOptions
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.
deleteRecognizer
Deletes the Recognizer .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::deleteRecognizerAsync() .
request
callOptions
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.
getConfig
Returns the requested Config .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::getConfigAsync() .
request
callOptions
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.
getCustomClass
Returns the requested CustomClass .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::getCustomClassAsync() .
request
callOptions
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.
getPhraseSet
Returns the requested PhraseSet .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::getPhraseSetAsync() .
request
callOptions
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.
getRecognizer
Returns the requested Recognizer . Fails with NOT_FOUND if the requested Recognizer doesn't exist.
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::getRecognizerAsync() .
request
callOptions
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.
listCustomClasses
Lists CustomClasses.
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::listCustomClassesAsync() .
request
callOptions
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.
listPhraseSets
Lists PhraseSets.
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::listPhraseSetsAsync() .
request
callOptions
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.
listRecognizers
Lists Recognizers.
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::listRecognizersAsync() .
request
callOptions
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.
recognize
Performs synchronous Speech recognition: receive results after all audio has been sent and processed.
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::recognizeAsync() .
request
callOptions
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.
streamingRecognize
Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
undeleteCustomClass
Undeletes the CustomClass .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::undeleteCustomClassAsync() .
request
Google\Cloud\Speech\V2\UndeleteCustomClassRequest
A request to house fields associated with the call.
callOptions
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.
undeletePhraseSet
Undeletes the PhraseSet .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::undeletePhraseSetAsync() .
request
callOptions
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.
undeleteRecognizer
Undeletes the Recognizer .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::undeleteRecognizerAsync() .
request
Google\Cloud\Speech\V2\UndeleteRecognizerRequest
A request to house fields associated with the call.
callOptions
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.
updateConfig
Updates the Config .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::updateConfigAsync() .
request
callOptions
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.
updateCustomClass
Updates the CustomClass .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::updateCustomClassAsync() .
request
callOptions
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.
updatePhraseSet
Updates the PhraseSet .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::updatePhraseSetAsync() .
request
callOptions
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.
updateRecognizer
Updates the Recognizer .
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::updateRecognizerAsync() .
request
callOptions
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::getLocationAsync() .
request
callOptions
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Speech\V2\Client\BaseClient\self::listLocationsAsync() .
request
callOptions
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.
batchRecognizeAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createCustomClassAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createPhraseSetAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createRecognizerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteCustomClassAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deletePhraseSetAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteRecognizerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getConfigAsync
GuzzleHttp\Promise\PromiseInterface
getCustomClassAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getPhraseSetAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getRecognizerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listCustomClassesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listPhraseSetsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listRecognizersAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
recognizeAsync
GuzzleHttp\Promise\PromiseInterface
undeleteCustomClassAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
undeletePhraseSetAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
undeleteRecognizerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateConfigAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateCustomClassAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updatePhraseSetAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateRecognizerAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::configName
Formats a string containing the fully-qualified path to represent a config resource.
project
string
location
string
string
static::cryptoKeyName
Formats a string containing the fully-qualified path to represent a crypto_key resource.
project
string
location
string
keyRing
string
cryptoKey
string
string
static::cryptoKeyVersionName
Formats a string containing the fully-qualified path to represent a crypto_key_version resource.
project
string
location
string
keyRing
string
cryptoKey
string
cryptoKeyVersion
string
string
static::customClassName
Formats a string containing the fully-qualified path to represent a custom_class resource.
project
string
location
string
customClass
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::phraseSetName
Formats a string containing the fully-qualified path to represent a phrase_set resource.
project
string
location
string
phraseSet
string
string
static::recognizerName
Formats a string containing the fully-qualified path to represent a recognizer resource.
project
string
location
string
recognizer
string
string
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
- config: projects/{project}/locations/{location}/config
- cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- cryptoKeyVersion: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
- customClass: projects/{project}/locations/{location}/customClasses/{custom_class}
- location: projects/{project}/locations/{location}
- phraseSet: projects/{project}/locations/{location}/phraseSets/{phrase_set}
- recognizer: projects/{project}/locations/{location}/recognizers/{recognizer}
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
