Vision AI v1 API - Class SearchAssetsRequest (1.0.0-beta01)

public sealed class SearchAssetsRequest : IMessage<SearchAssetsRequest>, IEquatable<SearchAssetsRequest>, IDeepCloneable<SearchAssetsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Vision AI v1 API class SearchAssetsRequest.

Request message for SearchAssets.

Inheritance

object > SearchAssetsRequest

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

SearchAssetsRequest()

public SearchAssetsRequest()

SearchAssetsRequest(SearchAssetsRequest)

public SearchAssetsRequest(SearchAssetsRequest other)
Parameter
Name Description
other SearchAssetsRequest

Properties

ContentTimeRanges

public DateTimeRangeArray ContentTimeRanges { get; set; }

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.

Property Value
Type Description
DateTimeRangeArray

Corpus

public string Corpus { get; set; }

Required. The parent corpus to search. Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}'

Property Value
Type Description
string

CorpusAsCorpusName

public CorpusName CorpusAsCorpusName { get; set; }

CorpusName-typed view over the Corpus resource name property.

Property Value
Type Description
CorpusName

Criteria

public RepeatedField<Criteria> Criteria { get; }

Criteria applied to search results.

Property Value
Type Description
RepeatedFieldCriteria

FacetSelections

public RepeatedField<FacetGroup> FacetSelections { get; }

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.

Property Value
Type Description
RepeatedFieldFacetGroup

PageSize

public int PageSize { get; set; }

The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

The continuation token to fetch the next page. If empty, it means it is fetching the first page.

Property Value
Type Description
string

ResultAnnotationKeys

public RepeatedField<string> ResultAnnotationKeys { get; }

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.

Property Value
Type Description
RepeatedFieldstring

SchemaKeySortingStrategy

public SchemaKeySortingStrategy SchemaKeySortingStrategy { get; set; }

Sort by the value under the data schema key.

Property Value
Type Description
SchemaKeySortingStrategy

SearchQuery

public string SearchQuery { get; set; }

Global search query. Allows user to search assets without needing to specify which field the value belongs to.

Property Value
Type Description
string

SortSpecCase

public SearchAssetsRequest.SortSpecOneofCase SortSpecCase { get; }
Property Value
Type Description
SearchAssetsRequestSortSpecOneofCase