package google.cloud.vision.v1p3beta1

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

service ImageAnnotator

image_annotator.proto:39

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

service ProductSearch

product_search_service.proto:51

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model: - The API has a collection of [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] resources, named `projects/*/locations/*/productSets/*`, which acts as a way to put different products into groups to limit identification. In parallel, - The API has a collection of [Product][google.cloud.vision.v1p3beta1.Product] resources, named `projects/*/locations/*/products/*` - Each [Product][google.cloud.vision.v1p3beta1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1p3beta1.ReferenceImage] resources, named `projects/*/locations/*/products/*/referenceImages/*`

message AnnotateFileResponse

image_annotator.proto:643

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

message AnnotateImageRequest

image_annotator.proto:566

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.

Used in: BatchAnnotateImagesRequest

message AnnotateImageResponse

image_annotator.proto:589

Response to an image annotation request.

Used in: AnnotateFileResponse, BatchAnnotateImagesResponse

message AsyncAnnotateFileRequest

image_annotator.proto:664

An offline file annotation request.

Used in: AsyncBatchAnnotateFilesRequest

message AsyncAnnotateFileResponse

image_annotator.proto:679

The response for a single offline file annotation request.

Used in: AsyncBatchAnnotateFilesResponse

message AsyncBatchAnnotateFilesResponse

image_annotator.proto:692

Response to an async batch file annotation request.

message BatchOperationMetadata

product_search_service.proto:810

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.

enum BatchOperationMetadata.State

product_search_service.proto:812

Enumerates the possible states that the batch request can be in.

Used in: BatchOperationMetadata

message Block

text_annotation.proto:116

Logical element on the page.

Used in: Page

enum Block.BlockType

text_annotation.proto:118

Type of a block (text, image etc) as identified by OCR.

Used in: Block

message BoundingPoly

geometry.proto:49

A bounding polygon for the detected image annotation.

Used in: Block, CropHint, EntityAnnotation, FaceAnnotation, LocalizedObjectAnnotation, Paragraph, ProductSearchParams, ReferenceImage, Symbol, Word

message ColorInfo

image_annotator.proto:478

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Used in: DominantColorsAnnotation

message CropHint

image_annotator.proto:503

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

Used in: CropHintsAnnotation

message CropHintsAnnotation

image_annotator.proto:517

Set of crop hints that are used to generate new crops when serving images.

Used in: AnnotateImageResponse

message CropHintsParams

image_annotator.proto:523

Parameters for crop hints annotation request.

Used in: ImageContext

message DominantColorsAnnotation

image_annotator.proto:491

Set of dominant colors and their corresponding scores.

Used in: ImageProperties

message EntityAnnotation

image_annotator.proto:374

Set of detected entity features.

Used in: AnnotateImageResponse

message FaceAnnotation

image_annotator.proto:172

A face annotation object contains the results of face detection.

Used in: AnnotateImageResponse

message FaceAnnotation.Landmark

image_annotator.proto:174

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

Used in: FaceAnnotation

enum FaceAnnotation.Landmark.Type

image_annotator.proto:179

Face landmark (feature) type. Left and right are defined from the vantage of the viewer of the image without considering mirror projections typical of photos. So, `LEFT_EYE`, typically, is the person's right eye.

Used in: Landmark

message Feature

image_annotator.proto:67

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.

Used in: AnnotateImageRequest, AsyncAnnotateFileRequest

enum Feature.Type

image_annotator.proto:69

Type of Google Cloud Vision API feature to be extracted.

Used in: Feature

message GcsDestination

image_annotator.proto:735

The Google Cloud Storage location where the output will be written to.

Used in: OutputConfig

message GcsSource

image_annotator.proto:728

The Google Cloud Storage location where the input will be read from.

Used in: InputConfig

message Image

image_annotator.proto:159

Client image to perform Google Cloud Vision API tasks over.

Used in: AnnotateImageRequest

message ImageAnnotationContext

image_annotator.proto:579

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.

Used in: AnnotateImageResponse

message ImageContext

image_annotator.proto:540

Image context and/or feature-specific parameters.

Used in: AnnotateImageRequest, AsyncAnnotateFileRequest

message ImageProperties

image_annotator.proto:497

Stores image properties, such as dominant colors.

Used in: AnnotateImageResponse

message ImageSource

image_annotator.proto:129

External image source (Google Cloud Storage or web URL image location).

Used in: Image

message ImportProductSetsGcsSource

product_search_service.proto:704

The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.

Used in: ImportProductSetsInputConfig

message ImportProductSetsInputConfig

product_search_service.proto:766

The input content for the `ImportProductSets` method.

Used in: ImportProductSetsRequest

message ImportProductSetsResponse

product_search_service.proto:793

Response message for the `ImportProductSets` method. This message is returned by the [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned [google.longrunning.Operation.response][google.longrunning.Operation.response] field.

message InputConfig

image_annotator.proto:699

The desired input location and metadata.

Used in: AnnotateFileResponse, AsyncAnnotateFileRequest

message LatLongRect

image_annotator.proto:468

Rectangle determined by min and max `LatLng` pairs.

Used in: ImageContext

enum Likelihood

image_annotator.proto:756

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

Used in: FaceAnnotation, SafeSearchAnnotation

message LocalizedObjectAnnotation

image_annotator.proto:421

Set of detected objects with bounding boxes.

Used in: AnnotateImageResponse

message LocationInfo

image_annotator.proto:356

Detected entity location information.

Used in: EntityAnnotation

message NormalizedBoundingPoly

geometry.proto:58

A normalized bounding polygon around a portion of an image.

Used in: ProductSearchParams

message NormalizedVertex

geometry.proto:40

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.

Used in: BoundingPoly, NormalizedBoundingPoly

message OperationMetadata

image_annotator.proto:777

Contains metadata for the BatchAnnotateImages operation.

enum OperationMetadata.State

image_annotator.proto:779

Batch operation states.

Used in: OperationMetadata

message OutputConfig

image_annotator.proto:709

The desired output location and metadata.

Used in: AsyncAnnotateFileRequest, AsyncAnnotateFileResponse

message Page

text_annotation.proto:96

Detected page from OCR.

Used in: TextAnnotation

message Paragraph

text_annotation.proto:174

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

Used in: Block

message Position

geometry.proto:66

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.

Used in: FaceAnnotation.Landmark

message Product

product_search_service.proto:326

A Product contains ReferenceImages.

Used as response type in: ProductSearch.CreateProduct, ProductSearch.GetProduct, ProductSearch.UpdateProduct

Used as field type in: CreateProductRequest, ListProductsInProductSetResponse, ListProductsResponse, ProductSearchResults.Result, UpdateProductRequest

message Product.KeyValue

product_search_service.proto:328

A product label represented as a key-value pair.

Used in: Product

enum ProductSearchCategory

product_search.proto:142

Supported product search categories.

Used in: ProductSearchParams, ProductSearchResults

message ProductSearchParams

product_search.proto:31

Parameters for a product search request.

Used in: ImageContext

message ProductSearchResults

product_search.proto:84

Results for a product search request.

Used in: AnnotateImageResponse

message ProductSearchResults.ProductInfo

product_search.proto:86

Information about a product.

Used in: ProductSearchResults

message ProductSearchResults.Result

product_search.proto:105

Information about a product.

Used in: ProductSearchResults

enum ProductSearchResultsView

product_search.proto:154

Specifies the fields to include in product search results.

Used in: ProductSearchParams

message ProductSet

product_search_service.proto:375

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

Used as response type in: ProductSearch.CreateProductSet, ProductSearch.GetProductSet, ProductSearch.UpdateProductSet

Used as field type in: CreateProductSetRequest, ListProductSetsResponse, UpdateProductSetRequest

message Property

image_annotator.proto:362

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

Used in: EntityAnnotation

message ReferenceImage

product_search_service.proto:404

A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.

Used as response type in: ProductSearch.CreateReferenceImage, ProductSearch.GetReferenceImage

Used as field type in: CreateReferenceImageRequest, ImportProductSetsResponse, ListReferenceImagesResponse

message SafeSearchAnnotation

image_annotator.proto:443

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

Used in: AnnotateImageResponse

message Symbol

text_annotation.proto:233

A single symbol representation.

Used in: Word

message TextAnnotation

text_annotation.proto:36

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][google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty] message definition below for more detail.

Used in: AnnotateImageResponse

message TextAnnotation.DetectedBreak

text_annotation.proto:49

Detected start or end of a structural component.

Used in: TextProperty

enum TextAnnotation.DetectedBreak.BreakType

text_annotation.proto:51

Enum to denote the type of break found. New line, space etc.

Used in: DetectedBreak

message TextAnnotation.DetectedLanguage

text_annotation.proto:38

Detected language for a structural component.

Used in: TextProperty

message TextAnnotation.TextProperty

text_annotation.proto:80

Additional information detected on the structural component.

Used in: Block, Page, Paragraph, Symbol, Word

message Vertex

geometry.proto:29

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Used in: BoundingPoly

message WebDetection

web_detection.proto:28

Relevant information for the image from the Internet.

Used in: AnnotateImageResponse

message WebDetection.WebEntity

web_detection.proto:30

Entity deduced from similar images on the Internet.

Used in: WebDetection

message WebDetection.WebImage

web_detection.proto:43

Metadata for online images.

Used in: WebDetection, WebPage

message WebDetection.WebLabel

web_detection.proto:74

Label to provide extra metadata for the web detection.

Used in: WebDetection

message WebDetection.WebPage

web_detection.proto:52

Metadata for web pages.

Used in: WebDetection

message WebDetectionParams

image_annotator.proto:534

Parameters for web detection request.

Used in: ImageContext

message Word

text_annotation.proto:203

A word representation.

Used in: Paragraph