Class PredictResponse (2.39.0)

public final class PredictResponse extends GeneratedMessageV3 implements PredictResponseOrBuilder

Response message for PredictionService.Predict.

Protobuf type google.cloud.automl.v1beta1.PredictResponse

Static Fields

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER
Field Value
TypeDescription
int

PREPROCESSED_INPUT_FIELD_NUMBER

public static final int PREPROCESSED_INPUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PredictResponse getDefaultInstance()
Returns
TypeDescription
PredictResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PredictResponse.Builder newBuilder()
Returns
TypeDescription
PredictResponse.Builder

newBuilder(PredictResponse prototype)

public static PredictResponse.Builder newBuilder(PredictResponse prototype)
Parameter
NameDescription
prototypePredictResponse
Returns
TypeDescription
PredictResponse.Builder

parseDelimitedFrom(InputStream input)

public static PredictResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PredictResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PredictResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PredictResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PredictResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PredictResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PredictResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PredictResponse> parser()
Returns
TypeDescription
Parser<PredictResponse>

Methods

containsMetadata(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PredictResponse getDefaultInstanceForType()
Returns
TypeDescription
PredictResponse

getMetadata() (deprecated)

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public int getMetadataCount()

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

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;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<PredictResponse> getParserForType()
Returns
TypeDescription
Parser<PredictResponse>
Overrides

getPayload(int index)

public AnnotationPayload getPayload(int index)

Prediction result. Translation and Text Sentiment will return precisely one payload.

repeated .google.cloud.automl.v1beta1.AnnotationPayload payload = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
AnnotationPayload

getPayloadCount()

public int getPayloadCount()

Prediction result. Translation and Text Sentiment will return precisely one payload.

repeated .google.cloud.automl.v1beta1.AnnotationPayload payload = 1;

Returns
TypeDescription
int

getPayloadList()

public List<AnnotationPayload> getPayloadList()

Prediction result. Translation and Text Sentiment will return precisely one payload.

repeated .google.cloud.automl.v1beta1.AnnotationPayload payload = 1;

Returns
TypeDescription
List<AnnotationPayload>

getPayloadOrBuilder(int index)

public AnnotationPayloadOrBuilder getPayloadOrBuilder(int index)

Prediction result. Translation and Text Sentiment will return precisely one payload.

repeated .google.cloud.automl.v1beta1.AnnotationPayload payload = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
AnnotationPayloadOrBuilder

getPayloadOrBuilderList()

public List<? extends AnnotationPayloadOrBuilder> getPayloadOrBuilderList()

Prediction result. Translation and Text Sentiment will return precisely one payload.

repeated .google.cloud.automl.v1beta1.AnnotationPayload payload = 1;

Returns
TypeDescription
List<? extends com.google.cloud.automl.v1beta1.AnnotationPayloadOrBuilder>

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.ExamplePayload preprocessed_input = 3;

Returns
TypeDescription
ExamplePayload

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.ExamplePayload preprocessed_input = 3;

Returns
TypeDescription
ExamplePayloadOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.ExamplePayload preprocessed_input = 3;

Returns
TypeDescription
boolean

Whether the preprocessedInput field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PredictResponse.Builder newBuilderForType()
Returns
TypeDescription
PredictResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PredictResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PredictResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PredictResponse.Builder toBuilder()
Returns
TypeDescription
PredictResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException