Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class SearchAssetsRequest.
Request message for SearchAssets.
Generated from protobuf message google.cloud.visionai.v1.SearchAssetsRequest
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ schema_key_sorting_strategy
↳ corpus
string
Required. The parent corpus to search. Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}'
↳ page_size
int
The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.
↳ page_token
string
The continuation token to fetch the next page. If empty, it means it is fetching the first page.
↳ content_time_ranges
DateTimeRangeArray
Time ranges that matching video content must fall within. If no ranges are provided, there will be no time restriction. This field is treated just like the criteria below, but defined separately for convenience as it is used frequently. Note that if the end_time is in the future, it will be clamped to the time the request was received.
↳ criteria
↳ facet_selections
array< FacetGroup
>
Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria.
↳ result_annotation_keys
string[]
A list of annotation keys to specify the annotations to be retrieved and returned with each search result. Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search strategy must not be NO_SEARCH.
↳ search_query
string
Global search query. Allows user to search assets without needing to specify which field the value belongs to.
getSchemaKeySortingStrategy
Sort by the value under the data schema key.
hasSchemaKeySortingStrategy
setSchemaKeySortingStrategy
Sort by the value under the data schema key.
$this
getCorpus
Required. The parent corpus to search.
Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}'
string
setCorpus
Required. The parent corpus to search.
Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}'
var
string
$this
getPageSize
The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.
int
setPageSize
The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.
var
int
$this
getPageToken
The continuation token to fetch the next page. If empty, it means it is fetching the first page.
string
setPageToken
The continuation token to fetch the next page. If empty, it means it is fetching the first page.
var
string
$this
getContentTimeRanges
Time ranges that matching video content must fall within. If no ranges are provided, there will be no time restriction. This field is treated just like the criteria below, but defined separately for convenience as it is used frequently. Note that if the end_time is in the future, it will be clamped to the time the request was received.
hasContentTimeRanges
clearContentTimeRanges
setContentTimeRanges
Time ranges that matching video content must fall within. If no ranges are provided, there will be no time restriction. This field is treated just like the criteria below, but defined separately for convenience as it is used frequently. Note that if the end_time is in the future, it will be clamped to the time the request was received.
$this
getCriteria
Criteria applied to search results.
setCriteria
Criteria applied to search results.
$this
getFacetSelections
Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria.
setFacetSelections
Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria.
$this
getResultAnnotationKeys
A list of annotation keys to specify the annotations to be retrieved and returned with each search result.
Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search strategy must not be NO_SEARCH.
setResultAnnotationKeys
A list of annotation keys to specify the annotations to be retrieved and returned with each search result.
Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search strategy must not be NO_SEARCH.
var
string[]
$this
getSearchQuery
Global search query. Allows user to search assets without needing to specify which field the value belongs to.
string
setSearchQuery
Global search query. Allows user to search assets without needing to specify which field the value belongs to.
var
string
$this
getSortSpec
string
