Interface SearchResultItemOrBuilder (0.11.0) 

public interface SearchResultItemOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnnotationMatchingResults(int index)

public abstract AnnotationMatchingResult getAnnotationMatchingResults(int index)

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.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name Description
index int
Returns
Type Description
AnnotationMatchingResult

getAnnotationMatchingResultsCount()

public abstract int getAnnotationMatchingResultsCount()

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.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Returns
Type Description
int

getAnnotationMatchingResultsList()

public abstract List<AnnotationMatchingResult> getAnnotationMatchingResultsList()

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.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Returns
Type Description
List<AnnotationMatchingResult>

getAnnotationMatchingResultsOrBuilder(int index)

public abstract AnnotationMatchingResultOrBuilder getAnnotationMatchingResultsOrBuilder(int index)

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.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name Description
index int
Returns
Type Description
AnnotationMatchingResultOrBuilder

getAnnotationMatchingResultsOrBuilderList()

public abstract List<? extends AnnotationMatchingResultOrBuilder> getAnnotationMatchingResultsOrBuilderList()

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.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.AnnotationMatchingResultOrBuilder>

getAsset()

public abstract String getAsset()

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

string asset = 1;

Returns
Type Description
String

The asset.

getAssetBytes()

public abstract ByteString getAssetBytes()

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

string asset = 1;

Returns
Type Description
ByteString

The bytes for asset.

getRelevance()

public abstract double getRelevance()

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.

double relevance = 6;

Returns
Type Description
double

The relevance.

getRequestedAnnotations(int index)

public abstract Annotation getRequestedAnnotations(int index)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name Description
index int
Returns
Type Description
Annotation

getRequestedAnnotationsCount()

public abstract int getRequestedAnnotationsCount()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Returns
Type Description
int

getRequestedAnnotationsList()

public abstract List<Annotation> getRequestedAnnotationsList()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Returns
Type Description
List<Annotation>

getRequestedAnnotationsOrBuilder(int index)

public abstract AnnotationOrBuilder getRequestedAnnotationsOrBuilder(int index)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name Description
index int
Returns
Type Description
AnnotationOrBuilder

getRequestedAnnotationsOrBuilderList()

public abstract List<? extends AnnotationOrBuilder> getRequestedAnnotationsOrBuilderList()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.AnnotationOrBuilder>

getSegment()

public abstract Partition.TemporalPartition getSegment()

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Returns
Type Description
Partition.TemporalPartition

The segment.

getSegmentOrBuilder()

public abstract Partition.TemporalPartitionOrBuilder getSegmentOrBuilder()

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Returns
Type Description
Partition.TemporalPartitionOrBuilder

getSegments(int index) (deprecated)

public abstract Partition.TemporalPartition getSegments(int index)

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

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
Partition.TemporalPartition

getSegmentsCount() (deprecated)

public abstract int getSegmentsCount()

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

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Returns
Type Description
int

getSegmentsList() (deprecated)

public abstract List<Partition.TemporalPartition> getSegmentsList()

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

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Returns
Type Description
List<TemporalPartition>

getSegmentsOrBuilder(int index) (deprecated)

public abstract Partition.TemporalPartitionOrBuilder getSegmentsOrBuilder(int index)

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

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
Partition.TemporalPartitionOrBuilder

getSegmentsOrBuilderList() (deprecated)

public abstract List<? extends Partition.TemporalPartitionOrBuilder> getSegmentsOrBuilderList()

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

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.Partition.TemporalPartitionOrBuilder>

hasSegment()

public abstract boolean hasSegment()

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Returns
Type Description
boolean

Whether the segment field is set.