com.google.cloud.automl.v1beta1.BatchPredictRequestOrBuilder 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-v1beta1 Show documentation
Show all versions of proto-google-cloud-automl-v1beta1 Show documentation
PROTO library for proto-google-cloud-automl-v1beta1
/*
* 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/v1beta1/prediction_service.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.automl.v1beta1;
public interface BatchPredictRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.automl.v1beta1.BatchPredictRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Name of the model requested to serve the batch prediction.
*
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Required. Name of the model requested to serve the batch prediction.
*
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The input configuration for batch prediction.
*
*
*
* .google.cloud.automl.v1beta1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the inputConfig field is set.
*/
boolean hasInputConfig();
/**
*
*
*
* Required. The input configuration for batch prediction.
*
*
*
* .google.cloud.automl.v1beta1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The inputConfig.
*/
com.google.cloud.automl.v1beta1.BatchPredictInputConfig getInputConfig();
/**
*
*
*
* Required. The input configuration for batch prediction.
*
*
*
* .google.cloud.automl.v1beta1.BatchPredictInputConfig input_config = 3 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.automl.v1beta1.BatchPredictInputConfigOrBuilder getInputConfigOrBuilder();
/**
*
*
*
* Required. The Configuration specifying where output predictions should
* be written.
*
*
*
* .google.cloud.automl.v1beta1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the outputConfig field is set.
*/
boolean hasOutputConfig();
/**
*
*
*
* Required. The Configuration specifying where output predictions should
* be written.
*
*
*
* .google.cloud.automl.v1beta1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The outputConfig.
*/
com.google.cloud.automl.v1beta1.BatchPredictOutputConfig getOutputConfig();
/**
*
*
*
* Required. The Configuration specifying where output predictions should
* be written.
*
*
*
* .google.cloud.automl.v1beta1.BatchPredictOutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.automl.v1beta1.BatchPredictOutputConfigOrBuilder getOutputConfigOrBuilder();
/**
*
*
*
* Required. Additional domain-specific parameters for the predictions, any string must
* be up to 25000 characters long.
*
* * For Text Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a text snippet, it will only produce results
* that have at least this confidence score. The default is 0.5.
*
* * For Image Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for an image, it will only produce results that
* have at least this confidence score. The default is 0.5.
*
* * For Image Object Detection:
*
* `score_threshold` - (float) When Model detects objects on the image,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be produced per image. Default is 100, the
* requested value may be limited by server.
*
* * For Video Classification :
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a video, it will only produce results that
* have at least this confidence score. The default is 0.5.
* `segment_classification` - (boolean) Set to true to request
* segment-level classification. AutoML Video Intelligence returns
* labels and their confidence scores for the entire segment of the
* video that user specified in the request configuration.
* The default is "true".
* `shot_classification` - (boolean) Set to true to request shot-level
* classification. AutoML Video Intelligence determines the boundaries
* for each camera shot in the entire segment of the video that user
* specified in the request configuration. AutoML Video Intelligence
* then returns labels and their confidence scores for each detected
* shot, along with the start and end time of the shot.
* WARNING: Model evaluation is not done for this classification type,
* the quality of it depends on training data, but there are no metrics
* provided to describe that quality. The default is "false".
* `1s_interval_classification` - (boolean) Set to true to request
* classification for a video at one-second intervals. AutoML Video
* Intelligence returns labels and their confidence scores for each
* second of the entire segment of the video that user specified in the
* request configuration.
* WARNING: Model evaluation is not done for this classification
* type, the quality of it depends on training data, but there are no
* metrics provided to describe that quality. The default is
* "false".
*
* * For Tables:
*
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotations. The
* default is false.
*
* * For Video Object Tracking:
*
* `score_threshold` - (float) When Model detects objects on video frames,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be returned per frame. Default is 100, the requested
* value may be limited by server.
* `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
* at least that long as a relative value of video frame size will be
* returned. Value in 0 to 1 range. Default is 0.
*
*
* map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
*/
int getParamsCount();
/**
*
*
*
* Required. Additional domain-specific parameters for the predictions, any string must
* be up to 25000 characters long.
*
* * For Text Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a text snippet, it will only produce results
* that have at least this confidence score. The default is 0.5.
*
* * For Image Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for an image, it will only produce results that
* have at least this confidence score. The default is 0.5.
*
* * For Image Object Detection:
*
* `score_threshold` - (float) When Model detects objects on the image,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be produced per image. Default is 100, the
* requested value may be limited by server.
*
* * For Video Classification :
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a video, it will only produce results that
* have at least this confidence score. The default is 0.5.
* `segment_classification` - (boolean) Set to true to request
* segment-level classification. AutoML Video Intelligence returns
* labels and their confidence scores for the entire segment of the
* video that user specified in the request configuration.
* The default is "true".
* `shot_classification` - (boolean) Set to true to request shot-level
* classification. AutoML Video Intelligence determines the boundaries
* for each camera shot in the entire segment of the video that user
* specified in the request configuration. AutoML Video Intelligence
* then returns labels and their confidence scores for each detected
* shot, along with the start and end time of the shot.
* WARNING: Model evaluation is not done for this classification type,
* the quality of it depends on training data, but there are no metrics
* provided to describe that quality. The default is "false".
* `1s_interval_classification` - (boolean) Set to true to request
* classification for a video at one-second intervals. AutoML Video
* Intelligence returns labels and their confidence scores for each
* second of the entire segment of the video that user specified in the
* request configuration.
* WARNING: Model evaluation is not done for this classification
* type, the quality of it depends on training data, but there are no
* metrics provided to describe that quality. The default is
* "false".
*
* * For Tables:
*
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotations. The
* default is false.
*
* * For Video Object Tracking:
*
* `score_threshold` - (float) When Model detects objects on video frames,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be returned per frame. Default is 100, the requested
* value may be limited by server.
* `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
* at least that long as a relative value of video frame size will be
* returned. Value in 0 to 1 range. Default is 0.
*
*
* map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
*/
boolean containsParams(java.lang.String key);
/** Use {@link #getParamsMap()} instead. */
@java.lang.Deprecated
java.util.Map getParams();
/**
*
*
*
* Required. Additional domain-specific parameters for the predictions, any string must
* be up to 25000 characters long.
*
* * For Text Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a text snippet, it will only produce results
* that have at least this confidence score. The default is 0.5.
*
* * For Image Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for an image, it will only produce results that
* have at least this confidence score. The default is 0.5.
*
* * For Image Object Detection:
*
* `score_threshold` - (float) When Model detects objects on the image,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be produced per image. Default is 100, the
* requested value may be limited by server.
*
* * For Video Classification :
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a video, it will only produce results that
* have at least this confidence score. The default is 0.5.
* `segment_classification` - (boolean) Set to true to request
* segment-level classification. AutoML Video Intelligence returns
* labels and their confidence scores for the entire segment of the
* video that user specified in the request configuration.
* The default is "true".
* `shot_classification` - (boolean) Set to true to request shot-level
* classification. AutoML Video Intelligence determines the boundaries
* for each camera shot in the entire segment of the video that user
* specified in the request configuration. AutoML Video Intelligence
* then returns labels and their confidence scores for each detected
* shot, along with the start and end time of the shot.
* WARNING: Model evaluation is not done for this classification type,
* the quality of it depends on training data, but there are no metrics
* provided to describe that quality. The default is "false".
* `1s_interval_classification` - (boolean) Set to true to request
* classification for a video at one-second intervals. AutoML Video
* Intelligence returns labels and their confidence scores for each
* second of the entire segment of the video that user specified in the
* request configuration.
* WARNING: Model evaluation is not done for this classification
* type, the quality of it depends on training data, but there are no
* metrics provided to describe that quality. The default is
* "false".
*
* * For Tables:
*
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotations. The
* default is false.
*
* * For Video Object Tracking:
*
* `score_threshold` - (float) When Model detects objects on video frames,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be returned per frame. Default is 100, the requested
* value may be limited by server.
* `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
* at least that long as a relative value of video frame size will be
* returned. Value in 0 to 1 range. Default is 0.
*
*
* map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
*/
java.util.Map getParamsMap();
/**
*
*
*
* Required. Additional domain-specific parameters for the predictions, any string must
* be up to 25000 characters long.
*
* * For Text Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a text snippet, it will only produce results
* that have at least this confidence score. The default is 0.5.
*
* * For Image Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for an image, it will only produce results that
* have at least this confidence score. The default is 0.5.
*
* * For Image Object Detection:
*
* `score_threshold` - (float) When Model detects objects on the image,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be produced per image. Default is 100, the
* requested value may be limited by server.
*
* * For Video Classification :
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a video, it will only produce results that
* have at least this confidence score. The default is 0.5.
* `segment_classification` - (boolean) Set to true to request
* segment-level classification. AutoML Video Intelligence returns
* labels and their confidence scores for the entire segment of the
* video that user specified in the request configuration.
* The default is "true".
* `shot_classification` - (boolean) Set to true to request shot-level
* classification. AutoML Video Intelligence determines the boundaries
* for each camera shot in the entire segment of the video that user
* specified in the request configuration. AutoML Video Intelligence
* then returns labels and their confidence scores for each detected
* shot, along with the start and end time of the shot.
* WARNING: Model evaluation is not done for this classification type,
* the quality of it depends on training data, but there are no metrics
* provided to describe that quality. The default is "false".
* `1s_interval_classification` - (boolean) Set to true to request
* classification for a video at one-second intervals. AutoML Video
* Intelligence returns labels and their confidence scores for each
* second of the entire segment of the video that user specified in the
* request configuration.
* WARNING: Model evaluation is not done for this classification
* type, the quality of it depends on training data, but there are no
* metrics provided to describe that quality. The default is
* "false".
*
* * For Tables:
*
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotations. The
* default is false.
*
* * For Video Object Tracking:
*
* `score_threshold` - (float) When Model detects objects on video frames,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be returned per frame. Default is 100, the requested
* value may be limited by server.
* `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
* at least that long as a relative value of video frame size will be
* returned. Value in 0 to 1 range. Default is 0.
*
*
* map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
*/
/* nullable */
java.lang.String getParamsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Required. Additional domain-specific parameters for the predictions, any string must
* be up to 25000 characters long.
*
* * For Text Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a text snippet, it will only produce results
* that have at least this confidence score. The default is 0.5.
*
* * For Image Classification:
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for an image, it will only produce results that
* have at least this confidence score. The default is 0.5.
*
* * For Image Object Detection:
*
* `score_threshold` - (float) When Model detects objects on the image,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be produced per image. Default is 100, the
* requested value may be limited by server.
*
* * For Video Classification :
*
* `score_threshold` - (float) A value from 0.0 to 1.0. When the model
* makes predictions for a video, it will only produce results that
* have at least this confidence score. The default is 0.5.
* `segment_classification` - (boolean) Set to true to request
* segment-level classification. AutoML Video Intelligence returns
* labels and their confidence scores for the entire segment of the
* video that user specified in the request configuration.
* The default is "true".
* `shot_classification` - (boolean) Set to true to request shot-level
* classification. AutoML Video Intelligence determines the boundaries
* for each camera shot in the entire segment of the video that user
* specified in the request configuration. AutoML Video Intelligence
* then returns labels and their confidence scores for each detected
* shot, along with the start and end time of the shot.
* WARNING: Model evaluation is not done for this classification type,
* the quality of it depends on training data, but there are no metrics
* provided to describe that quality. The default is "false".
* `1s_interval_classification` - (boolean) Set to true to request
* classification for a video at one-second intervals. AutoML Video
* Intelligence returns labels and their confidence scores for each
* second of the entire segment of the video that user specified in the
* request configuration.
* WARNING: Model evaluation is not done for this classification
* type, the quality of it depends on training data, but there are no
* metrics provided to describe that quality. The default is
* "false".
*
* * For Tables:
*
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotations. The
* default is false.
*
* * For Video Object Tracking:
*
* `score_threshold` - (float) When Model detects objects on video frames,
* it will only produce bounding boxes which have at least this
* confidence score. Value in 0 to 1 range, default is 0.5.
* `max_bounding_box_count` - (int64) No more than this number of bounding
* boxes will be returned per frame. Default is 100, the requested
* value may be limited by server.
* `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
* at least that long as a relative value of video frame size will be
* returned. Value in 0 to 1 range. Default is 0.
*
*
* map<string, string> params = 5 [(.google.api.field_behavior) = REQUIRED];
*/
java.lang.String getParamsOrThrow(java.lang.String key);
}