ProjectsLocationsDatasetsSearchDataItemsOptions

import type { ProjectsLocationsDatasetsSearchDataItemsOptions } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

Additional options for AIplatform#projectsLocationsDatasetsSearchDataItems.

interface ProjectsLocationsDatasetsSearchDataItemsOptions {

annotationFilters?: string;

annotationsFilter?: string;

annotationsLimit?: number;

dataItemFilter?: string;

dataLabelingJob?: string;

fieldMask?: string;

orderBy?: string;

[orderByAnnotation.orderBy]?: string;

[orderByAnnotation.savedQuery]?: string;

orderByDataItem?: string;

pageSize?: number;

pageToken?: string;

savedQuery?: string;

}

§Properties

annotationFilters?: string

[src]

An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned.

annotation_spec_id - for = or !=. Must specify saved_query_id= - saved query id that annotations should belong to.

annotationsFilter?: string

[src]

An expression for filtering the Annotations that will be returned per DataItem. * annotation_spec_id - for = or !=.

annotationsLimit?: number

[src]

If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.

dataItemFilter?: string

[src]

An expression for filtering the DataItem that will be returned. * data_item_id - for = or !=. * labeled - for = or !=. * has_annotation(ANNOTATION_SPEC_ID) - true only for DataItem that have at least one annotation with annotation_spec_id = ANNOTATION_SPEC_ID in the context of SavedQuery or DataLabelingJob. For example: * data_item=1 * has_annotation(5)

dataLabelingJob?: string

[src]

The resource name of a DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job} If this field is set, all of the search will be done in the context of this DataLabelingJob.

fieldMask?: string

[src]

Mask specifying which fields of DataItemView to read.

orderBy?: string

[src]

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

[orderByAnnotation.orderBy]?: string

[src]

A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

[orderByAnnotation.savedQuery]?: string

[src]

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

orderByDataItem?: string

[src]

A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

pageSize?: number

[src]

Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.

pageToken?: string

[src]

A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.

savedQuery?: string

[src]

The resource name of a SavedQuery(annotation set in UI). Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query} All of the search will be done in the context of this SavedQuery.