Enables speech transcription and resource management.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
SpeechClient(SpeechClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SpeechClient const &
|
SpeechClient(SpeechClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SpeechClient &&
|
SpeechClient(std::shared_ptr< SpeechConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< SpeechConnection >
|
opts |
Options
|
Operators
operator=(SpeechClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SpeechClient const &
|
Returns | |
---|---|
Type | Description |
SpeechClient & |
operator=(SpeechClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SpeechClient &&
|
Returns | |
---|---|
Type | Description |
SpeechClient & |
Functions
CreateRecognizer(std::string const &, google::cloud::speech::v2::Recognizer const &, std::string const &, Options)
Creates a Recognizer.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location where this Recognizer will be created. The expected format is |
recognizer |
google::cloud::speech::v2::Recognizer const &
Required. The Recognizer to create. |
recognizer_id |
std::string const &
The ID to use for the Recognizer, which will become the final component of the Recognizer's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
A |
CreateRecognizer(NoAwaitTag, std::string const &, google::cloud::speech::v2::Recognizer const &, std::string const &, Options)
Creates a Recognizer.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
recognizer |
google::cloud::speech::v2::Recognizer const &
|
recognizer_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateRecognizer(google::cloud::speech::v2::CreateRecognizerRequest const &, Options)
Creates a Recognizer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::CreateRecognizerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
A |
CreateRecognizer(NoAwaitTag, google::cloud::speech::v2::CreateRecognizerRequest const &, Options)
Creates a Recognizer.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::CreateRecognizerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateRecognizer(google::longrunning::Operation const &, Options)
Creates a Recognizer.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
ListRecognizers(std::string const &, Options)
Lists Recognizers.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location of Recognizers to list. The expected format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::speech::v2::Recognizer > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRecognizers(google::cloud::speech::v2::ListRecognizersRequest, Options)
Lists Recognizers.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::ListRecognizersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::speech::v2::Recognizer > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetRecognizer(std::string const &, Options)
Returns the requested Recognizer.
Fails with [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested Recognizer doesn't exist.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Recognizer to retrieve. The expected format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::Recognizer > |
the result of the RPC. The response message type (google.cloud.speech.v2.Recognizer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRecognizer(google::cloud::speech::v2::GetRecognizerRequest const &, Options)
Returns the requested Recognizer.
Fails with [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested Recognizer doesn't exist.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::GetRecognizerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::Recognizer > |
the result of the RPC. The response message type (google.cloud.speech.v2.Recognizer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRecognizer(google::cloud::speech::v2::Recognizer const &, google::protobuf::FieldMask const &, Options)
Updates the Recognizer.
Parameters | |
---|---|
Name | Description |
recognizer |
google::cloud::speech::v2::Recognizer const &
Required. The Recognizer to update. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to update. If empty, all non-default valued fields are considered for update. Use |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
A |
UpdateRecognizer(NoAwaitTag, google::cloud::speech::v2::Recognizer const &, google::protobuf::FieldMask const &, Options)
Updates the Recognizer.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
recognizer |
google::cloud::speech::v2::Recognizer const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateRecognizer(google::cloud::speech::v2::UpdateRecognizerRequest const &, Options)
Updates the Recognizer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::UpdateRecognizerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
A |
UpdateRecognizer(NoAwaitTag, google::cloud::speech::v2::UpdateRecognizerRequest const &, Options)
Updates the Recognizer.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::UpdateRecognizerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateRecognizer(google::longrunning::Operation const &, Options)
Updates the Recognizer.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
DeleteRecognizer(std::string const &, Options)
Deletes the Recognizer.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Recognizer to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
A |
DeleteRecognizer(NoAwaitTag, std::string const &, Options)
Deletes the Recognizer.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteRecognizer(google::cloud::speech::v2::DeleteRecognizerRequest const &, Options)
Deletes the Recognizer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::DeleteRecognizerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
A |
DeleteRecognizer(NoAwaitTag, google::cloud::speech::v2::DeleteRecognizerRequest const &, Options)
Deletes the Recognizer.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::DeleteRecognizerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteRecognizer(google::longrunning::Operation const &, Options)
Deletes the Recognizer.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
UndeleteRecognizer(std::string const &, Options)
Undeletes the Recognizer.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Recognizer to undelete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
A |
UndeleteRecognizer(NoAwaitTag, std::string const &, Options)
Undeletes the Recognizer.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeleteRecognizer(google::cloud::speech::v2::UndeleteRecognizerRequest const &, Options)
Undeletes the Recognizer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::UndeleteRecognizerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
A |
UndeleteRecognizer(NoAwaitTag, google::cloud::speech::v2::UndeleteRecognizerRequest const &, Options)
Undeletes the Recognizer.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::UndeleteRecognizerRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeleteRecognizer(google::longrunning::Operation const &, Options)
Undeletes the Recognizer.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::Recognizer > > |
Recognize(std::string const &, google::cloud::speech::v2::RecognitionConfig const &, google::protobuf::FieldMask const &, std::string const &, Options)
Performs synchronous Speech recognition: receive results after all audio has been sent and processed.
Parameters | |
---|---|
Name | Description |
recognizer |
std::string const &
Required. The name of the Recognizer to use during recognition. The expected format is |
config |
google::cloud::speech::v2::RecognitionConfig const &
Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource. |
config_mask |
google::protobuf::FieldMask const &
The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard ( |
content |
std::string const &
The audio data bytes encoded as specified in RecognitionConfig. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::RecognizeResponse > |
the result of the RPC. The response message type (google.cloud.speech.v2.RecognizeResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
Recognize(google::cloud::speech::v2::RecognizeRequest const &, Options)
Performs synchronous Speech recognition: receive results after all audio has been sent and processed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::RecognizeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::RecognizeResponse > |
the result of the RPC. The response message type (google.cloud.speech.v2.RecognizeResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AsyncStreamingRecognize(Options)
Performs bidirectional streaming speech recognition: receive results while sending audio.
This method is only available via the gRPC API (not REST).
Parameter | |
---|---|
Name | Description |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::speech::v2::StreamingRecognizeRequest, google::cloud::speech::v2::StreamingRecognizeResponse > > |
An object representing the bidirectional streaming RPC. Applications can send multiple request messages and receive multiple response messages through this API. Bidirectional streaming RPCs can impose restrictions on the sequence of request and response messages. Please consult the service documentation for details. The request message type (google.cloud.speech.v2.StreamingRecognizeRequest) and response messages (google.cloud.speech.v2.StreamingRecognizeResponse) are mapped to C++ classes using the Protobuf mapping rules. |
BatchRecognize(std::string const &, google::cloud::speech::v2::RecognitionConfig const &, google::protobuf::FieldMask const &, std::vector< google::cloud::speech::v2::BatchRecognizeFileMetadata > const &, Options)
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.
Parameters | |
---|---|
Name | Description |
recognizer |
std::string const &
Required. The name of the Recognizer to use during recognition. The expected format is |
config |
google::cloud::speech::v2::RecognitionConfig const &
Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the config_mask field can be used to override parts of the default_recognition_config of the Recognizer resource. |
config_mask |
google::protobuf::FieldMask const &
The list of fields in config that override the values in the default_recognition_config of the recognizer during this recognition request. If no mask is provided, all given fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard ( |
files |
std::vector< google::cloud::speech::v2::BatchRecognizeFileMetadata > const &
Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 15. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::BatchRecognizeResponse > > |
A |
BatchRecognize(NoAwaitTag, std::string const &, google::cloud::speech::v2::RecognitionConfig const &, google::protobuf::FieldMask const &, std::vector< google::cloud::speech::v2::BatchRecognizeFileMetadata > const &, Options)
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.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
recognizer |
std::string const &
|
config |
google::cloud::speech::v2::RecognitionConfig const &
|
config_mask |
google::protobuf::FieldMask const &
|
files |
std::vector< google::cloud::speech::v2::BatchRecognizeFileMetadata > const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
BatchRecognize(google::cloud::speech::v2::BatchRecognizeRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::BatchRecognizeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::BatchRecognizeResponse > > |
A |
BatchRecognize(NoAwaitTag, google::cloud::speech::v2::BatchRecognizeRequest const &, Options)
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.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::BatchRecognizeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
BatchRecognize(google::longrunning::Operation const &, Options)
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.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::BatchRecognizeResponse > > |
GetConfig(std::string const &, Options)
Returns the requested Config.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the config to retrieve. There is exactly one config resource per project per location. The expected format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::Config > |
the result of the RPC. The response message type (google.cloud.speech.v2.Config) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetConfig(google::cloud::speech::v2::GetConfigRequest const &, Options)
Returns the requested Config.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::GetConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::Config > |
the result of the RPC. The response message type (google.cloud.speech.v2.Config) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateConfig(google::cloud::speech::v2::Config const &, google::protobuf::FieldMask const &, Options)
Updates the Config.
Parameters | |
---|---|
Name | Description |
config |
google::cloud::speech::v2::Config const &
Required. The config to update. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::Config > |
the result of the RPC. The response message type (google.cloud.speech.v2.Config) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateConfig(google::cloud::speech::v2::UpdateConfigRequest const &, Options)
Updates the Config.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::UpdateConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::Config > |
the result of the RPC. The response message type (google.cloud.speech.v2.Config) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCustomClass(std::string const &, google::cloud::speech::v2::CustomClass const &, std::string const &, Options)
Creates a CustomClass.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location where this CustomClass will be created. The expected format is |
custom_class |
google::cloud::speech::v2::CustomClass const &
Required. The CustomClass to create. |
custom_class_id |
std::string const &
The ID to use for the CustomClass, which will become the final component of the CustomClass's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
A |
CreateCustomClass(NoAwaitTag, std::string const &, google::cloud::speech::v2::CustomClass const &, std::string const &, Options)
Creates a CustomClass.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
custom_class |
google::cloud::speech::v2::CustomClass const &
|
custom_class_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCustomClass(google::cloud::speech::v2::CreateCustomClassRequest const &, Options)
Creates a CustomClass.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::CreateCustomClassRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
A |
CreateCustomClass(NoAwaitTag, google::cloud::speech::v2::CreateCustomClassRequest const &, Options)
Creates a CustomClass.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::CreateCustomClassRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCustomClass(google::longrunning::Operation const &, Options)
Creates a CustomClass.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
ListCustomClasses(std::string const &, Options)
Lists CustomClasses.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location of CustomClass resources to list. The expected format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::speech::v2::CustomClass > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCustomClasses(google::cloud::speech::v2::ListCustomClassesRequest, Options)
Lists CustomClasses.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::ListCustomClassesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::speech::v2::CustomClass > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetCustomClass(std::string const &, Options)
Returns the requested CustomClass.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the CustomClass to retrieve. The expected format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::CustomClass > |
the result of the RPC. The response message type (google.cloud.speech.v2.CustomClass) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCustomClass(google::cloud::speech::v2::GetCustomClassRequest const &, Options)
Returns the requested CustomClass.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::GetCustomClassRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::CustomClass > |
the result of the RPC. The response message type (google.cloud.speech.v2.CustomClass) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateCustomClass(google::cloud::speech::v2::CustomClass const &, google::protobuf::FieldMask const &, Options)
Updates the CustomClass.
Parameters | |
---|---|
Name | Description |
custom_class |
google::cloud::speech::v2::CustomClass const &
Required. The CustomClass to update. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to be updated. If empty, all fields are considered for update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
A |
UpdateCustomClass(NoAwaitTag, google::cloud::speech::v2::CustomClass const &, google::protobuf::FieldMask const &, Options)
Updates the CustomClass.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
custom_class |
google::cloud::speech::v2::CustomClass const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateCustomClass(google::cloud::speech::v2::UpdateCustomClassRequest const &, Options)
Updates the CustomClass.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::UpdateCustomClassRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
A |
UpdateCustomClass(NoAwaitTag, google::cloud::speech::v2::UpdateCustomClassRequest const &, Options)
Updates the CustomClass.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::UpdateCustomClassRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateCustomClass(google::longrunning::Operation const &, Options)
Updates the CustomClass.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
DeleteCustomClass(std::string const &, Options)
Deletes the CustomClass.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the CustomClass to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
A |
DeleteCustomClass(NoAwaitTag, std::string const &, Options)
Deletes the CustomClass.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteCustomClass(google::cloud::speech::v2::DeleteCustomClassRequest const &, Options)
Deletes the CustomClass.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::DeleteCustomClassRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
A |
DeleteCustomClass(NoAwaitTag, google::cloud::speech::v2::DeleteCustomClassRequest const &, Options)
Deletes the CustomClass.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::DeleteCustomClassRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteCustomClass(google::longrunning::Operation const &, Options)
Deletes the CustomClass.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
UndeleteCustomClass(std::string const &, Options)
Undeletes the CustomClass.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the CustomClass to undelete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
A |
UndeleteCustomClass(NoAwaitTag, std::string const &, Options)
Undeletes the CustomClass.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeleteCustomClass(google::cloud::speech::v2::UndeleteCustomClassRequest const &, Options)
Undeletes the CustomClass.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::UndeleteCustomClassRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
A |
UndeleteCustomClass(NoAwaitTag, google::cloud::speech::v2::UndeleteCustomClassRequest const &, Options)
Undeletes the CustomClass.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::UndeleteCustomClassRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeleteCustomClass(google::longrunning::Operation const &, Options)
Undeletes the CustomClass.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::CustomClass > > |
CreatePhraseSet(std::string const &, google::cloud::speech::v2::PhraseSet const &, std::string const &, Options)
Creates a PhraseSet.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location where this PhraseSet will be created. The expected format is |
phrase_set |
google::cloud::speech::v2::PhraseSet const &
Required. The PhraseSet to create. |
phrase_set_id |
std::string const &
The ID to use for the PhraseSet, which will become the final component of the PhraseSet's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
A |
CreatePhraseSet(NoAwaitTag, std::string const &, google::cloud::speech::v2::PhraseSet const &, std::string const &, Options)
Creates a PhraseSet.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
phrase_set |
google::cloud::speech::v2::PhraseSet const &
|
phrase_set_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreatePhraseSet(google::cloud::speech::v2::CreatePhraseSetRequest const &, Options)
Creates a PhraseSet.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::CreatePhraseSetRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
A |
CreatePhraseSet(NoAwaitTag, google::cloud::speech::v2::CreatePhraseSetRequest const &, Options)
Creates a PhraseSet.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::CreatePhraseSetRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreatePhraseSet(google::longrunning::Operation const &, Options)
Creates a PhraseSet.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
ListPhraseSets(std::string const &, Options)
Lists PhraseSets.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location of PhraseSet resources to list. The expected format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::speech::v2::PhraseSet > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListPhraseSets(google::cloud::speech::v2::ListPhraseSetsRequest, Options)
Lists PhraseSets.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::ListPhraseSetsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::speech::v2::PhraseSet > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetPhraseSet(std::string const &, Options)
Returns the requested PhraseSet.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the PhraseSet to retrieve. The expected format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::PhraseSet > |
the result of the RPC. The response message type (google.cloud.speech.v2.PhraseSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetPhraseSet(google::cloud::speech::v2::GetPhraseSetRequest const &, Options)
Returns the requested PhraseSet.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::GetPhraseSetRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v2::PhraseSet > |
the result of the RPC. The response message type (google.cloud.speech.v2.PhraseSet) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdatePhraseSet(google::cloud::speech::v2::PhraseSet const &, google::protobuf::FieldMask const &, Options)
Updates the PhraseSet.
Parameters | |
---|---|
Name | Description |
phrase_set |
google::cloud::speech::v2::PhraseSet const &
Required. The PhraseSet to update. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to update. If empty, all non-default valued fields are considered for update. Use |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
A |
UpdatePhraseSet(NoAwaitTag, google::cloud::speech::v2::PhraseSet const &, google::protobuf::FieldMask const &, Options)
Updates the PhraseSet.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
phrase_set |
google::cloud::speech::v2::PhraseSet const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdatePhraseSet(google::cloud::speech::v2::UpdatePhraseSetRequest const &, Options)
Updates the PhraseSet.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::UpdatePhraseSetRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
A |
UpdatePhraseSet(NoAwaitTag, google::cloud::speech::v2::UpdatePhraseSetRequest const &, Options)
Updates the PhraseSet.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::UpdatePhraseSetRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdatePhraseSet(google::longrunning::Operation const &, Options)
Updates the PhraseSet.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
DeletePhraseSet(std::string const &, Options)
Deletes the PhraseSet.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the PhraseSet to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
A |
DeletePhraseSet(NoAwaitTag, std::string const &, Options)
Deletes the PhraseSet.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeletePhraseSet(google::cloud::speech::v2::DeletePhraseSetRequest const &, Options)
Deletes the PhraseSet.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::DeletePhraseSetRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
A |
DeletePhraseSet(NoAwaitTag, google::cloud::speech::v2::DeletePhraseSetRequest const &, Options)
Deletes the PhraseSet.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::DeletePhraseSetRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeletePhraseSet(google::longrunning::Operation const &, Options)
Deletes the PhraseSet.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
UndeletePhraseSet(std::string const &, Options)
Undeletes the PhraseSet.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the PhraseSet to undelete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
A |
UndeletePhraseSet(NoAwaitTag, std::string const &, Options)
Undeletes the PhraseSet.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeletePhraseSet(google::cloud::speech::v2::UndeletePhraseSetRequest const &, Options)
Undeletes the PhraseSet.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v2::UndeletePhraseSetRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |
A |
UndeletePhraseSet(NoAwaitTag, google::cloud::speech::v2::UndeletePhraseSetRequest const &, Options)
Undeletes the PhraseSet.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v2::UndeletePhraseSetRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeletePhraseSet(google::longrunning::Operation const &, Options)
Undeletes the PhraseSet.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v2::PhraseSet > > |