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 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}"
↳ 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.
annotationspec.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 annotationspec.display_name =
{display_name}"
Returns
Type
Description
string
setFilter
Optional. To search evaluations, you can filter by the following:
annotationspec.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 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
static::build
Parameters
Name
Description
parent
string
Required. Evaluation search parent (project ID). Format:
"projects/{project_id}"
Please see DataLabelingServiceClient::evaluationName() for help formatting this field.
filter
string
Optional. To search evaluations, you can filter by the following:
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}"
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Datalabeling V1beta1 Client - Class SearchEvaluationsRequest (0.6.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.3 (latest)](/php/docs/reference/cloud-datalabeling/latest/V1beta1.SearchEvaluationsRequest)\n- [0.6.2](/php/docs/reference/cloud-datalabeling/0.6.2/V1beta1.SearchEvaluationsRequest)\n- [0.5.7](/php/docs/reference/cloud-datalabeling/0.5.7/V1beta1.SearchEvaluationsRequest)\n- [0.4.2](/php/docs/reference/cloud-datalabeling/0.4.2/V1beta1.SearchEvaluationsRequest)\n- [0.3.1](/php/docs/reference/cloud-datalabeling/0.3.1/V1beta1.SearchEvaluationsRequest)\n- [0.2.0](/php/docs/reference/cloud-datalabeling/0.2.0/V1beta1.SearchEvaluationsRequest)\n- [0.1.14](/php/docs/reference/cloud-datalabeling/0.1.14/V1beta1.SearchEvaluationsRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class SearchEvaluationsRequest.\n\nRequest message for SearchEvaluation.\n\nGenerated from protobuf message `google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataLabeling \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Evaluation search parent (project ID). Format:\n\"projects/\u003cvar translate=\"no\"\u003e{project_id}\u003c/var\u003e\"\n\n### setParent\n\nRequired. Evaluation search parent (project ID). Format:\n\"projects/\u003cvar translate=\"no\"\u003e{project_id}\u003c/var\u003e\"\n\n### getFilter\n\nOptional. To search evaluations, you can filter by the following:\n\n- evaluation_job.evaluation_job_id (the last part of [EvaluationJob.name](/php/docs/reference/cloud-datalabeling/latest/V1beta1.EvaluationJob#_Google_Cloud_DataLabeling_V1beta1_EvaluationJob__getName__))\n- evaluation_job.model_id (the \u003cvar translate=\"no\"\u003e{model_name}\u003c/var\u003e portion of [EvaluationJob.modelVersion](/php/docs/reference/cloud-datalabeling/latest/V1beta1.EvaluationJob#_Google_Cloud_DataLabeling_V1beta1_EvaluationJob__getModelVersion__))\n- evaluation_job.evaluation_job_run_time_start (Minimum threshold for the [evaluationJobRunTime](/php/docs/reference/cloud-datalabeling/latest/V1beta1.Evaluation#_Google_Cloud_DataLabeling_V1beta1_Evaluation__getEvaluationJobRunTime__) that created the evaluation)\n- evaluation_job.evaluation_job_run_time_end (Maximum threshold for the [evaluationJobRunTime](/php/docs/reference/cloud-datalabeling/latest/V1beta1.Evaluation#_Google_Cloud_DataLabeling_V1beta1_Evaluation__getEvaluationJobRunTime__) that created the evaluation)\n- evaluation_job.job_state ([EvaluationJob.state](/php/docs/reference/cloud-datalabeling/latest/V1beta1.EvaluationJob#_Google_Cloud_DataLabeling_V1beta1_EvaluationJob__getState__))\n- annotationspec.display_name (the Evaluation contains a metric for the annotation spec with this [displayName](/php/docs/reference/cloud-datalabeling/latest/V1beta1.AnnotationSpec#_Google_Cloud_DataLabeling_V1beta1_AnnotationSpec__getDisplayName__)) 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 = \u003cvar translate=\"no\"\u003e{evaluation_job_id}\u003c/var\u003e AND evaluationjob.model_id = \u003cvar translate=\"no\"\u003e{model_name}\u003c/var\u003e AND evaluationjob.evaluation_job_run_time_start = \u003cvar translate=\"no\"\u003e{timestamp_1}\u003c/var\u003e AND evaluationjob.evaluation_job_run_time_end = \u003cvar translate=\"no\"\u003e{timestamp_2}\u003c/var\u003e AND annotationspec.display_name = \u003cvar translate=\"no\"\u003e{display_name}\u003c/var\u003e\"\n\n### setFilter\n\nOptional. To search evaluations, you can filter by the following:\n\n- evaluation_job.evaluation_job_id (the last part of [EvaluationJob.name](/php/docs/reference/cloud-datalabeling/latest/V1beta1.EvaluationJob#_Google_Cloud_DataLabeling_V1beta1_EvaluationJob__getName__))\n- evaluation_job.model_id (the \u003cvar translate=\"no\"\u003e{model_name}\u003c/var\u003e portion of [EvaluationJob.modelVersion](/php/docs/reference/cloud-datalabeling/latest/V1beta1.EvaluationJob#_Google_Cloud_DataLabeling_V1beta1_EvaluationJob__getModelVersion__))\n- evaluation_job.evaluation_job_run_time_start (Minimum threshold for the [evaluationJobRunTime](/php/docs/reference/cloud-datalabeling/latest/V1beta1.Evaluation#_Google_Cloud_DataLabeling_V1beta1_Evaluation__getEvaluationJobRunTime__) that created the evaluation)\n- evaluation_job.evaluation_job_run_time_end (Maximum threshold for the [evaluationJobRunTime](/php/docs/reference/cloud-datalabeling/latest/V1beta1.Evaluation#_Google_Cloud_DataLabeling_V1beta1_Evaluation__getEvaluationJobRunTime__) that created the evaluation)\n- evaluation_job.job_state ([EvaluationJob.state](/php/docs/reference/cloud-datalabeling/latest/V1beta1.EvaluationJob#_Google_Cloud_DataLabeling_V1beta1_EvaluationJob__getState__))\n- annotationspec.display_name (the Evaluation contains a metric for the annotation spec with this [displayName](/php/docs/reference/cloud-datalabeling/latest/V1beta1.AnnotationSpec#_Google_Cloud_DataLabeling_V1beta1_AnnotationSpec__getDisplayName__)) 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 = \u003cvar translate=\"no\"\u003e{evaluation_job_id}\u003c/var\u003e AND evaluationjob.model_id = \u003cvar translate=\"no\"\u003e{model_name}\u003c/var\u003e AND evaluationjob.evaluation_job_run_time_start = \u003cvar translate=\"no\"\u003e{timestamp_1}\u003c/var\u003e AND evaluationjob.evaluation_job_run_time_end = \u003cvar translate=\"no\"\u003e{timestamp_2}\u003c/var\u003e AND annotationspec.display_name = \u003cvar translate=\"no\"\u003e{display_name}\u003c/var\u003e\"\n\n### getPageSize\n\nOptional. Requested page size. Server may return fewer results than\nrequested. Default value is 100.\n\n### setPageSize\n\nOptional. Requested page size. Server may return fewer results than\nrequested. Default value is 100.\n\n### getPageToken\n\nOptional. A token identifying a page of results for the server to return.\n\nTypically obtained by the\n[nextPageToken](/php/docs/reference/cloud-datalabeling/latest/V1beta1.SearchEvaluationsResponse#_Google_Cloud_DataLabeling_V1beta1_SearchEvaluationsResponse__getNextPageToken__) of the response\nto a previous search request.\nIf you don't specify this field, the API call requests the first page of\nthe search.\n\n### setPageToken\n\nOptional. A token identifying a page of results for the server to return.\n\nTypically obtained by the\n[nextPageToken](/php/docs/reference/cloud-datalabeling/latest/V1beta1.SearchEvaluationsResponse#_Google_Cloud_DataLabeling_V1beta1_SearchEvaluationsResponse__getNextPageToken__) of the response\nto a previous search request.\nIf you don't specify this field, the API call requests the first page of\nthe search.\n\n### static::build"]]
