Blame - docs/dyn/vision_v1p1beta1.projects.locations.files.html - platform/external/python/google-api-python-client

<h1><a href="vision_v1p1beta1.html">Cloud Vision API</a> . <a href="vision_v1p1beta1.projects.html">projects</a> . <a href="vision_v1p1beta1.projects.locations.html">locations</a> . <a href="vision_v1p1beta1.projects.locations.files.html">files</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#annotate">annotate(parent, body=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Service that performs image detection and annotation for a batch of files.</p>

80

81

<code><a href="#asyncBatchAnnotate">asyncBatchAnnotate(parent, body=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Run asynchronous image detection and annotation for a list of generic</p>

83

<h3>Method Details</h3>

84

85

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

86

<pre>Service that performs image detection and annotation for a batch of files.

87

Now only "application/pdf", "image/tiff" and "image/gif" are supported.

88

89

This service will extract at most 5 (customers can specify which 5 in

90

AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each

91

file provided and perform detection and annotation for each image

extracted.

Args:

parent: string, Optional. Target project and location to make a call.

96

97

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

98

99

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

100

101

Supported location-ids:

102

`us`: USA country only,

103

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

104

`eu`: The European Union.

105

106

Example: `projects/project-A/locations/eu`. (required)

107

body: object, The request body.

108

The object takes the form of:

109

110

{ # A list of requests to annotate files using the BatchAnnotateFiles API.

Bu Sun Kim

6502091

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

[diff] [blame]

111

"requests": [ # Required. The list of file annotation requests. Right now we support only one

112

# AnnotateFileRequest in BatchAnnotateFilesRequest.

113

{ # A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

Bu Sun Kim

6502091

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

[diff] [blame]

114

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

115

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

116

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

117

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

118

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

119

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

120

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

121

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

122

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

123

"A String",

124

],

125

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

126

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

127

},

128

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

129

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

130

# of doubles representing degrees latitude and degrees longitude. Unless

131

# specified otherwise, this must conform to the

132

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

133

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

134

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

135

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

136

},

137

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

138

# of doubles representing degrees latitude and degrees longitude. Unless

139

# specified otherwise, this must conform to the

140

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

141

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

142

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

143

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

144

},

145

},

146

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

147

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

148

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

149

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

150

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

151

# 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

6502091

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

[diff] [blame]

157

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

158

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

159

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

160

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

161

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

162

# and range from 0 to 1.

163

"y": 3.14, # Y coordinate.

164

"x": 3.14, # X coordinate.

165

},

166

],

167

"vertices": [ # The bounding polygon vertices.

168

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

169

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

170

"y": 42, # Y coordinate.

171

"x": 42, # X coordinate.

},

],

},

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

176

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

177

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

178

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

179

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

180

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

181

# migrate existing products to these categories as well.

182

"A String",

183

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

184

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

185

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

186

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

187

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

188

#

189

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

190

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

191

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

192

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

193

#

194

# Format is:

195

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

Bu Sun Kim

6502091

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

[diff] [blame]

196

},

197

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

198

"pages": [ # Pages of the file to perform image annotation.

199

#

200

# Pages starts from 1, we assume the first page of the file is page 1.

201

# At most 5 pages are supported per request. Pages can be negative.

202

#

203

# Page 1 means the first page.

204

# Page 2 means the second page.

205

# Page -1 means the last page.

206

# Page -2 means the second to the last page.

207

#

208

# If the file is GIF instead of PDF or TIFF, page refers to GIF frames.

209

#

210

# If this field is empty, by default the service performs image annotation

211

# for the first 5 pages of the file.

212

42,

213

],

214

"inputConfig": { # The desired input location and metadata. # Required. Information about the input file.

215

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

216

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

217

# representation, whereas JSON representations use base64.

218

#

219

# Currently, this field only works for BatchAnnotateFiles requests. It does

220

# not work for AsyncBatchAnnotateFiles requests.

221

"gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.

222

"uri": "A String", # Google Cloud Storage URI for the input file. This must only be a

223

# Google Cloud Storage object. Wildcards are not currently supported.

224

},

225

"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and

226

# "image/gif" are supported. Wildcards are not supported.

227

},

228

"features": [ # Required. Requested features.

229

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

230

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

231

# be specified in the `features` list.

232

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

233

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

234

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

235

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

236

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

237

# "builtin/latest".

238

},

239

],

Bu Sun Kim

6502091

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

[diff] [blame]

240

},

241

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

242

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

243

#

244

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

245

#

246

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

247

#

248

# Supported location-ids:

249

# `us`: USA country only,

250

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

251

# `eu`: The European Union.

252

#

253

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

Bu Sun Kim

6502091

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

[diff] [blame]

254

}

255

256

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

263

264

{ # A list of file annotation responses.

265

"responses": [ # The list of file annotation responses, each response corresponding to each

266

# AnnotateFileRequest in BatchAnnotateFilesRequest.

267

{ # Response to a single file annotation request. A file may contain one or more

268

# images, which individually have their own responses.

Bu Sun Kim

6502091

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

[diff] [blame]

269

"responses": [ # Individual responses to images found within the file. This field will be

270

# empty if the `error` field is set.

271

{ # Response to an image annotation request.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

272

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

273

# This will be sorted descending by confidence score.

274

{ # Set of detected objects with bounding boxes.

275

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

276

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

Bu Sun Kim

6502091

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

[diff] [blame]

277

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

278

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

279

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

280

# and range from 0 to 1.

281

"y": 3.14, # Y coordinate.

282

"x": 3.14, # X coordinate.

283

},

284

],

285

"vertices": [ # The bounding polygon vertices.

286

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

287

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

288

"y": 42, # Y coordinate.

289

"x": 42, # X coordinate.

290

},

291

],

292

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

293

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

294

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

295

# information, see

296

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

297

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

Bu Sun Kim

6502091

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

[diff] [blame]

298

},

299

],

300

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

301

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

302

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

303

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

304

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

305

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

306

# image.

Bu Sun Kim

6502091

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

[diff] [blame]

307

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

308

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

309

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

310

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

311

# and range from 0 to 1.

312

"y": 3.14, # Y coordinate.

313

"x": 3.14, # X coordinate.

314

},

315

],

316

"vertices": [ # The bounding polygon vertices.

317

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

318

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

319

"y": 42, # Y coordinate.

320

"x": 42, # X coordinate.

},

],

},

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

325

{ # Information about a product.

326

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

327

# to the query.

328

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

329

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

330

#

331

# Format is:

332

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

333

#

334

# This field is ignored when creating a product.

Bu Sun Kim

6502091

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

[diff] [blame]

335

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

336

# 4096 characters long.

337

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

338

# characters long.

339

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

340

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

341

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

342

# not be used for new products.

343

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

344

# constraints can be specified based on the product_labels.

345

#

346

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

347

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

348

# to be supported soon.

349

#

350

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

351

# 500 product_labels.

352

#

353

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

354

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

355

# will refuse to work for that ProductSet.

356

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

357

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

358

# exceed 128 bytes.

359

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

360

# cannot exceed 128 bytes.

361

},

362

],

Bu Sun Kim

6502091

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

[diff] [blame]

363

},

364

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

365

# 1 (full confidence).

366

},

367

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

368

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

369

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

370

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

371

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

372

# information, see

373

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

374

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

375

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

376

},

377

],

Bu Sun Kim

6502091

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

[diff] [blame]

378

},

379

],

380

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

381

{ # Information about a product.

382

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

383

# to the query.

384

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

385

"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.

Bu Sun Kim

6502091

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

[diff] [blame]

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

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

400

# constraints can be specified based on the product_labels.

401

#

402

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

403

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

404

# to be supported soon.

405

#

406

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

407

# 500 product_labels.

408

#

409

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

410

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

411

# will refuse to work for that ProductSet.

412

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

413

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

414

# exceed 128 bytes.

415

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

416

# cannot exceed 128 bytes.

417

},

418

],

Bu Sun Kim

6502091

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

[diff] [blame]

419

},

420

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

421

# 1 (full confidence).

422

},

423

],

424

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

425

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

426

# not reflected in the current results.

427

},

Bu Sun Kim

6502091

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

[diff] [blame]

428

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

429

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

430

# correct, even when `error` is set.

431

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

432

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

433

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

434

#

435

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

436

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

Bu Sun Kim

6502091

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

[diff] [blame]

437

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

438

# message types for APIs to use.

439

{

440

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

441

},

442

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

443

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

444

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

445

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

446

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

Bu Sun Kim

6502091

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

[diff] [blame]

447

},

448

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

449

# completed successfully.

450

# This annotation provides the structural hierarchy for the OCR detected

451

# text.

452

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

453

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

454

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

455

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

456

# to the TextAnnotation.TextProperty message definition below for more

457

# detail.

458

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

459

{ # Detected page from OCR.

Bu Sun Kim

6502091

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

[diff] [blame]

460

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

461

{ # Logical element on the page.

462

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

463

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

464

{ # Detected language for a structural component.

465

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

466

# information, see

467

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

468

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

469

},

470

],

471

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

472

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

473

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

474

},

475

},

476

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

477

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

478

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

479

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

480

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

481

# read in the 'natural' orientation.

482

# For example:

483

#

484

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

#

# 0----1

# | |

# 3----2

#

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

#

# 2----3

# | |

# 1----0

#

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

497

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

498

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

499

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

500

# and range from 0 to 1.

501

"y": 3.14, # Y coordinate.

502

"x": 3.14, # X coordinate.

503

},

504

],

505

"vertices": [ # The bounding polygon vertices.

506

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

507

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

508

"y": 42, # Y coordinate.

509

"x": 42, # X coordinate.

},

],

},

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

514

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

515

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

516

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

517

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

518

{ # Detected language for a structural component.

519

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

520

# information, see

521

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

522

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

523

},

524

],

525

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

526

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

527

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

528

},

529

},

530

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

531

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

532

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

533

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

534

# read in the 'natural' orientation.

535

# For example:

536

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

# 0----1

# | |

# 3----2

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

# 2----3

# | |

# 1----0

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

545

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

546

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

547

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

548

# and range from 0 to 1.

549

"y": 3.14, # Y coordinate.

550

"x": 3.14, # X coordinate.

551

},

552

],

553

"vertices": [ # The bounding polygon vertices.

554

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

555

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

556

"y": 42, # Y coordinate.

557

"x": 42, # X coordinate.

},

],

},

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

562

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

563

{ # A word representation.

564

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

565

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

566

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

567

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

568

# read in the 'natural' orientation.

569

# For example:

570

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

# 0----1

# | |

# 3----2

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

# 2----3

# | |

# 1----0

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

579

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

580

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

581

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

582

# and range from 0 to 1.

583

"y": 3.14, # Y coordinate.

584

"x": 3.14, # X coordinate.

585

},

586

],

587

"vertices": [ # The bounding polygon vertices.

588

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

589

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

590

"y": 42, # Y coordinate.

591

"x": 42, # X coordinate.

},

],

},

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

596

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

597

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

598

{ # A single symbol representation.

599

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

600

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

601

{ # Detected language for a structural component.

602

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

603

# information, see

604

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

605

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

606

},

607

],

608

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

609

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

610

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

611

},

612

},

613

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

614

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

615

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

616

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

617

# read in the 'natural' orientation.

618

# For example:

619

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

# 0----1

# | |

# 3----2

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

# 2----3

# | |

# 1----0

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

628

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

629

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

630

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

631

# and range from 0 to 1.

632

"y": 3.14, # Y coordinate.

633

"x": 3.14, # X coordinate.

634

},

635

],

636

"vertices": [ # The bounding polygon vertices.

637

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

638

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

639

"y": 42, # Y coordinate.

640

"x": 42, # X coordinate.

},

],

},

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

645

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

646

},

647

],

648

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

649

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

650

{ # Detected language for a structural component.

651

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

652

# information, see

653

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

654

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

655

},

656

],

657

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

658

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

659

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

},

},

},

],

},

],

},

],

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

669

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

670

{ # Detected language for a structural component.

671

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

672

# information, see

673

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

674

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

675

},

676

],

677

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

678

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

679

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

680

},

681

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

682

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

683

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

684

# TIFFs) the unit is pixels.

685

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

686

# TIFFs) the unit is pixels.

Bu Sun Kim

6502091

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

[diff] [blame]

687

},

688

],

689

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

690

},

691

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

692

{ # Set of detected entity features.

Bu Sun Kim

6502091

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

[diff] [blame]

693

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

694

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

695

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

696

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

697

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

698

# Location information is usually present for landmarks.

699

{ # Detected entity location information.

700

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

701

# of doubles representing degrees latitude and degrees longitude. Unless

702

# specified otherwise, this must conform to the

703

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

704

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

705

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

706

"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

711

# [Google Knowledge Graph Search

712

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

713

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

714

# The accuracy of the entity detection in an image.

715

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

716

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

717

# image. Range [0, 1].

718

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

719

# for `LABEL_DETECTION` features.

720

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

721

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

722

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

723

# and range from 0 to 1.

724

"y": 3.14, # Y coordinate.

725

"x": 3.14, # X coordinate.

726

},

727

],

728

"vertices": [ # The bounding polygon vertices.

729

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

730

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

731

"y": 42, # Y coordinate.

732

"x": 42, # X coordinate.

},

],

},

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

737

# `description` is expressed.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

738

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

739

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

740

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

741

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

742

# detected distant towering building, even though the confidence that

743

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

744

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

745

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

746

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

747

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

748

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

749

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

750

},

751

],

Bu Sun Kim

6502091

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

[diff] [blame]

752

},

753

],

754

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

755

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

756

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

757

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

758

# the image that the color occupies in the image.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

759

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

Bu Sun Kim

6502091

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

[diff] [blame]

760

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

761

# Value in range [0, 1].

762

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

763

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

764

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

765

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

766

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

767

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

768

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

769

#

770

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

771

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

772

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

# space.

#

# Example (Java):

#

# import com.google.type.Color;

778

#

779

# // ...

780

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

781

# float alpha = protocolor.hasAlpha()

782

# ? protocolor.getAlpha().getValue()

783

# : 1.0;

784

#

785

# return new java.awt.Color(

786

# protocolor.getRed(),

787

# protocolor.getGreen(),

788

# protocolor.getBlue(),

# alpha);

# }

#

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

793

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

794

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

795

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

796

# float denominator = 255.0;

797

# Color.Builder resultBuilder =

798

# Color

799

# .newBuilder()

800

# .setRed(red / denominator)

801

# .setGreen(green / denominator)

802

# .setBlue(blue / denominator);

803

# int alpha = color.getAlpha();

804

# if (alpha != 255) {

# result.setAlpha(

# FloatValue

# .newBuilder()

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

809

# .build());

810

# }

811

# return resultBuilder.build();

# }

# // ...

#

# Example (iOS / Obj-C):

816

#

817

# // ...

818

# static UIColor* fromProto(Color* protocolor) {

819

# float red = [protocolor red];

820

# float green = [protocolor green];

821

# float blue = [protocolor blue];

822

# FloatValue* alpha_wrapper = [protocolor alpha];

823

# float alpha = 1.0;

824

# if (alpha_wrapper != nil) {

825

# alpha = [alpha_wrapper value];

826

# }

827

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

828

# }

829

#

830

# static Color* toProto(UIColor* color) {

831

# CGFloat red, green, blue, alpha;

832

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

833

# return nil;

834

# }

835

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

836

# [result setRed:red];

837

# [result setGreen:green];

838

# [result setBlue:blue];

839

# if (alpha <= 0.9999) {

840

# [result setAlpha:floatWrapperWithValue(alpha)];

841

# }

842

# [result autorelease];

# return result;

# }

# // ...

#

# Example (JavaScript):

#

# // ...

#

# var protoToCssColor = function(rgb_color) {

852

# var redFrac = rgb_color.red || 0.0;

853

# var greenFrac = rgb_color.green || 0.0;

854

# var blueFrac = rgb_color.blue || 0.0;

855

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

856

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

857

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

858

#

859

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

860

# return rgbToCssColor_(red, green, blue);

861

# }

862

#

863

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

864

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

865

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

866

# };

867

#

868

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

869

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

870

# var hexString = rgbNumber.toString(16);

871

# var missingZeros = 6 - hexString.length;

872

# var resultBuilder = ['#'];

873

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

874

# resultBuilder.push('0');

875

# }

876

# resultBuilder.push(hexString);

877

# return resultBuilder.join('');

# };

#

# // ...

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

882

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

883

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

884

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

885

# the final pixel color is defined by the equation:

886

#

887

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

888

#

889

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

890

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

891

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

892

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

893

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

894

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

895

},

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

},

},

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

901

{ # Set of detected entity features.

Bu Sun Kim

6502091

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

[diff] [blame]

902

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

903

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

904

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

905

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

906

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

907

# Location information is usually present for landmarks.

908

{ # Detected entity location information.

909

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

910

# of doubles representing degrees latitude and degrees longitude. Unless

911

# specified otherwise, this must conform to the

912

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

913

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

914

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

915

"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

920

# [Google Knowledge Graph Search

921

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

922

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

923

# The accuracy of the entity detection in an image.

924

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

925

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

926

# image. Range [0, 1].

927

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

928

# for `LABEL_DETECTION` features.

929

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

930

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

931

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

932

# and range from 0 to 1.

933

"y": 3.14, # Y coordinate.

934

"x": 3.14, # X coordinate.

935

},

936

],

937

"vertices": [ # The bounding polygon vertices.

938

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

939

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

940

"y": 42, # Y coordinate.

941

"x": 42, # X coordinate.

},

],

},

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

946

# `description` is expressed.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

947

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

948

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

949

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

950

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

951

# detected distant towering building, even though the confidence that

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

},

960

],

Bu Sun Kim

6502091

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

[diff] [blame]

961

},

962

],

963

"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

964

# comes from.

965

# information about the source of that image.

966

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

967

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

968

# the file used to produce the image.

969

},

970

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

971

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

972

{ # Metadata for online images.

973

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

974

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

975

},

976

],

977

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

978

# Inferred from similar images on the open web.

979

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

980

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

981

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

982

# For more information, see

983

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

984

},

985

],

986

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

987

# Can include resized copies of the query image.

988

{ # Metadata for online images.

989

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

990

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

991

},

992

],

993

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

994

{ # Entity deduced from similar images on the Internet.

995

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

996

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

997

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

998

# Not normalized and not comparable across different image queries.

999

},

1000

],

1001

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

1002

{ # Metadata for web pages.

Bu Sun Kim

6502091

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

[diff] [blame]

1003

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

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

1006

# crops.

1007

{ # Metadata for online images.

1008

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

1009

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

1010

},

1011

],

1012

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

1013

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

1014

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

1015

# Can include resized copies of the query image.

1016

{ # Metadata for online images.

1017

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

1018

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

1019

},

1020

],

1021

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

Bu Sun Kim

6502091

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

[diff] [blame]

1022

},

1023

],

1024

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

1025

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

1026

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

1027

{ # Metadata for online images.

1028

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

1029

"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.

1034

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

1035

# violence).

Bu Sun Kim

6502091

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

[diff] [blame]

1036

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

1037

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

1038

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

1039

# sexual activities.

1040

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

1041

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

1042

# funny or offensive.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

1043

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

1044

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

1045

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

1046

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

1047

# body areas.

Bu Sun Kim

6502091

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

[diff] [blame]

1048

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

1049

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

1050

{ # Set of detected entity features.

1051

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

1052

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

1053

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

1054

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

1055

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

1056

# Location information is usually present for landmarks.

1057

{ # Detected entity location information.

1058

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

1059

# of doubles representing degrees latitude and degrees longitude. Unless

1060

# specified otherwise, this must conform to the

1061

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

1062

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

1063

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

1064

"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

1069

# [Google Knowledge Graph Search

1070

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

1071

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

1072

# The accuracy of the entity detection in an image.

1073

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

1074

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

1075

# image. Range [0, 1].

1076

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

1077

# for `LABEL_DETECTION` features.

1078

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

1079

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

1080

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

1081

# and range from 0 to 1.

1082

"y": 3.14, # Y coordinate.

1083

"x": 3.14, # X coordinate.

1084

},

1085

],

1086

"vertices": [ # The bounding polygon vertices.

1087

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

1088

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

1089

"y": 42, # Y coordinate.

1090

"x": 42, # X coordinate.

},

],

},

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

1095

# `description` is expressed.

1096

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

1097

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

1098

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

1099

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

1100

# detected distant towering building, even though the confidence that

1101

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

1102

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

1103

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

1104

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

1105

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

1106

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

1107

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

},

],

},

],

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

1113

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

1114

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

1115

"landmarks": [ # Detected face landmarks.

1116

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

1117

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

1118

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

1119

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

1120

"x": 3.14, # X coordinate.

1121

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

1122

"y": 3.14, # Y coordinate.

1123

},

1124

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

1125

},

1126

],

1127

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

1128

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

1129

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

1130

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

1131

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

1132

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

1133

# [-180,180].

1134

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

1135

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

1136

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

1137

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

1138

# are in the original image's scale.

1139

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

1140

# expectations. It is based on the landmarker results.

1141

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

1142

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

1143

# appears in the image to be annotated.

1144

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

1145

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

1146

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

1147

# and range from 0 to 1.

1148

"y": 3.14, # Y coordinate.

1149

"x": 3.14, # X coordinate.

1150

},

1151

],

1152

"vertices": [ # The bounding polygon vertices.

1153

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

1154

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

1155

"y": 42, # Y coordinate.

1156

"x": 42, # X coordinate.

},

],

},

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

1161

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

1162

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

1163

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

1164

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

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

# and range from 0 to 1.

1176

"y": 3.14, # Y coordinate.

1177

"x": 3.14, # X coordinate.

1178

},

1179

],

1180

"vertices": [ # The bounding polygon vertices.

1181

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

1182

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

1183

"y": 42, # Y coordinate.

1184

"x": 42, # X coordinate.

},

],

},

},

],

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

1191

"cropHints": [ # Crop hint results.

1192

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

1193

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

1194

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

1195

# image.

1196

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

1197

# box are in the original image's scale.

1198

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

1199

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

1200

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

1201

# and range from 0 to 1.

1202

"y": 3.14, # Y coordinate.

1203

"x": 3.14, # X coordinate.

1204

},

1205

],

1206

"vertices": [ # The bounding polygon vertices.

1207

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

1208

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

1209

"y": 42, # Y coordinate.

1210

"x": 42, # X coordinate.

},

],

},

},

],

},

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

1218

{ # Set of detected entity features.

1219

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

1220

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

1221

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

1222

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

1223

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

1224

# Location information is usually present for landmarks.

1225

{ # Detected entity location information.

1226

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

1227

# of doubles representing degrees latitude and degrees longitude. Unless

1228

# specified otherwise, this must conform to the

1229

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

1230

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

1231

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

1232

"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

1237

# [Google Knowledge Graph Search

1238

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

1239

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

1240

# The accuracy of the entity detection in an image.

1241

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

1242

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

1243

# image. Range [0, 1].

1244

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

1245

# for `LABEL_DETECTION` features.

1246

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

1247

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

1248

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

1249

# and range from 0 to 1.

1250

"y": 3.14, # Y coordinate.

1251

"x": 3.14, # X coordinate.

1252

},

1253

],

1254

"vertices": [ # The bounding polygon vertices.

1255

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

1256

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

1257

"y": 42, # Y coordinate.

1258

"x": 42, # X coordinate.

},

],

},

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

1263

# `description` is expressed.

1264

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

1265

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

1266

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

1267

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

1268

# detected distant towering building, even though the confidence that

1269

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

1270

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

1271

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

1272

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

1273

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

1274

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

1275

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

},

],

},

],

Bu Sun Kim

6502091

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

[diff] [blame]

1280

},

1281

],

1282

"inputConfig": { # The desired input location and metadata. # Information about the file for which this response is generated.

1283

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

1284

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

1285

# representation, whereas JSON representations use base64.

1286

#

1287

# Currently, this field only works for BatchAnnotateFiles requests. It does

1288

# not work for AsyncBatchAnnotateFiles requests.

1289

"gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.

1290

"uri": "A String", # Google Cloud Storage URI for the input file. This must only be a

1291

# Google Cloud Storage object. Wildcards are not currently supported.

1292

},

1293

"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and

1294

# "image/gif" are supported. Wildcards are not supported.

1295

},

1296

"totalPages": 42, # This field gives the total number of pages in the file.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

1297

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

1298

# `responses` field will not be set in this case.

1299

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

1300

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

1301

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

1302

#

1303

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

1304

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

1305

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

1306

# message types for APIs to use.

1307

{

1308

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

1309

},

1310

],

1311

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

1312

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

1313

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

1314

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

1315

},

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

}</pre>

</div>

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

1323

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

1324

files, such as PDF files, which may contain multiple pages and multiple

1325

images per page. Progress and results can be retrieved through the

1326

`google.longrunning.Operations` interface.

1327

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

1328

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

1329

1330

Args:

1331

parent: string, Optional. Target project and location to make a call.

1332

1333

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

1334

1335

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

1336

1337

Supported location-ids:

1338

`us`: USA country only,

1339

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

1340

`eu`: The European Union.

1341

1342

Example: `projects/project-A/locations/eu`. (required)

1343

body: object, The request body.

1344

The object takes the form of:

1345

1346

{ # Multiple async file annotation requests are batched into a single service

1347

# call.

1348

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

1349

{ # An offline file annotation request.

1350

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

1351

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

1352

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

1353

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

1354

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

1355

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

1356

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

1357

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

1358

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

1359

"A String",

1360

],

1361

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

1362

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

1363

},

1364

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

1365

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

1366

# of doubles representing degrees latitude and degrees longitude. Unless

1367

# specified otherwise, this must conform to the

1368

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

1369

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

1370

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

1371

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

1372

},

1373

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

1374

# of doubles representing degrees latitude and degrees longitude. Unless

1375

# specified otherwise, this must conform to the

1376

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

1377

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

1378

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

1379

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

1380

},

1381

},

1382

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

1383

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

1384

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

1385

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

1386

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

1387

# 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

6502091

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

[diff] [blame]

1393

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

1394

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

1395

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

1396

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

1397

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

1398

# and range from 0 to 1.

1399

"y": 3.14, # Y coordinate.

1400

"x": 3.14, # X coordinate.

1401

},

1402

],

1403

"vertices": [ # The bounding polygon vertices.

1404

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

1405

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

1406

"y": 42, # Y coordinate.

1407

"x": 42, # X coordinate.

},

],

},

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

1412

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

1413

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

1414

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

1415

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

1416

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

1417

# migrate existing products to these categories as well.

1418

"A String",

1419

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

1420

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

1421

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

1422

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

1423

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

1424

#

1425

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

1426

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

1427

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

1428

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

1429

#

1430

# Format is:

1431

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

Bu Sun Kim

6502091

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

[diff] [blame]

1432

},

1433

},

1434

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

1435

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

1436

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

1437

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

1438

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

1439

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

1440

# 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

1446

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

1447

# output files will begin with "filenameprefix".

1448

#

1449

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

1450

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

1451

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

1452

# specified.

1453

#

1454

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

1455

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

1456

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

1457

# and overflows into multiple sharded files.

1458

},

1459

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

1460

# Google Cloud Storage.

1461

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

1462

#

1463

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

1464

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

1465

# containing 20 response protos will be written under the prefix

1466

# `gcs_destination`.`uri`.

1467

#

1468

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

1469

# support for other output configurations.

1470

},

1471

"inputConfig": { # The desired input location and metadata. # Required. Information about the input file.

1472

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

1473

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

1474

# representation, whereas JSON representations use base64.

1475

#

1476

# Currently, this field only works for BatchAnnotateFiles requests. It does

1477

# not work for AsyncBatchAnnotateFiles requests.

1478

"gcsSource": { # The Google Cloud Storage location where the input will be read from. # The Google Cloud Storage location to read the input from.

1479

"uri": "A String", # Google Cloud Storage URI for the input file. This must only be a

1480

# Google Cloud Storage object. Wildcards are not currently supported.

1481

},

1482

"mimeType": "A String", # The type of the file. Currently only "application/pdf", "image/tiff" and

1483

# "image/gif" are supported. Wildcards are not supported.

1484

},

1485

"features": [ # Required. Requested features.

1486

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

1487

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

1488

# be specified in the `features` list.

1489

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

1490

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

1491

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

1492

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

1493

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

# "builtin/latest".

},

],

},

],

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

1500

#

1501

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

1502

#

1503

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

1504

#

1505

# Supported location-ids:

1506

# `us`: USA country only,

1507

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

1508

# `eu`: The European Union.

1509

#

1510

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

1511

}

1512

1513

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1520

1521

{ # This resource represents a long-running operation that is the result of a

1522

# network API call.

1523

"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.

1524

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

1525

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

1526

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

1527

#

1528

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

1529

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

Bu Sun Kim

6502091

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

[diff] [blame]

1530

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

1531

# message types for APIs to use.

1532

{

1533

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

1534

},

1535

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

1536

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

1537

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

1538

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

1539

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

Bu Sun Kim

6502091

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

[diff] [blame]

1540

},

1541

"metadata": { # Service-specific metadata associated with the operation. It typically

1542

# contains progress information and common metadata such as create time.

1543

# Some services might not provide such metadata. Any method that returns a

1544

# long-running operation should document the metadata type, if any.

1545

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

1546

},

1547

"done": True or False, # If the value is `false`, it means the operation is still in progress.

1548

# If `true`, the operation is completed, and either `error` or `response` is

1549

# available.

1550

"response": { # The normal response of the operation in case of success. If the original

1551

# method returns no data on success, such as `Delete`, the response is

1552

# `google.protobuf.Empty`. If the original method is standard

1553

# `Get`/`Create`/`Update`, the response should be the resource. For other

1554

# methods, the response should have the type `XxxResponse`, where `Xxx`

1555

# is the original method name. For example, if the original method name

1556

# is `TakeSnapshot()`, the inferred response type is

1557

# `TakeSnapshotResponse`.

1558

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

1559

},

1560

"name": "A String", # The server-assigned name, which is only unique within the same service that

1561

# originally returns it. If you use the default HTTP mapping, the

1562

# `name` should be a resource name ending with `operations/{unique_id}`.

}</pre>

</div>

</body></html>