Package com.google.cloud.visionai.v1

Interface SearchResultItemOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchResultItem, SearchResultItem.Builder
@Generated public interface SearchResultItemOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getAsset

      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:
      The asset.

    • getAssetBytes

      com.google.protobuf.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:
      The bytes for asset.

    • getSegmentsList

      @Deprecated List<Partition.TemporalPartition> getSegmentsList()
      Deprecated.
       The matched asset segments.
 Deprecated: please use singular `segment` field.
      repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

    • getSegments

      @Deprecated Partition.TemporalPartition getSegments(int index)
      Deprecated.
       The matched asset segments.
 Deprecated: please use singular `segment` field.
      repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

    • getSegmentsCount

      @Deprecated int getSegmentsCount()
      Deprecated.
       The matched asset segments.
 Deprecated: please use singular `segment` field.
      repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

    • getSegmentsOrBuilderList

      @Deprecated List<? extends Partition.TemporalPartitionOrBuilder> getSegmentsOrBuilderList()
      Deprecated.
       The matched asset segments.
 Deprecated: please use singular `segment` field.
      repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

    • getSegmentsOrBuilder

      @Deprecated Partition.TemporalPartitionOrBuilder getSegmentsOrBuilder(int index)
      Deprecated.
       The matched asset segments.
 Deprecated: please use singular `segment` field.
      repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

    • hasSegment

      boolean hasSegment()
       The matched asset segment.
      .google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;
      Returns:
      Whether the segment field is set.

    • getSegment

      Partition.TemporalPartition getSegment()
       The matched asset segment.
      .google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;
      Returns:
      The segment.

    • getSegmentOrBuilder

      Partition.TemporalPartitionOrBuilder getSegmentOrBuilder()
       The matched asset segment.
      .google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

    • getRelevance

      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:
      The relevance.

    • getRequestedAnnotationsList

      List<Annotation> getRequestedAnnotationsList()
       Search result annotations specified by result_annotation_keys in search
 request.
      repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

    • getRequestedAnnotations

      Annotation getRequestedAnnotations(int index)
       Search result annotations specified by result_annotation_keys in search
 request.
      repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

    • getRequestedAnnotationsCount

      int getRequestedAnnotationsCount()
       Search result annotations specified by result_annotation_keys in search
 request.
      repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

    • getRequestedAnnotationsOrBuilderList

      List<? extends AnnotationOrBuilder> getRequestedAnnotationsOrBuilderList()
       Search result annotations specified by result_annotation_keys in search
 request.
      repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

    • getRequestedAnnotationsOrBuilder

      AnnotationOrBuilder getRequestedAnnotationsOrBuilder(int index)
       Search result annotations specified by result_annotation_keys in search
 request.
      repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

    • getAnnotationMatchingResultsList

      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;

    • getAnnotationMatchingResults

      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;

    • getAnnotationMatchingResultsCount

      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;

    • getAnnotationMatchingResultsOrBuilderList

      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;

    • getAnnotationMatchingResultsOrBuilder

      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;