Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class SearchEvaluationsRequest.
Request message for SearchEvaluation.
Generated from protobuf message google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest
Methods
build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. Evaluation search parent (project ID). Format: "projects/{project_id}" Please see {@see \Google\Cloud\DataLabeling\V1beta1\DataLabelingServiceClient::evaluationName()} for help formatting this field. |
filter |
string
Optional. To search evaluations, you can filter by the following:
To filter by multiple critiera, use the "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 | |
|---|---|
| Type | Description |
Google\Cloud\DataLabeling\V1beta1\SearchEvaluationsRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Evaluation search parent (project ID). Format: "projects/{project_id}" |
↳ filter |
string
Optional. To search evaluations, you can filter by the following: * evaluationjob.evaluation_job_id (the last part of EvaluationJob.name) * evaluationjob.model_id (the {model_name} portion of EvaluationJob.modelVersion) * evaluationjob.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation) * evaluationjob.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation) * evaluationjob.job_state (EvaluationJob.state) * annotationspec.display_name (the Evaluation contains a metric for the annotation spec with this displayName) To filter by multiple critiera, use the |
↳ page_size |
int
Optional. Requested page size. Server may return fewer results than requested. Default value is 100. |
↳ page_token |
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. |
getParent
Required. Evaluation search parent (project ID). Format: "projects/{project_id}"
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. Evaluation search parent (project ID). Format: "projects/{project_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
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)
- annotationspec.display_name (the Evaluation contains a
metric for the annotation spec with this
displayName)
To filter by multiple critiera, use the
ANDoperator or theORoperator. 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 annotationspec.display_name = {display_name}"
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
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)
- annotationspec.display_name (the Evaluation contains a
metric for the annotation spec with this
displayName)
To filter by multiple critiera, use the
ANDoperator or theORoperator. 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 annotationspec.display_name = {display_name}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |