1 | <?php
|
---|
2 | /*
|
---|
3 | * Copyright 2014 Google Inc.
|
---|
4 | *
|
---|
5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
7 | * the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
14 | * License for the specific language governing permissions and limitations under
|
---|
15 | * the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | namespace Google\Service\DataLabeling\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\DataLabeling\GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "evaluations" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $datalabelingService = new Google\Service\DataLabeling(...);
|
---|
27 | * $evaluations = $datalabelingService->projects_evaluations;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class ProjectsEvaluations extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * Searches evaluations within a project. (evaluations.search)
|
---|
34 | *
|
---|
35 | * @param string $parent Required. Evaluation search parent (project ID).
|
---|
36 | * Format: "projects/ {project_id}"
|
---|
37 | * @param array $optParams Optional parameters.
|
---|
38 | *
|
---|
39 | * @opt_param string filter Optional. To search evaluations, you can filter by
|
---|
40 | * the following: * evaluation_job.evaluation_job_id (the last part of
|
---|
41 | * EvaluationJob.name) * evaluation_job.model_id (the {model_name} portion of
|
---|
42 | * EvaluationJob.modelVersion) * evaluation_job.evaluation_job_run_time_start
|
---|
43 | * (Minimum threshold for the evaluationJobRunTime that created the evaluation)
|
---|
44 | * * evaluation_job.evaluation_job_run_time_end (Maximum threshold for the
|
---|
45 | * evaluationJobRunTime that created the evaluation) * evaluation_job.job_state
|
---|
46 | * (EvaluationJob.state) * annotation_spec.display_name (the Evaluation contains
|
---|
47 | * a metric for the annotation spec with this displayName) To filter by multiple
|
---|
48 | * critiera, use the `AND` operator or the `OR` operator. The following examples
|
---|
49 | * shows a string that filters by several critiera:
|
---|
50 | * "evaluation_job.evaluation_job_id = {evaluation_job_id} AND
|
---|
51 | * evaluation_job.model_id = {model_name} AND
|
---|
52 | * evaluation_job.evaluation_job_run_time_start = {timestamp_1} AND
|
---|
53 | * evaluation_job.evaluation_job_run_time_end = {timestamp_2} AND
|
---|
54 | * annotation_spec.display_name = {display_name}"
|
---|
55 | * @opt_param int pageSize Optional. Requested page size. Server may return
|
---|
56 | * fewer results than requested. Default value is 100.
|
---|
57 | * @opt_param string pageToken Optional. A token identifying a page of results
|
---|
58 | * for the server to return. Typically obtained by the nextPageToken of the
|
---|
59 | * response to a previous search request. If you don't specify this field, the
|
---|
60 | * API call requests the first page of the search.
|
---|
61 | * @return GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse
|
---|
62 | * @throws \Google\Service\Exception
|
---|
63 | */
|
---|
64 | public function search($parent, $optParams = [])
|
---|
65 | {
|
---|
66 | $params = ['parent' => $parent];
|
---|
67 | $params = array_merge($params, $optParams);
|
---|
68 | return $this->call('search', [$params], GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse::class);
|
---|
69 | }
|
---|
70 | }
|
---|
71 |
|
---|
72 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
73 | class_alias(ProjectsEvaluations::class, 'Google_Service_DataLabeling_Resource_ProjectsEvaluations');
|
---|