Vision AI V1 API - Class Google::Cloud::VisionAI::V1::SearchAssetsRequest (v0.2.0)

Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::SearchAssetsRequest.

Request message for SearchAssets.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#content_time_ranges

def content_time_ranges() -> ::Google::Cloud::VisionAI::V1::DateTimeRangeArray
Returns
  • (::Google::Cloud::VisionAI::V1::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.

#content_time_ranges=

def content_time_ranges=(value) -> ::Google::Cloud::VisionAI::V1::DateTimeRangeArray
Parameter
  • value (::Google::Cloud::VisionAI::V1::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.
Returns
  • (::Google::Cloud::VisionAI::V1::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.

#corpus

def corpus() -> ::String
Returns
  • (::String) — Required. The parent corpus to search. Format: projects/{project_id}/locations/{location_id}/corpora/{corpus_id}

#corpus=

def corpus=(value) -> ::String
Parameter
  • value (::String) — Required. The parent corpus to search. Format: projects/{project_id}/locations/{location_id}/corpora/{corpus_id}
Returns
  • (::String) — Required. The parent corpus to search. Format: projects/{project_id}/locations/{location_id}/corpora/{corpus_id}

#criteria

def criteria() -> ::Array<::Google::Cloud::VisionAI::V1::Criteria>
Returns

#criteria=

def criteria=(value) -> ::Array<::Google::Cloud::VisionAI::V1::Criteria>
Parameter
Returns

#facet_selections

def facet_selections() -> ::Array<::Google::Cloud::VisionAI::V1::FacetGroup>
Returns
  • (::Array<::Google::Cloud::VisionAI::V1::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.

#facet_selections=

def facet_selections=(value) -> ::Array<::Google::Cloud::VisionAI::V1::FacetGroup>
Parameter
  • value (::Array<::Google::Cloud::VisionAI::V1::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.
Returns
  • (::Array<::Google::Cloud::VisionAI::V1::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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.
Returns
  • (::Integer) — The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.

#page_token

def page_token() -> ::String
Returns
  • (::String) — The continuation token to fetch the next page. If empty, it means it is fetching the first page.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The continuation token to fetch the next page. If empty, it means it is fetching the first page.
Returns
  • (::String) — The continuation token to fetch the next page. If empty, it means it is fetching the first page.

#result_annotation_keys

def result_annotation_keys() -> ::Array<::String>
Returns
  • (::Array<::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.

#result_annotation_keys=

def result_annotation_keys=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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.
Returns
  • (::Array<::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.

#schema_key_sorting_strategy

def schema_key_sorting_strategy() -> ::Google::Cloud::VisionAI::V1::SchemaKeySortingStrategy
Returns

#schema_key_sorting_strategy=

def schema_key_sorting_strategy=(value) -> ::Google::Cloud::VisionAI::V1::SchemaKeySortingStrategy
Parameter
Returns

#search_query

def search_query() -> ::String
Returns
  • (::String) — Global search query. Allows user to search assets without needing to specify which field the value belongs to.

#search_query=

def search_query=(value) -> ::String
Parameter
  • value (::String) — Global search query. Allows user to search assets without needing to specify which field the value belongs to.
Returns
  • (::String) — Global search query. Allows user to search assets without needing to specify which field the value belongs to.