com.google.cloud.automl.v1.PredictResponseOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-automl-v1 Show documentation
Show all versions of proto-google-cloud-automl-v1 Show documentation
PROTO library for proto-google-cloud-automl-v1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/automl/v1/prediction_service.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.automl.v1;
public interface PredictResponseOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.automl.v1.PredictResponse)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Prediction result.
* AutoML Translation and AutoML Natural Language Sentiment Analysis
* return precisely one payload.
*
*
* repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
*/
java.util.List getPayloadList();
/**
*
*
*
* Prediction result.
* AutoML Translation and AutoML Natural Language Sentiment Analysis
* return precisely one payload.
*
*
* repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
*/
com.google.cloud.automl.v1.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;
*/
int getPayloadCount();
/**
*
*
*
* Prediction result.
* AutoML Translation and AutoML Natural Language Sentiment Analysis
* return precisely one payload.
*
*
* repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
*/
java.util.List
getPayloadOrBuilderList();
/**
*
*
*
* Prediction result.
* AutoML Translation and AutoML Natural Language Sentiment Analysis
* return precisely one payload.
*
*
* repeated .google.cloud.automl.v1.AnnotationPayload payload = 1;
*/
com.google.cloud.automl.v1.AnnotationPayloadOrBuilder getPayloadOrBuilder(int index);
/**
*
*
*
* 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;
*
* @return Whether the preprocessedInput field is set.
*/
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;
*
* @return The preprocessedInput.
*/
com.google.cloud.automl.v1.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;
*/
com.google.cloud.automl.v1.ExamplePayloadOrBuilder getPreprocessedInputOrBuilder();
/**
*
*
*
* 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;
*/
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;
*/
boolean containsMetadata(java.lang.String key);
/** Use {@link #getMetadataMap()} instead. */
@java.lang.Deprecated
java.util.Map getMetadata();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getMetadataOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getMetadataOrThrow(java.lang.String key);
}