com.google.cloud.automl.v1beta1.PredictRequestOrBuilder 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 PredictRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.automl.v1beta1.PredictRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Name of the model requested to serve the 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 prediction.
*
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. Payload to perform a prediction on. The payload must match the
* problem type that the model was trained to solve.
*
*
*
* .google.cloud.automl.v1beta1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the payload field is set.
*/
boolean hasPayload();
/**
*
*
*
* Required. Payload to perform a prediction on. The payload must match the
* problem type that the model was trained to solve.
*
*
*
* .google.cloud.automl.v1beta1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The payload.
*/
com.google.cloud.automl.v1beta1.ExamplePayload getPayload();
/**
*
*
*
* Required. Payload to perform a prediction on. The payload must match the
* problem type that the model was trained to solve.
*
*
*
* .google.cloud.automl.v1beta1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.automl.v1beta1.ExamplePayloadOrBuilder getPayloadOrBuilder();
/**
*
*
*
* Additional domain-specific parameters, any string must be up to 25000
* characters long.
*
* * 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 returned in the response. Default is 100, the
* requested value may be limited by server.
* * For Tables:
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotation.
* The default is false.
*
*
* map<string, string> params = 3;
*/
int getParamsCount();
/**
*
*
*
* Additional domain-specific parameters, any string must be up to 25000
* characters long.
*
* * 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 returned in the response. Default is 100, the
* requested value may be limited by server.
* * For Tables:
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotation.
* The default is false.
*
*
* map<string, string> params = 3;
*/
boolean containsParams(java.lang.String key);
/** Use {@link #getParamsMap()} instead. */
@java.lang.Deprecated
java.util.Map getParams();
/**
*
*
*
* Additional domain-specific parameters, any string must be up to 25000
* characters long.
*
* * 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 returned in the response. Default is 100, the
* requested value may be limited by server.
* * For Tables:
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotation.
* The default is false.
*
*
* map<string, string> params = 3;
*/
java.util.Map getParamsMap();
/**
*
*
*
* Additional domain-specific parameters, any string must be up to 25000
* characters long.
*
* * 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 returned in the response. Default is 100, the
* requested value may be limited by server.
* * For Tables:
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotation.
* The default is false.
*
*
* map<string, string> params = 3;
*/
/* nullable */
java.lang.String getParamsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Additional domain-specific parameters, any string must be up to 25000
* characters long.
*
* * 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 returned in the response. Default is 100, the
* requested value may be limited by server.
* * For Tables:
* feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
* should be populated in the returned TablesAnnotation.
* The default is false.
*
*
* map<string, string> params = 3;
*/
java.lang.String getParamsOrThrow(java.lang.String key);
}