Class: Google::Cloud::VisionAI::V1::SearchResultItem

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/warehouse.rb

Overview

Search result contains asset name and corresponding time ranges.

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_matching_results ⇒ ::Array<::Google::Cloud::VisionAI::V1::AnnotationMatchingResult>

Returns 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:



2801
2802
2803
2804
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2801

class SearchResultItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#asset ⇒ ::String

Returns 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}



2801
2802
2803
2804
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2801

class SearchResultItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#relevance ⇒ ::Float

Returns 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.



2801
2802
2803
2804
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2801

class SearchResultItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#requested_annotations ⇒ ::Array<::Google::Cloud::VisionAI::V1::Annotation>

Returns Search result annotations specified by result_annotation_keys in search request.

Returns:



2801
2802
2803
2804
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2801

class SearchResultItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#segment ⇒ ::Google::Cloud::VisionAI::V1::Partition::TemporalPartition

Returns The matched asset segment.

Returns:



2801
2802
2803
2804
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2801

class SearchResultItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#segments ⇒ ::Array<::Google::Cloud::VisionAI::V1::Partition::TemporalPartition>

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns The matched asset segments. Deprecated: please use singular segment field.

Returns:



2801
2802
2803
2804
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2801

class SearchResultItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end