Class: Google::Cloud::Speech::V2::Speech::Client

Inherits:

Object

Object
Google::Cloud::Speech::V2::Speech::Client

show all

Includes:: Paths

Defined in:: lib/google/cloud/speech/v2/speech/client.rb

Overview

Client for the Speech service.

Enables speech transcription and resource management.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

#operations_client ⇒ ::Google::Cloud::Speech::V2::Speech::Operations readonly
Get the associated client for long-running operations.

Class Method Summary collapse

.configure {|config| ... } ⇒ Client::Configuration
Configure the Speech Client class.

Instance Method Summary collapse

#batch_recognize(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
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.
#configure {|config| ... } ⇒ Client::Configuration
Configure the Speech Client instance.
#create_custom_class(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a CustomClass.
#create_phrase_set(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a PhraseSet.
#create_recognizer(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a Recognizer.
#delete_custom_class(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes the CustomClass.
#delete_phrase_set(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes the PhraseSet.
#delete_recognizer(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes the Recognizer.
#get_config(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Speech::V2::Config
Returns the requested Config.
#get_custom_class(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Speech::V2::CustomClass
Returns the requested CustomClass.
#get_phrase_set(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Speech::V2::PhraseSet
Returns the requested PhraseSet.
#get_recognizer(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Speech::V2::Recognizer
Returns the requested Recognizer.
#initialize {|config| ... } ⇒ Client constructor
Create a new Speech client object.
#list_custom_classes(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>
Lists CustomClasses.
#list_phrase_sets(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>
Lists PhraseSets.
#list_recognizers(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>
Lists Recognizers.
#recognize(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Speech::V2::RecognizeResponse
Performs synchronous Speech recognition: receive results after all audio has been sent and processed.
#streaming_recognize(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::Speech::V2::StreamingRecognizeResponse>
Performs bidirectional streaming speech recognition: receive results while sending audio.
#undelete_custom_class(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Undeletes the CustomClass.
#undelete_phrase_set(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Undeletes the PhraseSet.
#undelete_recognizer(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Undeletes the Recognizer.
#update_config(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Speech::V2::Config
Updates the Config.
#update_custom_class(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates the CustomClass.
#update_phrase_set(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates the PhraseSet.
#update_recognizer(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates the Recognizer.

Methods included from Paths

#config_path, #crypto_key_path, #crypto_key_version_path, #custom_class_path, #location_path, #phrase_set_path, #recognizer_path

Constructor Details

#initialize {|config| ... } ⇒ `Client`

Create a new Speech client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Speech::V2::Speech::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Speech::V2::Speech::Client.new do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the Speech client.

Yield Parameters:

config (Client::Configuration)

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 114

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/speech/v2/cloud_speech_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @speech_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Speech::V2::Speech::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#operations_client ⇒ `::Google::Cloud::Speech::V2::Speech::Operations` (readonly)

Get the associated client for long-running operations.

Returns:

(::Google::Cloud::Speech::V2::Speech::Operations)



161
162
163

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 161

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ `Client::Configuration`

Configure the Speech Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Speech clients
::Google::Cloud::Speech::V2::Speech::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 56

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Speech", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 5000.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_recognize(request, options = nil) ⇒ `::Gapic::Operation` #batch_recognize(recognizer: nil, config: nil, config_mask: nil, files: nil) ⇒ `::Gapic::Operation`

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.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::BatchRecognizeRequest.new

# Call the batch_recognize method.
result = client.batch_recognize request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#batch_recognize(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to batch_recognize via a request object, either of type BatchRecognizeRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::BatchRecognizeRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#batch_recognize(recognizer: nil, config: nil, config_mask: nil, files: nil) ⇒ ::Gapic::Operation

Pass arguments to batch_recognize via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- recognizer (::String) (defaults to: nil) —
  Required. Resource name of the recognizer to be used for ASR.
- config (::Google::Cloud::Speech::V2::RecognitionConfig, ::Hash) (defaults to: nil) —
  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, ::Hash) (defaults to: nil) —
  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 (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.
- files (::Array<::Google::Cloud::Speech::V2::BatchRecognizeFileMetadata, ::Hash>) (defaults to: nil) —
  Audio files with file metadata for ASR.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1049

def batch_recognize request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::BatchRecognizeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_recognize.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.recognizer
    header_params["recognizer"] = request.recognizer
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_recognize.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_recognize.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :batch_recognize, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ `Client::Configuration`

Configure the Speech Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

#create_custom_class(request, options = nil) ⇒ `::Gapic::Operation` #create_custom_class(custom_class: nil, validate_only: nil, custom_class_id: nil, parent: nil) ⇒ `::Gapic::Operation`

Creates a CustomClass.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::CreateCustomClassRequest.new

# Call the create_custom_class method.
result = client.create_custom_class request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#create_custom_class(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to create_custom_class via a request object, either of type CreateCustomClassRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::CreateCustomClassRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_custom_class(custom_class: nil, validate_only: nil, custom_class_id: nil, parent: nil) ⇒ ::Gapic::Operation

Pass arguments to create_custom_class via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- custom_class (::Google::Cloud::Speech::V2::CustomClass, ::Hash) (defaults to: nil) —
  Required. The CustomClass to create.
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the CustomClass, but do not actually create it.
- custom_class_id (::String) (defaults to: nil) —
  The ID to use for the CustomClass, which will become the final component of the CustomClass's resource name.
  
  This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
- parent (::String) (defaults to: nil) —
  Required. The project and location where this CustomClass will be created. The expected format is projects/{project}/locations/{location}.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1331

def create_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::CreateCustomClassRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_custom_class.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :create_custom_class, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_phrase_set(request, options = nil) ⇒ `::Gapic::Operation` #create_phrase_set(phrase_set: nil, validate_only: nil, phrase_set_id: nil, parent: nil) ⇒ `::Gapic::Operation`

Creates a PhraseSet.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::CreatePhraseSetRequest.new

# Call the create_phrase_set method.
result = client.create_phrase_set request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#create_phrase_set(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to create_phrase_set via a request object, either of type CreatePhraseSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::CreatePhraseSetRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_phrase_set(phrase_set: nil, validate_only: nil, phrase_set_id: nil, parent: nil) ⇒ ::Gapic::Operation

Pass arguments to create_phrase_set via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- phrase_set (::Google::Cloud::Speech::V2::PhraseSet, ::Hash) (defaults to: nil) —
  Required. The PhraseSet to create.
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the PhraseSet, but do not actually create it.
- phrase_set_id (::String) (defaults to: nil) —
  The ID to use for the PhraseSet, which will become the final component of the PhraseSet's resource name.
  
  This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
- parent (::String) (defaults to: nil) —
  Required. The project and location where this PhraseSet will be created. The expected format is projects/{project}/locations/{location}.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1939

def create_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::CreatePhraseSetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_phrase_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :create_phrase_set, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_recognizer(request, options = nil) ⇒ `::Gapic::Operation` #create_recognizer(recognizer: nil, validate_only: nil, recognizer_id: nil, parent: nil) ⇒ `::Gapic::Operation`

Creates a Recognizer.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::CreateRecognizerRequest.new

# Call the create_recognizer method.
result = client.create_recognizer request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#create_recognizer(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to create_recognizer via a request object, either of type CreateRecognizerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::CreateRecognizerRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_recognizer(recognizer: nil, validate_only: nil, recognizer_id: nil, parent: nil) ⇒ ::Gapic::Operation

Pass arguments to create_recognizer via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- recognizer (::Google::Cloud::Speech::V2::Recognizer, ::Hash) (defaults to: nil) —
  Required. The Recognizer to create.
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the Recognizer, but do not actually create it.
- recognizer_id (::String) (defaults to: nil) —
  The ID to use for the Recognizer, which will become the final component of the Recognizer's resource name.
  
  This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
- parent (::String) (defaults to: nil) —
  Required. The project and location where this Recognizer will be created. The expected format is projects/{project}/locations/{location}.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 228

def create_recognizer request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::CreateRecognizerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_recognizer.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_recognizer.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_recognizer.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :create_recognizer, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_custom_class(request, options = nil) ⇒ `::Gapic::Operation` #delete_custom_class(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ `::Gapic::Operation`

Deletes the CustomClass.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::DeleteCustomClassRequest.new

# Call the delete_custom_class method.
result = client.delete_custom_class request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_custom_class(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_custom_class via a request object, either of type DeleteCustomClassRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::DeleteCustomClassRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_custom_class(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_custom_class via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomClass to delete. Format: projects/{project}/locations/{location}/customClasses/{custom_class}
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the deleted CustomClass, but do not actually delete it.
- allow_missing (::Boolean) (defaults to: nil) —
  If set to true, and the CustomClass is not found, the request will succeed and be a no-op (no Operation is recorded in this case).
- etag (::String) (defaults to: nil) —
  This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1732

def delete_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::DeleteCustomClassRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_custom_class.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :delete_custom_class, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_phrase_set(request, options = nil) ⇒ `::Gapic::Operation` #delete_phrase_set(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ `::Gapic::Operation`

Deletes the PhraseSet.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::DeletePhraseSetRequest.new

# Call the delete_phrase_set method.
result = client.delete_phrase_set request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_phrase_set(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_phrase_set via a request object, either of type DeletePhraseSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::DeletePhraseSetRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_phrase_set(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_phrase_set via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the PhraseSet to delete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the deleted PhraseSet, but do not actually delete it.
- allow_missing (::Boolean) (defaults to: nil) —
  If set to true, and the PhraseSet is not found, the request will succeed and be a no-op (no Operation is recorded in this case).
- etag (::String) (defaults to: nil) —
  This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 2337

def delete_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::DeletePhraseSetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_phrase_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :delete_phrase_set, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_recognizer(request, options = nil) ⇒ `::Gapic::Operation` #delete_recognizer(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ `::Gapic::Operation`

Deletes the Recognizer.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::DeleteRecognizerRequest.new

# Call the delete_recognizer method.
result = client.delete_recognizer request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#delete_recognizer(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to delete_recognizer via a request object, either of type DeleteRecognizerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::DeleteRecognizerRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_recognizer(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

Pass arguments to delete_recognizer via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the Recognizer to delete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the deleted Recognizer, but do not actually delete it.
- allow_missing (::Boolean) (defaults to: nil) —
  If set to true, and the Recognizer is not found, the request will succeed and be a no-op (no Operation is recorded in this case).
- etag (::String) (defaults to: nil) —
  This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 628

def delete_recognizer request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::DeleteRecognizerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_recognizer.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_recognizer.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_recognizer.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :delete_recognizer, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_config(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::Config` #get_config(name: nil) ⇒ `::Google::Cloud::Speech::V2::Config`

Returns the requested Config.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::GetConfigRequest.new

# Call the get_config method.
result = client.get_config request

# The returned object is of type Google::Cloud::Speech::V2::Config.
p result

Overloads:

#get_config(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::Config

Pass arguments to get_config via a request object, either of type GetConfigRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::GetConfigRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_config(name: nil) ⇒ ::Google::Cloud::Speech::V2::Config

Pass arguments to get_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the config to retrieve. There is exactly one config resource per project per location. The expected format is projects/{project}/locations/{location}/config.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::Speech::V2::Config)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::Speech::V2::Config)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1137

def get_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::GetConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :get_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_custom_class(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::CustomClass` #get_custom_class(name: nil) ⇒ `::Google::Cloud::Speech::V2::CustomClass`

Returns the requested CustomClass.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::GetCustomClassRequest.new

# Call the get_custom_class method.
result = client.get_custom_class request

# The returned object is of type Google::Cloud::Speech::V2::CustomClass.
p result

Overloads:

#get_custom_class(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::CustomClass

Pass arguments to get_custom_class via a request object, either of type GetCustomClassRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::GetCustomClassRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_custom_class(name: nil) ⇒ ::Google::Cloud::Speech::V2::CustomClass

Pass arguments to get_custom_class via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomClass to retrieve. The expected format is projects/{project}/locations/{location}/customClasses/{custom_class}.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::Speech::V2::CustomClass)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::Speech::V2::CustomClass)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1525

def get_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::GetCustomClassRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_custom_class.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :get_custom_class, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_phrase_set(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::PhraseSet` #get_phrase_set(name: nil) ⇒ `::Google::Cloud::Speech::V2::PhraseSet`

Returns the requested PhraseSet.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::GetPhraseSetRequest.new

# Call the get_phrase_set method.
result = client.get_phrase_set request

# The returned object is of type Google::Cloud::Speech::V2::PhraseSet.
p result

Overloads:

#get_phrase_set(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::PhraseSet

Pass arguments to get_phrase_set via a request object, either of type GetPhraseSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::GetPhraseSetRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_phrase_set(name: nil) ⇒ ::Google::Cloud::Speech::V2::PhraseSet

Pass arguments to get_phrase_set via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the PhraseSet to retrieve. The expected format is projects/{project}/locations/{location}/phraseSets/{phrase_set}.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::Speech::V2::PhraseSet)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::Speech::V2::PhraseSet)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 2132

def get_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::GetPhraseSetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_phrase_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :get_phrase_set, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_recognizer(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::Recognizer` #get_recognizer(name: nil) ⇒ `::Google::Cloud::Speech::V2::Recognizer`

Returns the requested Recognizer. Fails with [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested recognizer doesn't exist.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::GetRecognizerRequest.new

# Call the get_recognizer method.
result = client.get_recognizer request

# The returned object is of type Google::Cloud::Speech::V2::Recognizer.
p result

Overloads:

#get_recognizer(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::Recognizer

Pass arguments to get_recognizer via a request object, either of type GetRecognizerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::GetRecognizerRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_recognizer(name: nil) ⇒ ::Google::Cloud::Speech::V2::Recognizer

Pass arguments to get_recognizer via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the Recognizer to retrieve. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::Speech::V2::Recognizer)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::Speech::V2::Recognizer)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 423

def get_recognizer request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::GetRecognizerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_recognizer.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_recognizer.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_recognizer.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :get_recognizer, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_custom_classes(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>` #list_custom_classes(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>`

Lists CustomClasses.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::ListCustomClassesRequest.new

# Call the list_custom_classes method.
result = client.list_custom_classes request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Speech::V2::CustomClass.
  p item
end

Overloads:

#list_custom_classes(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>

Pass arguments to list_custom_classes via a request object, either of type ListCustomClassesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::ListCustomClassesRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_custom_classes(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>

Pass arguments to list_custom_classes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The project and location of CustomClass resources to list. The expected format is projects/{project}/locations/{location}.
- page_size (::Integer) (defaults to: nil) —
  Number of results per requests. A valid page_size ranges from 0 to 20 inclusive. If the page_size is zero or unspecified, a page size of 5 will be chosen. If the page size exceeds 20, it will be coerced down to 20. Note that a call might return fewer results than the requested page size.
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListCustomClasses call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListCustomClasses must match the call that provided the page token.
- show_deleted (::Boolean) (defaults to: nil) —
  Whether, or not, to show resources that have been deleted.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1437

def list_custom_classes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::ListCustomClassesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_custom_classes.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_custom_classes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_custom_classes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :list_custom_classes, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @speech_stub, :list_custom_classes, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_phrase_sets(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>` #list_phrase_sets(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>`

Lists PhraseSets.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::ListPhraseSetsRequest.new

# Call the list_phrase_sets method.
result = client.list_phrase_sets request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Speech::V2::PhraseSet.
  p item
end

Overloads:

#list_phrase_sets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>

Pass arguments to list_phrase_sets via a request object, either of type ListPhraseSetsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::ListPhraseSetsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_phrase_sets(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>

Pass arguments to list_phrase_sets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The project and location of PhraseSet resources to list. The expected format is projects/{project}/locations/{location}.
- page_size (::Integer) (defaults to: nil) —
  The maximum number of PhraseSets to return. The service may return fewer than this value. If unspecified, at most 20 PhraseSets will be returned. The maximum value is 20; values above 20 will be coerced to 20.
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListPhraseSets call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListPhraseSets must match the call that provided the page token.
- show_deleted (::Boolean) (defaults to: nil) —
  Whether, or not, to show resources that have been deleted.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 2044

def list_phrase_sets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::ListPhraseSetsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_phrase_sets.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_phrase_sets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_phrase_sets.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :list_phrase_sets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @speech_stub, :list_phrase_sets, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_recognizers(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>` #list_recognizers(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>`

Lists Recognizers.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::ListRecognizersRequest.new

# Call the list_recognizers method.
result = client.list_recognizers request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Speech::V2::Recognizer.
  p item
end

Overloads:

#list_recognizers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>

Pass arguments to list_recognizers via a request object, either of type ListRecognizersRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::ListRecognizersRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_recognizers(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>

Pass arguments to list_recognizers via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The project and location of Recognizers to list. The expected format is projects/{project}/locations/{location}.
- page_size (::Integer) (defaults to: nil) —
  The maximum number of Recognizers to return. The service may return fewer than this value. If unspecified, at most 20 Recognizers will be returned. The maximum value is 20; values above 20 will be coerced to 20.
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListRecognizers call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListRecognizers must match the call that provided the page token.
- show_deleted (::Boolean) (defaults to: nil) —
  Whether, or not, to show resources that have been deleted.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 333

def list_recognizers request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::ListRecognizersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_recognizers.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_recognizers.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_recognizers.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :list_recognizers, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @speech_stub, :list_recognizers, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#recognize(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::RecognizeResponse` #recognize(recognizer: nil, config: nil, config_mask: nil, content: nil, uri: nil) ⇒ `::Google::Cloud::Speech::V2::RecognizeResponse`

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

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::RecognizeRequest.new

# Call the recognize method.
result = client.recognize request

# The returned object is of type Google::Cloud::Speech::V2::RecognizeResponse.
p result

Overloads:

#recognize(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::RecognizeResponse

Pass arguments to recognize via a request object, either of type RecognizeRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::RecognizeRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#recognize(recognizer: nil, config: nil, config_mask: nil, content: nil, uri: nil) ⇒ ::Google::Cloud::Speech::V2::RecognizeResponse

Pass arguments to recognize via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- recognizer (::String) (defaults to: nil) —
  Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}.
- config (::Google::Cloud::Speech::V2::RecognitionConfig, ::Hash) (defaults to: nil) —
  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, ::Hash) (defaults to: nil) —
  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 (*) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.
- content (::String) (defaults to: nil) —
  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.
- uri (::String) (defaults to: nil) —
  URI that points to a file that contains audio data bytes as specified in RecognitionConfig. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::Speech::V2::RecognizeResponse)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::Speech::V2::RecognizeResponse)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 853

def recognize request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::RecognizeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.recognize.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.recognizer
    header_params["recognizer"] = request.recognizer
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.recognize.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.recognize.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :recognize, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#streaming_recognize(request, options = nil) {|response, operation| ... } ⇒ `::Enumerable<::Google::Cloud::Speech::V2::StreamingRecognizeResponse>`

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

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create an input stream.
input = Gapic::StreamInput.new

# Call the streaming_recognize method to start streaming.
output = client.streaming_recognize input

# Send requests on the stream. For each request object, set fields by
# passing keyword arguments. Be sure to close the stream when done.
input << Google::Cloud::Speech::V2::StreamingRecognizeRequest.new
input << Google::Cloud::Speech::V2::StreamingRecognizeRequest.new
input.close

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::Speech::V2::StreamingRecognizeResponse
output.each do |current_response|
  p current_response
end

Parameters:

request (::Gapic::StreamInput, ::Enumerable<::Google::Cloud::Speech::V2::StreamingRecognizeRequest, ::Hash>) —
An enumerable of Google::Cloud::Speech::V2::StreamingRecognizeRequest instances.
options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Enumerable<::Google::Cloud::Speech::V2::StreamingRecognizeResponse>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Enumerable<::Google::Cloud::Speech::V2::StreamingRecognizeResponse>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 935

def streaming_recognize request, options = nil
  unless request.is_a? ::Enumerable
    raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
    request = request.to_enum
  end

  request = request.lazy.map do |req|
    ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::Speech::V2::StreamingRecognizeRequest
  end

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.streaming_recognize.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.streaming_recognize.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.streaming_recognize.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :streaming_recognize, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#undelete_custom_class(request, options = nil) ⇒ `::Gapic::Operation` #undelete_custom_class(name: nil, validate_only: nil, etag: nil) ⇒ `::Gapic::Operation`

Undeletes the CustomClass.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::UndeleteCustomClassRequest.new

# Call the undelete_custom_class method.
result = client.undelete_custom_class request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#undelete_custom_class(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to undelete_custom_class via a request object, either of type UndeleteCustomClassRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::UndeleteCustomClassRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#undelete_custom_class(name: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Pass arguments to undelete_custom_class via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomClass to undelete. Format: projects/{project}/locations/{location}/customClasses/{custom_class}
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the undeleted CustomClass, but do not actually undelete it.
- etag (::String) (defaults to: nil) —
  This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1834

def undelete_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::UndeleteCustomClassRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.undelete_custom_class.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.undelete_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.undelete_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :undelete_custom_class, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#undelete_phrase_set(request, options = nil) ⇒ `::Gapic::Operation` #undelete_phrase_set(name: nil, validate_only: nil, etag: nil) ⇒ `::Gapic::Operation`

Undeletes the PhraseSet.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::UndeletePhraseSetRequest.new

# Call the undelete_phrase_set method.
result = client.undelete_phrase_set request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#undelete_phrase_set(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to undelete_phrase_set via a request object, either of type UndeletePhraseSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::UndeletePhraseSetRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#undelete_phrase_set(name: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Pass arguments to undelete_phrase_set via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the PhraseSet to undelete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the undeleted PhraseSet, but do not actually undelete it.
- etag (::String) (defaults to: nil) —
  This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 2438

def undelete_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::UndeletePhraseSetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.undelete_phrase_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.undelete_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.undelete_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :undelete_phrase_set, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#undelete_recognizer(request, options = nil) ⇒ `::Gapic::Operation` #undelete_recognizer(name: nil, validate_only: nil, etag: nil) ⇒ `::Gapic::Operation`

Undeletes the Recognizer.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::UndeleteRecognizerRequest.new

# Call the undelete_recognizer method.
result = client.undelete_recognizer request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#undelete_recognizer(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to undelete_recognizer via a request object, either of type UndeleteRecognizerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::UndeleteRecognizerRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#undelete_recognizer(name: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Pass arguments to undelete_recognizer via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the Recognizer to undelete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the undeleted Recognizer, but do not actually undelete it.
- etag (::String) (defaults to: nil) —
  This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 729

def undelete_recognizer request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::UndeleteRecognizerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.undelete_recognizer.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.undelete_recognizer.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.undelete_recognizer.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :undelete_recognizer, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_config(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::Config` #update_config(config: nil, update_mask: nil) ⇒ `::Google::Cloud::Speech::V2::Config`

Updates the Config.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::UpdateConfigRequest.new

# Call the update_config method.
result = client.update_config request

# The returned object is of type Google::Cloud::Speech::V2::Config.
p result

Overloads:

#update_config(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::Config

Pass arguments to update_config via a request object, either of type UpdateConfigRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::UpdateConfigRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_config(config: nil, update_mask: nil) ⇒ ::Google::Cloud::Speech::V2::Config

Pass arguments to update_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- config (::Google::Cloud::Speech::V2::Config, ::Hash) (defaults to: nil) —
  Required. The config to update.
  
  The config's name field is used to identify the config to be updated. The expected format is projects/{project}/locations/{location}/config.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  The list of fields to be updated.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Cloud::Speech::V2::Config)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Cloud::Speech::V2::Config)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1227

def update_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::UpdateConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.config&.name
    header_params["config.name"] = request.config.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :update_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_custom_class(request, options = nil) ⇒ `::Gapic::Operation` #update_custom_class(custom_class: nil, update_mask: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Updates the CustomClass.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::UpdateCustomClassRequest.new

# Call the update_custom_class method.
result = client.update_custom_class request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#update_custom_class(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to update_custom_class via a request object, either of type UpdateCustomClassRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::UpdateCustomClassRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_custom_class(custom_class: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to update_custom_class via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- custom_class (::Google::Cloud::Speech::V2::CustomClass, ::Hash) (defaults to: nil) —
  Required. The CustomClass to update.
  
  The CustomClass's name field is used to identify the CustomClass to update. Format: projects/{project}/locations/{location}/customClasses/{custom_class}.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  The list of fields to be updated. If empty, all fields are considered for update.
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the updated CustomClass, but do not actually update it.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 1627

def update_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::UpdateCustomClassRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_custom_class.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.custom_class&.name
    header_params["custom_class.name"] = request.custom_class.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :update_custom_class, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_phrase_set(request, options = nil) ⇒ `::Gapic::Operation` #update_phrase_set(phrase_set: nil, update_mask: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Updates the PhraseSet.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::UpdatePhraseSetRequest.new

# Call the update_phrase_set method.
result = client.update_phrase_set request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#update_phrase_set(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to update_phrase_set via a request object, either of type UpdatePhraseSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::UpdatePhraseSetRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_phrase_set(phrase_set: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to update_phrase_set via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- phrase_set (::Google::Cloud::Speech::V2::PhraseSet, ::Hash) (defaults to: nil) —
  Required. The PhraseSet to update.
  
  The PhraseSet's name field is used to identify the PhraseSet to update. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire PhraseSet resource.
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the updated PhraseSet, but do not actually update it.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 2233

def update_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::UpdatePhraseSetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_phrase_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.phrase_set&.name
    header_params["phrase_set.name"] = request.phrase_set.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :update_phrase_set, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_recognizer(request, options = nil) ⇒ `::Gapic::Operation` #update_recognizer(recognizer: nil, update_mask: nil, validate_only: nil) ⇒ `::Gapic::Operation`

Updates the Recognizer.

Examples:

Basic example

require "google/cloud/speech/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Speech::V2::Speech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Speech::V2::UpdateRecognizerRequest.new

# Call the update_recognizer method.
result = client.update_recognizer request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

#update_recognizer(request, options = nil) ⇒ ::Gapic::Operation

Pass arguments to update_recognizer via a request object, either of type UpdateRecognizerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Speech::V2::UpdateRecognizerRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_recognizer(recognizer: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation

Pass arguments to update_recognizer via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- recognizer (::Google::Cloud::Speech::V2::Recognizer, ::Hash) (defaults to: nil) —
  Required. The Recognizer to update.
  
  The Recognizer's name field is used to identify the Recognizer to update. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire Recognizer resource.
- validate_only (::Boolean) (defaults to: nil) —
  If set, validate the request and preview the updated Recognizer, but do not actually update it.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/cloud/speech/v2/speech/client.rb', line 524

def update_recognizer request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V2::UpdateRecognizerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_recognizer.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Speech::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.recognizer&.name
    header_params["recognizer.name"] = request.recognizer.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_recognizer.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_recognizer.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @speech_stub.call_rpc :update_recognizer, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

Class: Google::Cloud::Speech::V2::Speech::Client

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

Constructor Details

#initialize {|config| ... } ⇒ Client

Examples:

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Speech::V2::Speech::Operations (readonly)

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Examples:

Instance Method Details

#batch_recognize(request, options = nil) ⇒ ::Gapic::Operation #batch_recognize(recognizer: nil, config: nil, config_mask: nil, files: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#configure {|config| ... } ⇒ Client::Configuration

#create_custom_class(request, options = nil) ⇒ ::Gapic::Operation #create_custom_class(custom_class: nil, validate_only: nil, custom_class_id: nil, parent: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#create_phrase_set(request, options = nil) ⇒ ::Gapic::Operation #create_phrase_set(phrase_set: nil, validate_only: nil, phrase_set_id: nil, parent: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#create_recognizer(request, options = nil) ⇒ ::Gapic::Operation #create_recognizer(recognizer: nil, validate_only: nil, recognizer_id: nil, parent: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_custom_class(request, options = nil) ⇒ ::Gapic::Operation #delete_custom_class(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_phrase_set(request, options = nil) ⇒ ::Gapic::Operation #delete_phrase_set(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#delete_recognizer(request, options = nil) ⇒ ::Gapic::Operation #delete_recognizer(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#get_config(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::Config #get_config(name: nil) ⇒ ::Google::Cloud::Speech::V2::Config

Examples:

Basic example

#get_custom_class(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::CustomClass #get_custom_class(name: nil) ⇒ ::Google::Cloud::Speech::V2::CustomClass

Examples:

Basic example

#get_phrase_set(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::PhraseSet #get_phrase_set(name: nil) ⇒ ::Google::Cloud::Speech::V2::PhraseSet

Examples:

Basic example

#get_recognizer(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::Recognizer #get_recognizer(name: nil) ⇒ ::Google::Cloud::Speech::V2::Recognizer

Examples:

Basic example

#list_custom_classes(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass> #list_custom_classes(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>

Examples:

Basic example

#list_phrase_sets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet> #list_phrase_sets(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>

Examples:

Basic example

#list_recognizers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer> #list_recognizers(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>

Examples:

Basic example

#recognize(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::RecognizeResponse #recognize(recognizer: nil, config: nil, config_mask: nil, content: nil, uri: nil) ⇒ ::Google::Cloud::Speech::V2::RecognizeResponse

Examples:

Basic example

#streaming_recognize(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::Speech::V2::StreamingRecognizeResponse>

Examples:

Basic example

#undelete_custom_class(request, options = nil) ⇒ ::Gapic::Operation #undelete_custom_class(name: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#undelete_phrase_set(request, options = nil) ⇒ ::Gapic::Operation #undelete_phrase_set(name: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#undelete_recognizer(request, options = nil) ⇒ ::Gapic::Operation #undelete_recognizer(name: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#update_config(request, options = nil) ⇒ ::Google::Cloud::Speech::V2::Config #update_config(config: nil, update_mask: nil) ⇒ ::Google::Cloud::Speech::V2::Config

Examples:

Basic example

#update_custom_class(request, options = nil) ⇒ ::Gapic::Operation #update_custom_class(custom_class: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation

Examples:

Basic example

#initialize {|config| ... } ⇒ `Client`

#operations_client ⇒ `::Google::Cloud::Speech::V2::Speech::Operations` (readonly)

.configure {|config| ... } ⇒ `Client::Configuration`

#batch_recognize(request, options = nil) ⇒ `::Gapic::Operation` #batch_recognize(recognizer: nil, config: nil, config_mask: nil, files: nil) ⇒ `::Gapic::Operation`

#configure {|config| ... } ⇒ `Client::Configuration`

#create_custom_class(request, options = nil) ⇒ `::Gapic::Operation` #create_custom_class(custom_class: nil, validate_only: nil, custom_class_id: nil, parent: nil) ⇒ `::Gapic::Operation`

#create_phrase_set(request, options = nil) ⇒ `::Gapic::Operation` #create_phrase_set(phrase_set: nil, validate_only: nil, phrase_set_id: nil, parent: nil) ⇒ `::Gapic::Operation`

#create_recognizer(request, options = nil) ⇒ `::Gapic::Operation` #create_recognizer(recognizer: nil, validate_only: nil, recognizer_id: nil, parent: nil) ⇒ `::Gapic::Operation`

#delete_custom_class(request, options = nil) ⇒ `::Gapic::Operation` #delete_custom_class(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ `::Gapic::Operation`

#delete_phrase_set(request, options = nil) ⇒ `::Gapic::Operation` #delete_phrase_set(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ `::Gapic::Operation`

#delete_recognizer(request, options = nil) ⇒ `::Gapic::Operation` #delete_recognizer(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ `::Gapic::Operation`

#get_config(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::Config` #get_config(name: nil) ⇒ `::Google::Cloud::Speech::V2::Config`

#get_custom_class(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::CustomClass` #get_custom_class(name: nil) ⇒ `::Google::Cloud::Speech::V2::CustomClass`

#get_phrase_set(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::PhraseSet` #get_phrase_set(name: nil) ⇒ `::Google::Cloud::Speech::V2::PhraseSet`

#get_recognizer(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::Recognizer` #get_recognizer(name: nil) ⇒ `::Google::Cloud::Speech::V2::Recognizer`

#list_custom_classes(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>` #list_custom_classes(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::CustomClass>`

#list_phrase_sets(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>` #list_phrase_sets(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::PhraseSet>`

#list_recognizers(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>` #list_recognizers(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Cloud::Speech::V2::Recognizer>`

#recognize(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::RecognizeResponse` #recognize(recognizer: nil, config: nil, config_mask: nil, content: nil, uri: nil) ⇒ `::Google::Cloud::Speech::V2::RecognizeResponse`

#streaming_recognize(request, options = nil) {|response, operation| ... } ⇒ `::Enumerable<::Google::Cloud::Speech::V2::StreamingRecognizeResponse>`

#undelete_custom_class(request, options = nil) ⇒ `::Gapic::Operation` #undelete_custom_class(name: nil, validate_only: nil, etag: nil) ⇒ `::Gapic::Operation`

#undelete_phrase_set(request, options = nil) ⇒ `::Gapic::Operation` #undelete_phrase_set(name: nil, validate_only: nil, etag: nil) ⇒ `::Gapic::Operation`

#undelete_recognizer(request, options = nil) ⇒ `::Gapic::Operation` #undelete_recognizer(name: nil, validate_only: nil, etag: nil) ⇒ `::Gapic::Operation`

#update_config(request, options = nil) ⇒ `::Google::Cloud::Speech::V2::Config` #update_config(config: nil, update_mask: nil) ⇒ `::Google::Cloud::Speech::V2::Config`

#update_custom_class(request, options = nil) ⇒ `::Gapic::Operation` #update_custom_class(custom_class: nil, update_mask: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#update_phrase_set(request, options = nil) ⇒ `::Gapic::Operation` #update_phrase_set(phrase_set: nil, update_mask: nil, validate_only: nil) ⇒ `::Gapic::Operation`

#update_recognizer(request, options = nil) ⇒ `::Gapic::Operation` #update_recognizer(recognizer: nil, update_mask: nil, validate_only: nil) ⇒ `::Gapic::Operation`