com.google.cloud.vision.v1p3beta1.EntityAnnotationOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-vision-v1p3beta1 Show documentation
Show all versions of proto-google-cloud-vision-v1p3beta1 Show documentation
PROTO library for proto-google-cloud-vision-v1p3beta1
/*
* 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/vision/v1p3beta1/image_annotator.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.vision.v1p3beta1;
public interface EntityAnnotationOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.vision.v1p3beta1.EntityAnnotation)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Opaque entity ID. Some IDs may be available in
* [Google Knowledge Graph Search
* API](https://developers.google.com/knowledge-graph/).
*
*
* string mid = 1;
*
* @return The mid.
*/
java.lang.String getMid();
/**
*
*
*
* Opaque entity ID. Some IDs may be available in
* [Google Knowledge Graph Search
* API](https://developers.google.com/knowledge-graph/).
*
*
* string mid = 1;
*
* @return The bytes for mid.
*/
com.google.protobuf.ByteString getMidBytes();
/**
*
*
*
* The language code for the locale in which the entity textual
* `description` is expressed.
*
*
* string locale = 2;
*
* @return The locale.
*/
java.lang.String getLocale();
/**
*
*
*
* The language code for the locale in which the entity textual
* `description` is expressed.
*
*
* string locale = 2;
*
* @return The bytes for locale.
*/
com.google.protobuf.ByteString getLocaleBytes();
/**
*
*
*
* Entity textual description, expressed in its `locale` language.
*
*
* string description = 3;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Entity textual description, expressed in its `locale` language.
*
*
* string description = 3;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Overall score of the result. Range [0, 1].
*
*
* float score = 4;
*
* @return The score.
*/
float getScore();
/**
*
*
*
* **Deprecated. Use `score` instead.**
* The accuracy of the entity detection in an image.
* For example, for an image in which the "Eiffel Tower" entity is detected,
* this field represents the confidence that there is a tower in the query
* image. Range [0, 1].
*
*
* float confidence = 5;
*
* @return The confidence.
*/
float getConfidence();
/**
*
*
*
* The relevancy of the ICA (Image Content Annotation) label to the
* image. For example, the relevancy of "tower" is likely higher to an image
* containing the detected "Eiffel Tower" than to an image containing a
* detected distant towering building, even though the confidence that
* there is a tower in each image may be the same. Range [0, 1].
*
*
* float topicality = 6;
*
* @return The topicality.
*/
float getTopicality();
/**
*
*
*
* Image region to which this entity belongs. Not produced
* for `LABEL_DETECTION` features.
*
*
* .google.cloud.vision.v1p3beta1.BoundingPoly bounding_poly = 7;
*
* @return Whether the boundingPoly field is set.
*/
boolean hasBoundingPoly();
/**
*
*
*
* Image region to which this entity belongs. Not produced
* for `LABEL_DETECTION` features.
*
*
* .google.cloud.vision.v1p3beta1.BoundingPoly bounding_poly = 7;
*
* @return The boundingPoly.
*/
com.google.cloud.vision.v1p3beta1.BoundingPoly getBoundingPoly();
/**
*
*
*
* Image region to which this entity belongs. Not produced
* for `LABEL_DETECTION` features.
*
*
* .google.cloud.vision.v1p3beta1.BoundingPoly bounding_poly = 7;
*/
com.google.cloud.vision.v1p3beta1.BoundingPolyOrBuilder getBoundingPolyOrBuilder();
/**
*
*
*
* The location information for the detected entity. Multiple
* `LocationInfo` elements can be present because one location may
* indicate the location of the scene in the image, and another location
* may indicate the location of the place where the image was taken.
* Location information is usually present for landmarks.
*
*
* repeated .google.cloud.vision.v1p3beta1.LocationInfo locations = 8;
*/
java.util.List getLocationsList();
/**
*
*
*
* The location information for the detected entity. Multiple
* `LocationInfo` elements can be present because one location may
* indicate the location of the scene in the image, and another location
* may indicate the location of the place where the image was taken.
* Location information is usually present for landmarks.
*
*
* repeated .google.cloud.vision.v1p3beta1.LocationInfo locations = 8;
*/
com.google.cloud.vision.v1p3beta1.LocationInfo getLocations(int index);
/**
*
*
*
* The location information for the detected entity. Multiple
* `LocationInfo` elements can be present because one location may
* indicate the location of the scene in the image, and another location
* may indicate the location of the place where the image was taken.
* Location information is usually present for landmarks.
*
*
* repeated .google.cloud.vision.v1p3beta1.LocationInfo locations = 8;
*/
int getLocationsCount();
/**
*
*
*
* The location information for the detected entity. Multiple
* `LocationInfo` elements can be present because one location may
* indicate the location of the scene in the image, and another location
* may indicate the location of the place where the image was taken.
* Location information is usually present for landmarks.
*
*
* repeated .google.cloud.vision.v1p3beta1.LocationInfo locations = 8;
*/
java.util.List
getLocationsOrBuilderList();
/**
*
*
*
* The location information for the detected entity. Multiple
* `LocationInfo` elements can be present because one location may
* indicate the location of the scene in the image, and another location
* may indicate the location of the place where the image was taken.
* Location information is usually present for landmarks.
*
*
* repeated .google.cloud.vision.v1p3beta1.LocationInfo locations = 8;
*/
com.google.cloud.vision.v1p3beta1.LocationInfoOrBuilder getLocationsOrBuilder(int index);
/**
*
*
*
* Some entities may have optional user-supplied `Property` (name/value)
* fields, such a score or string that qualifies the entity.
*
*
* repeated .google.cloud.vision.v1p3beta1.Property properties = 9;
*/
java.util.List getPropertiesList();
/**
*
*
*
* Some entities may have optional user-supplied `Property` (name/value)
* fields, such a score or string that qualifies the entity.
*
*
* repeated .google.cloud.vision.v1p3beta1.Property properties = 9;
*/
com.google.cloud.vision.v1p3beta1.Property getProperties(int index);
/**
*
*
*
* Some entities may have optional user-supplied `Property` (name/value)
* fields, such a score or string that qualifies the entity.
*
*
* repeated .google.cloud.vision.v1p3beta1.Property properties = 9;
*/
int getPropertiesCount();
/**
*
*
*
* Some entities may have optional user-supplied `Property` (name/value)
* fields, such a score or string that qualifies the entity.
*
*
* repeated .google.cloud.vision.v1p3beta1.Property properties = 9;
*/
java.util.List
getPropertiesOrBuilderList();
/**
*
*
*
* Some entities may have optional user-supplied `Property` (name/value)
* fields, such a score or string that qualifies the entity.
*
*
* repeated .google.cloud.vision.v1p3beta1.Property properties = 9;
*/
com.google.cloud.vision.v1p3beta1.PropertyOrBuilder getPropertiesOrBuilder(int index);
}