/** * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { GaxiosPromise } from 'gaxios'; import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library'; import { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace vision_v1 { interface Options extends GlobalOptions { version: 'v1'; } interface StandardParameters { /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * API key. Your API key identifies your project and provides you with API * access, quota, and reports. Required unless you provide an OAuth 2.0 * token. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * Available to use for quota purposes for server-side applications. Can be * any arbitrary string assigned to a user, but should not exceed 40 * characters. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * Cloud Vision API * * Integrates Google Vision features, including image labeling, face, logo, * and landmark detection, optical character recognition (OCR), and detection * of explicit content, into applications. * * @example * const {google} = require('googleapis'); * const vision = google.vision('v1'); * * @namespace vision * @type {Function} * @version v1 * @variation v1 * @param {object=} options Options for Vision */ class Vision { files: Resource$Files; images: Resource$Images; locations: Resource$Locations; operations: Resource$Operations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * Request message for the `AddProductToProductSet` method. */ interface Schema$AddProductToProductSetRequest { /** * The resource name for the Product to be added to this ProductSet. Format * is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ product?: string; } /** * Response to a single file annotation request. A file may contain one or * more images, which individually have their own responses. */ interface Schema$AnnotateFileResponse { /** * Information about the file for which this response is generated. */ inputConfig?: Schema$InputConfig; /** * Individual responses to images found within the file. */ responses?: Schema$AnnotateImageResponse[]; } /** * Request for performing Google Cloud Vision API tasks over a user-provided * image, with user-requested features, and with context information. */ interface Schema$AnnotateImageRequest { /** * Requested features. */ features?: Schema$Feature[]; /** * The image to be processed. */ image?: Schema$Image; /** * Additional context that may accompany the image. */ imageContext?: Schema$ImageContext; } /** * Response to an image annotation request. */ interface Schema$AnnotateImageResponse { /** * If present, contextual information is needed to understand where this * image comes from. */ context?: Schema$ImageAnnotationContext; /** * If present, crop hints have completed successfully. */ cropHintsAnnotation?: Schema$CropHintsAnnotation; /** * If set, represents the error message for the operation. Note that * filled-in image annotations are guaranteed to be correct, even when * `error` is set. */ error?: Schema$Status; /** * If present, face detection has completed successfully. */ faceAnnotations?: Schema$FaceAnnotation[]; /** * If present, text (OCR) detection or document (OCR) text detection has * completed successfully. This annotation provides the structural hierarchy * for the OCR detected text. */ fullTextAnnotation?: Schema$TextAnnotation; /** * If present, image properties were extracted successfully. */ imagePropertiesAnnotation?: Schema$ImageProperties; /** * If present, label detection has completed successfully. */ labelAnnotations?: Schema$EntityAnnotation[]; /** * If present, landmark detection has completed successfully. */ landmarkAnnotations?: Schema$EntityAnnotation[]; /** * If present, localized object detection has completed successfully. This * will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$LocalizedObjectAnnotation[]; /** * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$EntityAnnotation[]; /** * If present, product search has completed successfully. */ productSearchResults?: Schema$ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ safeSearchAnnotation?: Schema$SafeSearchAnnotation; /** * If present, text (OCR) detection has completed successfully. */ textAnnotations?: Schema$EntityAnnotation[]; /** * If present, web detection has completed successfully. */ webDetection?: Schema$WebDetection; } /** * An offline file annotation request. */ interface Schema$AsyncAnnotateFileRequest { /** * Required. Requested features. */ features?: Schema$Feature[]; /** * Additional context that may accompany the image(s) in the file. */ imageContext?: Schema$ImageContext; /** * Required. Information about the input file. */ inputConfig?: Schema$InputConfig; /** * Required. The desired output location and metadata (e.g. format). */ outputConfig?: Schema$OutputConfig; } /** * The response for a single offline file annotation request. */ interface Schema$AsyncAnnotateFileResponse { /** * The output location and metadata from AsyncAnnotateFileRequest. */ outputConfig?: Schema$OutputConfig; } /** * Multiple async file annotation requests are batched into a single service * call. */ interface Schema$AsyncBatchAnnotateFilesRequest { /** * Individual async file annotation requests for this batch. */ requests?: Schema$AsyncAnnotateFileRequest[]; } /** * Response to an async batch file annotation request. */ interface Schema$AsyncBatchAnnotateFilesResponse { /** * The list of file annotation responses, one for each request in * AsyncBatchAnnotateFilesRequest. */ responses?: Schema$AsyncAnnotateFileResponse[]; } /** * Multiple image annotation requests are batched into a single service call. */ interface Schema$BatchAnnotateImagesRequest { /** * Individual image annotation requests for this batch. */ requests?: Schema$AnnotateImageRequest[]; } /** * Response to a batch image annotation request. */ interface Schema$BatchAnnotateImagesResponse { /** * Individual responses to image annotation requests within the batch. */ responses?: Schema$AnnotateImageResponse[]; } /** * Metadata for the batch operations such as the current state. This is * included in the `metadata` field of the `Operation` returned by the * `GetOperation` call of the `google::longrunning::Operations` service. */ interface Schema$BatchOperationMetadata { /** * The time when the batch request is finished and * google.longrunning.Operation.done is set to true. */ endTime?: string; /** * The current state of the batch operation. */ state?: string; /** * The time when the batch request was submitted to the server. */ submitTime?: string; } /** * Logical element on the page. */ interface Schema$Block { /** * Detected block type (text, image etc) for this block. */ blockType?: string; /** * The bounding box for the block. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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). */ boundingBox?: Schema$BoundingPoly; /** * Confidence of the OCR results on the block. Range [0, 1]. */ confidence?: number; /** * List of paragraphs in this block (if this blocks is of type text). */ paragraphs?: Schema$Paragraph[]; /** * Additional information detected for the block. */ property?: Schema$TextProperty; } /** * A bounding polygon for the detected image annotation. */ interface Schema$BoundingPoly { /** * The bounding polygon normalized vertices. */ normalizedVertices?: Schema$NormalizedVertex[]; /** * The bounding polygon vertices. */ vertices?: Schema$Vertex[]; } /** * The request message for Operations.CancelOperation. */ interface Schema$CancelOperationRequest { } /** * Represents a color in the RGBA color space. This representation is designed * for simplicity of conversion to/from color representations in various * languages over compactness; for example, the fields of this representation * can be trivially provided to the constructor of "java.awt.Color" * in Java; it can also be trivially provided to UIColor's * "+colorWithRed:green:blue:alpha" method in iOS; and, with just a * little work, it can be easily formatted into a CSS "rgba()" * string in JavaScript, as well. Here are some examples: Example (Java): * import com.google.type.Color; // ... public static * java.awt.Color fromProto(Color protocolor) { float alpha = * protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; * return new java.awt.Color( protocolor.getRed(), * protocolor.getGreen(), protocolor.getBlue(), alpha); * } public static Color toProto(java.awt.Color color) { float * red = (float) color.getRed(); float green = (float) * color.getGreen(); float blue = (float) color.getBlue(); float * denominator = 255.0; Color.Builder resultBuilder = Color * .newBuilder() .setRed(red / denominator) .setGreen(green / * denominator) .setBlue(blue / denominator); int alpha * = color.getAlpha(); if (alpha != 255) { result.setAlpha( * FloatValue .newBuilder() .setValue(((float) alpha) / * denominator) .build()); } return * resultBuilder.build(); } // ... Example (iOS / Obj-C): // * ... static UIColor* fromProto(Color* protocolor) { float red = * [protocolor red]; float green = [protocolor green]; float * blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor * alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { * alpha = [alpha_wrapper value]; } return [UIColor * colorWithRed:red green:green blue:blue alpha:alpha]; } static * Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; * if (![color getRed:&red green:&green blue:&blue * alpha:&alpha]) { return nil; } Color* * result = [[Color alloc] init]; [result setRed:red]; [result * setGreen:green]; [result setBlue:blue]; if (alpha <= * 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } * [result autorelease]; return result; } // ... Example * (JavaScript): // ... var protoToCssColor = function(rgb_color) { * var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green * || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = * Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); * var blue = Math.floor(blueFrac * 255); if (!('alpha' in * rgb_color)) { return rgbToCssColor_(red, green, blue); } * var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, * green, blue].join(','); return ['rgba(', rgbParams, * ',', alphaFrac, ')'].join(''); }; var * rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new * Number((red << 16) | (green << 8) | blue); var hexString * = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; * var resultBuilder = ['#']; for (var i = 0; i < * missingZeros; i++) { resultBuilder.push('0'); } * resultBuilder.push(hexString); return resultBuilder.join(''); * }; // ... */ interface Schema$Color { /** * The fraction of this color that should be applied to the pixel. That is, * the final pixel color is defined by the equation: pixel color = alpha * * (this color) + (1.0 - alpha) * (background color) This means that a * value of 1.0 corresponds to a solid color, whereas a value of 0.0 * corresponds to a completely transparent color. This uses a wrapper * message rather than a simple float scalar so that it is possible to * distinguish between a default value and the value being unset. If * omitted, this color object is to be rendered as a solid color (as if the * alpha value had been explicitly given with a value of 1.0). */ alpha?: number; /** * The amount of blue in the color as a value in the interval [0, 1]. */ blue?: number; /** * The amount of green in the color as a value in the interval [0, 1]. */ green?: number; /** * The amount of red in the color as a value in the interval [0, 1]. */ red?: number; } /** * Color information consists of RGB channels, score, and the fraction of the * image that the color occupies in the image. */ interface Schema$ColorInfo { /** * RGB components of the color. */ color?: Schema$Color; /** * The fraction of pixels the color occupies in the image. Value in range * [0, 1]. */ pixelFraction?: number; /** * Image-specific score for this color. Value in range [0, 1]. */ score?: number; } /** * Single crop hint that is used to generate a new crop when serving an image. */ interface Schema$CropHint { /** * The bounding polygon for the crop region. The coordinates of the bounding * box are in the original image's scale. */ boundingPoly?: Schema$BoundingPoly; /** * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number; /** * Fraction of importance of this salient region with respect to the * original image. */ importanceFraction?: number; } /** * Set of crop hints that are used to generate new crops when serving images. */ interface Schema$CropHintsAnnotation { /** * Crop hint results. */ cropHints?: Schema$CropHint[]; } /** * Parameters for crop hints annotation request. */ interface Schema$CropHintsParams { /** * Aspect ratios in floats, representing the ratio of the width to the * height of the image. For example, if the desired aspect ratio is 4/3, the * corresponding float value should be 1.33333. If not specified, the best * possible crop is returned. The number of provided aspect ratios is * limited to a maximum of 16; any aspect ratios provided after the 16th are * ignored. */ aspectRatios?: number[]; } /** * Detected start or end of a structural component. */ interface Schema$DetectedBreak { /** * True if break prepends the element. */ isPrefix?: boolean; /** * Detected break type. */ type?: string; } /** * Detected language for a structural component. */ interface Schema$DetectedLanguage { /** * Confidence of detected language. Range [0, 1]. */ confidence?: number; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } /** * Set of dominant colors and their corresponding scores. */ interface Schema$DominantColorsAnnotation { /** * RGB color values with their score and pixel fraction. */ colors?: Schema$ColorInfo[]; } /** * A generic empty message that you can re-use to avoid defining duplicated * empty messages in your APIs. A typical example is to use it as the request * or the response type of an API method. For instance: service Foo { rpc * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON * representation for `Empty` is empty JSON object `{}`. */ interface Schema$Empty { } /** * Set of detected entity features. */ interface Schema$EntityAnnotation { /** * Image region to which this entity belongs. Not produced for * `LABEL_DETECTION` features. */ boundingPoly?: Schema$BoundingPoly; /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection * in an image. For example, for an image in which the "Eiffel * Tower" entity is detected, this field represents the confidence that * there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** * Entity textual description, expressed in its `locale` language. */ description?: string; /** * The language code for the locale in which the entity textual * `description` is expressed. */ locale?: string; /** * The location information for the detected entity. Multiple `LocationInfo` * elements can be present because one location may indicate the location of * the scene in the image, and another location may indicate the location of * the place where the image was taken. Location information is usually * present for landmarks. */ locations?: Schema$LocationInfo[]; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph * Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** * Some entities may have optional user-supplied `Property` (name/value) * fields, such a score or string that qualifies the entity. */ properties?: Schema$Property[]; /** * Overall score of the result. Range [0, 1]. */ score?: number; /** * The relevancy of the ICA (Image Content Annotation) label to the image. * For example, the relevancy of "tower" is likely higher to an * image containing the detected "Eiffel Tower" than to an image * containing a detected distant towering building, even though the * confidence that there is a tower in each image may be the same. Range [0, * 1]. */ topicality?: number; } /** * A face annotation object contains the results of face detection. */ interface Schema$FaceAnnotation { /** * Anger likelihood. */ angerLikelihood?: string; /** * Blurred likelihood. */ blurredLikelihood?: string; /** * The bounding polygon around the face. The coordinates of the bounding box * are in the original image's scale. The bounding box is computed to * "frame" the face in accordance with human expectations. It is * based on the landmarker results. Note that one or more x and/or y * coordinates may not be generated in the `BoundingPoly` (the polygon will * be unbounded) if only a partial face appears in the image to be * annotated. */ boundingPoly?: Schema$BoundingPoly; /** * Detection confidence. Range [0, 1]. */ detectionConfidence?: number; /** * The `fd_bounding_poly` bounding polygon is tighter than the * `boundingPoly`, and encloses only the skin part of the face. Typically, * it is used to eliminate the face from any image analysis that detects the * "amount of skin" visible in an image. It is not based on the * landmarker results, only on the initial face detection, hence the * <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$BoundingPoly; /** * Headwear likelihood. */ headwearLikelihood?: string; /** * Joy likelihood. */ joyLikelihood?: string; /** * Face landmarking confidence. Range [0, 1]. */ landmarkingConfidence?: number; /** * Detected face landmarks. */ landmarks?: Schema$Landmark[]; /** * Yaw angle, which indicates the leftward/rightward angle that the face is * pointing relative to the vertical plane perpendicular to the image. Range * [-180,180]. */ panAngle?: number; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise * rotation of the face relative to the image vertical about the axis * perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** * Sorrow likelihood. */ sorrowLikelihood?: string; /** * Surprise likelihood. */ surpriseLikelihood?: string; /** * Pitch angle, which indicates the upwards/downwards angle that the face is * pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** * Under-exposed likelihood. */ underExposedLikelihood?: string; } /** * The type of Google Cloud Vision API detection to perform, and the maximum * number of results to return for that type. Multiple `Feature` objects can * be specified in the `features` list. */ interface Schema$Feature { /** * Maximum number of results of this type. Does not apply to * `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. */ maxResults?: number; /** * Model to use for the feature. Supported values: * "builtin/stable" (the default if unset) and * "builtin/latest". */ model?: string; /** * The feature type. */ type?: string; } /** * The Google Cloud Storage location where the output will be written to. */ interface Schema$GcsDestination { /** * Google Cloud Storage URI where the results will be stored. Results will * be in JSON format and preceded by its corresponding input URI. This field * can either represent a single file, or a prefix for multiple outputs. * Prefixes must end in a `/`. Examples: * File: * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ * * File: gs://bucket-name/prefix/here If multiple outputs, each * response is still AnnotateFileResponse, each of which contains some * subset of the full list of AnnotateImageResponse. Multiple outputs can * happen if, for example, the output JSON is too large and overflows into * multiple sharded files. */ uri?: string; } /** * The Google Cloud Storage location where the input will be read from. */ interface Schema$GcsSource { /** * Google Cloud Storage URI for the input file. This must only be a Google * Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** * Response to a single file annotation request. A file may contain one or * more images, which individually have their own responses. */ interface Schema$GoogleCloudVisionV1p1beta1AnnotateFileResponse { /** * Information about the file for which this response is generated. */ inputConfig?: Schema$GoogleCloudVisionV1p1beta1InputConfig; /** * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p1beta1AnnotateImageResponse[]; } /** * Response to an image annotation request. */ interface Schema$GoogleCloudVisionV1p1beta1AnnotateImageResponse { /** * If present, contextual information is needed to understand where this * image comes from. */ context?: Schema$GoogleCloudVisionV1p1beta1ImageAnnotationContext; /** * If present, crop hints have completed successfully. */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p1beta1CropHintsAnnotation; /** * If set, represents the error message for the operation. Note that * filled-in image annotations are guaranteed to be correct, even when * `error` is set. */ error?: Schema$Status; /** * If present, face detection has completed successfully. */ faceAnnotations?: Schema$GoogleCloudVisionV1p1beta1FaceAnnotation[]; /** * If present, text (OCR) detection or document (OCR) text detection has * completed successfully. This annotation provides the structural hierarchy * for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p1beta1TextAnnotation; /** * If present, image properties were extracted successfully. */ imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p1beta1ImageProperties; /** * If present, label detection has completed successfully. */ labelAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; /** * If present, landmark detection has completed successfully. */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; /** * If present, localized object detection has completed successfully. This * will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation[]; /** * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; /** * If present, product search has completed successfully. */ productSearchResults?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ safeSearchAnnotation?: Schema$GoogleCloudVisionV1p1beta1SafeSearchAnnotation; /** * If present, text (OCR) detection has completed successfully. */ textAnnotations?: Schema$GoogleCloudVisionV1p1beta1EntityAnnotation[]; /** * If present, web detection has completed successfully. */ webDetection?: Schema$GoogleCloudVisionV1p1beta1WebDetection; } /** * The response for a single offline file annotation request. */ interface Schema$GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse { /** * The output location and metadata from AsyncAnnotateFileRequest. */ outputConfig?: Schema$GoogleCloudVisionV1p1beta1OutputConfig; } /** * Response to an async batch file annotation request. */ interface Schema$GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse { /** * The list of file annotation responses, one for each request in * AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse[]; } /** * Logical element on the page. */ interface Schema$GoogleCloudVisionV1p1beta1Block { /** * Detected block type (text, image etc) for this block. */ blockType?: string; /** * The bounding box for the block. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * Confidence of the OCR results on the block. Range [0, 1]. */ confidence?: number; /** * List of paragraphs in this block (if this blocks is of type text). */ paragraphs?: Schema$GoogleCloudVisionV1p1beta1Paragraph[]; /** * Additional information detected for the block. */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; } /** * A bounding polygon for the detected image annotation. */ interface Schema$GoogleCloudVisionV1p1beta1BoundingPoly { /** * The bounding polygon normalized vertices. */ normalizedVertices?: Schema$GoogleCloudVisionV1p1beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ vertices?: Schema$GoogleCloudVisionV1p1beta1Vertex[]; } /** * Color information consists of RGB channels, score, and the fraction of the * image that the color occupies in the image. */ interface Schema$GoogleCloudVisionV1p1beta1ColorInfo { /** * RGB components of the color. */ color?: Schema$Color; /** * The fraction of pixels the color occupies in the image. Value in range * [0, 1]. */ pixelFraction?: number; /** * Image-specific score for this color. Value in range [0, 1]. */ score?: number; } /** * Single crop hint that is used to generate a new crop when serving an image. */ interface Schema$GoogleCloudVisionV1p1beta1CropHint { /** * The bounding polygon for the crop region. The coordinates of the bounding * box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number; /** * Fraction of importance of this salient region with respect to the * original image. */ importanceFraction?: number; } /** * Set of crop hints that are used to generate new crops when serving images. */ interface Schema$GoogleCloudVisionV1p1beta1CropHintsAnnotation { /** * Crop hint results. */ cropHints?: Schema$GoogleCloudVisionV1p1beta1CropHint[]; } /** * Set of dominant colors and their corresponding scores. */ interface Schema$GoogleCloudVisionV1p1beta1DominantColorsAnnotation { /** * RGB color values with their score and pixel fraction. */ colors?: Schema$GoogleCloudVisionV1p1beta1ColorInfo[]; } /** * Set of detected entity features. */ interface Schema$GoogleCloudVisionV1p1beta1EntityAnnotation { /** * Image region to which this entity belongs. Not produced for * `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection * in an image. For example, for an image in which the "Eiffel * Tower" entity is detected, this field represents the confidence that * there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** * Entity textual description, expressed in its `locale` language. */ description?: string; /** * The language code for the locale in which the entity textual * `description` is expressed. */ locale?: string; /** * The location information for the detected entity. Multiple `LocationInfo` * elements can be present because one location may indicate the location of * the scene in the image, and another location may indicate the location of * the place where the image was taken. Location information is usually * present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p1beta1LocationInfo[]; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph * Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** * Some entities may have optional user-supplied `Property` (name/value) * fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p1beta1Property[]; /** * Overall score of the result. Range [0, 1]. */ score?: number; /** * The relevancy of the ICA (Image Content Annotation) label to the image. * For example, the relevancy of "tower" is likely higher to an * image containing the detected "Eiffel Tower" than to an image * containing a detected distant towering building, even though the * confidence that there is a tower in each image may be the same. Range [0, * 1]. */ topicality?: number; } /** * A face annotation object contains the results of face detection. */ interface Schema$GoogleCloudVisionV1p1beta1FaceAnnotation { /** * Anger likelihood. */ angerLikelihood?: string; /** * Blurred likelihood. */ blurredLikelihood?: string; /** * The bounding polygon around the face. The coordinates of the bounding box * are in the original image's scale. The bounding box is computed to * "frame" the face in accordance with human expectations. It is * based on the landmarker results. Note that one or more x and/or y * coordinates may not be generated in the `BoundingPoly` (the polygon will * be unbounded) if only a partial face appears in the image to be * annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * Detection confidence. Range [0, 1]. */ detectionConfidence?: number; /** * The `fd_bounding_poly` bounding polygon is tighter than the * `boundingPoly`, and encloses only the skin part of the face. Typically, * it is used to eliminate the face from any image analysis that detects the * "amount of skin" visible in an image. It is not based on the * landmarker results, only on the initial face detection, hence the * <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * Headwear likelihood. */ headwearLikelihood?: string; /** * Joy likelihood. */ joyLikelihood?: string; /** * Face landmarking confidence. Range [0, 1]. */ landmarkingConfidence?: number; /** * Detected face landmarks. */ landmarks?: Schema$GoogleCloudVisionV1p1beta1FaceAnnotationLandmark[]; /** * Yaw angle, which indicates the leftward/rightward angle that the face is * pointing relative to the vertical plane perpendicular to the image. Range * [-180,180]. */ panAngle?: number; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise * rotation of the face relative to the image vertical about the axis * perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** * Sorrow likelihood. */ sorrowLikelihood?: string; /** * Surprise likelihood. */ surpriseLikelihood?: string; /** * Pitch angle, which indicates the upwards/downwards angle that the face is * pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** * Under-exposed likelihood. */ underExposedLikelihood?: string; } /** * A face-specific landmark (for example, a face feature). */ interface Schema$GoogleCloudVisionV1p1beta1FaceAnnotationLandmark { /** * Face landmark position. */ position?: Schema$GoogleCloudVisionV1p1beta1Position; /** * Face landmark type. */ type?: string; } /** * The Google Cloud Storage location where the output will be written to. */ interface Schema$GoogleCloudVisionV1p1beta1GcsDestination { /** * Google Cloud Storage URI where the results will be stored. Results will * be in JSON format and preceded by its corresponding input URI. This field * can either represent a single file, or a prefix for multiple outputs. * Prefixes must end in a `/`. Examples: * File: * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ * * File: gs://bucket-name/prefix/here If multiple outputs, each * response is still AnnotateFileResponse, each of which contains some * subset of the full list of AnnotateImageResponse. Multiple outputs can * happen if, for example, the output JSON is too large and overflows into * multiple sharded files. */ uri?: string; } /** * The Google Cloud Storage location where the input will be read from. */ interface Schema$GoogleCloudVisionV1p1beta1GcsSource { /** * Google Cloud Storage URI for the input file. This must only be a Google * Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** * If an image was produced from a file (e.g. a PDF), this message gives * information about the source of that image. */ interface Schema$GoogleCloudVisionV1p1beta1ImageAnnotationContext { /** * If the file was a PDF or TIFF, this field gives the page number within * the file used to produce the image. */ pageNumber?: number; /** * The URI of the file used to produce the image. */ uri?: string; } /** * Stores image properties, such as dominant colors. */ interface Schema$GoogleCloudVisionV1p1beta1ImageProperties { /** * If present, dominant colors completed successfully. */ dominantColors?: Schema$GoogleCloudVisionV1p1beta1DominantColorsAnnotation; } /** * The desired input location and metadata. */ interface Schema$GoogleCloudVisionV1p1beta1InputConfig { /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p1beta1GcsSource; /** * The type of the file. Currently only "application/pdf" and * "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } /** * Set of detected objects with bounding boxes. */ interface Schema$GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation { /** * Image region to which this object belongs. This must be populated. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** * Object ID that should align with EntityAnnotation mid. */ mid?: string; /** * Object name, expressed in its `language_code` language. */ name?: string; /** * Score of the result. Range [0, 1]. */ score?: number; } /** * Detected entity location information. */ interface Schema$GoogleCloudVisionV1p1beta1LocationInfo { /** * lat/long location coordinates. */ latLng?: Schema$LatLng; } /** * A vertex represents a 2D point in the image. NOTE: the normalized vertex * coordinates are relative to the original image and range from 0 to 1. */ interface Schema$GoogleCloudVisionV1p1beta1NormalizedVertex { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; } /** * Contains metadata for the BatchAnnotateImages operation. */ interface Schema$GoogleCloudVisionV1p1beta1OperationMetadata { /** * The time when the batch request was received. */ createTime?: string; /** * Current state of the batch operation. */ state?: string; /** * The time when the operation result was last updated. */ updateTime?: string; } /** * The desired output location and metadata. */ interface Schema$GoogleCloudVisionV1p1beta1OutputConfig { /** * The max number of response protos to put into each output JSON file on * Google Cloud Storage. The valid range is [1, 100]. If not specified, the * default value is 20. For example, for one pdf file with 100 pages, 100 * response protos will be generated. If `batch_size` = 20, then 5 json * files each containing 20 response protos will be written under the prefix * `gcs_destination`.`uri`. Currently, batch_size only applies to * GcsDestination, with potential future support for other output * configurations. */ batchSize?: number; /** * The Google Cloud Storage location to write the output(s) to. */ gcsDestination?: Schema$GoogleCloudVisionV1p1beta1GcsDestination; } /** * Detected page from OCR. */ interface Schema$GoogleCloudVisionV1p1beta1Page { /** * List of blocks of text, images etc on this page. */ blocks?: Schema$GoogleCloudVisionV1p1beta1Block[]; /** * Confidence of the OCR results on the page. Range [0, 1]. */ confidence?: number; /** * Page height. For PDFs the unit is points. For images (including TIFFs) * the unit is pixels. */ height?: number; /** * Additional information detected on the page. */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** * Page width. For PDFs the unit is points. For images (including TIFFs) the * unit is pixels. */ width?: number; } /** * Structural unit of text representing a number of words in certain order. */ interface Schema$GoogleCloudVisionV1p1beta1Paragraph { /** * The bounding box for the paragraph. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the paragraph. */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** * List of words in this paragraph. */ words?: Schema$GoogleCloudVisionV1p1beta1Word[]; } /** * A 3D position in the image, used primarily for Face detection landmarks. A * valid Position must have both x and y coordinates. The position coordinates * are in the same scale as the original image. */ interface Schema$GoogleCloudVisionV1p1beta1Position { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; /** * Z coordinate (or depth). */ z?: number; } /** * A Product contains ReferenceImages. */ interface Schema$GoogleCloudVisionV1p1beta1Product { /** * User-provided metadata to be stored with this product. Must be at most * 4096 characters long. */ description?: string; /** * The user-provided name for this Product. Must not be empty. Must be at * most 4096 characters long. */ displayName?: string; /** * The resource name of the product. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field * is ignored when creating a product. */ name?: string; /** * The category for the product identified by the reference image. This * should be either "homegoods", "apparel", or * "toys". This field is immutable. */ productCategory?: string; /** * Key-value pairs that can be attached to a product. At query time, * constraints can be specified based on the product_labels. Note that * integer values can be provided as strings, e.g. "1199". Only * strings with integer values can match a range-based restriction which is * to be supported soon. Multiple values can be assigned to the same key. * One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p1beta1ProductKeyValue[]; } /** * A product label represented as a key-value pair. */ interface Schema$GoogleCloudVisionV1p1beta1ProductKeyValue { /** * The key of the label attached to the product. Cannot be empty and cannot * exceed 128 bytes. */ key?: string; /** * The value of the label attached to the product. Cannot be empty and * cannot exceed 128 bytes. */ value?: string; } /** * Results for a product search request. */ interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResults { /** * Timestamp of the index which provided these results. Changes made after * this time are not reflected in the current results. */ indexTime?: string; /** * List of results grouped by products detected in the query image. Each * entry corresponds to one bounding polygon in the query image, and * contains the matching products specific to that region. There may be * duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult[]; /** * List of results, one for each product match. */ results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; } /** * Information about the products similar to a single product in a query * image. */ interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult { /** * The bounding polygon around the product detected in the query image. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * List of results, one for each product match. */ results?: Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult[]; } /** * Information about a product. */ interface Schema$GoogleCloudVisionV1p1beta1ProductSearchResultsResult { /** * The resource name of the image from the product that is the closest match * to the query. */ image?: string; /** * The Product. */ product?: Schema$GoogleCloudVisionV1p1beta1Product; /** * A confidence level on the match, ranging from 0 (no confidence) to 1 * (full confidence). */ score?: number; } /** * A `Property` consists of a user-supplied name/value pair. */ interface Schema$GoogleCloudVisionV1p1beta1Property { /** * Name of the property. */ name?: string; /** * Value of numeric properties. */ uint64Value?: string; /** * Value of the property. */ value?: string; } /** * Set of features pertaining to the image, computed by computer vision * methods over safe-search verticals (for example, adult, spoof, medical, * violence). */ interface Schema$GoogleCloudVisionV1p1beta1SafeSearchAnnotation { /** * Represents the adult content likelihood for the image. Adult content may * contain elements such as nudity, pornographic images or cartoons, or * sexual activities. */ adult?: string; /** * Likelihood that this is a medical image. */ medical?: string; /** * Likelihood that the request image contains racy content. Racy content may * include (but is not limited to) skimpy or sheer clothing, strategically * covered nudity, lewd or provocative poses, or close-ups of sensitive body * areas. */ racy?: string; /** * Spoof likelihood. The likelihood that an modification was made to the * image's canonical version to make it appear funny or offensive. */ spoof?: string; /** * Likelihood that this image contains violent content. */ violence?: string; } /** * A single symbol representation. */ interface Schema$GoogleCloudVisionV1p1beta1Symbol { /** * The bounding box for the symbol. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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 vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the symbol. */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** * The actual UTF-8 representation of the symbol. */ text?: string; } /** * TextAnnotation contains a structured representation of OCR extracted text. * The hierarchy of an OCR extracted text structure is like this: * TextAnnotation -> Page -> Block -> Paragraph -> Word -> * Symbol Each structural component, starting from Page, may further have * their own properties. Properties describe detected languages, breaks etc.. * Please refer to the TextAnnotation.TextProperty message definition below * for more detail. */ interface Schema$GoogleCloudVisionV1p1beta1TextAnnotation { /** * List of pages detected by OCR. */ pages?: Schema$GoogleCloudVisionV1p1beta1Page[]; /** * UTF-8 text detected on the pages. */ text?: string; } /** * Detected start or end of a structural component. */ interface Schema$GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak { /** * True if break prepends the element. */ isPrefix?: boolean; /** * Detected break type. */ type?: string; } /** * Detected language for a structural component. */ interface Schema$GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage { /** * Confidence of detected language. Range [0, 1]. */ confidence?: number; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } /** * Additional information detected on the structural component. */ interface Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty { /** * Detected start or end of a text segment. */ detectedBreak?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak; /** * A list of detected languages together with confidence. */ detectedLanguages?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage[]; } /** * A vertex represents a 2D point in the image. NOTE: the vertex coordinates * are in the same scale as the original image. */ interface Schema$GoogleCloudVisionV1p1beta1Vertex { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; } /** * Relevant information for the image from the Internet. */ interface Schema$GoogleCloudVisionV1p1beta1WebDetection { /** * The service's best guess as to the topic of the request image. * Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebLabel[]; /** * Fully matching images from the Internet. Can include resized copies of * the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** * Web pages containing the matching images from the Internet. */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebPage[]; /** * Partial matching images from the Internet. Those images are similar * enough to share some key-point features. For example an original image * will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** * The visually similar image results. */ visuallySimilarImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** * Deduced entities from similar images on the Internet. */ webEntities?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebEntity[]; } /** * Entity deduced from similar images on the Internet. */ interface Schema$GoogleCloudVisionV1p1beta1WebDetectionWebEntity { /** * Canonical description of the entity, in English. */ description?: string; /** * Opaque entity ID. */ entityId?: string; /** * Overall relevancy score for the entity. Not normalized and not comparable * across different image queries. */ score?: number; } /** * Metadata for online images. */ interface Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage { /** * (Deprecated) Overall relevancy score for the image. */ score?: number; /** * The result image URL. */ url?: string; } /** * Label to provide extra metadata for the web detection. */ interface Schema$GoogleCloudVisionV1p1beta1WebDetectionWebLabel { /** * Label for extra metadata. */ label?: string; /** * The BCP-47 language code for `label`, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } /** * Metadata for web pages. */ interface Schema$GoogleCloudVisionV1p1beta1WebDetectionWebPage { /** * Fully matching images on the page. Can include resized copies of the * query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** * Title for the web page, may contain HTML markups. */ pageTitle?: string; /** * Partial matching images on the page. Those images are similar enough to * share some key-point features. For example an original image will likely * have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p1beta1WebDetectionWebImage[]; /** * (Deprecated) Overall relevancy score for the web page. */ score?: number; /** * The result web page URL. */ url?: string; } /** * A word representation. */ interface Schema$GoogleCloudVisionV1p1beta1Word { /** * The bounding box for the word. The vertices are in the order of top-left, * top-right, bottom-right, bottom-left. When a rotation of the bounding box * is detected the rotation is represented as around the top-left corner as * defined when the text is read in the 'natural' orientation. For * example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** * Confidence of the OCR results for the word. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the word. */ property?: Schema$GoogleCloudVisionV1p1beta1TextAnnotationTextProperty; /** * List of symbols in the word. The order of the symbols follows the natural * reading order. */ symbols?: Schema$GoogleCloudVisionV1p1beta1Symbol[]; } /** * Response to a single file annotation request. A file may contain one or * more images, which individually have their own responses. */ interface Schema$GoogleCloudVisionV1p2beta1AnnotateFileResponse { /** * Information about the file for which this response is generated. */ inputConfig?: Schema$GoogleCloudVisionV1p2beta1InputConfig; /** * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse[]; } /** * Response to an image annotation request. */ interface Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse { /** * If present, contextual information is needed to understand where this * image comes from. */ context?: Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext; /** * If present, crop hints have completed successfully. */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation; /** * If set, represents the error message for the operation. Note that * filled-in image annotations are guaranteed to be correct, even when * `error` is set. */ error?: Schema$Status; /** * If present, face detection has completed successfully. */ faceAnnotations?: Schema$GoogleCloudVisionV1p2beta1FaceAnnotation[]; /** * If present, text (OCR) detection or document (OCR) text detection has * completed successfully. This annotation provides the structural hierarchy * for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p2beta1TextAnnotation; /** * If present, image properties were extracted successfully. */ imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p2beta1ImageProperties; /** * If present, label detection has completed successfully. */ labelAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; /** * If present, landmark detection has completed successfully. */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; /** * If present, localized object detection has completed successfully. This * will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation[]; /** * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; /** * If present, product search has completed successfully. */ productSearchResults?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ safeSearchAnnotation?: Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation; /** * If present, text (OCR) detection has completed successfully. */ textAnnotations?: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; /** * If present, web detection has completed successfully. */ webDetection?: Schema$GoogleCloudVisionV1p2beta1WebDetection; } /** * The response for a single offline file annotation request. */ interface Schema$GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse { /** * The output location and metadata from AsyncAnnotateFileRequest. */ outputConfig?: Schema$GoogleCloudVisionV1p2beta1OutputConfig; } /** * Response to an async batch file annotation request. */ interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse { /** * The list of file annotation responses, one for each request in * AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse[]; } /** * Logical element on the page. */ interface Schema$GoogleCloudVisionV1p2beta1Block { /** * Detected block type (text, image etc) for this block. */ blockType?: string; /** * The bounding box for the block. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * Confidence of the OCR results on the block. Range [0, 1]. */ confidence?: number; /** * List of paragraphs in this block (if this blocks is of type text). */ paragraphs?: Schema$GoogleCloudVisionV1p2beta1Paragraph[]; /** * Additional information detected for the block. */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; } /** * A bounding polygon for the detected image annotation. */ interface Schema$GoogleCloudVisionV1p2beta1BoundingPoly { /** * The bounding polygon normalized vertices. */ normalizedVertices?: Schema$GoogleCloudVisionV1p2beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ vertices?: Schema$GoogleCloudVisionV1p2beta1Vertex[]; } /** * Color information consists of RGB channels, score, and the fraction of the * image that the color occupies in the image. */ interface Schema$GoogleCloudVisionV1p2beta1ColorInfo { /** * RGB components of the color. */ color?: Schema$Color; /** * The fraction of pixels the color occupies in the image. Value in range * [0, 1]. */ pixelFraction?: number; /** * Image-specific score for this color. Value in range [0, 1]. */ score?: number; } /** * Single crop hint that is used to generate a new crop when serving an image. */ interface Schema$GoogleCloudVisionV1p2beta1CropHint { /** * The bounding polygon for the crop region. The coordinates of the bounding * box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number; /** * Fraction of importance of this salient region with respect to the * original image. */ importanceFraction?: number; } /** * Set of crop hints that are used to generate new crops when serving images. */ interface Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation { /** * Crop hint results. */ cropHints?: Schema$GoogleCloudVisionV1p2beta1CropHint[]; } /** * Set of dominant colors and their corresponding scores. */ interface Schema$GoogleCloudVisionV1p2beta1DominantColorsAnnotation { /** * RGB color values with their score and pixel fraction. */ colors?: Schema$GoogleCloudVisionV1p2beta1ColorInfo[]; } /** * Set of detected entity features. */ interface Schema$GoogleCloudVisionV1p2beta1EntityAnnotation { /** * Image region to which this entity belongs. Not produced for * `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection * in an image. For example, for an image in which the "Eiffel * Tower" entity is detected, this field represents the confidence that * there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** * Entity textual description, expressed in its `locale` language. */ description?: string; /** * The language code for the locale in which the entity textual * `description` is expressed. */ locale?: string; /** * The location information for the detected entity. Multiple `LocationInfo` * elements can be present because one location may indicate the location of * the scene in the image, and another location may indicate the location of * the place where the image was taken. Location information is usually * present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p2beta1LocationInfo[]; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph * Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** * Some entities may have optional user-supplied `Property` (name/value) * fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p2beta1Property[]; /** * Overall score of the result. Range [0, 1]. */ score?: number; /** * The relevancy of the ICA (Image Content Annotation) label to the image. * For example, the relevancy of "tower" is likely higher to an * image containing the detected "Eiffel Tower" than to an image * containing a detected distant towering building, even though the * confidence that there is a tower in each image may be the same. Range [0, * 1]. */ topicality?: number; } /** * A face annotation object contains the results of face detection. */ interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotation { /** * Anger likelihood. */ angerLikelihood?: string; /** * Blurred likelihood. */ blurredLikelihood?: string; /** * The bounding polygon around the face. The coordinates of the bounding box * are in the original image's scale. The bounding box is computed to * "frame" the face in accordance with human expectations. It is * based on the landmarker results. Note that one or more x and/or y * coordinates may not be generated in the `BoundingPoly` (the polygon will * be unbounded) if only a partial face appears in the image to be * annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * Detection confidence. Range [0, 1]. */ detectionConfidence?: number; /** * The `fd_bounding_poly` bounding polygon is tighter than the * `boundingPoly`, and encloses only the skin part of the face. Typically, * it is used to eliminate the face from any image analysis that detects the * "amount of skin" visible in an image. It is not based on the * landmarker results, only on the initial face detection, hence the * <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * Headwear likelihood. */ headwearLikelihood?: string; /** * Joy likelihood. */ joyLikelihood?: string; /** * Face landmarking confidence. Range [0, 1]. */ landmarkingConfidence?: number; /** * Detected face landmarks. */ landmarks?: Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark[]; /** * Yaw angle, which indicates the leftward/rightward angle that the face is * pointing relative to the vertical plane perpendicular to the image. Range * [-180,180]. */ panAngle?: number; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise * rotation of the face relative to the image vertical about the axis * perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** * Sorrow likelihood. */ sorrowLikelihood?: string; /** * Surprise likelihood. */ surpriseLikelihood?: string; /** * Pitch angle, which indicates the upwards/downwards angle that the face is * pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** * Under-exposed likelihood. */ underExposedLikelihood?: string; } /** * A face-specific landmark (for example, a face feature). */ interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark { /** * Face landmark position. */ position?: Schema$GoogleCloudVisionV1p2beta1Position; /** * Face landmark type. */ type?: string; } /** * The Google Cloud Storage location where the output will be written to. */ interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { /** * Google Cloud Storage URI where the results will be stored. Results will * be in JSON format and preceded by its corresponding input URI. This field * can either represent a single file, or a prefix for multiple outputs. * Prefixes must end in a `/`. Examples: * File: * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ * * File: gs://bucket-name/prefix/here If multiple outputs, each * response is still AnnotateFileResponse, each of which contains some * subset of the full list of AnnotateImageResponse. Multiple outputs can * happen if, for example, the output JSON is too large and overflows into * multiple sharded files. */ uri?: string; } /** * The Google Cloud Storage location where the input will be read from. */ interface Schema$GoogleCloudVisionV1p2beta1GcsSource { /** * Google Cloud Storage URI for the input file. This must only be a Google * Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** * If an image was produced from a file (e.g. a PDF), this message gives * information about the source of that image. */ interface Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext { /** * If the file was a PDF or TIFF, this field gives the page number within * the file used to produce the image. */ pageNumber?: number; /** * The URI of the file used to produce the image. */ uri?: string; } /** * Stores image properties, such as dominant colors. */ interface Schema$GoogleCloudVisionV1p2beta1ImageProperties { /** * If present, dominant colors completed successfully. */ dominantColors?: Schema$GoogleCloudVisionV1p2beta1DominantColorsAnnotation; } /** * The desired input location and metadata. */ interface Schema$GoogleCloudVisionV1p2beta1InputConfig { /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p2beta1GcsSource; /** * The type of the file. Currently only "application/pdf" and * "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } /** * Set of detected objects with bounding boxes. */ interface Schema$GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation { /** * Image region to which this object belongs. This must be populated. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** * Object ID that should align with EntityAnnotation mid. */ mid?: string; /** * Object name, expressed in its `language_code` language. */ name?: string; /** * Score of the result. Range [0, 1]. */ score?: number; } /** * Detected entity location information. */ interface Schema$GoogleCloudVisionV1p2beta1LocationInfo { /** * lat/long location coordinates. */ latLng?: Schema$LatLng; } /** * A vertex represents a 2D point in the image. NOTE: the normalized vertex * coordinates are relative to the original image and range from 0 to 1. */ interface Schema$GoogleCloudVisionV1p2beta1NormalizedVertex { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; } /** * Contains metadata for the BatchAnnotateImages operation. */ interface Schema$GoogleCloudVisionV1p2beta1OperationMetadata { /** * The time when the batch request was received. */ createTime?: string; /** * Current state of the batch operation. */ state?: string; /** * The time when the operation result was last updated. */ updateTime?: string; } /** * The desired output location and metadata. */ interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { /** * The max number of response protos to put into each output JSON file on * Google Cloud Storage. The valid range is [1, 100]. If not specified, the * default value is 20. For example, for one pdf file with 100 pages, 100 * response protos will be generated. If `batch_size` = 20, then 5 json * files each containing 20 response protos will be written under the prefix * `gcs_destination`.`uri`. Currently, batch_size only applies to * GcsDestination, with potential future support for other output * configurations. */ batchSize?: number; /** * The Google Cloud Storage location to write the output(s) to. */ gcsDestination?: Schema$GoogleCloudVisionV1p2beta1GcsDestination; } /** * Detected page from OCR. */ interface Schema$GoogleCloudVisionV1p2beta1Page { /** * List of blocks of text, images etc on this page. */ blocks?: Schema$GoogleCloudVisionV1p2beta1Block[]; /** * Confidence of the OCR results on the page. Range [0, 1]. */ confidence?: number; /** * Page height. For PDFs the unit is points. For images (including TIFFs) * the unit is pixels. */ height?: number; /** * Additional information detected on the page. */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** * Page width. For PDFs the unit is points. For images (including TIFFs) the * unit is pixels. */ width?: number; } /** * Structural unit of text representing a number of words in certain order. */ interface Schema$GoogleCloudVisionV1p2beta1Paragraph { /** * The bounding box for the paragraph. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the paragraph. */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** * List of words in this paragraph. */ words?: Schema$GoogleCloudVisionV1p2beta1Word[]; } /** * A 3D position in the image, used primarily for Face detection landmarks. A * valid Position must have both x and y coordinates. The position coordinates * are in the same scale as the original image. */ interface Schema$GoogleCloudVisionV1p2beta1Position { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; /** * Z coordinate (or depth). */ z?: number; } /** * A Product contains ReferenceImages. */ interface Schema$GoogleCloudVisionV1p2beta1Product { /** * User-provided metadata to be stored with this product. Must be at most * 4096 characters long. */ description?: string; /** * The user-provided name for this Product. Must not be empty. Must be at * most 4096 characters long. */ displayName?: string; /** * The resource name of the product. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field * is ignored when creating a product. */ name?: string; /** * The category for the product identified by the reference image. This * should be either "homegoods", "apparel", or * "toys". This field is immutable. */ productCategory?: string; /** * Key-value pairs that can be attached to a product. At query time, * constraints can be specified based on the product_labels. Note that * integer values can be provided as strings, e.g. "1199". Only * strings with integer values can match a range-based restriction which is * to be supported soon. Multiple values can be assigned to the same key. * One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p2beta1ProductKeyValue[]; } /** * A product label represented as a key-value pair. */ interface Schema$GoogleCloudVisionV1p2beta1ProductKeyValue { /** * The key of the label attached to the product. Cannot be empty and cannot * exceed 128 bytes. */ key?: string; /** * The value of the label attached to the product. Cannot be empty and * cannot exceed 128 bytes. */ value?: string; } /** * Results for a product search request. */ interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResults { /** * Timestamp of the index which provided these results. Changes made after * this time are not reflected in the current results. */ indexTime?: string; /** * List of results grouped by products detected in the query image. Each * entry corresponds to one bounding polygon in the query image, and * contains the matching products specific to that region. There may be * duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult[]; /** * List of results, one for each product match. */ results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; } /** * Information about the products similar to a single product in a query * image. */ interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult { /** * The bounding polygon around the product detected in the query image. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * List of results, one for each product match. */ results?: Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult[]; } /** * Information about a product. */ interface Schema$GoogleCloudVisionV1p2beta1ProductSearchResultsResult { /** * The resource name of the image from the product that is the closest match * to the query. */ image?: string; /** * The Product. */ product?: Schema$GoogleCloudVisionV1p2beta1Product; /** * A confidence level on the match, ranging from 0 (no confidence) to 1 * (full confidence). */ score?: number; } /** * A `Property` consists of a user-supplied name/value pair. */ interface Schema$GoogleCloudVisionV1p2beta1Property { /** * Name of the property. */ name?: string; /** * Value of numeric properties. */ uint64Value?: string; /** * Value of the property. */ value?: string; } /** * Set of features pertaining to the image, computed by computer vision * methods over safe-search verticals (for example, adult, spoof, medical, * violence). */ interface Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation { /** * Represents the adult content likelihood for the image. Adult content may * contain elements such as nudity, pornographic images or cartoons, or * sexual activities. */ adult?: string; /** * Likelihood that this is a medical image. */ medical?: string; /** * Likelihood that the request image contains racy content. Racy content may * include (but is not limited to) skimpy or sheer clothing, strategically * covered nudity, lewd or provocative poses, or close-ups of sensitive body * areas. */ racy?: string; /** * Spoof likelihood. The likelihood that an modification was made to the * image's canonical version to make it appear funny or offensive. */ spoof?: string; /** * Likelihood that this image contains violent content. */ violence?: string; } /** * A single symbol representation. */ interface Schema$GoogleCloudVisionV1p2beta1Symbol { /** * The bounding box for the symbol. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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 vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the symbol. */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** * The actual UTF-8 representation of the symbol. */ text?: string; } /** * TextAnnotation contains a structured representation of OCR extracted text. * The hierarchy of an OCR extracted text structure is like this: * TextAnnotation -> Page -> Block -> Paragraph -> Word -> * Symbol Each structural component, starting from Page, may further have * their own properties. Properties describe detected languages, breaks etc.. * Please refer to the TextAnnotation.TextProperty message definition below * for more detail. */ interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { /** * List of pages detected by OCR. */ pages?: Schema$GoogleCloudVisionV1p2beta1Page[]; /** * UTF-8 text detected on the pages. */ text?: string; } /** * Detected start or end of a structural component. */ interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak { /** * True if break prepends the element. */ isPrefix?: boolean; /** * Detected break type. */ type?: string; } /** * Detected language for a structural component. */ interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage { /** * Confidence of detected language. Range [0, 1]. */ confidence?: number; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } /** * Additional information detected on the structural component. */ interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty { /** * Detected start or end of a text segment. */ detectedBreak?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak; /** * A list of detected languages together with confidence. */ detectedLanguages?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage[]; } /** * A vertex represents a 2D point in the image. NOTE: the vertex coordinates * are in the same scale as the original image. */ interface Schema$GoogleCloudVisionV1p2beta1Vertex { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; } /** * Relevant information for the image from the Internet. */ interface Schema$GoogleCloudVisionV1p2beta1WebDetection { /** * The service's best guess as to the topic of the request image. * Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel[]; /** * Fully matching images from the Internet. Can include resized copies of * the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** * Web pages containing the matching images from the Internet. */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage[]; /** * Partial matching images from the Internet. Those images are similar * enough to share some key-point features. For example an original image * will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** * The visually similar image results. */ visuallySimilarImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** * Deduced entities from similar images on the Internet. */ webEntities?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebEntity[]; } /** * Entity deduced from similar images on the Internet. */ interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebEntity { /** * Canonical description of the entity, in English. */ description?: string; /** * Opaque entity ID. */ entityId?: string; /** * Overall relevancy score for the entity. Not normalized and not comparable * across different image queries. */ score?: number; } /** * Metadata for online images. */ interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage { /** * (Deprecated) Overall relevancy score for the image. */ score?: number; /** * The result image URL. */ url?: string; } /** * Label to provide extra metadata for the web detection. */ interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel { /** * Label for extra metadata. */ label?: string; /** * The BCP-47 language code for `label`, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } /** * Metadata for web pages. */ interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage { /** * Fully matching images on the page. Can include resized copies of the * query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** * Title for the web page, may contain HTML markups. */ pageTitle?: string; /** * Partial matching images on the page. Those images are similar enough to * share some key-point features. For example an original image will likely * have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; /** * (Deprecated) Overall relevancy score for the web page. */ score?: number; /** * The result web page URL. */ url?: string; } /** * A word representation. */ interface Schema$GoogleCloudVisionV1p2beta1Word { /** * The bounding box for the word. The vertices are in the order of top-left, * top-right, bottom-right, bottom-left. When a rotation of the bounding box * is detected the rotation is represented as around the top-left corner as * defined when the text is read in the 'natural' orientation. For * example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** * Confidence of the OCR results for the word. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the word. */ property?: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; /** * List of symbols in the word. The order of the symbols follows the natural * reading order. */ symbols?: Schema$GoogleCloudVisionV1p2beta1Symbol[]; } /** * Response to a single file annotation request. A file may contain one or * more images, which individually have their own responses. */ interface Schema$GoogleCloudVisionV1p3beta1AnnotateFileResponse { /** * Information about the file for which this response is generated. */ inputConfig?: Schema$GoogleCloudVisionV1p3beta1InputConfig; /** * Individual responses to images found within the file. */ responses?: Schema$GoogleCloudVisionV1p3beta1AnnotateImageResponse[]; } /** * Response to an image annotation request. */ interface Schema$GoogleCloudVisionV1p3beta1AnnotateImageResponse { /** * If present, contextual information is needed to understand where this * image comes from. */ context?: Schema$GoogleCloudVisionV1p3beta1ImageAnnotationContext; /** * If present, crop hints have completed successfully. */ cropHintsAnnotation?: Schema$GoogleCloudVisionV1p3beta1CropHintsAnnotation; /** * If set, represents the error message for the operation. Note that * filled-in image annotations are guaranteed to be correct, even when * `error` is set. */ error?: Schema$Status; /** * If present, face detection has completed successfully. */ faceAnnotations?: Schema$GoogleCloudVisionV1p3beta1FaceAnnotation[]; /** * If present, text (OCR) detection or document (OCR) text detection has * completed successfully. This annotation provides the structural hierarchy * for the OCR detected text. */ fullTextAnnotation?: Schema$GoogleCloudVisionV1p3beta1TextAnnotation; /** * If present, image properties were extracted successfully. */ imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p3beta1ImageProperties; /** * If present, label detection has completed successfully. */ labelAnnotations?: Schema$GoogleCloudVisionV1p3beta1EntityAnnotation[]; /** * If present, landmark detection has completed successfully. */ landmarkAnnotations?: Schema$GoogleCloudVisionV1p3beta1EntityAnnotation[]; /** * If present, localized object detection has completed successfully. This * will be sorted descending by confidence score. */ localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation[]; /** * If present, logo detection has completed successfully. */ logoAnnotations?: Schema$GoogleCloudVisionV1p3beta1EntityAnnotation[]; /** * If present, product search has completed successfully. */ productSearchResults?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ safeSearchAnnotation?: Schema$GoogleCloudVisionV1p3beta1SafeSearchAnnotation; /** * If present, text (OCR) detection has completed successfully. */ textAnnotations?: Schema$GoogleCloudVisionV1p3beta1EntityAnnotation[]; /** * If present, web detection has completed successfully. */ webDetection?: Schema$GoogleCloudVisionV1p3beta1WebDetection; } /** * The response for a single offline file annotation request. */ interface Schema$GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse { /** * The output location and metadata from AsyncAnnotateFileRequest. */ outputConfig?: Schema$GoogleCloudVisionV1p3beta1OutputConfig; } /** * Response to an async batch file annotation request. */ interface Schema$GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse { /** * The list of file annotation responses, one for each request in * AsyncBatchAnnotateFilesRequest. */ responses?: Schema$GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse[]; } /** * Metadata for the batch operations such as the current state. This is * included in the `metadata` field of the `Operation` returned by the * `GetOperation` call of the `google::longrunning::Operations` service. */ interface Schema$GoogleCloudVisionV1p3beta1BatchOperationMetadata { /** * The time when the batch request is finished and * google.longrunning.Operation.done is set to true. */ endTime?: string; /** * The current state of the batch operation. */ state?: string; /** * The time when the batch request was submitted to the server. */ submitTime?: string; } /** * Logical element on the page. */ interface Schema$GoogleCloudVisionV1p3beta1Block { /** * Detected block type (text, image etc) for this block. */ blockType?: string; /** * The bounding box for the block. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * Confidence of the OCR results on the block. Range [0, 1]. */ confidence?: number; /** * List of paragraphs in this block (if this blocks is of type text). */ paragraphs?: Schema$GoogleCloudVisionV1p3beta1Paragraph[]; /** * Additional information detected for the block. */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; } /** * A bounding polygon for the detected image annotation. */ interface Schema$GoogleCloudVisionV1p3beta1BoundingPoly { /** * The bounding polygon normalized vertices. */ normalizedVertices?: Schema$GoogleCloudVisionV1p3beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ vertices?: Schema$GoogleCloudVisionV1p3beta1Vertex[]; } /** * Color information consists of RGB channels, score, and the fraction of the * image that the color occupies in the image. */ interface Schema$GoogleCloudVisionV1p3beta1ColorInfo { /** * RGB components of the color. */ color?: Schema$Color; /** * The fraction of pixels the color occupies in the image. Value in range * [0, 1]. */ pixelFraction?: number; /** * Image-specific score for this color. Value in range [0, 1]. */ score?: number; } /** * Single crop hint that is used to generate a new crop when serving an image. */ interface Schema$GoogleCloudVisionV1p3beta1CropHint { /** * The bounding polygon for the crop region. The coordinates of the bounding * box are in the original image's scale. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * Confidence of this being a salient region. Range [0, 1]. */ confidence?: number; /** * Fraction of importance of this salient region with respect to the * original image. */ importanceFraction?: number; } /** * Set of crop hints that are used to generate new crops when serving images. */ interface Schema$GoogleCloudVisionV1p3beta1CropHintsAnnotation { /** * Crop hint results. */ cropHints?: Schema$GoogleCloudVisionV1p3beta1CropHint[]; } /** * Set of dominant colors and their corresponding scores. */ interface Schema$GoogleCloudVisionV1p3beta1DominantColorsAnnotation { /** * RGB color values with their score and pixel fraction. */ colors?: Schema$GoogleCloudVisionV1p3beta1ColorInfo[]; } /** * Set of detected entity features. */ interface Schema$GoogleCloudVisionV1p3beta1EntityAnnotation { /** * Image region to which this entity belongs. Not produced for * `LABEL_DETECTION` features. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection * in an image. For example, for an image in which the "Eiffel * Tower" entity is detected, this field represents the confidence that * there is a tower in the query image. Range [0, 1]. */ confidence?: number; /** * Entity textual description, expressed in its `locale` language. */ description?: string; /** * The language code for the locale in which the entity textual * `description` is expressed. */ locale?: string; /** * The location information for the detected entity. Multiple `LocationInfo` * elements can be present because one location may indicate the location of * the scene in the image, and another location may indicate the location of * the place where the image was taken. Location information is usually * present for landmarks. */ locations?: Schema$GoogleCloudVisionV1p3beta1LocationInfo[]; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph * Search API](https://developers.google.com/knowledge-graph/). */ mid?: string; /** * Some entities may have optional user-supplied `Property` (name/value) * fields, such a score or string that qualifies the entity. */ properties?: Schema$GoogleCloudVisionV1p3beta1Property[]; /** * Overall score of the result. Range [0, 1]. */ score?: number; /** * The relevancy of the ICA (Image Content Annotation) label to the image. * For example, the relevancy of "tower" is likely higher to an * image containing the detected "Eiffel Tower" than to an image * containing a detected distant towering building, even though the * confidence that there is a tower in each image may be the same. Range [0, * 1]. */ topicality?: number; } /** * A face annotation object contains the results of face detection. */ interface Schema$GoogleCloudVisionV1p3beta1FaceAnnotation { /** * Anger likelihood. */ angerLikelihood?: string; /** * Blurred likelihood. */ blurredLikelihood?: string; /** * The bounding polygon around the face. The coordinates of the bounding box * are in the original image's scale. The bounding box is computed to * "frame" the face in accordance with human expectations. It is * based on the landmarker results. Note that one or more x and/or y * coordinates may not be generated in the `BoundingPoly` (the polygon will * be unbounded) if only a partial face appears in the image to be * annotated. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * Detection confidence. Range [0, 1]. */ detectionConfidence?: number; /** * The `fd_bounding_poly` bounding polygon is tighter than the * `boundingPoly`, and encloses only the skin part of the face. Typically, * it is used to eliminate the face from any image analysis that detects the * "amount of skin" visible in an image. It is not based on the * landmarker results, only on the initial face detection, hence the * <code>fd</code> (face detection) prefix. */ fdBoundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * Headwear likelihood. */ headwearLikelihood?: string; /** * Joy likelihood. */ joyLikelihood?: string; /** * Face landmarking confidence. Range [0, 1]. */ landmarkingConfidence?: number; /** * Detected face landmarks. */ landmarks?: Schema$GoogleCloudVisionV1p3beta1FaceAnnotationLandmark[]; /** * Yaw angle, which indicates the leftward/rightward angle that the face is * pointing relative to the vertical plane perpendicular to the image. Range * [-180,180]. */ panAngle?: number; /** * Roll angle, which indicates the amount of clockwise/anti-clockwise * rotation of the face relative to the image vertical about the axis * perpendicular to the face. Range [-180,180]. */ rollAngle?: number; /** * Sorrow likelihood. */ sorrowLikelihood?: string; /** * Surprise likelihood. */ surpriseLikelihood?: string; /** * Pitch angle, which indicates the upwards/downwards angle that the face is * pointing relative to the image's horizontal plane. Range [-180,180]. */ tiltAngle?: number; /** * Under-exposed likelihood. */ underExposedLikelihood?: string; } /** * A face-specific landmark (for example, a face feature). */ interface Schema$GoogleCloudVisionV1p3beta1FaceAnnotationLandmark { /** * Face landmark position. */ position?: Schema$GoogleCloudVisionV1p3beta1Position; /** * Face landmark type. */ type?: string; } /** * The Google Cloud Storage location where the output will be written to. */ interface Schema$GoogleCloudVisionV1p3beta1GcsDestination { /** * Google Cloud Storage URI where the results will be stored. Results will * be in JSON format and preceded by its corresponding input URI. This field * can either represent a single file, or a prefix for multiple outputs. * Prefixes must end in a `/`. Examples: * File: * gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ * * File: gs://bucket-name/prefix/here If multiple outputs, each * response is still AnnotateFileResponse, each of which contains some * subset of the full list of AnnotateImageResponse. Multiple outputs can * happen if, for example, the output JSON is too large and overflows into * multiple sharded files. */ uri?: string; } /** * The Google Cloud Storage location where the input will be read from. */ interface Schema$GoogleCloudVisionV1p3beta1GcsSource { /** * Google Cloud Storage URI for the input file. This must only be a Google * Cloud Storage object. Wildcards are not currently supported. */ uri?: string; } /** * If an image was produced from a file (e.g. a PDF), this message gives * information about the source of that image. */ interface Schema$GoogleCloudVisionV1p3beta1ImageAnnotationContext { /** * If the file was a PDF or TIFF, this field gives the page number within * the file used to produce the image. */ pageNumber?: number; /** * The URI of the file used to produce the image. */ uri?: string; } /** * Stores image properties, such as dominant colors. */ interface Schema$GoogleCloudVisionV1p3beta1ImageProperties { /** * If present, dominant colors completed successfully. */ dominantColors?: Schema$GoogleCloudVisionV1p3beta1DominantColorsAnnotation; } /** * Response message for the `ImportProductSets` method. This message is * returned by the google.longrunning.Operations.GetOperation method in the * returned google.longrunning.Operation.response field. */ interface Schema$GoogleCloudVisionV1p3beta1ImportProductSetsResponse { /** * The list of reference_images that are imported successfully. */ referenceImages?: Schema$GoogleCloudVisionV1p3beta1ReferenceImage[]; /** * The rpc status for each ImportProductSet request, including both * successes and errors. The number of statuses here matches the number of * lines in the csv file, and statuses[i] stores the success or failure * status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } /** * The desired input location and metadata. */ interface Schema$GoogleCloudVisionV1p3beta1InputConfig { /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GoogleCloudVisionV1p3beta1GcsSource; /** * The type of the file. Currently only "application/pdf" and * "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } /** * Set of detected objects with bounding boxes. */ interface Schema$GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation { /** * Image region to which this object belongs. This must be populated. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** * Object ID that should align with EntityAnnotation mid. */ mid?: string; /** * Object name, expressed in its `language_code` language. */ name?: string; /** * Score of the result. Range [0, 1]. */ score?: number; } /** * Detected entity location information. */ interface Schema$GoogleCloudVisionV1p3beta1LocationInfo { /** * lat/long location coordinates. */ latLng?: Schema$LatLng; } /** * A vertex represents a 2D point in the image. NOTE: the normalized vertex * coordinates are relative to the original image and range from 0 to 1. */ interface Schema$GoogleCloudVisionV1p3beta1NormalizedVertex { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; } /** * Contains metadata for the BatchAnnotateImages operation. */ interface Schema$GoogleCloudVisionV1p3beta1OperationMetadata { /** * The time when the batch request was received. */ createTime?: string; /** * Current state of the batch operation. */ state?: string; /** * The time when the operation result was last updated. */ updateTime?: string; } /** * The desired output location and metadata. */ interface Schema$GoogleCloudVisionV1p3beta1OutputConfig { /** * The max number of response protos to put into each output JSON file on * Google Cloud Storage. The valid range is [1, 100]. If not specified, the * default value is 20. For example, for one pdf file with 100 pages, 100 * response protos will be generated. If `batch_size` = 20, then 5 json * files each containing 20 response protos will be written under the prefix * `gcs_destination`.`uri`. Currently, batch_size only applies to * GcsDestination, with potential future support for other output * configurations. */ batchSize?: number; /** * The Google Cloud Storage location to write the output(s) to. */ gcsDestination?: Schema$GoogleCloudVisionV1p3beta1GcsDestination; } /** * Detected page from OCR. */ interface Schema$GoogleCloudVisionV1p3beta1Page { /** * List of blocks of text, images etc on this page. */ blocks?: Schema$GoogleCloudVisionV1p3beta1Block[]; /** * Confidence of the OCR results on the page. Range [0, 1]. */ confidence?: number; /** * Page height. For PDFs the unit is points. For images (including TIFFs) * the unit is pixels. */ height?: number; /** * Additional information detected on the page. */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** * Page width. For PDFs the unit is points. For images (including TIFFs) the * unit is pixels. */ width?: number; } /** * Structural unit of text representing a number of words in certain order. */ interface Schema$GoogleCloudVisionV1p3beta1Paragraph { /** * The bounding box for the paragraph. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the paragraph. */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** * List of words in this paragraph. */ words?: Schema$GoogleCloudVisionV1p3beta1Word[]; } /** * A 3D position in the image, used primarily for Face detection landmarks. A * valid Position must have both x and y coordinates. The position coordinates * are in the same scale as the original image. */ interface Schema$GoogleCloudVisionV1p3beta1Position { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; /** * Z coordinate (or depth). */ z?: number; } /** * A Product contains ReferenceImages. */ interface Schema$GoogleCloudVisionV1p3beta1Product { /** * User-provided metadata to be stored with this product. Must be at most * 4096 characters long. */ description?: string; /** * The user-provided name for this Product. Must not be empty. Must be at * most 4096 characters long. */ displayName?: string; /** * The resource name of the product. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field * is ignored when creating a product. */ name?: string; /** * The category for the product identified by the reference image. This * should be either "homegoods", "apparel", or * "toys". This field is immutable. */ productCategory?: string; /** * Key-value pairs that can be attached to a product. At query time, * constraints can be specified based on the product_labels. Note that * integer values can be provided as strings, e.g. "1199". Only * strings with integer values can match a range-based restriction which is * to be supported soon. Multiple values can be assigned to the same key. * One product may have up to 100 product_labels. */ productLabels?: Schema$GoogleCloudVisionV1p3beta1ProductKeyValue[]; } /** * A product label represented as a key-value pair. */ interface Schema$GoogleCloudVisionV1p3beta1ProductKeyValue { /** * The key of the label attached to the product. Cannot be empty and cannot * exceed 128 bytes. */ key?: string; /** * The value of the label attached to the product. Cannot be empty and * cannot exceed 128 bytes. */ value?: string; } /** * Results for a product search request. */ interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResults { /** * Timestamp of the index which provided these results. Changes made after * this time are not reflected in the current results. */ indexTime?: string; /** * List of results grouped by products detected in the query image. Each * entry corresponds to one bounding polygon in the query image, and * contains the matching products specific to that region. There may be * duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult[]; /** * List of results, one for each product match. */ results?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult[]; } /** * Information about the products similar to a single product in a query * image. */ interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult { /** * The bounding polygon around the product detected in the query image. */ boundingPoly?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * List of results, one for each product match. */ results?: Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult[]; } /** * Information about a product. */ interface Schema$GoogleCloudVisionV1p3beta1ProductSearchResultsResult { /** * The resource name of the image from the product that is the closest match * to the query. */ image?: string; /** * The Product. */ product?: Schema$GoogleCloudVisionV1p3beta1Product; /** * A confidence level on the match, ranging from 0 (no confidence) to 1 * (full confidence). */ score?: number; } /** * A `Property` consists of a user-supplied name/value pair. */ interface Schema$GoogleCloudVisionV1p3beta1Property { /** * Name of the property. */ name?: string; /** * Value of numeric properties. */ uint64Value?: string; /** * Value of the property. */ value?: string; } /** * A `ReferenceImage` represents a product image and its associated metadata, * such as bounding boxes. */ interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** * Bounding polygons around the areas of interest in the reference image. * Optional. If this field is empty, the system will try to detect regions * of interest. At most 10 bounding polygons will be used. The provided * shape is converted into a non-rotated rectangle. Once converted, the * small edge of the rectangle must be greater than or equal to 300 pixels. * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** * The resource name of the reference image. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. * This field is ignored when creating a reference image. */ name?: string; /** * The Google Cloud Storage URI of the reference image. The URI must start * with `gs://`. Required. */ uri?: string; } /** * Set of features pertaining to the image, computed by computer vision * methods over safe-search verticals (for example, adult, spoof, medical, * violence). */ interface Schema$GoogleCloudVisionV1p3beta1SafeSearchAnnotation { /** * Represents the adult content likelihood for the image. Adult content may * contain elements such as nudity, pornographic images or cartoons, or * sexual activities. */ adult?: string; /** * Likelihood that this is a medical image. */ medical?: string; /** * Likelihood that the request image contains racy content. Racy content may * include (but is not limited to) skimpy or sheer clothing, strategically * covered nudity, lewd or provocative poses, or close-ups of sensitive body * areas. */ racy?: string; /** * Spoof likelihood. The likelihood that an modification was made to the * image's canonical version to make it appear funny or offensive. */ spoof?: string; /** * Likelihood that this image contains violent content. */ violence?: string; } /** * A single symbol representation. */ interface Schema$GoogleCloudVisionV1p3beta1Symbol { /** * The bounding box for the symbol. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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 vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the symbol. */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** * The actual UTF-8 representation of the symbol. */ text?: string; } /** * TextAnnotation contains a structured representation of OCR extracted text. * The hierarchy of an OCR extracted text structure is like this: * TextAnnotation -> Page -> Block -> Paragraph -> Word -> * Symbol Each structural component, starting from Page, may further have * their own properties. Properties describe detected languages, breaks etc.. * Please refer to the TextAnnotation.TextProperty message definition below * for more detail. */ interface Schema$GoogleCloudVisionV1p3beta1TextAnnotation { /** * List of pages detected by OCR. */ pages?: Schema$GoogleCloudVisionV1p3beta1Page[]; /** * UTF-8 text detected on the pages. */ text?: string; } /** * Detected start or end of a structural component. */ interface Schema$GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak { /** * True if break prepends the element. */ isPrefix?: boolean; /** * Detected break type. */ type?: string; } /** * Detected language for a structural component. */ interface Schema$GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage { /** * Confidence of detected language. Range [0, 1]. */ confidence?: number; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } /** * Additional information detected on the structural component. */ interface Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty { /** * Detected start or end of a text segment. */ detectedBreak?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak; /** * A list of detected languages together with confidence. */ detectedLanguages?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage[]; } /** * A vertex represents a 2D point in the image. NOTE: the vertex coordinates * are in the same scale as the original image. */ interface Schema$GoogleCloudVisionV1p3beta1Vertex { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; } /** * Relevant information for the image from the Internet. */ interface Schema$GoogleCloudVisionV1p3beta1WebDetection { /** * The service's best guess as to the topic of the request image. * Inferred from similar images on the open web. */ bestGuessLabels?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebLabel[]; /** * Fully matching images from the Internet. Can include resized copies of * the query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** * Web pages containing the matching images from the Internet. */ pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebPage[]; /** * Partial matching images from the Internet. Those images are similar * enough to share some key-point features. For example an original image * will likely have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** * The visually similar image results. */ visuallySimilarImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** * Deduced entities from similar images on the Internet. */ webEntities?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebEntity[]; } /** * Entity deduced from similar images on the Internet. */ interface Schema$GoogleCloudVisionV1p3beta1WebDetectionWebEntity { /** * Canonical description of the entity, in English. */ description?: string; /** * Opaque entity ID. */ entityId?: string; /** * Overall relevancy score for the entity. Not normalized and not comparable * across different image queries. */ score?: number; } /** * Metadata for online images. */ interface Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage { /** * (Deprecated) Overall relevancy score for the image. */ score?: number; /** * The result image URL. */ url?: string; } /** * Label to provide extra metadata for the web detection. */ interface Schema$GoogleCloudVisionV1p3beta1WebDetectionWebLabel { /** * Label for extra metadata. */ label?: string; /** * The BCP-47 language code for `label`, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } /** * Metadata for web pages. */ interface Schema$GoogleCloudVisionV1p3beta1WebDetectionWebPage { /** * Fully matching images on the page. Can include resized copies of the * query image. */ fullMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** * Title for the web page, may contain HTML markups. */ pageTitle?: string; /** * Partial matching images on the page. Those images are similar enough to * share some key-point features. For example an original image will likely * have partial matching for its crops. */ partialMatchingImages?: Schema$GoogleCloudVisionV1p3beta1WebDetectionWebImage[]; /** * (Deprecated) Overall relevancy score for the web page. */ score?: number; /** * The result web page URL. */ url?: string; } /** * A word representation. */ interface Schema$GoogleCloudVisionV1p3beta1Word { /** * The bounding box for the word. The vertices are in the order of top-left, * top-right, bottom-right, bottom-left. When a rotation of the bounding box * is detected the rotation is represented as around the top-left corner as * defined when the text is read in the 'natural' orientation. For * example: * 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). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** * Confidence of the OCR results for the word. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the word. */ property?: Schema$GoogleCloudVisionV1p3beta1TextAnnotationTextProperty; /** * List of symbols in the word. The order of the symbols follows the natural * reading order. */ symbols?: Schema$GoogleCloudVisionV1p3beta1Symbol[]; } /** * Information about the products similar to a single product in a query * image. */ interface Schema$GroupedResult { /** * The bounding polygon around the product detected in the query image. */ boundingPoly?: Schema$BoundingPoly; /** * List of results, one for each product match. */ results?: Schema$Result[]; } /** * Client image to perform Google Cloud Vision API tasks over. */ interface Schema$Image { /** * Image content, represented as a stream of bytes. Note: As with all * `bytes` fields, protobuffers use a pure binary representation, whereas * JSON representations use base64. */ content?: string; /** * Google Cloud Storage image location, or publicly-accessible image URL. If * both `content` and `source` are provided for an image, `content` takes * precedence and is used to perform the image annotation request. */ source?: Schema$ImageSource; } /** * If an image was produced from a file (e.g. a PDF), this message gives * information about the source of that image. */ interface Schema$ImageAnnotationContext { /** * If the file was a PDF or TIFF, this field gives the page number within * the file used to produce the image. */ pageNumber?: number; /** * The URI of the file used to produce the image. */ uri?: string; } /** * Image context and/or feature-specific parameters. */ interface Schema$ImageContext { /** * Parameters for crop hints annotation request. */ cropHintsParams?: Schema$CropHintsParams; /** * List of languages to use for TEXT_DETECTION. In most cases, an empty * value yields the best results since it enables automatic language * detection. For languages based on the Latin alphabet, setting * `language_hints` is not needed. In rare cases, when the language of the * text in the image is known, setting a hint will help get better results * (although it will be a significant hindrance if the hint is wrong). Text * detection returns an error if one or more of the specified languages is * not one of the [supported languages](/vision/docs/languages). */ languageHints?: string[]; /** * Not used. */ latLongRect?: Schema$LatLongRect; /** * Parameters for product search. */ productSearchParams?: Schema$ProductSearchParams; /** * Parameters for web detection. */ webDetectionParams?: Schema$WebDetectionParams; } /** * Stores image properties, such as dominant colors. */ interface Schema$ImageProperties { /** * If present, dominant colors completed successfully. */ dominantColors?: Schema$DominantColorsAnnotation; } /** * External image source (Google Cloud Storage or web URL image location). */ interface Schema$ImageSource { /** * **Use `image_uri` instead.** The Google Cloud Storage URI of the form * `gs://bucket_name/object_name`. Object versioning is not supported. See * [Google Cloud Storage Request * URIs](https://cloud.google.com/storage/docs/reference-uris) for more * info. */ gcsImageUri?: string; /** * The URI of the source image. Can be either: 1. A Google Cloud Storage * URI of the form `gs://bucket_name/object_name`. Object versioning is * not supported. See [Google Cloud Storage Request * URIs](https://cloud.google.com/storage/docs/reference-uris) for more * info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching * images from HTTP/HTTPS URLs, Google cannot guarantee that the request * will be completed. Your request may fail if the specified host denies * the request (e.g. due to request throttling or DOS prevention), or if * Google throttles requests to the site for abuse prevention. You should * not depend on externally-hosted images for production applications. * When both `gcs_image_uri` and `image_uri` are specified, `image_uri` * takes precedence. */ imageUri?: string; } /** * The Google Cloud Storage location for a csv file which preserves a list of * ImportProductSetRequests in each line. */ interface Schema$ImportProductSetsGcsSource { /** * The Google Cloud Storage URI of the input csv file. The URI must start * with `gs://`. The format of the input csv file should be one image per * line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. * product-set-id 4. product-id 5. product-category 6. * product-display-name 7. labels 8. bounding-poly The `image-uri`, * `product-set-id`, `product-id`, and `product-category` columns are * required. All other columns are optional. If the `ProductSet` or * `Product` specified by the `product-set-id` and `product-id` values does * not exist, then the system will create a new `ProductSet` or `Product` * for the image. In this case, the `product-display-name` column refers to * display_name, the `product-category` column refers to product_category, * and the `labels` column refers to product_labels. The `image-id` column * is optional but must be unique if provided. If it is empty, the system * will automatically assign a unique id to the image. The * `product-display-name` column is optional. If it is empty, the system * sets the display_name field for the product to a space (" "). * You can update the `display_name` later by using the API. If a `Product` * with the specified `product-id` already exists, then the system ignores * the `product-display-name`, `product-category`, and `labels` columns. The * `labels` column (optional) is a line containing a list of comma-separated * key-value pairs, in the following format: * "key_1=value_1,key_2=value_2,...,key_n=value_n" The * `bounding-poly` column (optional) identifies one region of interest from * the image in the same manner as `CreateReferenceImage`. If you do not * specify the `bounding-poly` column, then the system will try to detect * regions of interest automatically. At most one `bounding-poly` column is * allowed per line. If the image contains multiple regions of interest, add * a line to the CSV file that includes the same product information, and * the `bounding-poly` values for each region of interest. The * `bounding-poly` column must contain an even number of comma-separated * numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use * non-negative integers for absolute bounding polygons, and float values in * [0, 1] for normalized bounding polygons. The system will resize the * image if the image resolution is too large to process (larger than 20MP). */ csvFileUri?: string; } /** * The input content for the `ImportProductSets` method. */ interface Schema$ImportProductSetsInputConfig { /** * The Google Cloud Storage location for a csv file which preserves a list * of ImportProductSetRequests in each line. */ gcsSource?: Schema$ImportProductSetsGcsSource; } /** * Request message for the `ImportProductSets` method. */ interface Schema$ImportProductSetsRequest { /** * The input content for the list of requests. */ inputConfig?: Schema$ImportProductSetsInputConfig; } /** * Response message for the `ImportProductSets` method. This message is * returned by the google.longrunning.Operations.GetOperation method in the * returned google.longrunning.Operation.response field. */ interface Schema$ImportProductSetsResponse { /** * The list of reference_images that are imported successfully. */ referenceImages?: Schema$ReferenceImage[]; /** * The rpc status for each ImportProductSet request, including both * successes and errors. The number of statuses here matches the number of * lines in the csv file, and statuses[i] stores the success or failure * status of processing the i-th line of the csv, starting from line 0. */ statuses?: Schema$Status[]; } /** * The desired input location and metadata. */ interface Schema$InputConfig { /** * The Google Cloud Storage location to read the input from. */ gcsSource?: Schema$GcsSource; /** * The type of the file. Currently only "application/pdf" and * "image/tiff" are supported. Wildcards are not supported. */ mimeType?: string; } /** * A product label represented as a key-value pair. */ interface Schema$KeyValue { /** * The key of the label attached to the product. Cannot be empty and cannot * exceed 128 bytes. */ key?: string; /** * The value of the label attached to the product. Cannot be empty and * cannot exceed 128 bytes. */ value?: string; } /** * A face-specific landmark (for example, a face feature). */ interface Schema$Landmark { /** * Face landmark position. */ position?: Schema$Position; /** * Face landmark type. */ type?: string; } /** * An object representing a latitude/longitude pair. This is expressed as a * pair of doubles representing degrees latitude and degrees longitude. Unless * specified otherwise, this must conform to the <a * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 * standard</a>. Values must be within normalized ranges. */ interface Schema$LatLng { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ latitude?: number; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ longitude?: number; } /** * Rectangle determined by min and max `LatLng` pairs. */ interface Schema$LatLongRect { /** * Max lat/long pair. */ maxLatLng?: Schema$LatLng; /** * Min lat/long pair. */ minLatLng?: Schema$LatLng; } /** * The response message for Operations.ListOperations. */ interface Schema$ListOperationsResponse { /** * The standard List next-page token. */ nextPageToken?: string; /** * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; } /** * Response message for the `ListProductSets` method. */ interface Schema$ListProductSetsResponse { /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; /** * List of ProductSets. */ productSets?: Schema$ProductSet[]; } /** * Response message for the `ListProductsInProductSet` method. */ interface Schema$ListProductsInProductSetResponse { /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; /** * The list of Products. */ products?: Schema$Product[]; } /** * Response message for the `ListProducts` method. */ interface Schema$ListProductsResponse { /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; /** * List of products. */ products?: Schema$Product[]; } /** * Response message for the `ListReferenceImages` method. */ interface Schema$ListReferenceImagesResponse { /** * The next_page_token returned from a previous List request, if any. */ nextPageToken?: string; /** * The maximum number of items to return. Default 10, maximum 100. */ pageSize?: number; /** * The list of reference images. */ referenceImages?: Schema$ReferenceImage[]; } /** * Set of detected objects with bounding boxes. */ interface Schema$LocalizedObjectAnnotation { /** * Image region to which this object belongs. This must be populated. */ boundingPoly?: Schema$BoundingPoly; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; /** * Object ID that should align with EntityAnnotation mid. */ mid?: string; /** * Object name, expressed in its `language_code` language. */ name?: string; /** * Score of the result. Range [0, 1]. */ score?: number; } /** * Detected entity location information. */ interface Schema$LocationInfo { /** * lat/long location coordinates. */ latLng?: Schema$LatLng; } /** * A vertex represents a 2D point in the image. NOTE: the normalized vertex * coordinates are relative to the original image and range from 0 to 1. */ interface Schema$NormalizedVertex { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; } /** * This resource represents a long-running operation that is the result of a * network API call. */ interface Schema$Operation { /** * If the value is `false`, it means the operation is still in progress. If * `true`, the operation is completed, and either `error` or `response` is * available. */ done?: boolean; /** * The error result of the operation in case of failure or cancellation. */ error?: Schema$Status; /** * Service-specific metadata associated with the operation. It typically * contains progress information and common metadata such as create time. * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ metadata?: { [key: string]: any; }; /** * The server-assigned name, which is only unique within the same service * that originally returns it. If you use the default HTTP mapping, the * `name` should have the format of `operations/some/unique/name`. */ name?: string; /** * The normal response of the operation in case of success. If the original * method returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other * methods, the response should have the type `XxxResponse`, where `Xxx` is * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: { [key: string]: any; }; } /** * Contains metadata for the BatchAnnotateImages operation. */ interface Schema$OperationMetadata { /** * The time when the batch request was received. */ createTime?: string; /** * Current state of the batch operation. */ state?: string; /** * The time when the operation result was last updated. */ updateTime?: string; } /** * The desired output location and metadata. */ interface Schema$OutputConfig { /** * The max number of response protos to put into each output JSON file on * Google Cloud Storage. The valid range is [1, 100]. If not specified, the * default value is 20. For example, for one pdf file with 100 pages, 100 * response protos will be generated. If `batch_size` = 20, then 5 json * files each containing 20 response protos will be written under the prefix * `gcs_destination`.`uri`. Currently, batch_size only applies to * GcsDestination, with potential future support for other output * configurations. */ batchSize?: number; /** * The Google Cloud Storage location to write the output(s) to. */ gcsDestination?: Schema$GcsDestination; } /** * Detected page from OCR. */ interface Schema$Page { /** * List of blocks of text, images etc on this page. */ blocks?: Schema$Block[]; /** * Confidence of the OCR results on the page. Range [0, 1]. */ confidence?: number; /** * Page height. For PDFs the unit is points. For images (including TIFFs) * the unit is pixels. */ height?: number; /** * Additional information detected on the page. */ property?: Schema$TextProperty; /** * Page width. For PDFs the unit is points. For images (including TIFFs) the * unit is pixels. */ width?: number; } /** * Structural unit of text representing a number of words in certain order. */ interface Schema$Paragraph { /** * The bounding box for the paragraph. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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). */ boundingBox?: Schema$BoundingPoly; /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the paragraph. */ property?: Schema$TextProperty; /** * List of words in this paragraph. */ words?: Schema$Word[]; } /** * A 3D position in the image, used primarily for Face detection landmarks. A * valid Position must have both x and y coordinates. The position coordinates * are in the same scale as the original image. */ interface Schema$Position { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; /** * Z coordinate (or depth). */ z?: number; } /** * A Product contains ReferenceImages. */ interface Schema$Product { /** * User-provided metadata to be stored with this product. Must be at most * 4096 characters long. */ description?: string; /** * The user-provided name for this Product. Must not be empty. Must be at * most 4096 characters long. */ displayName?: string; /** * The resource name of the product. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field * is ignored when creating a product. */ name?: string; /** * The category for the product identified by the reference image. This * should be either "homegoods", "apparel", or * "toys". This field is immutable. */ productCategory?: string; /** * Key-value pairs that can be attached to a product. At query time, * constraints can be specified based on the product_labels. Note that * integer values can be provided as strings, e.g. "1199". Only * strings with integer values can match a range-based restriction which is * to be supported soon. Multiple values can be assigned to the same key. * One product may have up to 100 product_labels. */ productLabels?: Schema$KeyValue[]; } /** * Parameters for a product search request. */ interface Schema$ProductSearchParams { /** * The bounding polygon around the area of interest in the image. Optional. * If it is not specified, system discretion will be applied. */ boundingPoly?: Schema$BoundingPoly; /** * The filtering expression. This can be used to restrict search results * based on Product labels. We currently support an AND of OR of key-value * expressions, where each expression within an OR must have the same key. * For example, "(color = red OR color = blue) AND brand = Google" * is acceptable, but not "(color = red OR brand = Google)" or * "color: red". */ filter?: string; /** * The list of product categories to search in. Currently, we only consider * the first category, and either "homegoods", * "apparel", or "toys" should be specified. */ productCategories?: string[]; /** * The resource name of a ProductSet to be searched for similar images. * Format is: * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. */ productSet?: string; } /** * Results for a product search request. */ interface Schema$ProductSearchResults { /** * Timestamp of the index which provided these results. Changes made after * this time are not reflected in the current results. */ indexTime?: string; /** * List of results grouped by products detected in the query image. Each * entry corresponds to one bounding polygon in the query image, and * contains the matching products specific to that region. There may be * duplicate product matches in the union of all the per-product results. */ productGroupedResults?: Schema$GroupedResult[]; /** * List of results, one for each product match. */ results?: Schema$Result[]; } /** * A ProductSet contains Products. A ProductSet can contain a maximum of 1 * million reference images. If the limit is exceeded, periodic indexing will * fail. */ interface Schema$ProductSet { /** * The user-provided name for this ProductSet. Must not be empty. Must be at * most 4096 characters long. */ displayName?: string; /** * Output only. If there was an error with indexing the product set, the * field is populated. This field is ignored when creating a ProductSet. */ indexError?: Schema$Status; /** * Output only. The time at which this ProductSet was last indexed. Query * results will reflect all updates before this time. If this ProductSet has * never been indexed, this timestamp is the default value * "1970-01-01T00:00:00Z". This field is ignored when creating a * ProductSet. */ indexTime?: string; /** * The resource name of the ProductSet. Format is: * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This * field is ignored when creating a ProductSet. */ name?: string; } /** * A `Property` consists of a user-supplied name/value pair. */ interface Schema$Property { /** * Name of the property. */ name?: string; /** * Value of numeric properties. */ uint64Value?: string; /** * Value of the property. */ value?: string; } /** * A `ReferenceImage` represents a product image and its associated metadata, * such as bounding boxes. */ interface Schema$ReferenceImage { /** * Bounding polygons around the areas of interest in the reference image. * Optional. If this field is empty, the system will try to detect regions * of interest. At most 10 bounding polygons will be used. The provided * shape is converted into a non-rotated rectangle. Once converted, the * small edge of the rectangle must be greater than or equal to 300 pixels. * The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** * The resource name of the reference image. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. * This field is ignored when creating a reference image. */ name?: string; /** * The Google Cloud Storage URI of the reference image. The URI must start * with `gs://`. Required. */ uri?: string; } /** * Request message for the `RemoveProductFromProductSet` method. */ interface Schema$RemoveProductFromProductSetRequest { /** * The resource name for the Product to be removed from this ProductSet. * Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ product?: string; } /** * Information about a product. */ interface Schema$Result { /** * The resource name of the image from the product that is the closest match * to the query. */ image?: string; /** * The Product. */ product?: Schema$Product; /** * A confidence level on the match, ranging from 0 (no confidence) to 1 * (full confidence). */ score?: number; } /** * Set of features pertaining to the image, computed by computer vision * methods over safe-search verticals (for example, adult, spoof, medical, * violence). */ interface Schema$SafeSearchAnnotation { /** * Represents the adult content likelihood for the image. Adult content may * contain elements such as nudity, pornographic images or cartoons, or * sexual activities. */ adult?: string; /** * Likelihood that this is a medical image. */ medical?: string; /** * Likelihood that the request image contains racy content. Racy content may * include (but is not limited to) skimpy or sheer clothing, strategically * covered nudity, lewd or provocative poses, or close-ups of sensitive body * areas. */ racy?: string; /** * Spoof likelihood. The likelihood that an modification was made to the * image's canonical version to make it appear funny or offensive. */ spoof?: string; /** * Likelihood that this image contains violent content. */ violence?: string; } /** * The `Status` type defines a logical error model that is suitable for * different programming environments, including REST APIs and RPC APIs. It is * used by [gRPC](https://github.com/grpc). The error model is designed to be: * - Simple to use and understand for most users - Flexible enough to meet * unexpected needs # Overview The `Status` message contains three pieces of * data: error code, error message, and error details. The error code should * be an enum value of google.rpc.Code, but it may accept additional error * codes if needed. The error message should be a developer-facing English * message that helps developers *understand* and *resolve* the error. If a * localized user-facing error message is needed, put the localized message in * the error details or localize it in the client. The optional error details * may contain arbitrary information about the error. There is a predefined * set of error detail types in the package `google.rpc` that can be used for * common error conditions. # Language mapping The `Status` message is the * logical representation of the error model, but it is not necessarily the * actual wire format. When the `Status` message is exposed in different * client libraries and different wire protocols, it can be mapped * differently. For example, it will likely be mapped to some exceptions in * Java, but more likely mapped to some error codes in C. # Other uses The * error model and the `Status` message can be used in a variety of * environments, either with or without APIs, to provide a consistent * developer experience across different environments. Example uses of this * error model include: - Partial errors. If a service needs to return * partial errors to the client, it may embed the `Status` in the normal * response to indicate the partial errors. - Workflow errors. A typical * workflow has multiple steps. Each step may have a `Status` message for * error reporting. - Batch operations. If a client uses batch request and * batch response, the `Status` message should be used directly inside * batch response, one for each error sub-response. - Asynchronous * operations. If an API call embeds asynchronous operation results in its * response, the status of those operations should be represented directly * using the `Status` message. - Logging. If some API errors are stored in * logs, the message `Status` could be used directly after any stripping * needed for security/privacy reasons. */ interface Schema$Status { /** * The status code, which should be an enum value of google.rpc.Code. */ code?: number; /** * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ details?: Array<{ [key: string]: any; }>; /** * A developer-facing error message, which should be in English. Any * user-facing error message should be localized and sent in the * google.rpc.Status.details field, or localized by the client. */ message?: string; } /** * A single symbol representation. */ interface Schema$Symbol { /** * The bounding box for the symbol. The vertices are in the order of * top-left, top-right, bottom-right, bottom-left. When a rotation of the * bounding box is detected the rotation is represented as around the * top-left corner as defined when the text is read in the 'natural' * orientation. For example: * 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 vertice order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the symbol. */ property?: Schema$TextProperty; /** * The actual UTF-8 representation of the symbol. */ text?: string; } /** * TextAnnotation contains a structured representation of OCR extracted text. * The hierarchy of an OCR extracted text structure is like this: * TextAnnotation -> Page -> Block -> Paragraph -> Word -> * Symbol Each structural component, starting from Page, may further have * their own properties. Properties describe detected languages, breaks etc.. * Please refer to the TextAnnotation.TextProperty message definition below * for more detail. */ interface Schema$TextAnnotation { /** * List of pages detected by OCR. */ pages?: Schema$Page[]; /** * UTF-8 text detected on the pages. */ text?: string; } /** * Additional information detected on the structural component. */ interface Schema$TextProperty { /** * Detected start or end of a text segment. */ detectedBreak?: Schema$DetectedBreak; /** * A list of detected languages together with confidence. */ detectedLanguages?: Schema$DetectedLanguage[]; } /** * A vertex represents a 2D point in the image. NOTE: the vertex coordinates * are in the same scale as the original image. */ interface Schema$Vertex { /** * X coordinate. */ x?: number; /** * Y coordinate. */ y?: number; } /** * Relevant information for the image from the Internet. */ interface Schema$WebDetection { /** * The service's best guess as to the topic of the request image. * Inferred from similar images on the open web. */ bestGuessLabels?: Schema$WebLabel[]; /** * Fully matching images from the Internet. Can include resized copies of * the query image. */ fullMatchingImages?: Schema$WebImage[]; /** * Web pages containing the matching images from the Internet. */ pagesWithMatchingImages?: Schema$WebPage[]; /** * Partial matching images from the Internet. Those images are similar * enough to share some key-point features. For example an original image * will likely have partial matching for its crops. */ partialMatchingImages?: Schema$WebImage[]; /** * The visually similar image results. */ visuallySimilarImages?: Schema$WebImage[]; /** * Deduced entities from similar images on the Internet. */ webEntities?: Schema$WebEntity[]; } /** * Parameters for web detection request. */ interface Schema$WebDetectionParams { /** * Whether to include results derived from the geo information in the image. */ includeGeoResults?: boolean; } /** * Entity deduced from similar images on the Internet. */ interface Schema$WebEntity { /** * Canonical description of the entity, in English. */ description?: string; /** * Opaque entity ID. */ entityId?: string; /** * Overall relevancy score for the entity. Not normalized and not comparable * across different image queries. */ score?: number; } /** * Metadata for online images. */ interface Schema$WebImage { /** * (Deprecated) Overall relevancy score for the image. */ score?: number; /** * The result image URL. */ url?: string; } /** * Label to provide extra metadata for the web detection. */ interface Schema$WebLabel { /** * Label for extra metadata. */ label?: string; /** * The BCP-47 language code for `label`, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ languageCode?: string; } /** * Metadata for web pages. */ interface Schema$WebPage { /** * Fully matching images on the page. Can include resized copies of the * query image. */ fullMatchingImages?: Schema$WebImage[]; /** * Title for the web page, may contain HTML markups. */ pageTitle?: string; /** * Partial matching images on the page. Those images are similar enough to * share some key-point features. For example an original image will likely * have partial matching for its crops. */ partialMatchingImages?: Schema$WebImage[]; /** * (Deprecated) Overall relevancy score for the web page. */ score?: number; /** * The result web page URL. */ url?: string; } /** * A word representation. */ interface Schema$Word { /** * The bounding box for the word. The vertices are in the order of top-left, * top-right, bottom-right, bottom-left. When a rotation of the bounding box * is detected the rotation is represented as around the top-left corner as * defined when the text is read in the 'natural' orientation. For * example: * 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). */ boundingBox?: Schema$BoundingPoly; /** * Confidence of the OCR results for the word. Range [0, 1]. */ confidence?: number; /** * Additional information detected for the word. */ property?: Schema$TextProperty; /** * List of symbols in the word. The order of the symbols follows the natural * reading order. */ symbols?: Schema$Symbol[]; } class Resource$Files { constructor(); /** * vision.files.asyncBatchAnnotate * @desc Run asynchronous image detection and annotation for a list of * generic files, such as PDF files, which may contain multiple pages and * multiple images per page. Progress and results can be retrieved through * the `google.longrunning.Operations` interface. `Operation.metadata` * contains `OperationMetadata` (metadata). `Operation.response` contains * `AsyncBatchAnnotateFilesResponse` (results). * @alias vision.files.asyncBatchAnnotate * @memberOf! () * * @param {object} params Parameters for request * @param {().AsyncBatchAnnotateFilesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ asyncBatchAnnotate(params?: Params$Resource$Files$Asyncbatchannotate, options?: MethodOptions): GaxiosPromise; asyncBatchAnnotate(params: Params$Resource$Files$Asyncbatchannotate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; asyncBatchAnnotate(params: Params$Resource$Files$Asyncbatchannotate, callback: BodyResponseCallback): void; asyncBatchAnnotate(callback: BodyResponseCallback): void; } interface Params$Resource$Files$Asyncbatchannotate extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$AsyncBatchAnnotateFilesRequest; } class Resource$Images { constructor(); /** * vision.images.annotate * @desc Run image detection and annotation for a batch of images. * @example * * // BEFORE RUNNING: * // --------------- * // 1. If not already done, enable the Google Cloud Vision API * // and check the quota for your project at * // https://console.developers.google.com/apis/api/vision * // 2. This sample uses Application Default Credentials for * authentication. * // If not already done, install the gcloud CLI from * // https://cloud.google.com/sdk and run * // `gcloud beta auth application-default login`. * // For more information, see * // * https://developers.google.com/identity/protocols/application-default-credentials * // 3. Install the Node.js client library by running * // `npm install googleapis --save` * * var google = require('googleapis'); * var vision = google.vision('v1'); * * authorize(function(authClient) { * var request = { * resource: { * // TODO: Add desired properties to the request body. * }, * * auth: authClient, * }; * * vision.images.annotate(request, function(err, response) { * if (err) { * console.error(err); * return; * } * * // TODO: Change code below to process the `response` object: * console.log(JSON.stringify(response, null, 2)); * }); * }); * * function authorize(callback) { * google.auth.getApplicationDefault(function(err, authClient) { * if (err) { * console.error('authentication failed: ', err); * return; * } * if (authClient.createScopedRequired && * authClient.createScopedRequired()) { var scopes = * ['https://www.googleapis.com/auth/cloud-platform']; authClient = * authClient.createScoped(scopes); * } * callback(authClient); * }); * } * @alias vision.images.annotate * @memberOf! () * * @param {object} params Parameters for request * @param {().BatchAnnotateImagesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ annotate(params?: Params$Resource$Images$Annotate, options?: MethodOptions): GaxiosPromise; annotate(params: Params$Resource$Images$Annotate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; annotate(params: Params$Resource$Images$Annotate, callback: BodyResponseCallback): void; annotate(callback: BodyResponseCallback): void; } interface Params$Resource$Images$Annotate extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$BatchAnnotateImagesRequest; } class Resource$Locations { operations: Resource$Locations$Operations; constructor(); } class Resource$Locations$Operations { constructor(); /** * vision.locations.operations.get * @desc Gets the latest state of a long-running operation. Clients can use * this method to poll the operation result at intervals as recommended by * the API service. * @alias vision.locations.operations.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Locations$Operations$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Locations$Operations$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; } interface Params$Resource$Locations$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the operation resource. */ name?: string; } class Resource$Operations { constructor(); /** * vision.operations.cancel * @desc Starts asynchronous cancellation on a long-running operation. The * server makes a best effort to cancel the operation, but success is not * guaranteed. If the server doesn't support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation * or other methods to check whether the cancellation succeeded or whether * the operation completed despite cancellation. On successful cancellation, * the operation is not deleted; instead, it becomes an operation with an * Operation.error value with a google.rpc.Status.code of 1, corresponding * to `Code.CANCELLED`. * @alias vision.operations.cancel * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource to be cancelled. * @param {().CancelOperationRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ cancel(params?: Params$Resource$Operations$Cancel, options?: MethodOptions): GaxiosPromise; cancel(params: Params$Resource$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; cancel(params: Params$Resource$Operations$Cancel, callback: BodyResponseCallback): void; cancel(callback: BodyResponseCallback): void; /** * vision.operations.delete * @desc Deletes a long-running operation. This method indicates that the * client is no longer interested in the operation result. It does not * cancel the operation. If the server doesn't support this method, it * returns `google.rpc.Code.UNIMPLEMENTED`. * @alias vision.operations.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource to be deleted. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Operations$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Operations$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vision.operations.get * @desc Gets the latest state of a long-running operation. Clients can use * this method to poll the operation result at intervals as recommended by * the API service. * @alias vision.operations.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * vision.operations.list * @desc Lists operations that match the specified filter in the request. If * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: * the `name` binding allows API services to override the binding to use * different resource name schemes, such as `users/x/operations`. To * override the binding, API services can add a binding such as * `"/v1/{name=users/x}/operations"` to their service configuration. For * backwards compatibility, the default name includes the operations * collection id, however overriding users must ensure the name binding is * the parent resource, without the operations collection id. * @alias vision.operations.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter The standard list filter. * @param {string} params.name The name of the operation's parent resource. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Operations$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Operations$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Operations$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Operations$Cancel extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the operation resource to be cancelled. */ name?: string; /** * Request body metadata */ requestBody?: Schema$CancelOperationRequest; } interface Params$Resource$Operations$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the operation resource to be deleted. */ name?: string; } interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the operation resource. */ name?: string; } interface Params$Resource$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The standard list filter. */ filter?: string; /** * The name of the operation's parent resource. */ name?: string; /** * The standard list page size. */ pageSize?: number; /** * The standard list page token. */ pageToken?: string; } class Resource$Projects { locations: Resource$Projects$Locations; constructor(); } class Resource$Projects$Locations { products: Resource$Projects$Locations$Products; productSets: Resource$Projects$Locations$Productsets; constructor(); } class Resource$Projects$Locations$Products { referenceImages: Resource$Projects$Locations$Products$Referenceimages; constructor(); /** * vision.projects.locations.products.create * @desc Creates and returns a new product resource. Possible errors: * * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 * characters. * Returns INVALID_ARGUMENT if description is longer than 4096 * characters. * Returns INVALID_ARGUMENT if product_category is missing or * invalid. * @alias vision.projects.locations.products.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {string=} params.productId A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().Product} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Projects$Locations$Products$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Projects$Locations$Products$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Locations$Products$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * vision.projects.locations.products.delete * @desc Permanently deletes a product and its reference images. Metadata * of the product and all its images will be deleted right away, but search * queries against ProductSets containing the product may still work until * all related caches are refreshed. Possible errors: * Returns NOT_FOUND * if the product does not exist. * @alias vision.projects.locations.products.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Locations$Products$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Locations$Products$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Locations$Products$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vision.projects.locations.products.get * @desc Gets information associated with a Product. Possible errors: * * Returns NOT_FOUND if the Product does not exist. * @alias vision.projects.locations.products.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Locations$Products$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Locations$Products$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Products$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * vision.projects.locations.products.list * @desc Lists products in an unspecified order. Possible errors: * * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. * @alias vision.projects.locations.products.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. * @param {string} params.parent The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Locations$Products$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Locations$Products$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Products$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * vision.projects.locations.products.patch * @desc Makes changes to a Product resource. Only the `display_name`, * `description`, and `labels` fields can be updated right now. If labels * are updated, the change will not be reflected in queries until the next * index time. Possible errors: * Returns NOT_FOUND if the Product does * not exist. * Returns INVALID_ARGUMENT if display_name is present in * update_mask but is missing from the request or longer than 4096 * characters. * Returns INVALID_ARGUMENT if description is present in * update_mask but is longer than 4096 characters. * Returns * INVALID_ARGUMENT if product_category is present in update_mask. * @alias vision.projects.locations.products.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. * @param {string=} params.updateMask The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`. * @param {().Product} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: Params$Resource$Projects$Locations$Products$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Projects$Locations$Products$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Projects$Locations$Products$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Locations$Products$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The project in which the Product should be created. Format is * `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** * A user-supplied resource id for this Product. If set, the server will * attempt to use this value as the resource id. If it is already in use, an * error is returned with code ALREADY_EXISTS. Must be at most 128 * characters long. It cannot contain the character `/`. */ productId?: string; /** * Request body metadata */ requestBody?: Schema$Product; } interface Params$Resource$Projects$Locations$Products$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Resource name of product to delete. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ name?: string; } interface Params$Resource$Projects$Locations$Products$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Resource name of the Product to get. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ name?: string; } interface Params$Resource$Projects$Locations$Products$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The maximum number of items to return. Default 10, maximum 100. */ pageSize?: number; /** * The next_page_token returned from a previous List request, if any. */ pageToken?: string; /** * The project OR ProductSet from which Products should be listed. Format: * `projects/PROJECT_ID/locations/LOC_ID` */ parent?: string; } interface Params$Resource$Projects$Locations$Products$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name of the product. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field * is ignored when creating a product. */ name?: string; /** * The FieldMask that specifies which fields to update. If update_mask isn't * specified, all mutable fields are to be updated. Valid mask paths include * `product_labels`, `display_name`, and `description`. */ updateMask?: string; /** * Request body metadata */ requestBody?: Schema$Product; } class Resource$Projects$Locations$Products$Referenceimages { constructor(); /** * vision.projects.locations.products.referenceImages.create * @desc Creates and returns a new ReferenceImage resource. The * `bounding_poly` field is optional. If `bounding_poly` is not specified, * the system will try to detect regions of interest in the image that are * compatible with the product_category on the parent product. If it is * specified, detection is ALWAYS skipped. The system converts polygons into * non-rotated rectangles. Note that the pipeline will resize the image if * the image resolution is too large to process (above 50MP). Possible * errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer * than 4096 characters. * Returns INVALID_ARGUMENT if the product does * not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, * and nothing compatible with the parent product's product_category is * detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than * 10 polygons. * @alias vision.projects.locations.products.referenceImages.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. * @param {string=} params.referenceImageId A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().ReferenceImage} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Projects$Locations$Products$Referenceimages$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Projects$Locations$Products$Referenceimages$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Locations$Products$Referenceimages$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * vision.projects.locations.products.referenceImages.delete * @desc Permanently deletes a reference image. The image metadata will be * deleted right away, but search queries against ProductSets containing the * image may still work until all related caches are refreshed. The actual * image files are not deleted from Google Cloud Storage. Possible errors: * * Returns NOT_FOUND if the reference image does not exist. * @alias vision.projects.locations.products.referenceImages.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Locations$Products$Referenceimages$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Locations$Products$Referenceimages$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Locations$Products$Referenceimages$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vision.projects.locations.products.referenceImages.get * @desc Gets information associated with a ReferenceImage. Possible * errors: * Returns NOT_FOUND if the specified image does not exist. * @alias vision.projects.locations.products.referenceImages.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Locations$Products$Referenceimages$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Locations$Products$Referenceimages$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Products$Referenceimages$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * vision.projects.locations.products.referenceImages.list * @desc Lists reference images. Possible errors: * Returns NOT_FOUND if * the parent product does not exist. * Returns INVALID_ARGUMENT if the * page_size is greater than 100, or less than 1. * @alias vision.projects.locations.products.referenceImages.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. * @param {string} params.parent Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Locations$Products$Referenceimages$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Locations$Products$Referenceimages$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Products$Referenceimages$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Locations$Products$Referenceimages$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Resource name of the product in which to create the reference image. * Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. */ parent?: string; /** * A user-supplied resource id for the ReferenceImage to be added. If set, * the server will attempt to use this value as the resource id. If it is * already in use, an error is returned with code ALREADY_EXISTS. Must be at * most 128 characters long. It cannot contain the character `/`. */ referenceImageId?: string; /** * Request body metadata */ requestBody?: Schema$ReferenceImage; } interface Params$Resource$Projects$Locations$Products$Referenceimages$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name of the reference image to delete. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` */ name?: string; } interface Params$Resource$Projects$Locations$Products$Referenceimages$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name of the ReferenceImage to get. Format is: * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. */ name?: string; } interface Params$Resource$Projects$Locations$Products$Referenceimages$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The maximum number of items to return. Default 10, maximum 100. */ pageSize?: number; /** * A token identifying a page of results to be returned. This is the value * of `nextPageToken` returned in a previous reference image list request. * Defaults to the first page if not specified. */ pageToken?: string; /** * Resource name of the product containing the reference images. Format is * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. */ parent?: string; } class Resource$Projects$Locations$Productsets { products: Resource$Projects$Locations$Productsets$Products; constructor(); /** * vision.projects.locations.productSets.addProduct * @desc Adds a Product to the specified ProductSet. If the Product is * already present, no change is made. One Product can be added to at most * 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or * the ProductSet doesn't exist. * @alias vision.projects.locations.productSets.addProduct * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {().AddProductToProductSetRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ addProduct(params?: Params$Resource$Projects$Locations$Productsets$Addproduct, options?: MethodOptions): GaxiosPromise; addProduct(params: Params$Resource$Projects$Locations$Productsets$Addproduct, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; addProduct(params: Params$Resource$Projects$Locations$Productsets$Addproduct, callback: BodyResponseCallback): void; addProduct(callback: BodyResponseCallback): void; /** * vision.projects.locations.productSets.create * @desc Creates and returns a new ProductSet resource. Possible errors: * * Returns INVALID_ARGUMENT if display_name is missing, or is longer than * 4096 characters. * @alias vision.projects.locations.productSets.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {string=} params.productSetId A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().ProductSet} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Projects$Locations$Productsets$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Projects$Locations$Productsets$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Locations$Productsets$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * vision.projects.locations.productSets.delete * @desc Permanently deletes a ProductSet. Products and ReferenceImages in * the ProductSet are not deleted. The actual image files are not deleted * from Google Cloud Storage. Possible errors: * Returns NOT_FOUND if the * ProductSet does not exist. * @alias vision.projects.locations.productSets.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Locations$Productsets$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Locations$Productsets$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Locations$Productsets$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * vision.projects.locations.productSets.get * @desc Gets information associated with a ProductSet. Possible errors: * * Returns NOT_FOUND if the ProductSet does not exist. * @alias vision.projects.locations.productSets.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Locations$Productsets$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Locations$Productsets$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Productsets$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * vision.projects.locations.productSets.import * @desc Asynchronous API that imports a list of reference images to specified * product sets based on a list of image information. The * google.longrunning.Operation API can be used to keep track of the progress * and results of the request. `Operation.metadata` contains * `BatchOperationMetadata`. (progress) `Operation.response` contains * `ImportProductSetsResponse`. (results) The input source of this method is a * csv file on Google Cloud Storage. For the format of the csv file please see * ImportProductSetsGcsSource.csv_file_uri. * @alias vision.projects.locations.productSets.import * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {().ImportProductSetsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ import(params?: Params$Resource$Projects$Locations$Productsets$Import, options?: MethodOptions): GaxiosPromise; import(params: Params$Resource$Projects$Locations$Productsets$Import, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; import(params: Params$Resource$Projects$Locations$Productsets$Import, callback: BodyResponseCallback): void; import(callback: BodyResponseCallback): void; /** * vision.projects.locations.productSets.list * @desc Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1. * @alias vision.projects.locations.productSets.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. * @param {string} params.parent The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Locations$Productsets$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Locations$Productsets$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Productsets$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * vision.projects.locations.productSets.patch * @desc Makes changes to a ProductSet resource. Only display_name can be * updated currently. Possible errors: * Returns NOT_FOUND if the * ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is * present in update_mask but missing from the request or longer than 4096 * characters. * @alias vision.projects.locations.productSets.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. * @param {string=} params.updateMask The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is `display_name`. * @param {().ProductSet} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: Params$Resource$Projects$Locations$Productsets$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Projects$Locations$Productsets$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Projects$Locations$Productsets$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * vision.projects.locations.productSets.removeProduct * @desc Removes a Product from the specified ProductSet. Possible errors: * * Returns NOT_FOUND If the Product is not found under the ProductSet. * @alias vision.projects.locations.productSets.removeProduct * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {().RemoveProductFromProductSetRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ removeProduct(params?: Params$Resource$Projects$Locations$Productsets$Removeproduct, options?: MethodOptions): GaxiosPromise; removeProduct(params: Params$Resource$Projects$Locations$Productsets$Removeproduct, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; removeProduct(params: Params$Resource$Projects$Locations$Productsets$Removeproduct, callback: BodyResponseCallback): void; removeProduct(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Locations$Productsets$Addproduct extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name for the ProductSet to modify. Format is: * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; /** * Request body metadata */ requestBody?: Schema$AddProductToProductSetRequest; } interface Params$Resource$Projects$Locations$Productsets$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The project in which the ProductSet should be created. Format is * `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** * A user-supplied resource id for this ProductSet. If set, the server will * attempt to use this value as the resource id. If it is already in use, an * error is returned with code ALREADY_EXISTS. Must be at most 128 * characters long. It cannot contain the character `/`. */ productSetId?: string; /** * Request body metadata */ requestBody?: Schema$ProductSet; } interface Params$Resource$Projects$Locations$Productsets$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Resource name of the ProductSet to delete. Format is: * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; } interface Params$Resource$Projects$Locations$Productsets$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Resource name of the ProductSet to get. Format is: * `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` */ name?: string; } interface Params$Resource$Projects$Locations$Productsets$Import extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The project in which the ProductSets should be imported. Format is * `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** * Request body metadata */ requestBody?: Schema$ImportProductSetsRequest; } interface Params$Resource$Projects$Locations$Productsets$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The maximum number of items to return. Default 10, maximum 100. */ pageSize?: number; /** * The next_page_token returned from a previous List request, if any. */ pageToken?: string; /** * The project from which ProductSets should be listed. Format is * `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; } interface Params$Resource$Projects$Locations$Productsets$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name of the ProductSet. Format is: * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This * field is ignored when creating a ProductSet. */ name?: string; /** * The FieldMask that specifies which fields to update. If update_mask isn't * specified, all mutable fields are to be updated. Valid mask path is * `display_name`. */ updateMask?: string; /** * Request body metadata */ requestBody?: Schema$ProductSet; } interface Params$Resource$Projects$Locations$Productsets$Removeproduct extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name for the ProductSet to modify. Format is: * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; /** * Request body metadata */ requestBody?: Schema$RemoveProductFromProductSetRequest; } class Resource$Projects$Locations$Productsets$Products { constructor(); /** * vision.projects.locations.productSets.products.list * @desc Lists the Products in a ProductSet, in an unspecified order. If the * ProductSet does not exist, the products field of the response will be * empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is * greater than 100 or less than 1. * @alias vision.projects.locations.productSets.products.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Locations$Productsets$Products$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Locations$Productsets$Products$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Productsets$Products$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Locations$Productsets$Products$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The ProductSet resource for which to retrieve Products. Format is: * `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; /** * The maximum number of items to return. Default 10, maximum 100. */ pageSize?: number; /** * The next_page_token returned from a previous List request, if any. */ pageToken?: string; } }