Vision AI V1 API - Class Google::Cloud::VisionAI::V1::SearchResultItem (v0.3.0)

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

#annotation_matching_results=

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

#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) — Available to IMAGE corpus types. Relevance of this SearchResultItem to user search query (text query or image query). By default this represents cosine similarity between the query and the retrieved media content. The value is in the range of [-1, 1]. Note that search ranking is not only decided by this relevance score, but also other factors such as the match of annotations.

#relevance=

def relevance=(value) -> ::Float
Parameter
  • value (::Float) — Available to IMAGE corpus types. Relevance of this SearchResultItem to user search query (text query or image query). By default this represents cosine similarity between the query and the retrieved media content. The value is in the range of [-1, 1]. Note that search ranking is not only decided by this relevance score, but also other factors such as the match of annotations.
Returns
  • (::Float) — Available to IMAGE corpus types. Relevance of this SearchResultItem to user search query (text query or image query). By default this represents cosine similarity between the query and the retrieved media content. The value is in the range of [-1, 1]. Note that search ranking is not only decided by this relevance score, but also other factors such as the match of annotations.

#requested_annotations

def requested_annotations() -> ::Array<::Google::Cloud::VisionAI::V1::Annotation>
Returns

#requested_annotations=

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

#segment

def segment() -> ::Google::Cloud::VisionAI::V1::Partition::TemporalPartition
Returns

#segment=

def segment=(value) -> ::Google::Cloud::VisionAI::V1::Partition::TemporalPartition
Parameter
Returns

#segments

def segments() -> ::Array<::Google::Cloud::VisionAI::V1::Partition::TemporalPartition>
Returns

#segments=

def segments=(value) -> ::Array<::Google::Cloud::VisionAI::V1::Partition::TemporalPartition>
Parameter
Returns