Package com.google.cloud.automl.v1

Interface PredictResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PredictResponse, PredictResponse.Builder
    public interface PredictResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getPayloadList

        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;

      • getPayload

        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;

      • getPayloadCount

        int getPayloadCount()
         Prediction result.
 AutoML Translation and AutoML Natural Language Sentiment Analysis
 return precisely one payload.
        repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;

      • getPayloadOrBuilderList

        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;

      • getPayloadOrBuilder

        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;

      • hasPreprocessedInput

        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;
        Returns:
        Whether the preprocessedInput field is set.

      • getPreprocessedInput

        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;
        Returns:
        The preprocessedInput.

      • getPreprocessedInputOrBuilder

        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;

      • getMetadataCount

        int getMetadataCount()
         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;

      • containsMetadata

        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;

      • getMetadataMap

        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;

      • getMetadataOrDefault

        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;

      • getMetadataOrThrow

        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;