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

public sealed class SearchResultItem : IMessage<SearchResultItem>, IEquatable<SearchResultItem>, IDeepCloneable<SearchResultItem>, IBufferMessage, IMessage

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

Search result contains asset name and corresponding time ranges.

Inheritance

object > SearchResultItem

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

SearchResultItem()

public SearchResultItem()

SearchResultItem(SearchResultItem)

public SearchResultItem(SearchResultItem other)
Parameter
Name Description
other SearchResultItem

Properties

AnnotationMatchingResults

public RepeatedField<AnnotationMatchingResult> AnnotationMatchingResults { get; }

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.

Property Value
Type Description
RepeatedFieldAnnotationMatchingResult

Asset

public string Asset { get; set; }

The resource name of the asset. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

Property Value
Type Description
string

Relevance

public double Relevance { get; set; }

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.

Property Value
Type Description
double

RequestedAnnotations

public RepeatedField<Annotation> RequestedAnnotations { get; }

Search result annotations specified by result_annotation_keys in search request.

Property Value
Type Description
RepeatedFieldAnnotation

Segment

public Partition.Types.TemporalPartition Segment { get; set; }

The matched asset segment.

Property Value
Type Description
PartitionTypesTemporalPartition

Segments

[Obsolete]
public RepeatedField<Partition.Types.TemporalPartition> Segments { get; }

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

Property Value
Type Description
RepeatedFieldPartitionTypesTemporalPartition