Cloud Speech V2 Client - Class BatchRecognizeFileResult (1.18.3)

Version 1.18.3

• 1.19.1 (latest)
• 1.19.0
• 1.18.3
• 1.16.0
• 1.15.0
• 1.14.3
• 1.13.1
• 1.12.0
• 1.11.2
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0

Reference documentation and code samples for the Cloud Speech V2 Client class BatchRecognizeFileResult.

Final results for a single file.

Generated from protobuf message google.cloud.speech.v2.BatchRecognizeFileResult

Namespace

Google \ Cloud \ Speech \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ error	Google\Rpc\Status Error if one was encountered.
↳ metadata	Google\Cloud\Speech\V2\RecognitionResponseMetadata
↳ cloud_storage_result	Google\Cloud\Speech\V2\CloudStorageResult Recognition results written to Cloud Storage. This is populated only when GcsOutputConfig is set in the [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig].
↳ inline_result	Google\Cloud\Speech\V2\InlineResult Recognition results. This is populated only when InlineOutputConfig is set in the [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig].
↳ uri	string Deprecated. Use cloud_storage_result.native_format_uri instead.
↳ transcript	Google\Cloud\Speech\V2\BatchRecognizeResults Deprecated. Use inline_result.transcript instead.

getError

Error if one was encountered.

Returns
Type	Description
Google\Rpc\Status|null

hasError

clearError

setError

Error if one was encountered.

Parameter
Name	Description
var	Google\Rpc\Status

Returns
Type	Description
$this

getMetadata

Generated from protobuf field .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 3;

Returns
Type	Description
Google\Cloud\Speech\V2\RecognitionResponseMetadata|null

hasMetadata

clearMetadata

setMetadata

Generated from protobuf field .google.cloud.speech.v2.RecognitionResponseMetadata metadata = 3;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\RecognitionResponseMetadata

Returns
Type	Description
$this

getCloudStorageResult

Recognition results written to Cloud Storage. This is populated only when GcsOutputConfig is set in the [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig].

Returns
Type	Description
Google\Cloud\Speech\V2\CloudStorageResult|null

hasCloudStorageResult

setCloudStorageResult

Recognition results written to Cloud Storage. This is populated only when GcsOutputConfig is set in the [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig].

Parameter
Name	Description
var	Google\Cloud\Speech\V2\CloudStorageResult

Returns
Type	Description
$this

getInlineResult

Recognition results. This is populated only when InlineOutputConfig is set in the [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig].

Returns
Type	Description
Google\Cloud\Speech\V2\InlineResult|null

hasInlineResult

setInlineResult

Recognition results. This is populated only when InlineOutputConfig is set in the [RecognitionOutputConfig][[google.cloud.speech.v2.RecognitionOutputConfig].

Parameter
Name	Description
var	Google\Cloud\Speech\V2\InlineResult

Returns
Type	Description
$this

getUri

Deprecated. Use cloud_storage_result.native_format_uri instead.

Returns
Type	Description
string

setUri

Deprecated. Use cloud_storage_result.native_format_uri instead.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTranscript

Deprecated. Use inline_result.transcript instead.

Returns
Type	Description
Google\Cloud\Speech\V2\BatchRecognizeResults|null

hasTranscript

clearTranscript

setTranscript

Deprecated. Use inline_result.transcript instead.

Parameter
Name	Description
var	Google\Cloud\Speech\V2\BatchRecognizeResults

Returns
Type	Description
$this

getResult

Returns
Type	Description
string