Interface SearchEvaluationsRequestOrBuilder (0.175.0) 

public interface SearchEvaluationsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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

  • evaluation<span>_</span>job.evaluation_job_id (the last part of EvaluationJob.name)
  • evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion of EvaluationJob.modelVersion)
  • evaluation<span>_</span>job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation<span>_</span>job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation<span>_</span>job.job_state (EvaluationJob.state)

  • annotation<span>_</span>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:

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

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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

  • evaluation<span>_</span>job.evaluation_job_id (the last part of EvaluationJob.name)
  • evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion of EvaluationJob.modelVersion)
  • evaluation<span>_</span>job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation<span>_</span>job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation<span>_</span>job.job_state (EvaluationJob.state)

  • annotation<span>_</span>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:

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

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int getPageSize()

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

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.