Blame - docs/dyn/vision_v1p2beta1.images.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

101

# URL. If both `content` and `source` are provided for an image, `content`

102

# takes precedence and is used to perform the image annotation request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

103

"gcsImageUri": "A String", # **Use `image_uri` instead.**

104

#

105

# The Google Cloud Storage URI of the form

106

# `gs://bucket_name/object_name`. Object versioning is not supported. See

107

# [Google Cloud Storage Request

108

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

109

"imageUri": "A String", # The URI of the source image. Can be either:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

110

#

111

# 1. A Google Cloud Storage URI of the form

112

# `gs://bucket_name/object_name`. Object versioning is not supported. See

113

# [Google Cloud Storage Request

114

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more

115

# info.

116

#

117

# 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from

118

# HTTP/HTTPS URLs, Google cannot guarantee that the request will be

119

# completed. Your request may fail if the specified host denies the

120

# request (e.g. due to request throttling or DOS prevention), or if Google

121

# throttles requests to the site for abuse prevention. You should not

122

# depend on externally-hosted images for production applications.

123

#

124

# When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes

125

# precedence.

126

},

127

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

128

"features": [ # Requested features.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

129

{ # The type of Google Cloud Vision API detection to perform, and the maximum

130

# number of results to return for that type. Multiple `Feature` objects can

131

# be specified in the `features` list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

132

"type": "A String", # The feature type.

133

"maxResults": 42, # Maximum number of results of this type. Does not apply to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

134

# `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

135

"model": "A String", # Model to use for the feature.

136

# Supported values: "builtin/stable" (the default if unset) and

137

# "builtin/latest".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

138

},

139

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

140

"imageContext": { # Image context and/or feature-specific parameters. # Additional context that may accompany the image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

141

"cropHintsParams": { # Parameters for crop hints annotation request. # Parameters for crop hints annotation request.

142

"aspectRatios": [ # Aspect ratios in floats, representing the ratio of the width to the height

143

# of the image. For example, if the desired aspect ratio is 4/3, the

144

# corresponding float value should be 1.33333. If not specified, the

145

# best possible crop is returned. The number of provided aspect ratios is

146

# limited to a maximum of 16; any aspect ratios provided after the 16th are

# ignored.

3.14,

],

},

"productSearchParams": { # Parameters for a product search request. # Parameters for product search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

152

"productCategories": [ # The list of product categories to search in. Currently, we only consider

153

# the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",

154

# "packagedgoods-v1", or "general-v1" should be specified. The legacy

155

# categories "homegoods", "apparel", and "toys" are still supported but will

156

# be deprecated. For new products, please use "homegoods-v2", "apparel-v2",

157

# or "toys-v2" for better product search accuracy. It is recommended to

158

# migrate existing products to these categories as well.

159

"A String",

160

],

161

"filter": "A String", # The filtering expression. This can be used to restrict search results based

162

# on Product labels. We currently support an AND of OR of key-value

163

# expressions, where each expression within an OR must have the same key. An

164

# '=' should be used to connect the key and value.

165

#

166

# For example, "(color = red OR color = blue) AND brand = Google" is

167

# acceptable, but "(color = red OR brand = Google)" is not acceptable.

168

# "color: red" is not acceptable because it uses a ':' instead of an '='.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

169

"productSet": "A String", # The resource name of a ProductSet to be searched for similar images.

170

#

171

# Format is:

172

# `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

173

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the area of interest in the image.

174

# If it is not specified, system discretion will be applied.

175

"normalizedVertices": [ # The bounding polygon normalized vertices.

176

{ # A vertex represents a 2D point in the image.

177

# NOTE: the normalized vertex coordinates are relative to the original image

178

# and range from 0 to 1.

179

"x": 3.14, # X coordinate.

180

"y": 3.14, # Y coordinate.

181

},

182

],

183

"vertices": [ # The bounding polygon vertices.

184

{ # A vertex represents a 2D point in the image.

185

# NOTE: the vertex coordinates are in the same scale as the original image.

186

"y": 42, # Y coordinate.

187

"x": 42, # X coordinate.

},

],

},

},

"languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value

193

# yields the best results since it enables automatic language detection. For

194

# languages based on the Latin alphabet, setting `language_hints` is not

195

# needed. In rare cases, when the language of the text in the image is known,

196

# setting a hint will help get better results (although it will be a

197

# significant hindrance if the hint is wrong). Text detection returns an

198

# error if one or more of the specified languages is not one of the

199

# [supported languages](https://cloud.google.com/vision/docs/languages).

200

"A String",

201

],

202

"webDetectionParams": { # Parameters for web detection request. # Parameters for web detection.

203

"includeGeoResults": True or False, # Whether to include results derived from the geo information in the image.

204

},

205

"latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used.

206

"maxLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Max lat/long pair.

207

# of doubles representing degrees latitude and degrees longitude. Unless

208

# specified otherwise, this must conform to the

209

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

210

# standard</a>. Values must be within normalized ranges.

211

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

212

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

213

},

214

"minLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Min lat/long pair.

215

# of doubles representing degrees latitude and degrees longitude. Unless

216

# specified otherwise, this must conform to the

217

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

218

# standard</a>. Values must be within normalized ranges.

219

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

220

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

221

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

222

},

223

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

224

},

225

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

226

"parent": "A String", # Optional. Target project and location to make a call.

227

#

228

# Format: `projects/{project-id}/locations/{location-id}`.

229

#

230

# If no parent is specified, a region will be chosen automatically.

231

#

232

# Supported location-ids:

233

# `us`: USA country only,

234

# `asia`: East asia areas, like Japan, Taiwan,

235

# `eu`: The European Union.

236

#

237

# Example: `projects/project-A/locations/eu`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

238

}

239

240

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

247

248

{ # Response to a batch image annotation request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

249

"responses": [ # Individual responses to image annotation requests within the batch.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

250

{ # Response to an image annotation request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

251

"localizedObjectAnnotations": [ # If present, localized object detection has completed successfully.

252

# This will be sorted descending by confidence score.

253

{ # Set of detected objects with bounding boxes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

254

"name": "A String", # Object name, expressed in its `language_code` language.

255

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this object belongs. This must be populated.

256

"normalizedVertices": [ # The bounding polygon normalized vertices.

257

{ # A vertex represents a 2D point in the image.

258

# NOTE: the normalized vertex coordinates are relative to the original image

259

# and range from 0 to 1.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

260

"x": 3.14, # X coordinate.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

261

"y": 3.14, # Y coordinate.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

262

},

263

],

264

"vertices": [ # The bounding polygon vertices.

265

{ # A vertex represents a 2D point in the image.

266

# NOTE: the vertex coordinates are in the same scale as the original image.

267

"y": 42, # Y coordinate.

268

"x": 42, # X coordinate.

},

],

},

"score": 3.14, # Score of the result. Range [0, 1].

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

273

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

274

# information, see

275

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

276

"mid": "A String", # Object ID that should align with EntityAnnotation mid.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

277

},

278

],

279

"productSearchResults": { # Results for a product search request. # If present, product search has completed successfully.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

280

"results": [ # List of results, one for each product match.

281

{ # Information about a product.

282

"image": "A String", # The resource name of the image from the product that is the closest match

283

# to the query.

284

"product": { # A Product contains ReferenceImages. # The Product.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

285

"productLabels": [ # Key-value pairs that can be attached to a product. At query time,

286

# constraints can be specified based on the product_labels.

287

#

288

# Note that integer values can be provided as strings, e.g. "1199". Only

289

# strings with integer values can match a range-based restriction which is

290

# to be supported soon.

291

#

292

# Multiple values can be assigned to the same key. One product may have up to

293

# 500 product_labels.

294

#

295

# Notice that the total number of distinct product_labels over all products

296

# in one ProductSet cannot exceed 1M, otherwise the product search pipeline

297

# will refuse to work for that ProductSet.

298

{ # A product label represented as a key-value pair.

299

"value": "A String", # The value of the label attached to the product. Cannot be empty and

300

# cannot exceed 128 bytes.

301

"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot

302

# exceed 128 bytes.

303

},

304

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

305

"name": "A String", # The resource name of the product.

306

#

307

# Format is:

308

# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

309

#

310

# This field is ignored when creating a product.

311

"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most

312

# 4096 characters long.

313

"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096

314

# characters long.

315

"productCategory": "A String", # Immutable. The category for the product identified by the reference image. This should

316

# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories

317

# "homegoods", "apparel", and "toys" are still supported, but these should

318

# not be used for new products.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

319

},

320

"score": 3.14, # A confidence level on the match, ranging from 0 (no confidence) to

321

# 1 (full confidence).

322

},

323

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

324

"indexTime": "A String", # Timestamp of the index which provided these results. Products added to the

325

# product set and products removed from the product set after this time are

326

# not reflected in the current results.

327

"productGroupedResults": [ # List of results grouped by products detected in the query image. Each entry

328

# corresponds to one bounding polygon in the query image, and contains the

329

# matching products specific to that region. There may be duplicate product

330

# matches in the union of all the per-product results.

331

{ # Information about the products similar to a single product in a query

332

# image.

333

"objectAnnotations": [ # List of generic predictions for the object in the bounding box.

334

{ # Prediction for what the object in the bounding box is.

335

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

336

# information, see

337

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

338

"mid": "A String", # Object ID that should align with EntityAnnotation mid.

339

"name": "A String", # Object name, expressed in its `language_code` language.

340

"score": 3.14, # Score of the result. Range [0, 1].

341

},

342

],

343

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the product detected in the query image.

344

"normalizedVertices": [ # The bounding polygon normalized vertices.

345

{ # A vertex represents a 2D point in the image.

346

# NOTE: the normalized vertex coordinates are relative to the original image

347

# and range from 0 to 1.

348

"x": 3.14, # X coordinate.

349

"y": 3.14, # Y coordinate.

350

},

351

],

352

"vertices": [ # The bounding polygon vertices.

353

{ # A vertex represents a 2D point in the image.

354

# NOTE: the vertex coordinates are in the same scale as the original image.

355

"y": 42, # Y coordinate.

356

"x": 42, # X coordinate.

},

],

},

"results": [ # List of results, one for each product match.

361

{ # Information about a product.

362

"image": "A String", # The resource name of the image from the product that is the closest match

363

# to the query.

364

"product": { # A Product contains ReferenceImages. # The Product.

365

"productLabels": [ # Key-value pairs that can be attached to a product. At query time,

366

# constraints can be specified based on the product_labels.

367

#

368

# Note that integer values can be provided as strings, e.g. "1199". Only

369

# strings with integer values can match a range-based restriction which is

370

# to be supported soon.

371

#

372

# Multiple values can be assigned to the same key. One product may have up to

373

# 500 product_labels.

374

#

375

# Notice that the total number of distinct product_labels over all products

376

# in one ProductSet cannot exceed 1M, otherwise the product search pipeline

377

# will refuse to work for that ProductSet.

378

{ # A product label represented as a key-value pair.

379

"value": "A String", # The value of the label attached to the product. Cannot be empty and

380

# cannot exceed 128 bytes.

381

"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot

# exceed 128 bytes.

},

],

"name": "A String", # The resource name of the product.

386

#

387

# Format is:

388

# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

389

#

390

# This field is ignored when creating a product.

391

"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most

392

# 4096 characters long.

393

"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096

394

# characters long.

395

"productCategory": "A String", # Immutable. The category for the product identified by the reference image. This should

396

# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories

397

# "homegoods", "apparel", and "toys" are still supported, but these should

398

# not be used for new products.

399

},

400

"score": 3.14, # A confidence level on the match, ranging from 0 (no confidence) to

401

# 1 (full confidence).

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

406

},

407

"error": { # The `Status` type defines a logical error model that is suitable for # If set, represents the error message for the operation.

408

# Note that filled-in image annotations are guaranteed to be

409

# correct, even when `error` is set.

410

# different programming environments, including REST APIs and RPC APIs. It is

411

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

412

# three pieces of data: error code, error message, and error details.

413

#

414

# You can find out more about this error model and how to work with it in the

415

# [API Design Guide](https://cloud.google.com/apis/design/errors).

416

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

417

"message": "A String", # A developer-facing error message, which should be in English. Any

418

# user-facing error message should be localized and sent in the

419

# google.rpc.Status.details field, or localized by the client.

420

"details": [ # A list of messages that carry the error details. There is a common set of

421

# message types for APIs to use.

422

{

423

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"fullTextAnnotation": { # TextAnnotation contains a structured representation of OCR extracted text. # If present, text (OCR) detection or document (OCR) text detection has

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

428

# completed successfully.

429

# This annotation provides the structural hierarchy for the OCR detected

430

# text.

431

# The hierarchy of an OCR extracted text structure is like this:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

432

# TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

433

# Each structural component, starting from Page, may further have their own

434

# properties. Properties describe detected languages, breaks etc.. Please refer

435

# to the TextAnnotation.TextProperty message definition below for more

436

# detail.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

437

"text": "A String", # UTF-8 text detected on the pages.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

438

"pages": [ # List of pages detected by OCR.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

439

{ # Detected page from OCR.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

440

"width": 42, # Page width. For PDFs the unit is points. For images (including

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

441

# TIFFs) the unit is pixels.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

442

"blocks": [ # List of blocks of text, images etc on this page.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

443

{ # Logical element on the page.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

444

"property": { # Additional information detected on the structural component. # Additional information detected for the block.

445

"detectedLanguages": [ # A list of detected languages together with confidence.

446

{ # Detected language for a structural component.

447

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

448

# information, see

449

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

450

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

451

},

452

],

453

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

454

"type": "A String", # Detected break type.

455

"isPrefix": True or False, # True if break prepends the element.

456

},

457

},

458

"blockType": "A String", # Detected block type (text, image etc) for this block.

459

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the block.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

460

# The vertices are in the order of top-left, top-right, bottom-right,

461

# bottom-left. When a rotation of the bounding box is detected the rotation

462

# is represented as around the top-left corner as defined when the text is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

463

# read in the 'natural' orientation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

464

# For example:

465

#

466

# * when the text is horizontal it might look like:

#

# 0----1

# | |

# 3----2

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

472

# * when it's rotated 180 degrees around the top-left corner it becomes:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

# 2----3

# | |

# 1----0

#

# and the vertex order will still be (0, 1, 2, 3).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

479

"normalizedVertices": [ # The bounding polygon normalized vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

480

{ # A vertex represents a 2D point in the image.

481

# NOTE: the normalized vertex coordinates are relative to the original image

482

# and range from 0 to 1.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

483

"x": 3.14, # X coordinate.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

484

"y": 3.14, # Y coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

485

},

486

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

487

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

488

{ # A vertex represents a 2D point in the image.

489

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

490

"y": 42, # Y coordinate.

491

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

492

},

493

],

494

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

495

"confidence": 3.14, # Confidence of the OCR results on the block. Range [0, 1].

496

"paragraphs": [ # List of paragraphs in this block (if this blocks is of type text).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

497

{ # Structural unit of text representing a number of words in certain order.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

498

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the paragraph.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

499

# The vertices are in the order of top-left, top-right, bottom-right,

500

# bottom-left. When a rotation of the bounding box is detected the rotation

501

# is represented as around the top-left corner as defined when the text is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

502

# read in the 'natural' orientation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

503

# For example:

504

# * when the text is horizontal it might look like:

505

# 0----1

506

# | |

507

# 3----2

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

508

# * when it's rotated 180 degrees around the top-left corner it becomes:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

# 2----3

# | |

# 1----0

# and the vertex order will still be (0, 1, 2, 3).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

513

"normalizedVertices": [ # The bounding polygon normalized vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

514

{ # A vertex represents a 2D point in the image.

515

# NOTE: the normalized vertex coordinates are relative to the original image

516

# and range from 0 to 1.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

517

"x": 3.14, # X coordinate.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

518

"y": 3.14, # Y coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

519

},

520

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

521

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

522

{ # A vertex represents a 2D point in the image.

523

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

524

"y": 42, # Y coordinate.

525

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

526

},

527

],

528

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

529

"confidence": 3.14, # Confidence of the OCR results for the paragraph. Range [0, 1].

530

"words": [ # List of all words in this paragraph.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

531

{ # A word representation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

532

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the word.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

533

# The vertices are in the order of top-left, top-right, bottom-right,

534

# bottom-left. When a rotation of the bounding box is detected the rotation

535

# is represented as around the top-left corner as defined when the text is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

536

# read in the 'natural' orientation.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

537

# For example:

538

# * when the text is horizontal it might look like:

539

# 0----1

540

# | |

541

# 3----2

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

542

# * when it's rotated 180 degrees around the top-left corner it becomes:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

# 2----3

# | |

# 1----0

# and the vertex order will still be (0, 1, 2, 3).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

547

"normalizedVertices": [ # The bounding polygon normalized vertices.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

548

{ # A vertex represents a 2D point in the image.

549

# NOTE: the normalized vertex coordinates are relative to the original image

550

# and range from 0 to 1.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

551

"x": 3.14, # X coordinate.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

552

"y": 3.14, # Y coordinate.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

553

},

554

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

555

"vertices": [ # The bounding polygon vertices.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

556

{ # A vertex represents a 2D point in the image.

557

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

558

"y": 42, # Y coordinate.

559

"x": 42, # X coordinate.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

560

},

561

],

562

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

563

"confidence": 3.14, # Confidence of the OCR results for the word. Range [0, 1].

564

"symbols": [ # List of symbols in the word.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

565

# The order of the symbols follows the natural reading order.

566

{ # A single symbol representation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

567

"text": "A String", # The actual UTF-8 representation of the symbol.

568

"property": { # Additional information detected on the structural component. # Additional information detected for the symbol.

569

"detectedLanguages": [ # A list of detected languages together with confidence.

570

{ # Detected language for a structural component.

571

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

572

# information, see

573

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

574

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

575

},

576

],

577

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

578

"type": "A String", # Detected break type.

579

"isPrefix": True or False, # True if break prepends the element.

580

},

581

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

582

"boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the symbol.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

583

# The vertices are in the order of top-left, top-right, bottom-right,

584

# bottom-left. When a rotation of the bounding box is detected the rotation

585

# is represented as around the top-left corner as defined when the text is

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

586

# read in the 'natural' orientation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

587

# For example:

588

# * when the text is horizontal it might look like:

589

# 0----1

590

# | |

591

# 3----2

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

592

# * when it's rotated 180 degrees around the top-left corner it becomes:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

593

# 2----3

594

# | |

595

# 1----0

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

596

# and the vertex order will still be (0, 1, 2, 3).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

597

"normalizedVertices": [ # The bounding polygon normalized vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

598

{ # A vertex represents a 2D point in the image.

599

# NOTE: the normalized vertex coordinates are relative to the original image

600

# and range from 0 to 1.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

601

"x": 3.14, # X coordinate.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

602

"y": 3.14, # Y coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

603

},

604

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

605

"vertices": [ # The bounding polygon vertices.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

606

{ # A vertex represents a 2D point in the image.

607

# NOTE: the vertex coordinates are in the same scale as the original image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

608

"y": 42, # Y coordinate.

609

"x": 42, # X coordinate.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

610

},

611

],

612

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

613

"confidence": 3.14, # Confidence of the OCR results for the symbol. Range [0, 1].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

614

},

615

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

616

"property": { # Additional information detected on the structural component. # Additional information detected for the word.

617

"detectedLanguages": [ # A list of detected languages together with confidence.

618

{ # Detected language for a structural component.

619

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

620

# information, see

621

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

622

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

623

},

624

],

625

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

626

"type": "A String", # Detected break type.

627

"isPrefix": True or False, # True if break prepends the element.

628

},

629

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

630

},

631

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

632

"property": { # Additional information detected on the structural component. # Additional information detected for the paragraph.

633

"detectedLanguages": [ # A list of detected languages together with confidence.

634

{ # Detected language for a structural component.

635

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

636

# information, see

637

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

638

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

639

},

640

],

641

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

642

"type": "A String", # Detected break type.

643

"isPrefix": True or False, # True if break prepends the element.

644

},

645

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

650

"property": { # Additional information detected on the structural component. # Additional information detected on the page.

651

"detectedLanguages": [ # A list of detected languages together with confidence.

652

{ # Detected language for a structural component.

653

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more

654

# information, see

655

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

656

"confidence": 3.14, # Confidence of detected language. Range [0, 1].

657

},

658

],

659

"detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.

660

"type": "A String", # Detected break type.

661

"isPrefix": True or False, # True if break prepends the element.

662

},

663

},

664

"confidence": 3.14, # Confidence of the OCR results on the page. Range [0, 1].

665

"height": 42, # Page height. For PDFs the unit is points. For images (including

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

666

# TIFFs) the unit is pixels.

667

},

668

],

669

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

670

"textAnnotations": [ # If present, text (OCR) detection has completed successfully.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

671

{ # Set of detected entity features.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

672

"locale": "A String", # The language code for the locale in which the entity textual

673

# `description` is expressed.

674

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced

675

# for `LABEL_DETECTION` features.

676

"normalizedVertices": [ # The bounding polygon normalized vertices.

677

{ # A vertex represents a 2D point in the image.

678

# NOTE: the normalized vertex coordinates are relative to the original image

679

# and range from 0 to 1.

680

"x": 3.14, # X coordinate.

681

"y": 3.14, # Y coordinate.

682

},

683

],

684

"vertices": [ # The bounding polygon vertices.

685

{ # A vertex represents a 2D point in the image.

686

# NOTE: the vertex coordinates are in the same scale as the original image.

687

"y": 42, # Y coordinate.

688

"x": 42, # X coordinate.

},

],

},

"description": "A String", # Entity textual description, expressed in its `locale` language.

693

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the

694

# image. For example, the relevancy of "tower" is likely higher to an image

695

# containing the detected "Eiffel Tower" than to an image containing a

696

# detected distant towering building, even though the confidence that

697

# there is a tower in each image may be the same. Range [0, 1].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

698

"properties": [ # Some entities may have optional user-supplied `Property` (name/value)

699

# fields, such a score or string that qualifies the entity.

700

{ # A `Property` consists of a user-supplied name/value pair.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

701

"value": "A String", # Value of the property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

702

"uint64Value": "A String", # Value of numeric properties.

703

"name": "A String", # Name of the property.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

704

},

705

],

706

"score": 3.14, # Overall score of the result. Range [0, 1].

707

"locations": [ # The location information for the detected entity. Multiple

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

708

# `LocationInfo` elements can be present because one location may

709

# indicate the location of the scene in the image, and another location

710

# may indicate the location of the place where the image was taken.

711

# Location information is usually present for landmarks.

712

{ # Detected entity location information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

713

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

714

# of doubles representing degrees latitude and degrees longitude. Unless

715

# specified otherwise, this must conform to the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

716

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

717

# standard</a>. Values must be within normalized ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

718

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

719

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

720

},

721

},

722

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

"mid": "A String", # Opaque entity ID. Some IDs may be available in

724

# [Google Knowledge Graph Search

725

# API](https://developers.google.com/knowledge-graph/).

726

"confidence": 3.14, # **Deprecated. Use `score` instead.**

727

# The accuracy of the entity detection in an image.

728

# For example, for an image in which the "Eiffel Tower" entity is detected,

729

# this field represents the confidence that there is a tower in the query

730

# image. Range [0, 1].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

731

},

732

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

733

"imagePropertiesAnnotation": { # Stores image properties, such as dominant colors. # If present, image properties were extracted successfully.

734

"dominantColors": { # Set of dominant colors and their corresponding scores. # If present, dominant colors completed successfully.

735

"colors": [ # RGB color values with their score and pixel fraction.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

736

{ # Color information consists of RGB channels, score, and the fraction of

737

# the image that the color occupies in the image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

738

"pixelFraction": 3.14, # The fraction of pixels the color occupies in the image.

739

# Value in range [0, 1].

740

"color": { # Represents a color in the RGBA color space. This representation is designed # RGB components of the color.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

741

# for simplicity of conversion to/from color representations in various

742

# languages over compactness; for example, the fields of this representation

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

743

# can be trivially provided to the constructor of "java.awt.Color" in Java; it

744

# can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

745

# method in iOS; and, with just a little work, it can be easily formatted into

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

746

# a CSS "rgba()" string in JavaScript, as well.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

747

#

748

# Note: this proto does not carry information about the absolute color space

749

# that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,

750

# DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color

# space.

#

# Example (Java):

#

# import com.google.type.Color;

756

#

757

# // ...

758

# public static java.awt.Color fromProto(Color protocolor) {

759

# float alpha = protocolor.hasAlpha()

760

# ? protocolor.getAlpha().getValue()

761

# : 1.0;

762

#

763

# return new java.awt.Color(

764

# protocolor.getRed(),

765

# protocolor.getGreen(),

766

# protocolor.getBlue(),

# alpha);

# }

#

# public static Color toProto(java.awt.Color color) {

771

# float red = (float) color.getRed();

772

# float green = (float) color.getGreen();

773

# float blue = (float) color.getBlue();

774

# float denominator = 255.0;

775

# Color.Builder resultBuilder =

776

# Color

777

# .newBuilder()

778

# .setRed(red / denominator)

779

# .setGreen(green / denominator)

780

# .setBlue(blue / denominator);

781

# int alpha = color.getAlpha();

782

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

# .setValue(((float) alpha) / denominator)

787

# .build());

788

# }

789

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

794

#

795

# // ...

796

# static UIColor* fromProto(Color* protocolor) {

797

# float red = [protocolor red];

798

# float green = [protocolor green];

799

# float blue = [protocolor blue];

800

# FloatValue* alpha_wrapper = [protocolor alpha];

801

# float alpha = 1.0;

802

# if (alpha_wrapper != nil) {

803

# alpha = [alpha_wrapper value];

804

# }

805

# return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];

806

# }

807

#

808

# static Color* toProto(UIColor* color) {

809

# CGFloat red, green, blue, alpha;

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

810

# if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

811

# return nil;

812

# }

813

# Color* result = [[Color alloc] init];

814

# [result setRed:red];

815

# [result setGreen:green];

816

# [result setBlue:blue];

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

817

# if (alpha <= 0.9999) {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

818

# [result setAlpha:floatWrapperWithValue(alpha)];

819

# }

820

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

830

# var redFrac = rgb_color.red || 0.0;

831

# var greenFrac = rgb_color.green || 0.0;

832

# var blueFrac = rgb_color.blue || 0.0;

833

# var red = Math.floor(redFrac * 255);

834

# var green = Math.floor(greenFrac * 255);

835

# var blue = Math.floor(blueFrac * 255);

836

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

837

# if (!('alpha' in rgb_color)) {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

838

# return rgbToCssColor_(red, green, blue);

839

# }

840

#

841

# var alphaFrac = rgb_color.alpha.value || 0.0;

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

842

# var rgbParams = [red, green, blue].join(',');

843

# return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

844

# };

845

#

846

# var rgbToCssColor_ = function(red, green, blue) {

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

847

# var rgbNumber = new Number((red << 16) | (green << 8) | blue);

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

848

# var hexString = rgbNumber.toString(16);

849

# var missingZeros = 6 - hexString.length;

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

850

# var resultBuilder = ['#'];

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

851

# for (var i = 0; i < missingZeros; i++) {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

852

# resultBuilder.push('0');

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

853

# }

854

# resultBuilder.push(hexString);

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

855

# return resultBuilder.join('');

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

856

# };

857

#

858

# // ...

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

859

"green": 3.14, # The amount of green in the color as a value in the interval [0, 1].

860

"blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].

861

"alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

862

# the final pixel color is defined by the equation:

863

#

864

# pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

865

#

866

# This means that a value of 1.0 corresponds to a solid color, whereas

867

# a value of 0.0 corresponds to a completely transparent color. This

868

# uses a wrapper message rather than a simple float scalar so that it is

869

# possible to distinguish between a default value and the value being unset.

870

# If omitted, this color object is to be rendered as a solid color

871

# (as if the alpha value had been explicitly given with a value of 1.0).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

872

"red": 3.14, # The amount of red in the color as a value in the interval [0, 1].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

873

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

874

"score": 3.14, # Image-specific score for this color. Value in range [0, 1].

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

879

"logoAnnotations": [ # If present, logo detection has completed successfully.

880

{ # Set of detected entity features.

881

"locale": "A String", # The language code for the locale in which the entity textual

882

# `description` is expressed.

883

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced

884

# for `LABEL_DETECTION` features.

885

"normalizedVertices": [ # The bounding polygon normalized vertices.

886

{ # A vertex represents a 2D point in the image.

887

# NOTE: the normalized vertex coordinates are relative to the original image

888

# and range from 0 to 1.

889

"x": 3.14, # X coordinate.

890

"y": 3.14, # Y coordinate.

891

},

892

],

893

"vertices": [ # The bounding polygon vertices.

894

{ # A vertex represents a 2D point in the image.

895

# NOTE: the vertex coordinates are in the same scale as the original image.

896

"y": 42, # Y coordinate.

897

"x": 42, # X coordinate.

},

],

},

"description": "A String", # Entity textual description, expressed in its `locale` language.

902

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the

903

# image. For example, the relevancy of "tower" is likely higher to an image

904

# containing the detected "Eiffel Tower" than to an image containing a

905

# detected distant towering building, even though the confidence that

906

# there is a tower in each image may be the same. Range [0, 1].

907

"properties": [ # Some entities may have optional user-supplied `Property` (name/value)

908

# fields, such a score or string that qualifies the entity.

909

{ # A `Property` consists of a user-supplied name/value pair.

910

"value": "A String", # Value of the property.

911

"uint64Value": "A String", # Value of numeric properties.

912

"name": "A String", # Name of the property.

913

},

914

],

915

"score": 3.14, # Overall score of the result. Range [0, 1].

916

"locations": [ # The location information for the detected entity. Multiple

917

# `LocationInfo` elements can be present because one location may

918

# indicate the location of the scene in the image, and another location

919

# may indicate the location of the place where the image was taken.

920

# Location information is usually present for landmarks.

921

{ # Detected entity location information.

922

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.

923

# of doubles representing degrees latitude and degrees longitude. Unless

924

# specified otherwise, this must conform to the

925

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

926

# standard</a>. Values must be within normalized ranges.

927

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

928

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

},

},

],

"mid": "A String", # Opaque entity ID. Some IDs may be available in

933

# [Google Knowledge Graph Search

934

# API](https://developers.google.com/knowledge-graph/).

935

"confidence": 3.14, # **Deprecated. Use `score` instead.**

936

# The accuracy of the entity detection in an image.

937

# For example, for an image in which the "Eiffel Tower" entity is detected,

938

# this field represents the confidence that there is a tower in the query

939

# image. Range [0, 1].

940

},

941

],

942

"context": { # If an image was produced from a file (e.g. a PDF), this message gives # If present, contextual information is needed to understand where this image

943

# comes from.

944

# information about the source of that image.

945

"uri": "A String", # The URI of the file used to produce the image.

946

"pageNumber": 42, # If the file was a PDF or TIFF, this field gives the page number within

947

# the file used to produce the image.

948

},

949

"webDetection": { # Relevant information for the image from the Internet. # If present, web detection has completed successfully.

950

"visuallySimilarImages": [ # The visually similar image results.

951

{ # Metadata for online images.

952

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

953

"url": "A String", # The result image URL.

954

},

955

],

956

"bestGuessLabels": [ # The service's best guess as to the topic of the request image.

957

# Inferred from similar images on the open web.

958

{ # Label to provide extra metadata for the web detection.

959

"label": "A String", # Label for extra metadata.

960

"languageCode": "A String", # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn".

961

# For more information, see

962

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

963

},

964

],

965

"fullMatchingImages": [ # Fully matching images from the Internet.

966

# Can include resized copies of the query image.

967

{ # Metadata for online images.

968

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

969

"url": "A String", # The result image URL.

970

},

971

],

972

"webEntities": [ # Deduced entities from similar images on the Internet.

973

{ # Entity deduced from similar images on the Internet.

974

"entityId": "A String", # Opaque entity ID.

975

"description": "A String", # Canonical description of the entity, in English.

976

"score": 3.14, # Overall relevancy score for the entity.

977

# Not normalized and not comparable across different image queries.

978

},

979

],

980

"pagesWithMatchingImages": [ # Web pages containing the matching images from the Internet.

981

{ # Metadata for web pages.

982

"score": 3.14, # (Deprecated) Overall relevancy score for the web page.

983

"partialMatchingImages": [ # Partial matching images on the page.

984

# Those images are similar enough to share some key-point features. For

985

# example an original image will likely have partial matching for its

986

# crops.

987

{ # Metadata for online images.

988

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

989

"url": "A String", # The result image URL.

990

},

991

],

992

"url": "A String", # The result web page URL.

993

"pageTitle": "A String", # Title for the web page, may contain HTML markups.

994

"fullMatchingImages": [ # Fully matching images on the page.

995

# Can include resized copies of the query image.

996

{ # Metadata for online images.

997

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

998

"url": "A String", # The result image URL.

},

],

},

],

"partialMatchingImages": [ # Partial matching images from the Internet.

1004

# Those images are similar enough to share some key-point features. For

1005

# example an original image will likely have partial matching for its crops.

1006

{ # Metadata for online images.

1007

"score": 3.14, # (Deprecated) Overall relevancy score for the image.

1008

"url": "A String", # The result image URL.

},

],

},

"safeSearchAnnotation": { # Set of features pertaining to the image, computed by computer vision # If present, safe-search annotation has completed successfully.

1013

# methods over safe-search verticals (for example, adult, spoof, medical,

1014

# violence).

1015

"adult": "A String", # Represents the adult content likelihood for the image. Adult content may

1016

# contain elements such as nudity, pornographic images or cartoons, or

1017

# sexual activities.

1018

"spoof": "A String", # Spoof likelihood. The likelihood that an modification

1019

# was made to the image's canonical version to make it appear

1020

# funny or offensive.

1021

"medical": "A String", # Likelihood that this is a medical image.

1022

"racy": "A String", # Likelihood that the request image contains racy content. Racy content may

1023

# include (but is not limited to) skimpy or sheer clothing, strategically

1024

# covered nudity, lewd or provocative poses, or close-ups of sensitive

1025

# body areas.

1026

"violence": "A String", # Likelihood that this image contains violent content.

1027

},

1028

"landmarkAnnotations": [ # If present, landmark detection has completed successfully.

1029

{ # Set of detected entity features.

1030

"locale": "A String", # The language code for the locale in which the entity textual

1031

# `description` is expressed.

1032

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced

1033

# for `LABEL_DETECTION` features.

1034

"normalizedVertices": [ # The bounding polygon normalized vertices.

1035

{ # A vertex represents a 2D point in the image.

1036

# NOTE: the normalized vertex coordinates are relative to the original image

1037

# and range from 0 to 1.

1038

"x": 3.14, # X coordinate.

1039

"y": 3.14, # Y coordinate.

1040

},

1041

],

1042

"vertices": [ # The bounding polygon vertices.

1043

{ # A vertex represents a 2D point in the image.

1044

# NOTE: the vertex coordinates are in the same scale as the original image.

1045

"y": 42, # Y coordinate.

1046

"x": 42, # X coordinate.

},

],

},

"description": "A String", # Entity textual description, expressed in its `locale` language.

1051

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the

1052

# image. For example, the relevancy of "tower" is likely higher to an image

1053

# containing the detected "Eiffel Tower" than to an image containing a

1054

# detected distant towering building, even though the confidence that

1055

# there is a tower in each image may be the same. Range [0, 1].

1056

"properties": [ # Some entities may have optional user-supplied `Property` (name/value)

1057

# fields, such a score or string that qualifies the entity.

1058

{ # A `Property` consists of a user-supplied name/value pair.

1059

"value": "A String", # Value of the property.

1060

"uint64Value": "A String", # Value of numeric properties.

1061

"name": "A String", # Name of the property.

1062

},

1063

],

1064

"score": 3.14, # Overall score of the result. Range [0, 1].

1065

"locations": [ # The location information for the detected entity. Multiple

1066

# `LocationInfo` elements can be present because one location may

1067

# indicate the location of the scene in the image, and another location

1068

# may indicate the location of the place where the image was taken.

1069

# Location information is usually present for landmarks.

1070

{ # Detected entity location information.

1071

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.

1072

# of doubles representing degrees latitude and degrees longitude. Unless

1073

# specified otherwise, this must conform to the

1074

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1075

# standard</a>. Values must be within normalized ranges.

1076

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1077

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

},

},

],

"mid": "A String", # Opaque entity ID. Some IDs may be available in

1082

# [Google Knowledge Graph Search

1083

# API](https://developers.google.com/knowledge-graph/).

1084

"confidence": 3.14, # **Deprecated. Use `score` instead.**

1085

# The accuracy of the entity detection in an image.

1086

# For example, for an image in which the "Eiffel Tower" entity is detected,

1087

# this field represents the confidence that there is a tower in the query

1088

# image. Range [0, 1].

1089

},

1090

],

1091

"faceAnnotations": [ # If present, face detection has completed successfully.

1092

{ # A face annotation object contains the results of face detection.

1093

"underExposedLikelihood": "A String", # Under-exposed likelihood.

1094

"panAngle": 3.14, # Yaw angle, which indicates the leftward/rightward angle that the face is

1095

# pointing relative to the vertical plane perpendicular to the image. Range

1096

# [-180,180].

1097

"detectionConfidence": 3.14, # Detection confidence. Range [0, 1].

1098

"blurredLikelihood": "A String", # Blurred likelihood.

1099

"headwearLikelihood": "A String", # Headwear likelihood.

1100

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the face. The coordinates of the bounding box

1101

# are in the original image's scale.

1102

# The bounding box is computed to "frame" the face in accordance with human

1103

# expectations. It is based on the landmarker results.

1104

# Note that one or more x and/or y coordinates may not be generated in the

1105

# `BoundingPoly` (the polygon will be unbounded) if only a partial face

1106

# appears in the image to be annotated.

1107

"normalizedVertices": [ # The bounding polygon normalized vertices.

1108

{ # A vertex represents a 2D point in the image.

1109

# NOTE: the normalized vertex coordinates are relative to the original image

1110

# and range from 0 to 1.

1111

"x": 3.14, # X coordinate.

1112

"y": 3.14, # Y coordinate.

1113

},

1114

],

1115

"vertices": [ # The bounding polygon vertices.

1116

{ # A vertex represents a 2D point in the image.

1117

# NOTE: the vertex coordinates are in the same scale as the original image.

1118

"y": 42, # Y coordinate.

1119

"x": 42, # X coordinate.

},

],

},

"rollAngle": 3.14, # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation

1124

# of the face relative to the image vertical about the axis perpendicular to

1125

# the face. Range [-180,180].

1126

"sorrowLikelihood": "A String", # Sorrow likelihood.

1127

"tiltAngle": 3.14, # Pitch angle, which indicates the upwards/downwards angle that the face is

1128

# pointing relative to the image's horizontal plane. Range [-180,180].

1129

"fdBoundingPoly": { # A bounding polygon for the detected image annotation. # The `fd_bounding_poly` bounding polygon is tighter than the

1130

# `boundingPoly`, and encloses only the skin part of the face. Typically, it

1131

# is used to eliminate the face from any image analysis that detects the

1132

# "amount of skin" visible in an image. It is not based on the

1133

# landmarker results, only on the initial face detection, hence

1134

# the <code>fd</code> (face detection) prefix.

1135

"normalizedVertices": [ # The bounding polygon normalized vertices.

1136

{ # A vertex represents a 2D point in the image.

1137

# NOTE: the normalized vertex coordinates are relative to the original image

1138

# and range from 0 to 1.

1139

"x": 3.14, # X coordinate.

1140

"y": 3.14, # Y coordinate.

1141

},

1142

],

1143

"vertices": [ # The bounding polygon vertices.

1144

{ # A vertex represents a 2D point in the image.

1145

# NOTE: the vertex coordinates are in the same scale as the original image.

1146

"y": 42, # Y coordinate.

1147

"x": 42, # X coordinate.

},

],

},

"angerLikelihood": "A String", # Anger likelihood.

1152

"landmarks": [ # Detected face landmarks.

1153

{ # A face-specific landmark (for example, a face feature).

1154

"type": "A String", # Face landmark type.

1155

"position": { # A 3D position in the image, used primarily for Face detection landmarks. # Face landmark position.

1156

# A valid Position must have both x and y coordinates.

1157

# The position coordinates are in the same scale as the original image.

1158

"x": 3.14, # X coordinate.

1159

"z": 3.14, # Z coordinate (or depth).

1160

"y": 3.14, # Y coordinate.

},

},

],

"surpriseLikelihood": "A String", # Surprise likelihood.

1165

"landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1].

1166

"joyLikelihood": "A String", # Joy likelihood.

1167

},

1168

],

1169

"cropHintsAnnotation": { # Set of crop hints that are used to generate new crops when serving images. # If present, crop hints have completed successfully.

1170

"cropHints": [ # Crop hint results.

1171

{ # Single crop hint that is used to generate a new crop when serving an image.

1172

"confidence": 3.14, # Confidence of this being a salient region. Range [0, 1].

1173

"importanceFraction": 3.14, # Fraction of importance of this salient region with respect to the original

1174

# image.

1175

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the crop region. The coordinates of the bounding

1176

# box are in the original image's scale.

1177

"normalizedVertices": [ # The bounding polygon normalized vertices.

1178

{ # A vertex represents a 2D point in the image.

1179

# NOTE: the normalized vertex coordinates are relative to the original image

1180

# and range from 0 to 1.

1181

"x": 3.14, # X coordinate.

1182

"y": 3.14, # Y coordinate.

1183

},

1184

],

1185

"vertices": [ # The bounding polygon vertices.

1186

{ # A vertex represents a 2D point in the image.

1187

# NOTE: the vertex coordinates are in the same scale as the original image.

1188

"y": 42, # Y coordinate.

1189

"x": 42, # X coordinate.

},

],

},

},

],

},

"labelAnnotations": [ # If present, label detection has completed successfully.

1197

{ # Set of detected entity features.

1198

"locale": "A String", # The language code for the locale in which the entity textual

1199

# `description` is expressed.

1200

"boundingPoly": { # A bounding polygon for the detected image annotation. # Image region to which this entity belongs. Not produced

1201

# for `LABEL_DETECTION` features.

1202

"normalizedVertices": [ # The bounding polygon normalized vertices.

1203

{ # A vertex represents a 2D point in the image.

1204

# NOTE: the normalized vertex coordinates are relative to the original image

1205

# and range from 0 to 1.

1206

"x": 3.14, # X coordinate.

1207

"y": 3.14, # Y coordinate.

1208

},

1209

],

1210

"vertices": [ # The bounding polygon vertices.

1211

{ # A vertex represents a 2D point in the image.

1212

# NOTE: the vertex coordinates are in the same scale as the original image.

1213

"y": 42, # Y coordinate.

1214

"x": 42, # X coordinate.

},

],

},

"description": "A String", # Entity textual description, expressed in its `locale` language.

1219

"topicality": 3.14, # The relevancy of the ICA (Image Content Annotation) label to the

1220

# image. For example, the relevancy of "tower" is likely higher to an image

1221

# containing the detected "Eiffel Tower" than to an image containing a

1222

# detected distant towering building, even though the confidence that

1223

# there is a tower in each image may be the same. Range [0, 1].

1224

"properties": [ # Some entities may have optional user-supplied `Property` (name/value)

1225

# fields, such a score or string that qualifies the entity.

1226

{ # A `Property` consists of a user-supplied name/value pair.

1227

"value": "A String", # Value of the property.

1228

"uint64Value": "A String", # Value of numeric properties.

1229

"name": "A String", # Name of the property.

1230

},

1231

],

1232

"score": 3.14, # Overall score of the result. Range [0, 1].

1233

"locations": [ # The location information for the detected entity. Multiple

1234

# `LocationInfo` elements can be present because one location may

1235

# indicate the location of the scene in the image, and another location

1236

# may indicate the location of the place where the image was taken.

1237

# Location information is usually present for landmarks.

1238

{ # Detected entity location information.

1239

"latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # lat/long location coordinates.

1240

# of doubles representing degrees latitude and degrees longitude. Unless

1241

# specified otherwise, this must conform to the

1242

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1243

# standard</a>. Values must be within normalized ranges.

1244

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1245

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

},

},

],

"mid": "A String", # Opaque entity ID. Some IDs may be available in

1250

# [Google Knowledge Graph Search

1251

# API](https://developers.google.com/knowledge-graph/).

1252

"confidence": 3.14, # **Deprecated. Use `score` instead.**

1253

# The accuracy of the entity detection in an image.

1254

# For example, for an image in which the "Eiffel Tower" entity is detected,

1255

# this field represents the confidence that there is a tower in the query

1256

# image. Range [0, 1].

1257

},

1258

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1265

<code class="details" id="asyncBatchAnnotate">asyncBatchAnnotate(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1266

<pre>Run asynchronous image detection and annotation for a list of images.

1267

1268

Progress and results can be retrieved through the

1269

`google.longrunning.Operations` interface.

1270

`Operation.metadata` contains `OperationMetadata` (metadata).

1271

`Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results).

1272

1273

This service will write image annotation outputs to json files in customer

1274

GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

1275

1276

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1277

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1278

The object takes the form of:

1279

1280

{ # Request for async image annotation for a list of images.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1281

"parent": "A String", # Optional. Target project and location to make a call.

1282

#

1283

# Format: `projects/{project-id}/locations/{location-id}`.

1284

#

1285

# If no parent is specified, a region will be chosen automatically.

1286

#

1287

# Supported location-ids:

1288

# `us`: USA country only,

1289

# `asia`: East asia areas, like Japan, Taiwan,

1290

# `eu`: The European Union.

1291

#

1292

# Example: `projects/project-A/locations/eu`.

1293

"outputConfig": { # The desired output location and metadata. # Required. The desired output location and metadata (e.g. format).

1294

"gcsDestination": { # The Google Cloud Storage location where the output will be written to. # The Google Cloud Storage location to write the output(s) to.

1295

"uri": "A String", # Google Cloud Storage URI prefix where the results will be stored. Results

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1296

# will be in JSON format and preceded by its corresponding input URI prefix.

1297

# This field can either represent a gcs file prefix or gcs directory. In

1298

# either case, the uri should be unique because in order to get all of the

1299

# output files, you will need to do a wildcard gcs search on the uri prefix

# you provide.

#

# Examples:

#

# * File Prefix: gs://bucket-name/here/filenameprefix The output files

1305

# will be created in gs://bucket-name/here/ and the names of the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1306

# output files will begin with "filenameprefix".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1307

#

1308

# * Directory Prefix: gs://bucket-name/some/location/ The output files

1309

# will be created in gs://bucket-name/some/location/ and the names of the

1310

# output files could be anything because there was no filename prefix

1311

# specified.

1312

#

1313

# If multiple outputs, each response is still AnnotateFileResponse, each of

1314

# which contains some subset of the full list of AnnotateImageResponse.

1315

# Multiple outputs can happen if, for example, the output JSON is too large

1316

# and overflows into multiple sharded files.

1317

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1318

"batchSize": 42, # The max number of response protos to put into each output JSON file on

1319

# Google Cloud Storage.

1320

# The valid range is [1, 100]. If not specified, the default value is 20.

1321

#

1322

# For example, for one pdf file with 100 pages, 100 response protos will

1323

# be generated. If `batch_size` = 20, then 5 json files each

1324

# containing 20 response protos will be written under the prefix

1325

# `gcs_destination`.`uri`.

1326

#

1327

# Currently, batch_size only applies to GcsDestination, with potential future

1328

# support for other output configurations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1329

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1330

"requests": [ # Required. Individual image annotation requests for this batch.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1331

{ # Request for performing Google Cloud Vision API tasks over a user-provided

1332

# image, with user-requested features, and with context information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1333

"image": { # Client image to perform Google Cloud Vision API tasks over. # The image to be processed.

1334

"content": "A String", # Image content, represented as a stream of bytes.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1335

# Note: As with all `bytes` fields, protobuffers use a pure binary

1336

# representation, whereas JSON representations use base64.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1337

"source": { # External image source (Google Cloud Storage or web URL image location). # Google Cloud Storage image location, or publicly-accessible image

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1338

# URL. If both `content` and `source` are provided for an image, `content`

1339

# takes precedence and is used to perform the image annotation request.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1340

"gcsImageUri": "A String", # **Use `image_uri` instead.**

1341

#

1342

# The Google Cloud Storage URI of the form

1343

# `gs://bucket_name/object_name`. Object versioning is not supported. See

1344

# [Google Cloud Storage Request

1345

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1346

"imageUri": "A String", # The URI of the source image. Can be either:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1347

#

1348

# 1. A Google Cloud Storage URI of the form

1349

# `gs://bucket_name/object_name`. Object versioning is not supported. See

1350

# [Google Cloud Storage Request

1351

# URIs](https://cloud.google.com/storage/docs/reference-uris) for more

1352

# info.

1353

#

1354

# 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from

1355

# HTTP/HTTPS URLs, Google cannot guarantee that the request will be

1356

# completed. Your request may fail if the specified host denies the

1357

# request (e.g. due to request throttling or DOS prevention), or if Google

1358

# throttles requests to the site for abuse prevention. You should not

1359

# depend on externally-hosted images for production applications.

1360

#

1361

# When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes

1362

# precedence.

1363

},

1364

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1365

"features": [ # Requested features.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1366

{ # The type of Google Cloud Vision API detection to perform, and the maximum

1367

# number of results to return for that type. Multiple `Feature` objects can

1368

# be specified in the `features` list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1369

"type": "A String", # The feature type.

1370

"maxResults": 42, # Maximum number of results of this type. Does not apply to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1371

# `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1372

"model": "A String", # Model to use for the feature.

1373

# Supported values: "builtin/stable" (the default if unset) and

1374

# "builtin/latest".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1375

},

1376

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1377

"imageContext": { # Image context and/or feature-specific parameters. # Additional context that may accompany the image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1378

"cropHintsParams": { # Parameters for crop hints annotation request. # Parameters for crop hints annotation request.

1379

"aspectRatios": [ # Aspect ratios in floats, representing the ratio of the width to the height

1380

# of the image. For example, if the desired aspect ratio is 4/3, the

1381

# corresponding float value should be 1.33333. If not specified, the

1382

# best possible crop is returned. The number of provided aspect ratios is

1383

# limited to a maximum of 16; any aspect ratios provided after the 16th are

# ignored.

3.14,

],

},

"productSearchParams": { # Parameters for a product search request. # Parameters for product search.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1389

"productCategories": [ # The list of product categories to search in. Currently, we only consider

1390

# the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",

1391

# "packagedgoods-v1", or "general-v1" should be specified. The legacy

1392

# categories "homegoods", "apparel", and "toys" are still supported but will

1393

# be deprecated. For new products, please use "homegoods-v2", "apparel-v2",

1394

# or "toys-v2" for better product search accuracy. It is recommended to

1395

# migrate existing products to these categories as well.

1396

"A String",

1397

],

1398

"filter": "A String", # The filtering expression. This can be used to restrict search results based

1399

# on Product labels. We currently support an AND of OR of key-value

1400

# expressions, where each expression within an OR must have the same key. An

1401

# '=' should be used to connect the key and value.

1402

#

1403

# For example, "(color = red OR color = blue) AND brand = Google" is

1404

# acceptable, but "(color = red OR brand = Google)" is not acceptable.

1405

# "color: red" is not acceptable because it uses a ':' instead of an '='.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1406

"productSet": "A String", # The resource name of a ProductSet to be searched for similar images.

1407

#

1408

# Format is:

1409

# `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

1410

"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the area of interest in the image.

1411

# If it is not specified, system discretion will be applied.

1412

"normalizedVertices": [ # The bounding polygon normalized vertices.

1413

{ # A vertex represents a 2D point in the image.

1414

# NOTE: the normalized vertex coordinates are relative to the original image

1415

# and range from 0 to 1.

1416

"x": 3.14, # X coordinate.

1417

"y": 3.14, # Y coordinate.

1418

},

1419

],

1420

"vertices": [ # The bounding polygon vertices.

1421

{ # A vertex represents a 2D point in the image.

1422

# NOTE: the vertex coordinates are in the same scale as the original image.

1423

"y": 42, # Y coordinate.

1424

"x": 42, # X coordinate.

},

],

},

},

"languageHints": [ # List of languages to use for TEXT_DETECTION. In most cases, an empty value

1430

# yields the best results since it enables automatic language detection. For

1431

# languages based on the Latin alphabet, setting `language_hints` is not

1432

# needed. In rare cases, when the language of the text in the image is known,

1433

# setting a hint will help get better results (although it will be a

1434

# significant hindrance if the hint is wrong). Text detection returns an

1435

# error if one or more of the specified languages is not one of the

1436

# [supported languages](https://cloud.google.com/vision/docs/languages).

1437

"A String",

1438

],

1439

"webDetectionParams": { # Parameters for web detection request. # Parameters for web detection.

1440

"includeGeoResults": True or False, # Whether to include results derived from the geo information in the image.

1441

},

1442

"latLongRect": { # Rectangle determined by min and max `LatLng` pairs. # Not used.

1443

"maxLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Max lat/long pair.

1444

# of doubles representing degrees latitude and degrees longitude. Unless

1445

# specified otherwise, this must conform to the

1446

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1447

# standard</a>. Values must be within normalized ranges.

1448

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1449

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

1450

},

1451

"minLatLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # Min lat/long pair.

1452

# of doubles representing degrees latitude and degrees longitude. Unless

1453

# specified otherwise, this must conform to the

1454

# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84

1455

# standard</a>. Values must be within normalized ranges.

1456

"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].

1457

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].

1458

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1459

},

1460

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1461

},

1462

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1463

}

1464

1465

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1472

1473

{ # This resource represents a long-running operation that is the result of a

1474

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1475

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1476

# different programming environments, including REST APIs and RPC APIs. It is

1477

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1478

# three pieces of data: error code, error message, and error details.

1479

#

1480

# You can find out more about this error model and how to work with it in the

1481

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1482

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1483

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1484

# user-facing error message should be localized and sent in the

1485

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1486

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1487

# message types for APIs to use.

1488

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1489

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1490

},

1491

],

1492

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1493

"metadata": { # Service-specific metadata associated with the operation. It typically

1494

# contains progress information and common metadata such as create time.

1495

# Some services might not provide such metadata. Any method that returns a

1496

# long-running operation should document the metadata type, if any.

1497

"a_key": "", # Properties of the object. Contains field @type with type URL.

1498

},

1499

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1500

# If `true`, the operation is completed, and either `error` or `response` is

1501

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1502

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1503

# method returns no data on success, such as `Delete`, the response is

1504

# `google.protobuf.Empty`. If the original method is standard

1505

# `Get`/`Create`/`Update`, the response should be the resource. For other

1506

# methods, the response should have the type `XxxResponse`, where `Xxx`

1507

# is the original method name. For example, if the original method name

1508

# is `TakeSnapshot()`, the inferred response type is

1509

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1510

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1511

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1512

"name": "A String", # The server-assigned name, which is only unique within the same service that

Bu Sun Kim