Package com.google.cloud.automl.v1beta1

Class PredictResponse

  • All Implemented Interfaces:
    PredictResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PredictResponse
extends com.google.protobuf.GeneratedMessageV3
implements PredictResponseOrBuilder
     Response message for [PredictionService.Predict][google.cloud.automl.v1beta1.PredictionService.Predict].
    Protobuf type google.cloud.automl.v1beta1.PredictResponse
    See Also:
    Serialized Form

    • Field Detail

      • PREPROCESSED_INPUT_FIELD_NUMBER

        public static final int PREPROCESSED_INPUT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getPayloadCount

        public int getPayloadCount()
         Prediction result.
 Translation and Text Sentiment will return precisely one payload.
        repeated .google.cloud.automl.v1beta1.AnnotationPayload payload = 1;
        Specified by:
        getPayloadCount in interface PredictResponseOrBuilder

      • getPayload

        public AnnotationPayload getPayload​(int index)
         Prediction result.
 Translation and Text Sentiment will return precisely one payload.
        repeated .google.cloud.automl.v1beta1.AnnotationPayload payload = 1;
        Specified by:
        getPayload 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 Text Extraction:
   If the input is a .pdf file, the OCR'ed text will be provided in
   [document_text][google.cloud.automl.v1beta1.Document.document_text].
        .google.cloud.automl.v1beta1.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 Text Extraction:
   If the input is a .pdf file, the OCR'ed text will be provided in
   [document_text][google.cloud.automl.v1beta1.Document.document_text].
        .google.cloud.automl.v1beta1.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 Text Extraction:
   If the input is a .pdf file, the OCR'ed text will be provided in
   [document_text][google.cloud.automl.v1beta1.Document.document_text].
        .google.cloud.automl.v1beta1.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.

 * For Image Object Detection:
  `max_bounding_box_count` - (int64) At most that many bounding boxes per
      image could have been returned.

 * For Text Sentiment:
  `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 will be also positive (though
      the least).
      The sentiment_score shouldn't be confused with "score" or "magnitude"
      from the previous Natural Language Sentiment Analysis API.
        map<string, string> metadata = 2;
        Specified by:
        getMetadataCount in interface PredictResponseOrBuilder

      • containsMetadata

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

 * For Image Object Detection:
  `max_bounding_box_count` - (int64) At most that many bounding boxes per
      image could have been returned.

 * For Text Sentiment:
  `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 will be also positive (though
      the least).
      The sentiment_score shouldn't be confused with "score" or "magnitude"
      from the previous Natural Language Sentiment Analysis API.
        map<string, string> metadata = 2;
        Specified by:
        containsMetadata in interface PredictResponseOrBuilder

      • getMetadataMap

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

 * For Image Object Detection:
  `max_bounding_box_count` - (int64) At most that many bounding boxes per
      image could have been returned.

 * For Text Sentiment:
  `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 will be also positive (though
      the least).
      The sentiment_score shouldn't be confused with "score" or "magnitude"
      from the previous Natural Language Sentiment Analysis 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.

 * For Image Object Detection:
  `max_bounding_box_count` - (int64) At most that many bounding boxes per
      image could have been returned.

 * For Text Sentiment:
  `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 will be also positive (though
      the least).
      The sentiment_score shouldn't be confused with "score" or "magnitude"
      from the previous Natural Language Sentiment Analysis API.
        map<string, string> metadata = 2;
        Specified by:
        getMetadataOrDefault in interface PredictResponseOrBuilder

      • getMetadataOrThrow

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

 * For Image Object Detection:
  `max_bounding_box_count` - (int64) At most that many bounding boxes per
      image could have been returned.

 * For Text Sentiment:
  `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 will be also positive (though
      the least).
      The sentiment_score shouldn't be confused with "score" or "magnitude"
      from the previous Natural Language Sentiment Analysis 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.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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