public final class PredictResponse extends GeneratedMessageV3 implements PredictResponseOrBuilder
Response message for PredictionService.Predict.
Protobuf type google.cloud.automl.v1beta1.PredictResponse
Static Fields
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 | |
public static final int PREPROCESSED_INPUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PredictResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PredictResponse.Builder newBuilder()
newBuilder(PredictResponse prototype)
public static PredictResponse.Builder newBuilder(PredictResponse prototype)
public static PredictResponse parseDelimitedFrom(InputStream input)
public static PredictResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PredictResponse parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PredictResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(CodedInputStream input)
public static PredictResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(InputStream input)
public static PredictResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PredictResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PredictResponse> parser()
Methods
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public PredictResponse getDefaultInstanceForType()
public Map<String,String> getMetadata()
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 |
|---|
| Type | Description |
int | |
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;
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;
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 |
|---|
| Name | Description |
key | String
|
getParserForType()
public Parser<PredictResponse> getParserForType()
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 |
|---|
| Name | Description |
index | int
|
getPayloadCount()
public int getPayloadCount()
Prediction result.
Translation and Text Sentiment will return precisely one payload.
repeated .google.cloud.automl.v1beta1.AnnotationPayload payload = 1;
| Returns |
|---|
| Type | Description |
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;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.cloud.automl.v1beta1.AnnotationPayloadOrBuilder> | |
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;
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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 |
|---|
| Type | Description |
boolean | Whether the preprocessedInput field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PredictResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PredictResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PredictResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
