Class PredictResponse (2.43.0)

public final class PredictResponse extends GeneratedMessageV3 implements PredictResponseOrBuilder

Response message for PredictionService.Predict.

Protobuf type google.cloud.automl.v1.PredictResponse

Static Fields

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER
Field Value
Type Description
int

PREPROCESSED_INPUT_FIELD_NUMBER

public static final int PREPROCESSED_INPUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PredictResponse getDefaultInstance()
Returns
Type Description
PredictResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PredictResponse.Builder newBuilder()
Returns
Type Description
PredictResponse.Builder

newBuilder(PredictResponse prototype)

public static PredictResponse.Builder newBuilder(PredictResponse prototype)
Parameter
Name Description
prototype PredictResponse
Returns
Type Description
PredictResponse.Builder

parseDelimitedFrom(InputStream input)

public static PredictResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PredictResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PredictResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PredictResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PredictResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PredictResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PredictResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PredictResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PredictResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PredictResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PredictResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PredictResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PredictResponse> parser()
Returns
Type Description
Parser<PredictResponse>

Methods

containsMetadata(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PredictResponse getDefaultInstanceForType()
Returns
Type Description
PredictResponse

getMetadata() (deprecated)

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public 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;

Returns
Type Description
int

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;

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<PredictResponse> getParserForType()
Returns
Type Description
Parser<PredictResponse>
Overrides

getPayload(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
AnnotationPayload

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;

Returns
Type Description
int

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;

Returns
Type Description
List<AnnotationPayload>

getPayloadOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
AnnotationPayloadOrBuilder

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;

Returns
Type Description
List<? extends com.google.cloud.automl.v1.AnnotationPayloadOrBuilder>

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 property.

.google.cloud.automl.v1.ExamplePayload preprocessed_input = 3;

Returns
Type Description
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 AutoML Natural Language (Classification, Entity Extraction, and Sentiment Analysis), if the input is a document, the recognized text is returned in the document_text property.

.google.cloud.automl.v1.ExamplePayload preprocessed_input = 3;

Returns
Type Description
ExamplePayloadOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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 AutoML Natural Language (Classification, Entity Extraction, and Sentiment Analysis), if the input is a document, the recognized text is returned in the document_text property.

.google.cloud.automl.v1.ExamplePayload preprocessed_input = 3;

Returns
Type Description
boolean

Whether the preprocessedInput field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PredictResponse.Builder newBuilderForType()
Returns
Type Description
PredictResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PredictResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PredictResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PredictResponse.Builder toBuilder()
Returns
Type Description
PredictResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException