Package com.google.cloud.automl.v1

Class PredictResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.automl.v1.PredictResponse
All Implemented Interfaces:
PredictResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PredictResponse extends com.google.protobuf.GeneratedMessage implements PredictResponseOrBuilder
 Response message for [PredictionService.Predict][google.cloud.automl.v1.PredictionService.Predict].
Protobuf type google.cloud.automl.v1.PredictResponse
See Also:

  • Field Details

    • PAYLOAD_FIELD_NUMBER

      public static final int PAYLOAD_FIELD_NUMBER
      See Also:

    • PREPROCESSED_INPUT_FIELD_NUMBER

      public static final int PREPROCESSED_INPUT_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPayloadList

      public List<AnnotationPayload> getPayloadList()
       Prediction result.
 AutoML Translation and AutoML Natural Language Sentiment Analysis
 return precisely one payload.
      repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
      Specified by:
      getPayloadList in interface PredictResponseOrBuilder

    • getPayloadOrBuilderList

      public List<? extends AnnotationPayloadOrBuilder> getPayloadOrBuilderList()
       Prediction result.
 AutoML Translation and AutoML Natural Language Sentiment Analysis
 return precisely one payload.
      repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
      Specified by:
      getPayloadOrBuilderList in interface PredictResponseOrBuilder

    • getPayloadCount

      public int getPayloadCount()
       Prediction result.
 AutoML Translation and AutoML Natural Language Sentiment Analysis
 return precisely one payload.
      repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
      Specified by:
      getPayloadCount in interface PredictResponseOrBuilder

    • getPayload

      public AnnotationPayload getPayload(int index)
       Prediction result.
 AutoML Translation and AutoML Natural Language Sentiment Analysis
 return precisely one payload.
      repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
      Specified by:
      getPayload in interface PredictResponseOrBuilder

    • getPayloadOrBuilder

      public AnnotationPayloadOrBuilder getPayloadOrBuilder(int index)
       Prediction result.
 AutoML Translation and AutoML Natural Language Sentiment Analysis
 return precisely one payload.
      repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
      Specified by:
      getPayloadOrBuilder in interface PredictResponseOrBuilder

    • hasPreprocessedInput

      public boolean hasPreprocessedInput()
       The preprocessed example that AutoML actually makes prediction on.
 Empty if AutoML does not preprocess the input example.

 For AutoML Natural Language (Classification, Entity Extraction, and
 Sentiment Analysis), if the input is a document, the recognized text is
 returned in the
 [document_text][google.cloud.automl.v1.Document.document_text]
 property.
      .google.cloud.automl.v1.ExamplePayload preprocessed_input = 3;
      Specified by:
      hasPreprocessedInput in interface PredictResponseOrBuilder
      Returns:
      Whether the preprocessedInput field is set.

    • getPreprocessedInput

      public ExamplePayload getPreprocessedInput()
       The preprocessed example that AutoML actually makes prediction on.
 Empty if AutoML does not preprocess the input example.

 For AutoML Natural Language (Classification, Entity Extraction, and
 Sentiment Analysis), if the input is a document, the recognized text is
 returned in the
 [document_text][google.cloud.automl.v1.Document.document_text]
 property.
      .google.cloud.automl.v1.ExamplePayload preprocessed_input = 3;
      Specified by:
      getPreprocessedInput in interface PredictResponseOrBuilder
      Returns:
      The preprocessedInput.

    • getPreprocessedInputOrBuilder

      public ExamplePayloadOrBuilder getPreprocessedInputOrBuilder()
       The preprocessed example that AutoML actually makes prediction on.
 Empty if AutoML does not preprocess the input example.

 For AutoML Natural Language (Classification, Entity Extraction, and
 Sentiment Analysis), if the input is a document, the recognized text is
 returned in the
 [document_text][google.cloud.automl.v1.Document.document_text]
 property.
      .google.cloud.automl.v1.ExamplePayload preprocessed_input = 3;
      Specified by:
      getPreprocessedInputOrBuilder in interface PredictResponseOrBuilder

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: PredictResponseOrBuilder
       Additional domain-specific prediction response metadata.

 AutoML Vision Object Detection

 `max_bounding_box_count`
 : (int64) The maximum number of bounding boxes to return per image.

 AutoML Natural Language Sentiment Analysis

 `sentiment_score`
 : (float, deprecated) A value between -1 and 1,
 -1 maps to least positive sentiment, while 1 maps to the most positive
 one and the higher the score, the more positive the sentiment in the
 document is. Yet these values are relative to the training data, so
 e.g. if all data was positive then -1 is also positive (though
 the least).
 `sentiment_score` is not the same as "score" and "magnitude"
 from Sentiment Analysis in the Natural Language API.
      map<string, string> metadata = 2;
      Specified by:
      getMetadataCount in interface PredictResponseOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
       Additional domain-specific prediction response metadata.

 AutoML Vision Object Detection

 `max_bounding_box_count`
 : (int64) The maximum number of bounding boxes to return per image.

 AutoML Natural Language Sentiment Analysis

 `sentiment_score`
 : (float, deprecated) A value between -1 and 1,
 -1 maps to least positive sentiment, while 1 maps to the most positive
 one and the higher the score, the more positive the sentiment in the
 document is. Yet these values are relative to the training data, so
 e.g. if all data was positive then -1 is also positive (though
 the least).
 `sentiment_score` is not the same as "score" and "magnitude"
 from Sentiment Analysis in the Natural Language API.
      map<string, string> metadata = 2;
      Specified by:
      containsMetadata in interface PredictResponseOrBuilder

    • getMetadata

      @Deprecated public Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface PredictResponseOrBuilder

    • getMetadataMap

      public Map<String,String> getMetadataMap()
       Additional domain-specific prediction response metadata.

 AutoML Vision Object Detection

 `max_bounding_box_count`
 : (int64) The maximum number of bounding boxes to return per image.

 AutoML Natural Language Sentiment Analysis

 `sentiment_score`
 : (float, deprecated) A value between -1 and 1,
 -1 maps to least positive sentiment, while 1 maps to the most positive
 one and the higher the score, the more positive the sentiment in the
 document is. Yet these values are relative to the training data, so
 e.g. if all data was positive then -1 is also positive (though
 the least).
 `sentiment_score` is not the same as "score" and "magnitude"
 from Sentiment Analysis in the Natural Language API.
      map<string, string> metadata = 2;
      Specified by:
      getMetadataMap in interface PredictResponseOrBuilder

    • getMetadataOrDefault

      public String getMetadataOrDefault(String key, String defaultValue)
       Additional domain-specific prediction response metadata.

 AutoML Vision Object Detection

 `max_bounding_box_count`
 : (int64) The maximum number of bounding boxes to return per image.

 AutoML Natural Language Sentiment Analysis

 `sentiment_score`
 : (float, deprecated) A value between -1 and 1,
 -1 maps to least positive sentiment, while 1 maps to the most positive
 one and the higher the score, the more positive the sentiment in the
 document is. Yet these values are relative to the training data, so
 e.g. if all data was positive then -1 is also positive (though
 the least).
 `sentiment_score` is not the same as "score" and "magnitude"
 from Sentiment Analysis in the Natural Language API.
      map<string, string> metadata = 2;
      Specified by:
      getMetadataOrDefault in interface PredictResponseOrBuilder

    • getMetadataOrThrow

      public String getMetadataOrThrow(String key)
       Additional domain-specific prediction response metadata.

 AutoML Vision Object Detection

 `max_bounding_box_count`
 : (int64) The maximum number of bounding boxes to return per image.

 AutoML Natural Language Sentiment Analysis

 `sentiment_score`
 : (float, deprecated) A value between -1 and 1,
 -1 maps to least positive sentiment, while 1 maps to the most positive
 one and the higher the score, the more positive the sentiment in the
 document is. Yet these values are relative to the training data, so
 e.g. if all data was positive then -1 is also positive (though
 the least).
 `sentiment_score` is not the same as "score" and "magnitude"
 from Sentiment Analysis in the Natural Language API.
      map<string, string> metadata = 2;
      Specified by:
      getMetadataOrThrow in interface PredictResponseOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PredictResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PredictResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PredictResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PredictResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PredictResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PredictResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PredictResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PredictResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PredictResponse.Builder newBuilder()

    • newBuilder

      public static PredictResponse.Builder newBuilder(PredictResponse prototype)

    • toBuilder

      public PredictResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PredictResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PredictResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PredictResponse> parser()

    • getParserForType

      public com.google.protobuf.Parser<PredictResponse> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PredictResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder