com.google.cloud.visionai.v1.SearchResultItemOrBuilder Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/visionai/v1/warehouse.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.visionai.v1;
public interface SearchResultItemOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.SearchResultItem)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The resource name of the asset.
* Format:
* `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}`
*
*
* string asset = 1;
*
* @return The asset.
*/
java.lang.String getAsset();
/**
*
*
*
* The resource name of the asset.
* Format:
* `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}`
*
*
* string asset = 1;
*
* @return The bytes for asset.
*/
com.google.protobuf.ByteString getAssetBytes();
/**
*
*
*
* The matched asset segments.
* Deprecated: please use singular `segment` field.
*
*
*
* repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];
*
*/
@java.lang.Deprecated
java.util.List getSegmentsList();
/**
*
*
*
* The matched asset segments.
* Deprecated: please use singular `segment` field.
*
*
*
* repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];
*
*/
@java.lang.Deprecated
com.google.cloud.visionai.v1.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];
*
*/
@java.lang.Deprecated
int getSegmentsCount();
/**
*
*
*
* The matched asset segments.
* Deprecated: please use singular `segment` field.
*
*
*
* repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];
*
*/
@java.lang.Deprecated
java.util.List
getSegmentsOrBuilderList();
/**
*
*
*
* The matched asset segments.
* Deprecated: please use singular `segment` field.
*
*
*
* repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];
*
*/
@java.lang.Deprecated
com.google.cloud.visionai.v1.Partition.TemporalPartitionOrBuilder getSegmentsOrBuilder(int index);
/**
*
*
*
* The matched asset segment.
*
*
* .google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;
*
* @return Whether the segment field is set.
*/
boolean hasSegment();
/**
*
*
*
* The matched asset segment.
*
*
* .google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;
*
* @return The segment.
*/
com.google.cloud.visionai.v1.Partition.TemporalPartition getSegment();
/**
*
*
*
* The matched asset segment.
*
*
* .google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;
*/
com.google.cloud.visionai.v1.Partition.TemporalPartitionOrBuilder getSegmentOrBuilder();
/**
*
*
*
* Relevance of this `SearchResultItem` to user search request.
* Currently available only in Image Warehouse, and by default represents
* cosine similarity. In the future can be other measures such as "dot
* product" or "topicality" requested in the search request.
*
*
* double relevance = 6;
*
* @return The relevance.
*/
double getRelevance();
/**
*
*
*
* Search result annotations specified by result_annotation_keys in search
* request.
*
*
* repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;
*/
java.util.List getRequestedAnnotationsList();
/**
*
*
*
* Search result annotations specified by result_annotation_keys in search
* request.
*
*
* repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;
*/
com.google.cloud.visionai.v1.Annotation getRequestedAnnotations(int index);
/**
*
*
*
* Search result annotations specified by result_annotation_keys in search
* request.
*
*
* repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;
*/
int getRequestedAnnotationsCount();
/**
*
*
*
* Search result annotations specified by result_annotation_keys in search
* request.
*
*
* repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;
*/
java.util.List
getRequestedAnnotationsOrBuilderList();
/**
*
*
*
* Search result annotations specified by result_annotation_keys in search
* request.
*
*
* repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;
*/
com.google.cloud.visionai.v1.AnnotationOrBuilder getRequestedAnnotationsOrBuilder(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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.visionai.v1.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;
*
*/
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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.visionai.v1.AnnotationMatchingResultOrBuilder
getAnnotationMatchingResultsOrBuilder(int index);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy