1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/automl/v1/prediction_service.proto 18 19 package com.google.cloud.automl.v1; 20 21 public interface PredictRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.automl.v1.PredictRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. Name of the model requested to serve the prediction. 31 * </pre> 32 * 33 * <code> 34 * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 35 * </code> 36 * 37 * @return The name. 38 */ getName()39 java.lang.String getName(); 40 /** 41 * 42 * 43 * <pre> 44 * Required. Name of the model requested to serve the prediction. 45 * </pre> 46 * 47 * <code> 48 * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 49 * </code> 50 * 51 * @return The bytes for name. 52 */ getNameBytes()53 com.google.protobuf.ByteString getNameBytes(); 54 55 /** 56 * 57 * 58 * <pre> 59 * Required. Payload to perform a prediction on. The payload must match the 60 * problem type that the model was trained to solve. 61 * </pre> 62 * 63 * <code> 64 * .google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED]; 65 * </code> 66 * 67 * @return Whether the payload field is set. 68 */ hasPayload()69 boolean hasPayload(); 70 /** 71 * 72 * 73 * <pre> 74 * Required. Payload to perform a prediction on. The payload must match the 75 * problem type that the model was trained to solve. 76 * </pre> 77 * 78 * <code> 79 * .google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED]; 80 * </code> 81 * 82 * @return The payload. 83 */ getPayload()84 com.google.cloud.automl.v1.ExamplePayload getPayload(); 85 /** 86 * 87 * 88 * <pre> 89 * Required. Payload to perform a prediction on. The payload must match the 90 * problem type that the model was trained to solve. 91 * </pre> 92 * 93 * <code> 94 * .google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED]; 95 * </code> 96 */ getPayloadOrBuilder()97 com.google.cloud.automl.v1.ExamplePayloadOrBuilder getPayloadOrBuilder(); 98 99 /** 100 * 101 * 102 * <pre> 103 * Additional domain-specific parameters, any string must be up to 25000 104 * characters long. 105 * AutoML Vision Classification 106 * `score_threshold` 107 * : (float) A value from 0.0 to 1.0. When the model 108 * makes predictions for an image, it will only produce results that have 109 * at least this confidence score. The default is 0.5. 110 * AutoML Vision Object Detection 111 * `score_threshold` 112 * : (float) When Model detects objects on the image, 113 * it will only produce bounding boxes which have at least this 114 * confidence score. Value in 0 to 1 range, default is 0.5. 115 * `max_bounding_box_count` 116 * : (int64) The maximum number of bounding 117 * boxes returned. The default is 100. The 118 * number of returned bounding boxes might be limited by the server. 119 * AutoML Tables 120 * `feature_importance` 121 * : (boolean) Whether 122 * [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance] 123 * is populated in the returned list of 124 * [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation] 125 * objects. The default is false. 126 * </pre> 127 * 128 * <code>map<string, string> params = 3;</code> 129 */ getParamsCount()130 int getParamsCount(); 131 /** 132 * 133 * 134 * <pre> 135 * Additional domain-specific parameters, any string must be up to 25000 136 * characters long. 137 * AutoML Vision Classification 138 * `score_threshold` 139 * : (float) A value from 0.0 to 1.0. When the model 140 * makes predictions for an image, it will only produce results that have 141 * at least this confidence score. The default is 0.5. 142 * AutoML Vision Object Detection 143 * `score_threshold` 144 * : (float) When Model detects objects on the image, 145 * it will only produce bounding boxes which have at least this 146 * confidence score. Value in 0 to 1 range, default is 0.5. 147 * `max_bounding_box_count` 148 * : (int64) The maximum number of bounding 149 * boxes returned. The default is 100. The 150 * number of returned bounding boxes might be limited by the server. 151 * AutoML Tables 152 * `feature_importance` 153 * : (boolean) Whether 154 * [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance] 155 * is populated in the returned list of 156 * [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation] 157 * objects. The default is false. 158 * </pre> 159 * 160 * <code>map<string, string> params = 3;</code> 161 */ containsParams(java.lang.String key)162 boolean containsParams(java.lang.String key); 163 /** Use {@link #getParamsMap()} instead. */ 164 @java.lang.Deprecated getParams()165 java.util.Map<java.lang.String, java.lang.String> getParams(); 166 /** 167 * 168 * 169 * <pre> 170 * Additional domain-specific parameters, any string must be up to 25000 171 * characters long. 172 * AutoML Vision Classification 173 * `score_threshold` 174 * : (float) A value from 0.0 to 1.0. When the model 175 * makes predictions for an image, it will only produce results that have 176 * at least this confidence score. The default is 0.5. 177 * AutoML Vision Object Detection 178 * `score_threshold` 179 * : (float) When Model detects objects on the image, 180 * it will only produce bounding boxes which have at least this 181 * confidence score. Value in 0 to 1 range, default is 0.5. 182 * `max_bounding_box_count` 183 * : (int64) The maximum number of bounding 184 * boxes returned. The default is 100. The 185 * number of returned bounding boxes might be limited by the server. 186 * AutoML Tables 187 * `feature_importance` 188 * : (boolean) Whether 189 * [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance] 190 * is populated in the returned list of 191 * [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation] 192 * objects. The default is false. 193 * </pre> 194 * 195 * <code>map<string, string> params = 3;</code> 196 */ getParamsMap()197 java.util.Map<java.lang.String, java.lang.String> getParamsMap(); 198 /** 199 * 200 * 201 * <pre> 202 * Additional domain-specific parameters, any string must be up to 25000 203 * characters long. 204 * AutoML Vision Classification 205 * `score_threshold` 206 * : (float) A value from 0.0 to 1.0. When the model 207 * makes predictions for an image, it will only produce results that have 208 * at least this confidence score. The default is 0.5. 209 * AutoML Vision Object Detection 210 * `score_threshold` 211 * : (float) When Model detects objects on the image, 212 * it will only produce bounding boxes which have at least this 213 * confidence score. Value in 0 to 1 range, default is 0.5. 214 * `max_bounding_box_count` 215 * : (int64) The maximum number of bounding 216 * boxes returned. The default is 100. The 217 * number of returned bounding boxes might be limited by the server. 218 * AutoML Tables 219 * `feature_importance` 220 * : (boolean) Whether 221 * [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance] 222 * is populated in the returned list of 223 * [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation] 224 * objects. The default is false. 225 * </pre> 226 * 227 * <code>map<string, string> params = 3;</code> 228 */ 229 /* nullable */ getParamsOrDefault( java.lang.String key, java.lang.String defaultValue)230 java.lang.String getParamsOrDefault( 231 java.lang.String key, 232 /* nullable */ 233 java.lang.String defaultValue); 234 /** 235 * 236 * 237 * <pre> 238 * Additional domain-specific parameters, any string must be up to 25000 239 * characters long. 240 * AutoML Vision Classification 241 * `score_threshold` 242 * : (float) A value from 0.0 to 1.0. When the model 243 * makes predictions for an image, it will only produce results that have 244 * at least this confidence score. The default is 0.5. 245 * AutoML Vision Object Detection 246 * `score_threshold` 247 * : (float) When Model detects objects on the image, 248 * it will only produce bounding boxes which have at least this 249 * confidence score. Value in 0 to 1 range, default is 0.5. 250 * `max_bounding_box_count` 251 * : (int64) The maximum number of bounding 252 * boxes returned. The default is 100. The 253 * number of returned bounding boxes might be limited by the server. 254 * AutoML Tables 255 * `feature_importance` 256 * : (boolean) Whether 257 * [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance] 258 * is populated in the returned list of 259 * [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation] 260 * objects. The default is false. 261 * </pre> 262 * 263 * <code>map<string, string> params = 3;</code> 264 */ getParamsOrThrow(java.lang.String key)265 java.lang.String getParamsOrThrow(java.lang.String key); 266 } 267