Class: Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb

Overview

REST client for the EvaluationService service.

EvaluationService exposes methods to perform evaluation for the CES app.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#agent_path, #app_path, #app_version_path, #changelog_path, #conversation_path, #evaluation_dataset_path, #evaluation_expectation_path, #evaluation_path, #evaluation_result_path, #evaluation_run_path, #scheduled_evaluation_run_path, #tool_path, #toolset_path

Constructor Details

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

Create a new EvaluationService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the EvaluationService client.

Yield Parameters:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 132

def initialize
  # 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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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 = ::Google::Cloud::Ces::V1beta::EvaluationService::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @evaluation_service_stub = ::Google::Cloud::Ces::V1beta::EvaluationService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @evaluation_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @evaluation_service_stub.endpoint
    config.universe_domain = @evaluation_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @evaluation_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Rest::Client) 


202
203
204
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 202

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::Ces::V1beta::EvaluationService::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



195
196
197
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 195

def operations_client
  @operations_client
end

Class Method Details

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

Configure the EvaluationService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all EvaluationService clients
::Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Ces", "V1beta"]
    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 = 60.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

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

Configure the EvaluationService 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:

Returns:



102
103
104
105
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#create_evaluation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation #create_evaluation(parent: nil, evaluation_id: nil, evaluation: nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

Creates an evaluation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateEvaluationRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Evaluation.
p result

Overloads:

  • #create_evaluation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

    Pass arguments to create_evaluation via a request object, either of type CreateEvaluationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::CreateEvaluationRequest, ::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_evaluation(parent: nil, evaluation_id: nil, evaluation: nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

    Pass arguments to create_evaluation 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 app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

    • evaluation_id (::String) (defaults to: nil) —

      Optional. The ID to use for the evaluation, which will become the final component of the evaluation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.

    • evaluation (::Google::Cloud::Ces::V1beta::Evaluation, ::Hash) (defaults to: nil) —

      Required. The evaluation to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 482

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::CreateEvaluationRequest

  # 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
  call_metadata = @config.rpcs.create_evaluation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_evaluation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_evaluation.retry_policy

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

  @evaluation_service_stub.create_evaluation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_evaluation_dataset(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset #create_evaluation_dataset(parent: nil, evaluation_dataset_id: nil, evaluation_dataset: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

Creates an evaluation dataset.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateEvaluationDatasetRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::EvaluationDataset.
p result

Overloads:

  • #create_evaluation_dataset(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

    Pass arguments to create_evaluation_dataset via a request object, either of type CreateEvaluationDatasetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::CreateEvaluationDatasetRequest, ::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_evaluation_dataset(parent: nil, evaluation_dataset_id: nil, evaluation_dataset: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

    Pass arguments to create_evaluation_dataset 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 app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

    • evaluation_dataset_id (::String) (defaults to: nil) —

      Optional. The ID to use for the evaluation dataset, which will become the final component of the evaluation dataset's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.

    • evaluation_dataset (::Google::Cloud::Ces::V1beta::EvaluationDataset, ::Hash) (defaults to: nil) —

      Required. The evaluation dataset to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 765

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::CreateEvaluationDatasetRequest

  # 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
  call_metadata = @config.rpcs.create_evaluation_dataset.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_evaluation_dataset.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_evaluation_dataset.retry_policy

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

  @evaluation_service_stub.create_evaluation_dataset request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_evaluation_expectation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation #create_evaluation_expectation(parent: nil, evaluation_expectation_id: nil, evaluation_expectation: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation

Creates an evaluation expectation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateEvaluationExpectationRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::EvaluationExpectation.
p result

Overloads:

  • #create_evaluation_expectation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation

    Pass arguments to create_evaluation_expectation via a request object, either of type CreateEvaluationExpectationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::CreateEvaluationExpectationRequest, ::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_evaluation_expectation(parent: nil, evaluation_expectation_id: nil, evaluation_expectation: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation

    Pass arguments to create_evaluation_expectation 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 app to create the evaluation expectation for. Format: projects/{project}/locations/{location}/apps/{app}

    • evaluation_expectation_id (::String) (defaults to: nil) —

      Optional. The ID to use for the evaluation expectation, which will become the final component of the evaluation expectation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation expectation.

    • evaluation_expectation (::Google::Cloud::Ces::V1beta::EvaluationExpectation, ::Hash) (defaults to: nil) —

      Required. The evaluation expectation to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2268

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::CreateEvaluationExpectationRequest

  # 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
  call_metadata = @config.rpcs.create_evaluation_expectation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_evaluation_expectation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_evaluation_expectation.retry_policy

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

  @evaluation_service_stub.create_evaluation_expectation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_scheduled_evaluation_run(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun #create_scheduled_evaluation_run(parent: nil, scheduled_evaluation_run_id: nil, scheduled_evaluation_run: nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

Creates a scheduled evaluation run.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::CreateScheduledEvaluationRunRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::ScheduledEvaluationRun.
p result

Overloads:

  • #create_scheduled_evaluation_run(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

    Pass arguments to create_scheduled_evaluation_run via a request object, either of type CreateScheduledEvaluationRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::CreateScheduledEvaluationRunRequest, ::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_scheduled_evaluation_run(parent: nil, scheduled_evaluation_run_id: nil, scheduled_evaluation_run: nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

    Pass arguments to create_scheduled_evaluation_run 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 app to create the scheduled evaluation run for. Format: projects/{project}/locations/{location}/apps/{app}

    • scheduled_evaluation_run_id (::String) (defaults to: nil) —

      Optional. The ID to use for the scheduled evaluation run, which will become the final component of the scheduled evaluation run's resource name. If not provided, a unique ID will be automatically assigned.

    • scheduled_evaluation_run (::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun, ::Hash) (defaults to: nil) —

      Required. The scheduled evaluation run to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2518

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::CreateScheduledEvaluationRunRequest

  # 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
  call_metadata = @config.rpcs.create_scheduled_evaluation_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_scheduled_evaluation_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_scheduled_evaluation_run.retry_policy

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

  @evaluation_service_stub.create_scheduled_evaluation_run request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_evaluation(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_evaluation(name: nil, force: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

Deletes an evaluation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteEvaluationRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_evaluation(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation via a request object, either of type DeleteEvaluationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::DeleteEvaluationRequest, ::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_evaluation(name: nil, force: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation 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 resource name of the evaluation to delete.

    • force (::Boolean) (defaults to: nil) —

      Optional. Indicates whether to forcefully delete the evaluation, even if it is still referenced by evaluation datasets.

      • If force = false, the deletion will fail if any datasets still reference the evaluation.
      • If force = true, all existing references from datasets will be removed and the evaluation will be deleted.
    • etag (::String) (defaults to: nil) —

      Optional. The current etag of the evaluation. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation, deletion will be blocked and an ABORTED error will be returned.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1018

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::DeleteEvaluationRequest

  # 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
  call_metadata = @config.rpcs.delete_evaluation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_evaluation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_evaluation.retry_policy

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

  @evaluation_service_stub.delete_evaluation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_evaluation_dataset(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_evaluation_dataset(name: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

Deletes an evaluation dataset.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteEvaluationDatasetRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_evaluation_dataset(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation_dataset via a request object, either of type DeleteEvaluationDatasetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::DeleteEvaluationDatasetRequest, ::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_evaluation_dataset(name: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation_dataset 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 resource name of the evaluation dataset to delete.

    • etag (::String) (defaults to: nil) —

      Optional. The current etag of the evaluation dataset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation dataset, deletion will be blocked and an ABORTED error will be returned.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1179

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::DeleteEvaluationDatasetRequest

  # 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
  call_metadata = @config.rpcs.delete_evaluation_dataset.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_evaluation_dataset.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_evaluation_dataset.retry_policy

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

  @evaluation_service_stub.delete_evaluation_dataset request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_evaluation_expectation(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_evaluation_expectation(name: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

Deletes an evaluation expectation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteEvaluationExpectationRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_evaluation_expectation(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation_expectation via a request object, either of type DeleteEvaluationExpectationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::DeleteEvaluationExpectationRequest, ::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_evaluation_expectation(name: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation_expectation 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 resource name of the evaluation expectation to delete.

    • etag (::String) (defaults to: nil) —

      Optional. The current etag of the evaluation expectation. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation expectation, deletion will be blocked and an ABORTED error will be returned.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2432

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::DeleteEvaluationExpectationRequest

  # 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
  call_metadata = @config.rpcs.delete_evaluation_expectation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_evaluation_expectation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_evaluation_expectation.retry_policy

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

  @evaluation_service_stub.delete_evaluation_expectation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_evaluation_result(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_evaluation_result(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an evaluation result.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteEvaluationResultRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_evaluation_result(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation_result via a request object, either of type DeleteEvaluationResultRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::DeleteEvaluationResultRequest, ::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_evaluation_result(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_evaluation_result 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 resource name of the evaluation result to delete.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1096

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::DeleteEvaluationResultRequest

  # 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
  call_metadata = @config.rpcs.delete_evaluation_result.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_evaluation_result.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_evaluation_result.retry_policy

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

  @evaluation_service_stub.delete_evaluation_result request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes an evaluation run.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteEvaluationRunRequest.new

# Call the delete_evaluation_run method.
result = client.delete_evaluation_run 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_evaluation_run(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_evaluation_run via a request object, either of type DeleteEvaluationRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::DeleteEvaluationRunRequest, ::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_evaluation_run(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_evaluation_run 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 resource name of the evaluation run to delete.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1264

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::DeleteEvaluationRunRequest

  # 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
  call_metadata = @config.rpcs.delete_evaluation_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_evaluation_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_evaluation_run.retry_policy

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

  @evaluation_service_stub.delete_evaluation_run request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_scheduled_evaluation_run(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_scheduled_evaluation_run(name: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

Deletes a scheduled evaluation run.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::DeleteScheduledEvaluationRunRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_scheduled_evaluation_run(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_scheduled_evaluation_run via a request object, either of type DeleteScheduledEvaluationRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::DeleteScheduledEvaluationRunRequest, ::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_scheduled_evaluation_run(name: nil, etag: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_scheduled_evaluation_run 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 resource name of the scheduled evaluation run to delete.

    • etag (::String) (defaults to: nil) —

      Optional. The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2865

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::DeleteScheduledEvaluationRunRequest

  # 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
  call_metadata = @config.rpcs.delete_scheduled_evaluation_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_scheduled_evaluation_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_scheduled_evaluation_run.retry_policy

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

  @evaluation_service_stub.delete_scheduled_evaluation_run request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#export_evaluations(request, options = nil) ⇒ ::Gapic::Operation #export_evaluations(parent: nil, names: nil, export_options: nil, include_evaluation_results: nil, include_evaluations: nil) ⇒ ::Gapic::Operation

Exports evaluations.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ExportEvaluationsRequest.new

# Call the export_evaluations method.
result = client.export_evaluations 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:

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

    Pass arguments to export_evaluations via a request object, either of type Google::Cloud::Ces::V1beta::ExportEvaluationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::ExportEvaluationsRequest, ::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.

  • #export_evaluations(parent: nil, names: nil, export_options: nil, include_evaluation_results: nil, include_evaluations: nil) ⇒ ::Gapic::Operation

    Pass arguments to export_evaluations 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 resource name of the app to export evaluations from. Format: projects/{project}/locations/{location}/apps/{app}

    • names (::Array<::String>) (defaults to: nil) —

      Required. The resource names of the evaluations to export.

    • export_options (::Google::Cloud::Ces::V1beta::ExportOptions, ::Hash) (defaults to: nil) —

      Optional. The export options for the evaluations.

    • include_evaluation_results (::Boolean) (defaults to: nil) —

      Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set.

    • include_evaluations (::Boolean) (defaults to: nil) —

      Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 3045

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::ExportEvaluationsRequest

  # 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
  call_metadata = @config.rpcs.export_evaluations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.export_evaluations.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.export_evaluations.retry_policy

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

  @evaluation_service_stub.export_evaluations request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#generate_evaluation(request, options = nil) ⇒ ::Gapic::Operation #generate_evaluation(conversation: nil, source: nil) ⇒ ::Gapic::Operation

Creates a golden evaluation from a conversation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GenerateEvaluationRequest.new

# Call the generate_evaluation method.
result = client.generate_evaluation 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:

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

    Pass arguments to generate_evaluation via a request object, either of type GenerateEvaluationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::GenerateEvaluationRequest, ::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.

  • #generate_evaluation(conversation: nil, source: nil) ⇒ ::Gapic::Operation

    Pass arguments to generate_evaluation 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:

    • conversation (::String) (defaults to: nil) —

      Required. The conversation to create the golden evaluation for. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

    • source (::Google::Cloud::Ces::V1beta::Conversation::Source) (defaults to: nil) —

      Optional. Indicate the source of the conversation. If not set, all sources will be searched.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 572

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::GenerateEvaluationRequest

  # 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
  call_metadata = @config.rpcs.generate_evaluation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.generate_evaluation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.generate_evaluation.retry_policy

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

  @evaluation_service_stub.generate_evaluation request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_evaluation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation #get_evaluation(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

Gets details of the specified evaluation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetEvaluationRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Evaluation.
p result

Overloads:

  • #get_evaluation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

    Pass arguments to get_evaluation via a request object, either of type GetEvaluationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::GetEvaluationRequest, ::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_evaluation(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

    Pass arguments to get_evaluation 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 resource name of the evaluation to retrieve.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1344

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::GetEvaluationRequest

  # 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
  call_metadata = @config.rpcs.get_evaluation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_evaluation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_evaluation.retry_policy

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

  @evaluation_service_stub.get_evaluation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_evaluation_dataset(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset #get_evaluation_dataset(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

Gets details of the specified evaluation dataset.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetEvaluationDatasetRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::EvaluationDataset.
p result

Overloads:

  • #get_evaluation_dataset(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

    Pass arguments to get_evaluation_dataset via a request object, either of type GetEvaluationDatasetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::GetEvaluationDatasetRequest, ::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_evaluation_dataset(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

    Pass arguments to get_evaluation_dataset 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 resource name of the evaluation dataset to retrieve.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1500

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::GetEvaluationDatasetRequest

  # 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
  call_metadata = @config.rpcs.get_evaluation_dataset.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_evaluation_dataset.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_evaluation_dataset.retry_policy

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

  @evaluation_service_stub.get_evaluation_dataset request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_evaluation_expectation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation #get_evaluation_expectation(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation

Gets details of the specified evaluation expectation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetEvaluationExpectationRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::EvaluationExpectation.
p result

Overloads:

  • #get_evaluation_expectation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation

    Pass arguments to get_evaluation_expectation via a request object, either of type GetEvaluationExpectationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::GetEvaluationExpectationRequest, ::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_evaluation_expectation(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation

    Pass arguments to get_evaluation_expectation 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 resource name of the evaluation expectation to retrieve.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2181

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::GetEvaluationExpectationRequest

  # 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
  call_metadata = @config.rpcs.get_evaluation_expectation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_evaluation_expectation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_evaluation_expectation.retry_policy

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

  @evaluation_service_stub.get_evaluation_expectation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_evaluation_result(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationResult #get_evaluation_result(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationResult

Gets details of the specified evaluation result.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetEvaluationResultRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::EvaluationResult.
p result

Overloads:

  • #get_evaluation_result(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationResult

    Pass arguments to get_evaluation_result via a request object, either of type GetEvaluationResultRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::GetEvaluationResultRequest, ::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_evaluation_result(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationResult

    Pass arguments to get_evaluation_result 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 resource name of the evaluation result to retrieve.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1422

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::GetEvaluationResultRequest

  # 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
  call_metadata = @config.rpcs.get_evaluation_result.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_evaluation_result.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_evaluation_result.retry_policy

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

  @evaluation_service_stub.get_evaluation_result request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_evaluation_run(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationRun #get_evaluation_run(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationRun

Gets details of the specified evaluation run.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetEvaluationRunRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::EvaluationRun.
p result

Overloads:

  • #get_evaluation_run(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationRun

    Pass arguments to get_evaluation_run via a request object, either of type GetEvaluationRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::GetEvaluationRunRequest, ::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_evaluation_run(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationRun

    Pass arguments to get_evaluation_run 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 resource name of the evaluation run to retrieve.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1578

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::GetEvaluationRunRequest

  # 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
  call_metadata = @config.rpcs.get_evaluation_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_evaluation_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_evaluation_run.retry_policy

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

  @evaluation_service_stub.get_evaluation_run request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_scheduled_evaluation_run(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun #get_scheduled_evaluation_run(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

Gets details of the specified scheduled evaluation run.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::GetScheduledEvaluationRunRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::ScheduledEvaluationRun.
p result

Overloads:

  • #get_scheduled_evaluation_run(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

    Pass arguments to get_scheduled_evaluation_run via a request object, either of type GetScheduledEvaluationRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::GetScheduledEvaluationRunRequest, ::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_scheduled_evaluation_run(name: nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

    Pass arguments to get_scheduled_evaluation_run 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 resource name of the scheduled evaluation run to retrieve.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2596

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::GetScheduledEvaluationRunRequest

  # 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
  call_metadata = @config.rpcs.get_scheduled_evaluation_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_scheduled_evaluation_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_scheduled_evaluation_run.retry_policy

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

  @evaluation_service_stub.get_scheduled_evaluation_run request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#import_evaluations(request, options = nil) ⇒ ::Gapic::Operation #import_evaluations(conversation_list: nil, gcs_uri: nil, csv_content: nil, parent: nil, import_options: nil) ⇒ ::Gapic::Operation

Imports evaluations into the app.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ImportEvaluationsRequest.new

# Call the import_evaluations method.
result = client.import_evaluations 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:

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

    Pass arguments to import_evaluations via a request object, either of type ImportEvaluationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::ImportEvaluationsRequest, ::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.

  • #import_evaluations(conversation_list: nil, gcs_uri: nil, csv_content: nil, parent: nil, import_options: nil) ⇒ ::Gapic::Operation

    Pass arguments to import_evaluations 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:

    • conversation_list (::Google::Cloud::Ces::V1beta::ImportEvaluationsRequest::ConversationList, ::Hash) (defaults to: nil) —

      The conversations to import the evaluations from.

      Note: The following parameters are mutually exclusive: conversation_list, gcs_uri, csv_content. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • gcs_uri (::String) (defaults to: nil) —

      The Google Cloud Storage URI from which to import evaluations. The format of this URI must be gs://<bucket-name>/<object-name>.

      Note: The following parameters are mutually exclusive: gcs_uri, conversation_list, csv_content. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • csv_content (::String) (defaults to: nil) —

      Raw bytes representing the csv file with the evaluations structure.

      Note: The following parameters are mutually exclusive: csv_content, conversation_list, gcs_uri. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • parent (::String) (defaults to: nil) —

      Required. The app to import the evaluations into. Format: projects/{project}/locations/{location}/apps/{app}

    • import_options (::Google::Cloud::Ces::V1beta::ImportEvaluationsRequest::ImportOptions, ::Hash) (defaults to: nil) —

      Optional. Options governing the import process for the evaluations.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 677

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::ImportEvaluationsRequest

  # 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
  call_metadata = @config.rpcs.import_evaluations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.import_evaluations.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.import_evaluations.retry_policy

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

  @evaluation_service_stub.import_evaluations request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_evaluation_datasets(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationDataset> #list_evaluation_datasets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationDataset>

Lists all evaluation datasets in the given app.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListEvaluationDatasetsRequest.new

# Call the list_evaluation_datasets method.
result = client.list_evaluation_datasets 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::Ces::V1beta::EvaluationDataset.
  p item
end

Overloads:

  • #list_evaluation_datasets(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationDataset>

    Pass arguments to list_evaluation_datasets via a request object, either of type ListEvaluationDatasetsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::ListEvaluationDatasetsRequest, ::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_evaluation_datasets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationDataset>

    Pass arguments to list_evaluation_datasets 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 resource name of the app to list evaluation datasets from.

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets call.

    • filter (::String) (defaults to: nil) —

      Optional. Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1896

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::ListEvaluationDatasetsRequest

  # 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
  call_metadata = @config.rpcs.list_evaluation_datasets.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_evaluation_datasets.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_evaluation_datasets.retry_policy

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

  @evaluation_service_stub.list_evaluation_datasets request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @evaluation_service_stub, :list_evaluation_datasets, "evaluation_datasets", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_evaluation_expectations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationExpectation> #list_evaluation_expectations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationExpectation>

Lists all evaluation expectations in the given app.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListEvaluationExpectationsRequest.new

# Call the list_evaluation_expectations method.
result = client.list_evaluation_expectations 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::Ces::V1beta::EvaluationExpectation.
  p item
end

Overloads:

  • #list_evaluation_expectations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationExpectation>

    Pass arguments to list_evaluation_expectations via a request object, either of type ListEvaluationExpectationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::ListEvaluationExpectationsRequest, ::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_evaluation_expectations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationExpectation>

    Pass arguments to list_evaluation_expectations 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 resource name of the app to list evaluation expectations from.

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.

    • filter (::String) (defaults to: nil) —

      Optional. Filter to be applied when listing the evaluation expectations. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2101

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::ListEvaluationExpectationsRequest

  # 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
  call_metadata = @config.rpcs.list_evaluation_expectations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_evaluation_expectations.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_evaluation_expectations.retry_policy

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

  @evaluation_service_stub.list_evaluation_expectations request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @evaluation_service_stub, :list_evaluation_expectations, "evaluation_expectations", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_evaluation_results(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationResult> #list_evaluation_results(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationResult>

Lists all evaluation results for a given evaluation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListEvaluationResultsRequest.new

# Call the list_evaluation_results method.
result = client.list_evaluation_results 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::Ces::V1beta::EvaluationResult.
  p item
end

Overloads:

  • #list_evaluation_results(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationResult>

    Pass arguments to list_evaluation_results via a request object, either of type ListEvaluationResultsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::ListEvaluationResultsRequest, ::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_evaluation_results(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationResult>

    Pass arguments to list_evaluation_results 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 resource name of the evaluation to list evaluation results from. To filter by evaluation run, use - as the evaluation ID and specify the evaluation run ID in the filter. For example: projects/{project}/locations/{location}/apps/{app}/evaluations/-

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call.

    • filter (::String) (defaults to: nil) —

      Optional. Filter to be applied when listing the evaluation results. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1794

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::ListEvaluationResultsRequest

  # 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
  call_metadata = @config.rpcs.list_evaluation_results.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_evaluation_results.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_evaluation_results.retry_policy

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

  @evaluation_service_stub.list_evaluation_results request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @evaluation_service_stub, :list_evaluation_results, "evaluation_results", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_evaluation_runs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationRun> #list_evaluation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationRun>

Lists all evaluation runs in the given app.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListEvaluationRunsRequest.new

# Call the list_evaluation_runs method.
result = client.list_evaluation_runs 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::Ces::V1beta::EvaluationRun.
  p item
end

Overloads:

  • #list_evaluation_runs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationRun>

    Pass arguments to list_evaluation_runs via a request object, either of type ListEvaluationRunsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::ListEvaluationRunsRequest, ::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_evaluation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationRun>

    Pass arguments to list_evaluation_runs 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 resource name of the app to list evaluation runs from.

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call.

    • filter (::String) (defaults to: nil) —

      Optional. Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1998

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::ListEvaluationRunsRequest

  # 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
  call_metadata = @config.rpcs.list_evaluation_runs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_evaluation_runs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_evaluation_runs.retry_policy

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

  @evaluation_service_stub.list_evaluation_runs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @evaluation_service_stub, :list_evaluation_runs, "evaluation_runs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_evaluations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Evaluation> #list_evaluations(parent: nil, page_size: nil, page_token: nil, filter: nil, evaluation_filter: nil, evaluation_run_filter: nil, order_by: nil, last_ten_results: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Evaluation>

Lists all evaluations in the given app.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListEvaluationsRequest.new

# Call the list_evaluations method.
result = client.list_evaluations 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::Ces::V1beta::Evaluation.
  p item
end

Overloads:

  • #list_evaluations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Evaluation>

    Pass arguments to list_evaluations via a request object, either of type ListEvaluationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::ListEvaluationsRequest, ::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_evaluations(parent: nil, page_size: nil, page_token: nil, filter: nil, evaluation_filter: nil, evaluation_run_filter: nil, order_by: nil, last_ten_results: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::Evaluation>

    Pass arguments to list_evaluations 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 resource name of the app to list evaluations from.

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.

    • filter (::String) (defaults to: nil) —

      Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.

    • evaluation_filter (::String) (defaults to: nil) —

      Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets

    • evaluation_run_filter (::String) (defaults to: nil) —

      Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

    • last_ten_results (::Boolean) (defaults to: nil) —

      Optional. Whether to include the last 10 evaluation results for each evaluation in the response.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 1689

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::ListEvaluationsRequest

  # 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
  call_metadata = @config.rpcs.list_evaluations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_evaluations.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_evaluations.retry_policy

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

  @evaluation_service_stub.list_evaluations request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @evaluation_service_stub, :list_evaluations, "evaluations", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_scheduled_evaluation_runs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun> #list_scheduled_evaluation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun>

Lists all scheduled evaluation runs in the given app.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::ListScheduledEvaluationRunsRequest.new

# Call the list_scheduled_evaluation_runs method.
result = client.list_scheduled_evaluation_runs 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::Ces::V1beta::ScheduledEvaluationRun.
  p item
end

Overloads:

  • #list_scheduled_evaluation_runs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun>

    Pass arguments to list_scheduled_evaluation_runs via a request object, either of type ListScheduledEvaluationRunsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::ListScheduledEvaluationRunsRequest, ::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_scheduled_evaluation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun>

    Pass arguments to list_scheduled_evaluation_runs 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 resource name of the app to list scheduled evaluation runs from.

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

    • page_token (::String) (defaults to: nil) —

      Optional. The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.

    • filter (::String) (defaults to: nil) —

      Optional. Filter to be applied when listing the scheduled evaluation runs. See https://google.aip.dev/160 for more details. Currently supports filtering by:

      • request.evaluations:evaluation_id
      • request.evaluation_dataset:evaluation_dataset_id
    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. Supported fields are: "name" (ascending), "create_time" (descending), "update_time" (descending), "next_scheduled_execution" (ascending), and "last_completed_run.create_time" (descending). If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2701

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::ListScheduledEvaluationRunsRequest

  # 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
  call_metadata = @config.rpcs.list_scheduled_evaluation_runs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_scheduled_evaluation_runs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_scheduled_evaluation_runs.retry_policy

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

  @evaluation_service_stub.list_scheduled_evaluation_runs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @evaluation_service_stub, :list_scheduled_evaluation_runs, "scheduled_evaluation_runs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


209
210
211
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 209

def logger
  @evaluation_service_stub.logger
end

#run_evaluation(request, options = nil) ⇒ ::Gapic::Operation #run_evaluation(app: nil, evaluations: nil, evaluation_dataset: nil, display_name: nil, app_version: nil, config: nil, run_count: nil, persona_run_configs: nil, optimization_config: nil, scheduled_evaluation_run: nil, golden_run_method: nil, generate_latency_report: nil) ⇒ ::Gapic::Operation

Runs an evaluation of the app.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::RunEvaluationRequest.new

# Call the run_evaluation method.
result = client.run_evaluation 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:

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

    Pass arguments to run_evaluation via a request object, either of type RunEvaluationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::RunEvaluationRequest, ::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.

  • #run_evaluation(app: nil, evaluations: nil, evaluation_dataset: nil, display_name: nil, app_version: nil, config: nil, run_count: nil, persona_run_configs: nil, optimization_config: nil, scheduled_evaluation_run: nil, golden_run_method: nil, generate_latency_report: nil) ⇒ ::Gapic::Operation

    Pass arguments to run_evaluation 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:

    • app (::String) (defaults to: nil) —

      Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

    • evaluations (::Array<::String>) (defaults to: nil) —

      Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

    • evaluation_dataset (::String) (defaults to: nil) —

      Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

    • display_name (::String) (defaults to: nil) —

      Optional. The display name of the evaluation run.

    • app_version (::String) (defaults to: nil) —

      Optional. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

    • config (::Google::Cloud::Ces::V1beta::EvaluationConfig, ::Hash) (defaults to: nil) —

      Optional. The configuration to use for the run.

    • run_count (::Integer) (defaults to: nil) —

      Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.

    • persona_run_configs (::Array<::Google::Cloud::Ces::V1beta::PersonaRunConfig, ::Hash>) (defaults to: nil) —

      Optional. The configuration to use for the run per persona.

    • optimization_config (::Google::Cloud::Ces::V1beta::OptimizationConfig, ::Hash) (defaults to: nil) —

      Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.

    • scheduled_evaluation_run (::String) (defaults to: nil) —

      Optional. The resource name of the ScheduledEvaluationRun that is triggering this evaluation run.

      If this field is set, the scheduled_evaluation_run field on the created EvaluationRun resource will be populated from this value. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}

    • golden_run_method (::Google::Cloud::Ces::V1beta::GoldenRunMethod) (defaults to: nil) —

      Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.

    • generate_latency_report (::Boolean) (defaults to: nil) —

      Optional. Whether to generate a latency report for the evaluation run.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 304

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::RunEvaluationRequest

  # 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
  call_metadata = @config.rpcs.run_evaluation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.run_evaluation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.run_evaluation.retry_policy

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

  @evaluation_service_stub.run_evaluation request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#test_persona_voice(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::TestPersonaVoiceResponse #test_persona_voice(app: nil, persona_id: nil, text: nil) ⇒ ::Google::Cloud::Ces::V1beta::TestPersonaVoiceResponse

Tests the voice of a persona. Also accepts a default persona.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::TestPersonaVoiceRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::TestPersonaVoiceResponse.
p result

Overloads:

  • #test_persona_voice(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::TestPersonaVoiceResponse

    Pass arguments to test_persona_voice via a request object, either of type TestPersonaVoiceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::TestPersonaVoiceRequest, ::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.

  • #test_persona_voice(app: nil, persona_id: nil, text: nil) ⇒ ::Google::Cloud::Ces::V1beta::TestPersonaVoiceResponse

    Pass arguments to test_persona_voice 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:

    • app (::String) (defaults to: nil) —

      Required. the resource name of the app to test the persona voice for. Format: projects/{project}/locations/{location}/apps/{app}

    • persona_id (::String) (defaults to: nil) —

      Required. The persona ID to test the voice for. Also accepts "default".

    • text (::String) (defaults to: nil) —

      Required. The text to test the voice for.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2949

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::TestPersonaVoiceRequest

  # 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
  call_metadata = @config.rpcs.test_persona_voice.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.test_persona_voice.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.test_persona_voice.retry_policy

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

  @evaluation_service_stub.test_persona_voice request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 112

def universe_domain
  @evaluation_service_stub.universe_domain
end

#update_evaluation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation #update_evaluation(evaluation: nil, update_mask: nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

Updates an evaluation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateEvaluationRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::Evaluation.
p result

Overloads:

  • #update_evaluation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

    Pass arguments to update_evaluation via a request object, either of type UpdateEvaluationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::UpdateEvaluationRequest, ::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_evaluation(evaluation: nil, update_mask: nil) ⇒ ::Google::Cloud::Ces::V1beta::Evaluation

    Pass arguments to update_evaluation 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:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 846

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::UpdateEvaluationRequest

  # 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
  call_metadata = @config.rpcs.update_evaluation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_evaluation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_evaluation.retry_policy

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

  @evaluation_service_stub.update_evaluation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_evaluation_dataset(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset #update_evaluation_dataset(evaluation_dataset: nil, update_mask: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

Updates an evaluation dataset.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateEvaluationDatasetRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::EvaluationDataset.
p result

Overloads:

  • #update_evaluation_dataset(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

    Pass arguments to update_evaluation_dataset via a request object, either of type UpdateEvaluationDatasetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::UpdateEvaluationDatasetRequest, ::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_evaluation_dataset(evaluation_dataset: nil, update_mask: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationDataset

    Pass arguments to update_evaluation_dataset 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:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 927

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::UpdateEvaluationDatasetRequest

  # 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
  call_metadata = @config.rpcs.update_evaluation_dataset.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_evaluation_dataset.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_evaluation_dataset.retry_policy

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

  @evaluation_service_stub.update_evaluation_dataset request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_evaluation_expectation(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation #update_evaluation_expectation(evaluation_expectation: nil, update_mask: nil) ⇒ ::Google::Cloud::Ces::V1beta::EvaluationExpectation

Updates an evaluation expectation.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateEvaluationExpectationRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::EvaluationExpectation.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2349

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::UpdateEvaluationExpectationRequest

  # 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
  call_metadata = @config.rpcs.update_evaluation_expectation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_evaluation_expectation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_evaluation_expectation.retry_policy

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

  @evaluation_service_stub.update_evaluation_expectation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_scheduled_evaluation_run(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun #update_scheduled_evaluation_run(scheduled_evaluation_run: nil, update_mask: nil) ⇒ ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

Updates a scheduled evaluation run.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UpdateScheduledEvaluationRunRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::ScheduledEvaluationRun.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 2784

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::UpdateScheduledEvaluationRunRequest

  # 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
  call_metadata = @config.rpcs.update_scheduled_evaluation_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_scheduled_evaluation_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_scheduled_evaluation_run.retry_policy

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

  @evaluation_service_stub.update_scheduled_evaluation_run request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#upload_evaluation_audio(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::UploadEvaluationAudioResponse #upload_evaluation_audio(name: nil, audio_content: nil, previous_audio_gcs_uri: nil) ⇒ ::Google::Cloud::Ces::V1beta::UploadEvaluationAudioResponse

Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

Examples:

Basic example

require "google/cloud/ces/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Ces::V1beta::EvaluationService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Ces::V1beta::UploadEvaluationAudioRequest.new

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

# The returned object is of type Google::Cloud::Ces::V1beta::UploadEvaluationAudioResponse.
p result

Overloads:

  • #upload_evaluation_audio(request, options = nil) ⇒ ::Google::Cloud::Ces::V1beta::UploadEvaluationAudioResponse

    Pass arguments to upload_evaluation_audio via a request object, either of type UploadEvaluationAudioRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Ces::V1beta::UploadEvaluationAudioRequest, ::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.

  • #upload_evaluation_audio(name: nil, audio_content: nil, previous_audio_gcs_uri: nil) ⇒ ::Google::Cloud::Ces::V1beta::UploadEvaluationAudioResponse

    Pass arguments to upload_evaluation_audio 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 resource name of the Evaluation for which to upload the evaluation audio. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

    • audio_content (::String) (defaults to: nil) —

      Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig).

    • previous_audio_gcs_uri (::String) (defaults to: nil) —

      Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: gs://<bucket-name>/<object-name>

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/google/cloud/ces/v1beta/evaluation_service/rest/client.rb', line 396

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Ces::V1beta::UploadEvaluationAudioRequest

  # 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
  call_metadata = @config.rpcs.upload_evaluation_audio.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Ces::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.upload_evaluation_audio.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.upload_evaluation_audio.retry_policy

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

  @evaluation_service_stub.upload_evaluation_audio request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end