Class: Google::Cloud::DataLabeling::V1beta1::SearchEvaluationsRequest

Inherits:

Object

• Object
• Google::Cloud::DataLabeling::V1beta1::SearchEvaluationsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/datalabeling/v1beta1/data_labeling_service.rb

Overview

Request message for SearchEvaluation.

Instance Attribute Summary

• #filter ⇒ ::String

  Optional.

• #page_size ⇒ ::Integer

  Optional.

• #page_token ⇒ ::String

  Optional.

• #parent ⇒ ::String

  Required.

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. To search evaluations, you can filter by the following:

• evaluation_job.evaluation_job_id (the last part of EvaluationJob.name)
• evaluation_job.model_id (the {model_name} portion of EvaluationJob.modelVersion)
• evaluation_job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation)
• evaluation_job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation)
• evaluation_job.job_state (EvaluationJob.state)
• annotation_spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName)

To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

"evaluationjob.evaluation_job_id = {evaluation_job_id} AND evaluationjob.model_id = {model_name} AND evaluationjob.evaluation_job_run_time_start = {timestamp_1} AND evaluationjob.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}".

Returns:

• (::String) —

  Optional. To search evaluations, you can filter by the following:

  • evaluation_job.evaluation_job_id (the last part of EvaluationJob.name)
  • evaluation_job.model_id (the {model_name} portion of EvaluationJob.modelVersion)
  • evaluation_job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation_job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation_job.job_state (EvaluationJob.state)
  • annotation_spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName)

  To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

  "evaluationjob.evaluation_job_id = {evaluation_job_id} AND evaluationjob.model_id = {model_name} AND evaluationjob.evaluation_job_run_time_start = {timestamp_1} AND evaluationjob.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}"

# File 'proto_docs/google/cloud/datalabeling/v1beta1/data_labeling_service.rb', line 650

class SearchEvaluationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

Returns:

• (::Integer) —

  Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

# File 'proto_docs/google/cloud/datalabeling/v1beta1/data_labeling_service.rb', line 650

class SearchEvaluationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search request.

If you don't specify this field, the API call requests the first page of the search.

Returns:

• (::String) —

  Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search request.

  If you don't specify this field, the API call requests the first page of the search.

# File 'proto_docs/google/cloud/datalabeling/v1beta1/data_labeling_service.rb', line 650

class SearchEvaluationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. Evaluation search parent (project ID). Format: "projects/{project_id}".

Returns:

• (::String) —

  Required. Evaluation search parent (project ID). Format: "projects/{project_id}"

# File 'proto_docs/google/cloud/datalabeling/v1beta1/data_labeling_service.rb', line 650

class SearchEvaluationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end