Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::EvaluationService::Client (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::EvaluationService::Client.

Client for the EvaluationService service.

EvaluationService exposes methods to perform evaluation for the CES app.

Inherits

Object

Includes

Google::Cloud::Ces::V1beta::EvaluationService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the EvaluationService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_evaluation

def create_evaluation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Evaluation
def create_evaluation(parent: nil, evaluation_id: nil, evaluation: nil) -> ::Google::Cloud::Ces::V1beta::Evaluation

Creates an evaluation.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}
evaluation_id (::String) — 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) — Required. The evaluation to create.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::Evaluation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::Evaluation)

Raises

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

Example

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::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

#create_evaluation_dataset

def create_evaluation_dataset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationDataset
def create_evaluation_dataset(parent: nil, evaluation_dataset_id: nil, evaluation_dataset: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationDataset

Creates an evaluation dataset.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}
evaluation_dataset_id (::String) — 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) — Required. The evaluation dataset to create.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::EvaluationDataset)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::EvaluationDataset)

Raises

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

Example

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::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

#create_evaluation_expectation

def create_evaluation_expectation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationExpectation
def create_evaluation_expectation(parent: nil, evaluation_expectation_id: nil, evaluation_expectation: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationExpectation

Creates an evaluation expectation.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The app to create the evaluation expectation for. Format: projects/{project}/locations/{location}/apps/{app}
evaluation_expectation_id (::String) — 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) — Required. The evaluation expectation to create.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::EvaluationExpectation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::EvaluationExpectation)

Raises

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

Example

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::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

#create_scheduled_evaluation_run

def create_scheduled_evaluation_run(request, options = nil) -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The app to create the scheduled evaluation run for. Format: projects/{project}/locations/{location}/apps/{app}
scheduled_evaluation_run_id (::String) — 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) — Required. The scheduled evaluation run to create.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun)

Raises

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

Example

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::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

#delete_evaluation

def delete_evaluation(request, options = nil) -> ::Google::Protobuf::Empty
def delete_evaluation(name: nil, force: nil, etag: nil) -> ::Google::Protobuf::Empty

Deletes an evaluation.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The resource name of the evaluation to delete.
force (::Boolean) —
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) — 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

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

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#delete_evaluation_dataset

def delete_evaluation_dataset(request, options = nil) -> ::Google::Protobuf::Empty
def delete_evaluation_dataset(name: nil, etag: nil) -> ::Google::Protobuf::Empty

Deletes an evaluation dataset.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The resource name of the evaluation dataset to delete.
etag (::String) — 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

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

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#delete_evaluation_expectation

def delete_evaluation_expectation(request, options = nil) -> ::Google::Protobuf::Empty
def delete_evaluation_expectation(name: nil, etag: nil) -> ::Google::Protobuf::Empty

Deletes an evaluation expectation.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The resource name of the evaluation expectation to delete.
etag (::String) — 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

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

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#delete_evaluation_result

def delete_evaluation_result(request, options = nil) -> ::Google::Protobuf::Empty
def delete_evaluation_result(name: nil) -> ::Google::Protobuf::Empty

Deletes an evaluation result.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The resource name of the evaluation result to delete.

Yields

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

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#delete_evaluation_run

def delete_evaluation_run(request, options = nil) -> ::Gapic::Operation
def delete_evaluation_run(name: nil) -> ::Gapic::Operation

Deletes an evaluation run.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The resource name of the evaluation run to delete.

Yields

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

Yield Parameters

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

Returns

(::Gapic::Operation)

Raises

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

Example

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::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

#delete_scheduled_evaluation_run

def delete_scheduled_evaluation_run(request, options = nil) -> ::Google::Protobuf::Empty
def delete_scheduled_evaluation_run(name: nil, etag: nil) -> ::Google::Protobuf::Empty

Deletes a scheduled evaluation run.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The resource name of the scheduled evaluation run to delete.
etag (::String) — Optional. The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag.

Yields

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

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#export_evaluations

def export_evaluations(request, options = nil) -> ::Gapic::Operation
def export_evaluations(parent: nil, names: nil, export_options: nil, include_evaluation_results: nil, include_evaluations: nil) -> ::Gapic::Operation

Exports evaluations.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The resource name of the app to export evaluations from. Format: projects/{project}/locations/{location}/apps/{app}
names (::Array<::String>) — Required. The resource names of the evaluations to export.
export_options (::Google::Cloud::Ces::V1beta::ExportOptions, ::Hash) — Optional. The export options for the evaluations.
include_evaluation_results (::Boolean) — Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set.
include_evaluations (::Boolean) — Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set.

Yields

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

Yield Parameters

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

Returns

(::Gapic::Operation)

Raises

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

Example

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::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

#generate_evaluation

def generate_evaluation(request, options = nil) -> ::Gapic::Operation
def generate_evaluation(conversation: nil, source: nil) -> ::Gapic::Operation

Creates a golden evaluation from a conversation.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — Optional. Indicate the source of the conversation. If not set, all sources will be searched.

Yields

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

Yield Parameters

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

Returns

(::Gapic::Operation)

Raises

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

Example

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::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

#get_evaluation

def get_evaluation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Evaluation
def get_evaluation(name: nil) -> ::Google::Cloud::Ces::V1beta::Evaluation

Gets details of the specified evaluation.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The resource name of the evaluation to retrieve.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::Evaluation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::Evaluation)

Raises

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

Example

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::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

#get_evaluation_dataset

def get_evaluation_dataset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationDataset
def get_evaluation_dataset(name: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationDataset

Gets details of the specified evaluation dataset.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The resource name of the evaluation dataset to retrieve.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::EvaluationDataset)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::EvaluationDataset)

Raises

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

Example

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::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

#get_evaluation_expectation

def get_evaluation_expectation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationExpectation
def get_evaluation_expectation(name: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationExpectation

Gets details of the specified evaluation expectation.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The resource name of the evaluation expectation to retrieve.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::EvaluationExpectation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::EvaluationExpectation)

Raises

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

Example

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::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

#get_evaluation_result

def get_evaluation_result(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationResult
def get_evaluation_result(name: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationResult

Gets details of the specified evaluation result.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The resource name of the evaluation result to retrieve.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::EvaluationResult)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::EvaluationResult)

Raises

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

Example

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::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

#get_evaluation_run

def get_evaluation_run(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationRun
def get_evaluation_run(name: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationRun

Gets details of the specified evaluation run.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The resource name of the evaluation run to retrieve.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::EvaluationRun)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::EvaluationRun)

Raises

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

Example

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::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

#get_scheduled_evaluation_run

def get_scheduled_evaluation_run(request, options = nil) -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun
def get_scheduled_evaluation_run(name: nil) -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

Gets details of the specified scheduled evaluation run.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The resource name of the scheduled evaluation run to retrieve.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun)

Raises

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

Example

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::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

#import_evaluations

def import_evaluations(request, options = nil) -> ::Gapic::Operation
def import_evaluations(conversation_list: nil, gcs_uri: nil, csv_content: nil, parent: nil, import_options: nil) -> ::Gapic::Operation

Imports evaluations into the app.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — 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) — 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) — Required. The app to import the evaluations into. Format: projects/{project}/locations/{location}/apps/{app}
import_options (::Google::Cloud::Ces::V1beta::ImportEvaluationsRequest::ImportOptions, ::Hash) — Optional. Options governing the import process for the evaluations.

Yields

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

Yield Parameters

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

Returns

(::Gapic::Operation)

Raises

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

Example

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::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

#initialize

def initialize() { |config| ... } -> Client

Create a new EvaluationService client object.

Yields

(config) — Configure the EvaluationService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

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

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

#list_evaluation_datasets

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

Lists all evaluation datasets in the given app.

Overloads

def list_evaluation_datasets(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_evaluation_datasets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::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) — Required. The resource name of the app to list evaluation datasets from.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets call.
filter (::String) — Optional. Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

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

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationDataset>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationDataset>)

Raises

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

Example

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::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

#list_evaluation_expectations

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

Lists all evaluation expectations in the given app.

Overloads

def list_evaluation_expectations(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_evaluation_expectations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::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) — Required. The resource name of the app to list evaluation expectations from.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.
filter (::String) — Optional. Filter to be applied when listing the evaluation expectations. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

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

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationExpectation>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationExpectation>)

Raises

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

Example

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::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

#list_evaluation_results

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

Lists all evaluation results for a given evaluation.

Overloads

def list_evaluation_results(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_evaluation_results(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::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) — 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) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call.
filter (::String) — Optional. Filter to be applied when listing the evaluation results. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

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

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationResult>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationResult>)

Raises

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

Example

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::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

#list_evaluation_runs

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

Lists all evaluation runs in the given app.

Overloads

def list_evaluation_runs(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_evaluation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::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) — Required. The resource name of the app to list evaluation runs from.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call.
filter (::String) — Optional. Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

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

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationRun>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::EvaluationRun>)

Raises

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

Example

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::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

#list_evaluations

def list_evaluations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::Evaluation>
def 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::PagedEnumerable<::Google::Cloud::Ces::V1beta::Evaluation>

Lists all evaluations in the given app.

Overloads

def list_evaluations(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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::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) — Required. The resource name of the app to list evaluations from.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.
filter (::String) — Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.
evaluation_filter (::String) — 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) — 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) — 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) — Optional. Whether to include the last 10 evaluation results for each evaluation in the response.

Yields

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

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::Evaluation>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::Evaluation>)

Raises

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

Example

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::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

#list_scheduled_evaluation_runs

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

Lists all scheduled evaluation runs in the given app.

Overloads

def list_scheduled_evaluation_runs(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_scheduled_evaluation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::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) — Required. The resource name of the app to list scheduled evaluation runs from.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token (::String) — Optional. The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.
filter (::String) —
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) — 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

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

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun>)

Raises

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

Example

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::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

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

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

Returns

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns

(Logger)

#operations_client

def operations_client() -> ::Google::Cloud::Ces::V1beta::EvaluationService::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::Ces::V1beta::EvaluationService::Operations)

#run_evaluation

def run_evaluation(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}
evaluations (::Array<::String>) — Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
evaluation_dataset (::String) — Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
display_name (::String) — Optional. The display name of the evaluation run.
app_version (::String) — Optional. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
config (::Google::Cloud::Ces::V1beta::EvaluationConfig, ::Hash) — Optional. The configuration to use for the run.
run_count (::Integer) — 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>) — Optional. The configuration to use for the run per persona.
optimization_config (::Google::Cloud::Ces::V1beta::OptimizationConfig, ::Hash) — 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) — 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) — Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.
generate_latency_report (::Boolean) — Optional. Whether to generate a latency report for the evaluation run.

Yields

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

Yield Parameters

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

Returns

(::Gapic::Operation)

Raises

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

Example

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::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

#test_persona_voice

def test_persona_voice(request, options = nil) -> ::Google::Cloud::Ces::V1beta::TestPersonaVoiceResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — Required. the resource name of the app to test the persona voice for. Format: projects/{project}/locations/{location}/apps/{app}
persona_id (::String) — Required. The persona ID to test the voice for. Also accepts "default".
text (::String) — Required. The text to test the voice for.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::TestPersonaVoiceResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::TestPersonaVoiceResponse)

Raises

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

Example

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::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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_evaluation

def update_evaluation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::Evaluation
def update_evaluation(evaluation: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::Evaluation

Updates an evaluation.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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

evaluation (::Google::Cloud::Ces::V1beta::Evaluation, ::Hash) — Required. The evaluation to update.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::Evaluation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::Evaluation)

Raises

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

Example

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::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

#update_evaluation_dataset

def update_evaluation_dataset(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationDataset
def update_evaluation_dataset(evaluation_dataset: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationDataset

Updates an evaluation dataset.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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

evaluation_dataset (::Google::Cloud::Ces::V1beta::EvaluationDataset, ::Hash) — Required. The evaluation dataset to update.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::EvaluationDataset)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::EvaluationDataset)

Raises

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

Example

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::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

#update_evaluation_expectation

def update_evaluation_expectation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationExpectation
def update_evaluation_expectation(evaluation_expectation: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationExpectation

Updates an evaluation expectation.

Overloads

def update_evaluation_expectation(request, options = nil) -> ::Google::Cloud::Ces::V1beta::EvaluationExpectation

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

Parameters

request (::Google::Cloud::Ces::V1beta::UpdateEvaluationExpectationRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_evaluation_expectation(evaluation_expectation: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::EvaluationExpectation

Pass arguments to update_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

evaluation_expectation (::Google::Cloud::Ces::V1beta::EvaluationExpectation, ::Hash) — Required. The evaluation expectation to update.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::EvaluationExpectation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::EvaluationExpectation)

Raises

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

Example

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::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

#update_scheduled_evaluation_run

def update_scheduled_evaluation_run(request, options = nil) -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun
def update_scheduled_evaluation_run(scheduled_evaluation_run: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

Updates a scheduled evaluation run.

Overloads

def update_scheduled_evaluation_run(request, options = nil) -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

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

Parameters

request (::Google::Cloud::Ces::V1beta::UpdateScheduledEvaluationRunRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_scheduled_evaluation_run(scheduled_evaluation_run: nil, update_mask: nil) -> ::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun

Pass arguments to update_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

scheduled_evaluation_run (::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun, ::Hash) — Required. The scheduled evaluation run to update.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::ScheduledEvaluationRun)

Raises

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

Example

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::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

#upload_evaluation_audio

def upload_evaluation_audio(request, options = nil) -> ::Google::Cloud::Ces::V1beta::UploadEvaluationAudioResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — 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) — Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: gs://<bucket-name>/<object-name>

Yields

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

Yield Parameters

response (::Google::Cloud::Ces::V1beta::UploadEvaluationAudioResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Ces::V1beta::UploadEvaluationAudioResponse)

Raises

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

Example

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::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

Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::EvaluationService::Client (v0.1.0) Stay organized with collections Save and categorize content based on your preferences.

Inherits

Includes

Methods

.configure

#configure

#create_evaluation

#create_evaluation_dataset

#create_evaluation_expectation

#create_scheduled_evaluation_run

#delete_evaluation

#delete_evaluation_dataset

#delete_evaluation_expectation

#delete_evaluation_result

#delete_evaluation_run

#delete_scheduled_evaluation_run

#export_evaluations

#generate_evaluation

#get_evaluation

#get_evaluation_dataset

#get_evaluation_expectation

#get_evaluation_result

#get_evaluation_run

#get_scheduled_evaluation_run

#import_evaluations

#initialize

#list_evaluation_datasets

#list_evaluation_expectations

#list_evaluation_results

#list_evaluation_runs

#list_evaluations

#list_scheduled_evaluation_runs

#location_client

#logger

#operations_client

#run_evaluation

#test_persona_voice

#universe_domain

#update_evaluation

#update_evaluation_dataset

#update_evaluation_expectation

#update_scheduled_evaluation_run

#upload_evaluation_audio

Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::EvaluationService::Client (v0.1.0)