Data Labeling v1beta1 API - Class SearchEvaluationsRequest (2.0.0-beta02) 

public sealed class SearchEvaluationsRequest : IMessage<SearchEvaluationsRequest>, IEquatable<SearchEvaluationsRequest>, IDeepCloneable<SearchEvaluationsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Data Labeling v1beta1 API class SearchEvaluationsRequest.

Request message for SearchEvaluation.

Inheritance

object > SearchEvaluationsRequest

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Constructors

SearchEvaluationsRequest()

public SearchEvaluationsRequest()

SearchEvaluationsRequest(SearchEvaluationsRequest)

public SearchEvaluationsRequest(SearchEvaluationsRequest other)
Parameter
NameDescription
otherSearchEvaluationsRequest

Properties

Filter

public string Filter { get; set; }

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

  • evaluation<span>_</span>job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation<span>_</span>job.evaluation_job_run_time_start (Minimum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation<span>_</span>job.evaluation_job_run_time_end (Maximum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation<span>_</span>job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation<span>_</span>spec.display_name (the Evaluation contains a metric for the annotation spec with this [displayName][google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name])

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

"evaluation<span></span>job.evaluation_job_id = <var>{evaluation_job_id}</var> AND evaluation<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.evaluation_job_run_time_start = <var>{timestamp_1}</var> AND evaluation<span></span>job.evaluation_job_run_time_end = <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name = <var>{display_name}</var>"

Property Value
TypeDescription
string

PageSize

public int PageSize { get; set; }

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

Property Value
TypeDescription
int

PageToken

public string PageToken { get; set; }

Optional. A token identifying a page of results for the server to return. Typically obtained by the [nextPageToken][google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token] 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.

Property Value
TypeDescription
string

Parent

public string Parent { get; set; }

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

Property Value
TypeDescription
string

ParentAsEvaluationName

public EvaluationName ParentAsEvaluationName { get; set; }

EvaluationName-typed view over the Parent resource name property.

Property Value
TypeDescription
EvaluationName