Class: Google::Cloud::AIPlatform::V1::EvaluationService::Rest::Client

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

Overview

REST client for the EvaluationService service.

Vertex AI Online Evaluation Service.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path

Constructor Details

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

Create a new EvaluationService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the EvaluationService client.

Yield Parameters:



128
129
130
131
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
 
# File 'lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb', line 128

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

  @evaluation_service_stub = ::Google::Cloud::AIPlatform::V1::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

  @iam_policy_client = Google::Iam::V1::IAMPolicy::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

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

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

Returns:

  • (Google::Iam::V1::IAMPolicy::Rest::Client) 


200
201
202
 
# File 'lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb', line 200

def iam_policy_client
  @iam_policy_client
end

#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) 


193
194
195
 
# File 'lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb', line 193

def location_client
  @location_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::AIPlatform::V1::EvaluationService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "AIPlatform", "V1"]
    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
  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:



98
99
100
101
 
# File 'lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb', line 98

def configure
  yield @config if block_given?
  @config
end

#evaluate_instances(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::EvaluateInstancesResponse #evaluate_instances(exact_match_input: nil, bleu_input: nil, rouge_input: nil, fluency_input: nil, coherence_input: nil, safety_input: nil, groundedness_input: nil, fulfillment_input: nil, summarization_quality_input: nil, pairwise_summarization_quality_input: nil, summarization_helpfulness_input: nil, summarization_verbosity_input: nil, question_answering_quality_input: nil, pairwise_question_answering_quality_input: nil, question_answering_relevance_input: nil, question_answering_helpfulness_input: nil, question_answering_correctness_input: nil, pointwise_metric_input: nil, pairwise_metric_input: nil, tool_call_valid_input: nil, tool_name_match_input: nil, tool_parameter_key_match_input: nil, tool_parameter_kv_match_input: nil, comet_input: nil, metricx_input: nil, location: nil) ⇒ ::Google::Cloud::AIPlatform::V1::EvaluateInstancesResponse

Evaluates instances based on a given metric.

Examples:

Basic example

require "google/cloud/ai_platform/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::EvaluateInstancesRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::EvaluateInstancesResponse.
p result

Overloads:

  • #evaluate_instances(request, options = nil) ⇒ ::Google::Cloud::AIPlatform::V1::EvaluateInstancesResponse

    Pass arguments to evaluate_instances via a request object, either of type Google::Cloud::AIPlatform::V1::EvaluateInstancesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::AIPlatform::V1::EvaluateInstancesRequest, ::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.

  • #evaluate_instances(exact_match_input: nil, bleu_input: nil, rouge_input: nil, fluency_input: nil, coherence_input: nil, safety_input: nil, groundedness_input: nil, fulfillment_input: nil, summarization_quality_input: nil, pairwise_summarization_quality_input: nil, summarization_helpfulness_input: nil, summarization_verbosity_input: nil, question_answering_quality_input: nil, pairwise_question_answering_quality_input: nil, question_answering_relevance_input: nil, question_answering_helpfulness_input: nil, question_answering_correctness_input: nil, pointwise_metric_input: nil, pairwise_metric_input: nil, tool_call_valid_input: nil, tool_name_match_input: nil, tool_parameter_key_match_input: nil, tool_parameter_kv_match_input: nil, comet_input: nil, metricx_input: nil, location: nil) ⇒ ::Google::Cloud::AIPlatform::V1::EvaluateInstancesResponse

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

    • exact_match_input (::Google::Cloud::AIPlatform::V1::ExactMatchInput, ::Hash) (defaults to: nil) —

      Auto metric instances. Instances and metric spec for exact match metric.

      Note: The following parameters are mutually exclusive: exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • bleu_input (::Google::Cloud::AIPlatform::V1::BleuInput, ::Hash) (defaults to: nil) —

      Instances and metric spec for bleu metric.

      Note: The following parameters are mutually exclusive: bleu_input, exact_match_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • rouge_input (::Google::Cloud::AIPlatform::V1::RougeInput, ::Hash) (defaults to: nil) —

      Instances and metric spec for rouge metric.

      Note: The following parameters are mutually exclusive: rouge_input, exact_match_input, bleu_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • fluency_input (::Google::Cloud::AIPlatform::V1::FluencyInput, ::Hash) (defaults to: nil) —

      LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric.

      Note: The following parameters are mutually exclusive: fluency_input, exact_match_input, bleu_input, rouge_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • coherence_input (::Google::Cloud::AIPlatform::V1::CoherenceInput, ::Hash) (defaults to: nil) —

      Input for coherence metric.

      Note: The following parameters are mutually exclusive: coherence_input, exact_match_input, bleu_input, rouge_input, fluency_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • safety_input (::Google::Cloud::AIPlatform::V1::SafetyInput, ::Hash) (defaults to: nil) —

      Input for safety metric.

      Note: The following parameters are mutually exclusive: safety_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • groundedness_input (::Google::Cloud::AIPlatform::V1::GroundednessInput, ::Hash) (defaults to: nil) —

      Input for groundedness metric.

      Note: The following parameters are mutually exclusive: groundedness_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • fulfillment_input (::Google::Cloud::AIPlatform::V1::FulfillmentInput, ::Hash) (defaults to: nil) —

      Input for fulfillment metric.

      Note: The following parameters are mutually exclusive: fulfillment_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • summarization_quality_input (::Google::Cloud::AIPlatform::V1::SummarizationQualityInput, ::Hash) (defaults to: nil) —

      Input for summarization quality metric.

      Note: The following parameters are mutually exclusive: summarization_quality_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • pairwise_summarization_quality_input (::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInput, ::Hash) (defaults to: nil) —

      Input for pairwise summarization quality metric.

      Note: The following parameters are mutually exclusive: pairwise_summarization_quality_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • summarization_helpfulness_input (::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInput, ::Hash) (defaults to: nil) —

      Input for summarization helpfulness metric.

      Note: The following parameters are mutually exclusive: summarization_helpfulness_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • summarization_verbosity_input (::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInput, ::Hash) (defaults to: nil) —

      Input for summarization verbosity metric.

      Note: The following parameters are mutually exclusive: summarization_verbosity_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • question_answering_quality_input (::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInput, ::Hash) (defaults to: nil) —

      Input for question answering quality metric.

      Note: The following parameters are mutually exclusive: question_answering_quality_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • pairwise_question_answering_quality_input (::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInput, ::Hash) (defaults to: nil) —

      Input for pairwise question answering quality metric.

      Note: The following parameters are mutually exclusive: pairwise_question_answering_quality_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • question_answering_relevance_input (::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInput, ::Hash) (defaults to: nil) —

      Input for question answering relevance metric.

      Note: The following parameters are mutually exclusive: question_answering_relevance_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • question_answering_helpfulness_input (::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInput, ::Hash) (defaults to: nil) —

      Input for question answering helpfulness metric.

      Note: The following parameters are mutually exclusive: question_answering_helpfulness_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • question_answering_correctness_input (::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInput, ::Hash) (defaults to: nil) —

      Input for question answering correctness metric.

      Note: The following parameters are mutually exclusive: question_answering_correctness_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • pointwise_metric_input (::Google::Cloud::AIPlatform::V1::PointwiseMetricInput, ::Hash) (defaults to: nil) —

      Input for pointwise metric.

      Note: The following parameters are mutually exclusive: pointwise_metric_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • pairwise_metric_input (::Google::Cloud::AIPlatform::V1::PairwiseMetricInput, ::Hash) (defaults to: nil) —

      Input for pairwise metric.

      Note: The following parameters are mutually exclusive: pairwise_metric_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • tool_call_valid_input (::Google::Cloud::AIPlatform::V1::ToolCallValidInput, ::Hash) (defaults to: nil) —

      Tool call metric instances. Input for tool call valid metric.

      Note: The following parameters are mutually exclusive: tool_call_valid_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • tool_name_match_input (::Google::Cloud::AIPlatform::V1::ToolNameMatchInput, ::Hash) (defaults to: nil) —

      Input for tool name match metric.

      Note: The following parameters are mutually exclusive: tool_name_match_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • tool_parameter_key_match_input (::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInput, ::Hash) (defaults to: nil) —

      Input for tool parameter key match metric.

      Note: The following parameters are mutually exclusive: tool_parameter_key_match_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_kv_match_input, comet_input, metricx_input. 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.

    • tool_parameter_kv_match_input (::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInput, ::Hash) (defaults to: nil) —

      Input for tool parameter key value match metric.

      Note: The following parameters are mutually exclusive: tool_parameter_kv_match_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, comet_input, metricx_input. 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.

    • comet_input (::Google::Cloud::AIPlatform::V1::CometInput, ::Hash) (defaults to: nil) —

      Translation metrics. Input for Comet metric.

      Note: The following parameters are mutually exclusive: comet_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, metricx_input. 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.

    • metricx_input (::Google::Cloud::AIPlatform::V1::MetricxInput, ::Hash) (defaults to: nil) —

      Input for Metricx metric.

      Note: The following parameters are mutually exclusive: metricx_input, exact_match_input, bleu_input, rouge_input, fluency_input, coherence_input, safety_input, groundedness_input, fulfillment_input, summarization_quality_input, pairwise_summarization_quality_input, summarization_helpfulness_input, summarization_verbosity_input, question_answering_quality_input, pairwise_question_answering_quality_input, question_answering_relevance_input, question_answering_helpfulness_input, question_answering_correctness_input, pointwise_metric_input, pairwise_metric_input, tool_call_valid_input, tool_name_match_input, tool_parameter_key_match_input, tool_parameter_kv_match_input, comet_input. 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.

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

      Required. The resource name of the Location to evaluate the instances. Format: projects/{project}/locations/{location}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb', line 364

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::EvaluateInstancesRequest

  # 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.evaluate_instances.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::AIPlatform::V1::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.evaluate_instances.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.evaluate_instances.retry_policy

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

  @evaluation_service_stub.evaluate_instances 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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


207
208
209
 
# File 'lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb', line 207

def logger
  @evaluation_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


108
109
110
 
# File 'lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb', line 108

def universe_domain
  @evaluation_service_stub.universe_domain
end