Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::SearchResultItem.
Search result contains asset name and corresponding time ranges.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotation_matching_results
def annotation_matching_results() -> ::Array<::Google::Cloud::VisionAI::V1::AnnotationMatchingResult>
Returns
- (::Array<::Google::Cloud::VisionAI::V1::AnnotationMatchingResult>) — Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.
#annotation_matching_results=
def annotation_matching_results=(value) -> ::Array<::Google::Cloud::VisionAI::V1::AnnotationMatchingResult>
Parameter
- value (::Array<::Google::Cloud::VisionAI::V1::AnnotationMatchingResult>) — Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.
Returns
- (::Array<::Google::Cloud::VisionAI::V1::AnnotationMatchingResult>) — Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.
#asset
def asset() -> ::String
Returns
-
(::String) — The resource name of the asset.
Format:
projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}
#asset=
def asset=(value) -> ::String
Parameter
-
value (::String) — The resource name of the asset.
Format:
projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}
Returns
-
(::String) — The resource name of the asset.
Format:
projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}
#relevance
def relevance() -> ::Float
Returns
-
(::Float) — Relevance of this
SearchResultItem
to user search request. Currently available only in Image Warehouse, and by default represents cosine similarity. In the future can be other measures such as "dot product" or "topicality" requested in the search request.
#relevance=
def relevance=(value) -> ::Float
Parameter
-
value (::Float) — Relevance of this
SearchResultItem
to user search request. Currently available only in Image Warehouse, and by default represents cosine similarity. In the future can be other measures such as "dot product" or "topicality" requested in the search request.
Returns
-
(::Float) — Relevance of this
SearchResultItem
to user search request. Currently available only in Image Warehouse, and by default represents cosine similarity. In the future can be other measures such as "dot product" or "topicality" requested in the search request.
#requested_annotations
def requested_annotations() -> ::Array<::Google::Cloud::VisionAI::V1::Annotation>
Returns
- (::Array<::Google::Cloud::VisionAI::V1::Annotation>) — Search result annotations specified by result_annotation_keys in search request.
#requested_annotations=
def requested_annotations=(value) -> ::Array<::Google::Cloud::VisionAI::V1::Annotation>
Parameter
- value (::Array<::Google::Cloud::VisionAI::V1::Annotation>) — Search result annotations specified by result_annotation_keys in search request.
Returns
- (::Array<::Google::Cloud::VisionAI::V1::Annotation>) — Search result annotations specified by result_annotation_keys in search request.
#segment
def segment() -> ::Google::Cloud::VisionAI::V1::Partition::TemporalPartition
Returns
- (::Google::Cloud::VisionAI::V1::Partition::TemporalPartition) — The matched asset segment.
#segment=
def segment=(value) -> ::Google::Cloud::VisionAI::V1::Partition::TemporalPartition
Parameter
- value (::Google::Cloud::VisionAI::V1::Partition::TemporalPartition) — The matched asset segment.
Returns
- (::Google::Cloud::VisionAI::V1::Partition::TemporalPartition) — The matched asset segment.
#segments
def segments() -> ::Array<::Google::Cloud::VisionAI::V1::Partition::TemporalPartition>
Returns
-
(::Array<::Google::Cloud::VisionAI::V1::Partition::TemporalPartition>) — The matched asset segments.
Deprecated: please use singular
segment
field.
#segments=
def segments=(value) -> ::Array<::Google::Cloud::VisionAI::V1::Partition::TemporalPartition>
Parameter
-
value (::Array<::Google::Cloud::VisionAI::V1::Partition::TemporalPartition>) — The matched asset segments.
Deprecated: please use singular
segment
field.
Returns
-
(::Array<::Google::Cloud::VisionAI::V1::Partition::TemporalPartition>) — The matched asset segments.
Deprecated: please use singular
segment
field.