Package google.cloud.vision.v1p3beta1

索引

ImageAnnotator

用于对客户端图片执行 Google Cloud Vision API 检测任务的服务，可执行人脸、标志、徽标、标签和文本等内容的检测。ImageAnnotator 服务返回从图片中检测到的实体。

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

对常规文件（例如可能包含多页、每页可能包含多张图片的 PDF 文件）列表运行异步图片检测和注释。您可以通过 google.longrunning.Operations 接口检索进度和结果。Operation.metadata 包含 OperationMetadata（元数据）。Operation.response 包含 AsyncBatchAnnotateFilesResponse（结果）。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
BatchAnnotateImages

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

对一批图片运行图片检测和注释。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。

ProductSearch

管理要在 Product Search 中使用的参考图片的 Product 和 ProductSet。它使用以下资源模型：

  • 该 API 有一个名为 projects/*/locations/*/productSets/* 的 ProductSet 资源集合，它是一种将不同商品放入组中，以限制识别的方式。

此外它还使用如下资源：

  • 该 API 有一个名为 projects/*/locations/*/products/* 的 Product 资源集合

  • 每个 Product 都有一组名为 projects/*/locations/*/products/*/referenceImages/* 的 ReferenceImage 资源

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

将 Product 添加到指定的 ProductSet。如果该 Product 已存在，则不会进行任何更改。

1 个 Product 最多只能添加到 100 个 ProductSet 中。

可能出现的错误：

  • 如果 Product 或 ProductSet 不存在，则返回 NOT_FOUND。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
CreateProduct

rpc CreateProduct(CreateProductRequest) returns (Product)

创建并返回新的商品资源。

可能出现的错误：

  • 如果 display_name 缺失或长度超过 4096 个字符，则返回 INVALID_ARGUMENT。
  • 如果说明长度超过 4096 个字符，则返回 INVALID_ARGUMENT。
  • 如果 product_category 缺失或无效，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
CreateProductSet

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

创建并返回新的 ProductSet 资源。

可能出现的错误：

  • 如果 display_name 缺少或长度超过 4096 个字符，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
CreateReferenceImage

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

创建并返回新的 ReferenceImage 资源。

bounding_poly 字段为可选字段。如果未指定 bounding_poly，系统会尝试检测图片中与父级商品的 product_category 类别相匹配的目标区域。如果已指定此字段，则始终跳过该项检测。系统会将多边形转换成非旋转式的矩形。

请注意，如果图片分辨率过大（超过 5 千万像素），无法处理，则流水线会调整图片大小。

可能出现的错误：

  • 如果 image_uri 缺失或长度超过 4096 个字符，则返回 INVALID_ARGUMENT。
  • 如果商品不存在，则返回 INVALID_ARGUMENT。
  • 如果未提供 bounding_poly，并且未检测到与父商品的 product_category 相兼容的项，则返回 INVALID_ARGUMENT。
  • 如果 bounding_poly 包含 10 个以上的多边形，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
DeleteProduct

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

永久删除一种商品及其参考图片。

系统会立即删除商品及其图片的所有元数据，但对包含该商品的 ProductSet 的搜索查询仍可能有效，直到刷新所有相关的缓存为止。

可能出现的错误：

  • 如果 Product 不存在，则返回 NOT_FOUND。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

永久删除一个 ProductSet。ProductSet 中的 Product 和 ReferenceImage 不会被删除。

实际图片文件不会从 Google Cloud Storage 中删除。

可能出现的错误：

  • 如果 ProductSet 不存在，则返回 NOT_FOUND。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
DeleteReferenceImage

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

永久删除一张参考图片。

系统会立即删除图片元数据，但对包含该图片的 ProductSet 的搜索查询仍可能有效，直到刷新所有相关的缓存为止。

实际图片文件不会从 Google Cloud Storage 中删除。

可能出现的错误：

  • 如果引用图片不存在，则返回 NOT_FOUND。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
GetProduct

rpc GetProduct(GetProductRequest) returns (Product)

获取与 Product 关联的信息。

可能出现的错误：

  • 如果 Product 不存在，则返回 NOT_FOUND。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
GetProductSet

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

获取与 ProductSet 关联的信息。

可能出现的错误：

  • 如果 ProductSet 不存在，则返回 NOT_FOUND。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
GetReferenceImage

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

获取与 ReferenceImage 关联的信息。

可能出现的错误：

  • 如果指定的图片不存在，则返回 NOT_FOUND。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
ImportProductSets

rpc ImportProductSets(ImportProductSetsRequest) returns (Operation)

此异步 API 可根据图片信息列表将参考图片列表导入指定的商品集中。

google.longrunning.Operation API 可用于跟踪请求的进度和结果。Operation.metadata 包含 BatchOperationMetadata。（进度）Operation.response 包含 ImportProductSetsResponse。（结果）

此方法的输入来源是 Google Cloud Storage 上的一个 csv 文件。如需了解 CSV 文件格式，请参阅 ImportProductSetsGcsSource.csv_file_uri。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
ListProductSets

rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse)

以未指定的顺序列出 ProductSet。

可能出现的错误：

  • 如果 page_size 大于 100 或小于 1，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

以未指定的顺序列出商品。

可能出现的错误：

  • 如果 page_size 大于 100 或小于 1，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
ListProductsInProductSet

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

按未指定的顺序列出 ProductSet 中的 Product。如果 ProductSet 不存在，则响应中的商品字段留空。

可能出现的错误：

  • 如果 page_size 大于 100 或小于 1，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
ListReferenceImages

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

列出参考图片。

可能出现的错误：

  • 如果父级商品不存在，则返回 NOT_FOUND。
  • 如果 page_size 大于 100 或小于 1，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

从指定的 ProductSet 中移除 Product。

可能出现的错误：

  • 如果未在 ProductSet 下找到 Product，则返回 NOT_FOUND。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
UpdateProduct

rpc UpdateProduct(UpdateProductRequest) returns (Product)

对一项 Product 资源执行更改。目前只能更新 display_name、description 和 labels 字段。

如果更新了标签，则更改要到下一次索引时，才会体现在查询中。

可能出现的错误：

  • 如果 Product 不存在，则返回 NOT_FOUND。
  • 如果 update_mask 中存在 display_name，但请求中 display_name 缺失或长度超过 4096 个字符，则返回 INVALID_ARGUMENT。
  • 如果 update_mask 中存在说明，但说明长度超过 4096 个字符，则返回 INVALID_ARGUMENT。
  • 如果 update_mask 中存在 product_category，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。
UpdateProductSet

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

对一项 ProductSet 资源进行更改。目前只能更新 display_name。

可能出现的错误：

  • 如果 ProductSet 不存在，则返回 NOT_FOUND。
  • 如果 update_mask 中存在 display_name，但请求中 display_name 缺失或长度超过 4096 个字符，则返回 INVALID_ARGUMENT。
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。

AddProductToProductSetRequest

对 AddProductToProductSet 方法的请求消息。

字段
name

string

要修改的 ProductSet 的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product

string

要添加到此 ProductSet 中的 Product 的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

AnnotateFileResponse

对单个文件注释请求的响应。一个文件中可以包含一张或多张图片，每张图片都分别有各自的响应。

字段
input_config

InputConfig

为其生成此响应的文件的相关信息。
responses[]

AnnotateImageResponse

对文件中找到的图片进行单独响应。

AnnotateImageRequest

请求对用户提供的图片执行 Google Cloud Vision API 任务，并提供用户请求的特征。

字段
image

Image

要处理的图片。
features[]

Feature

请求的功能。
image_context

ImageContext

图片可能随附的相关信息。

AnnotateImageResponse

对一个图片注释请求的响应。

字段
face_annotations[]

FaceAnnotation

如果存在，则人脸检测已成功完成。
landmark_annotations[]

EntityAnnotation

如果存在，则地标检测已成功完成。
logo_annotations[]

EntityAnnotation

如果存在，则徽标检测已成功完成。
label_annotations[]

EntityAnnotation

如果存在，则标签检测已成功完成。
localized_object_annotations[]

LocalizedObjectAnnotation

如果存在，则本地化对象检测已成功完成。此值会按置信度分数降序排序。
text_annotations[]

EntityAnnotation

如果存在，则文本 (OCR) 检测已成功完成。
full_text_annotation

TextAnnotation

如果存在，则文本 (OCR) 检测或文档 (OCR) 文本检测已成功完成。此注释提供 OCR 检测到的文本的结构性层次结构。
safe_search_annotation

SafeSearchAnnotation

如果存在，则安全搜索注释已成功完成。
image_properties_annotation

ImageProperties

如果存在，则已成功提取图片属性。
crop_hints_annotation

CropHintsAnnotation

如果存在，则剪裁提示已成功完成。
web_detection

WebDetection

如果存在，则 Web 检测已成功完成。
product_search_results

ProductSearchResults

如果存在，则 Google 商品搜索已成功完成。
error

Status

如果设置，则表示操作的错误消息。请注意，即便设置了 error，填充的图片注释也保证是正确的。
context

ImageAnnotationContext

只要存在上下文信息，即可了解此图片的来源。

AsyncAnnotateFileRequest

离线文件注释请求。

字段
input_config

InputConfig

必需。输入文件的相关信息。
features[]

Feature

必需。请求的功能。
image_context

ImageContext

文件中图片可能随附的其他上下文。
output_config

OutputConfig

必需。所需的输出位置和元数据（例如格式）。

AsyncAnnotateFileResponse

对单个离线文件注释请求的响应。

字段
output_config

OutputConfig

AsyncAnnotateFileRequest 的输出位置和元数据。

AsyncBatchAnnotateFilesRequest

多个异步文件注释请求会分批次，通过单个服务调用进行处理。

字段
requests[]

AsyncAnnotateFileRequest

此批次的各个异步文件注释请求。

AsyncBatchAnnotateFilesResponse

对一个异步批量文件注释请求的响应。

字段
responses[]

AsyncAnnotateFileResponse

文件注释响应列表，每个请求对应一个 AsyncBatchAnnotateFilesRequest。

BatchAnnotateImagesRequest

多个图片注释请求会分批次，通过单个服务调用进行处理。

字段
requests[]

AnnotateImageRequest

此批次的各个图片注释请求。

BatchAnnotateImagesResponse

对一个批量图片注释请求的响应。

字段
responses[]

AnnotateImageResponse

对批处理中图片注释请求的各个响应。

BatchOperationMetadata

批处理操作的元数据，例如当前状态。

这会包含在 google::longrunning::Operations 服务的 GetOperation 调用返回的 Operation 的 metadata 字段中。

字段
state

State

批处理操作的当前状态。
submit_time

Timestamp

向服务器提交批量请求的时间。

end_time

Timestamp

批量请求完成且 google.longrunning.Operation.done 设置为 true 的时间。

状态

枚举批量请求可能存在的各种状态。

枚举
STATE_UNSPECIFIED 无效。
PROCESSING 正在处理请求。
SUCCESSFUL 请求已完成，并且至少有一项已成功处理。
FAILED 该请求已完成，未成功处理任何项。
CANCELLED 该请求在用户调用 longrunning.Operations.CancelOperation 后完成。在 cancel 命令之前处理的任何记录都将按照请求中指定的方式输出。

阻止

页面上的逻辑元素。

字段
property

TextProperty

针对块检测到的其他信息。
bounding_box

BoundingPoly

块的边界框。顶点的顺序是左上角、右上角、右下角和左下角。检测到边界框发生旋转时，旋转的表示方式就是沿着左上角旋转，就像以“自然”的方向阅读文字时那样。例如：

  • 文字在水平方向时可能如下所示：
    0----1
    |    |
    3----2
  • 围绕左上角旋转 180 度时，就会变为：
    2----3
    |    |
    1----0

且顶点顺序仍为 (0, 1, 2, 3)。
paragraphs[]

Paragraph

此区块中的段落列表（如果此块为文本类型）。
block_type

BlockType

此块中检测到的块类型（文字、图片等）。
confidence

float

此块上 OCR 结果的置信度。介于 [0, 1] 范围内。

BlockType

OCR 所标识的块类型（文字、图片等）。

枚举
UNKNOWN 未知的块类型。
TEXT 普通文本块。
TABLE 表格块。
PICTURE 图片块。
RULER 水平/垂直线框。
BARCODE 条形码块。

BoundingPoly

检测到的图片注释的边界多边形。

字段
vertices[]

Vertex

外接多边形的顶点。

normalized_vertices[]

NormalizedVertex

外接多边形的规范化顶点。

ColorInfo

颜色信息，其中包含 RGB 通道、分数以及颜色在图片中所占的比例。

字段
color

Color

颜色的 RGB 分量。
score

float

此颜色的图片特定分数。 值介于 [0, 1] 范围内。
pixel_fraction

float

颜色在图片中占据的像素比例。 值介于 [0, 1] 范围内。

CreateProductRequest

对 CreateProduct 方法的请求消息。

字段
parent

string

应在其中创建 Product 的项目。

格式为 projects/PROJECT_ID/locations/LOC_ID。
product

Product

要创建的商品。
product_id

string

由用户为此 Product 提供的资源 ID。如果设置，则服务器会尝试将此值用作资源 ID。如果其已被使用，则系统会返回错误，并返回代码 ALREADY_EXISTS。长度不得超过 128 个字符。不能包含 / 字符。

CreateProductSetRequest

对 CreateProductSet 方法的请求消息。

字段
parent

string

应在其中创建 ProductSet 的项目。

格式为 projects/PROJECT_ID/locations/LOC_ID。
product_set

ProductSet

要创建的 ProductSet。
product_set_id

string

由用户为此 ProductSet 提供的资源 ID。如果设置，则服务器会尝试将此值用作资源 ID。如果其已被使用，则系统会返回错误，并返回代码 ALREADY_EXISTS。长度不得超过 128 个字符。不能包含 / 字符。

CreateReferenceImageRequest

对 CreateReferenceImage 方法的请求消息。

字段
parent

string

要在其中创建参考图片的商品的资源名称。

格式为 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID。
reference_image

ReferenceImage

要创建的参考图片。如果已指定图片 ID，则予以忽略。
reference_image_id

string

由用户为要添加的 ReferenceImage 提供的资源 ID。如果设置，则服务器会尝试将此值用作资源 ID。如果其已被使用，则系统会返回错误，并返回代码 ALREADY_EXISTS。长度不得超过 128 个字符。不能包含 / 字符。

CropHint

单一剪裁提示，在传送图片时用于生成新的剪裁。

字段
bounding_poly

BoundingPoly

剪裁区域的边界多边形。边界框的坐标采用原始图片的比例，如 ImageParams 中返回的值。

confidence

float

成为重要区域的置信度。介于 [0, 1] 范围内。
importance_fraction

float

此重要区域相对于原始图片的重要性比例。

CropHintsAnnotation

一组剪裁提示，在传送图片时用于生成新的剪裁。

字段
crop_hints[]

CropHint

剪裁提示结果。

CropHintsParams

剪裁提示注释请求的参数。

字段
aspect_ratios[]

float

以浮点数表示的宽高比，表示图片宽度与高度的比率。例如，如果所需的宽高比是 4/3，则相应的浮点值应为 1.33333。如果未指定，则返回可能最佳的剪裁区域。提供的宽高比上限为 16，16 之后提供的任何宽高比都将予以忽略。

DeleteProductRequest

对 DeleteProduct 方法的请求消息。

字段
name

string

要删除的商品的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

DeleteProductSetRequest

对 DeleteProductSet 方法的请求消息。

字段
name

string

要删除的 ProductSet 的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

DeleteReferenceImageRequest

对 DeleteReferenceImage 方法的请求消息。

字段
name

string

要删除的参考图片的资源名称。

格式为：

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

DominantColorsAnnotation

一组主色及其对应的分数。

字段
colors[]

ColorInfo

RGB 颜色值及其得分和像素分数。

EntityAnnotation

所检测到的实体特征集。

字段
mid

string

不透明实体 ID。一些 ID 可以在 Google Knowledge Graph Search API 中找到。

locale

string

表示实体文本 description 的语言区域的语言代码。
description

string

实体文本说明，以 locale 语言表示。
score

float

结果的总分。介于 [0, 1] 范围内。
confidence
(deprecated)

float

已弃用。请改用 score。图片中实体检测的准确性。例如，对于检测到“Eiffel Tower”实体的图片，此字段表示查询图片中有一个塔楼的置信度。介于 [0, 1] 范围内。
topicality

float

ICA（图片内容注释）标签与图片的相关性。例如，即使每个图片中都存在塔的置信度相同，“tower”与包含检测到的“Eiffel Tower”的图片的相关性也可能比包含检测到的遥远高层建筑图片的相关性更高。介于 [0, 1] 范围内。
bounding_poly

BoundingPoly

此实体所属的图片区域。不针对 LABEL_DETECTION 功能生成。
locations[]

LocationInfo

检测到的实体的位置信息。有可能存在多个 LocationInfo 元素，因为一个位置可能表示图片中的场景位置，而另一个位置可能表示图片的拍摄位置。地标通常存在位置信息。

properties[]

Property

某些实体可能具有用户提供的可选 Property（名称/值）字段，例如符合实体要求的得分或字符串。

FaceAnnotation

包含人脸检测结果的人脸检测对象。

字段
bounding_poly

BoundingPoly

脸部周围的边界多边形。边界框的坐标采用原始图片的比例，如 ImageParams 中返回的值。边界框是根据人的预期对脸部进行“框架”处理而计算出的。它以地标结果为依据。请注意，如果图片中只有局部脸部需要添加注释，则不得在 BoundingPoly 中生成一个或多个 x 和/或 y 坐标（系统将不会为多边形设置边界）。
fd_bounding_poly

BoundingPoly

fd_bounding_poly 边界多边形比 boundingPoly 更严格，并且只包含人脸的皮肤部分。通常，它用于在可检测图片中可见的“皮肤面积”的任何图片分析中去除脸部。它并不基于地标结果，仅取决于初始人脸检测，因此

fd

（人脸检测）前缀。
landmarks[]

Landmark

检测到的面部地标。
roll_angle

float

滚动角，表示人脸相对于垂直于脸部的轴的图片垂直面的顺时针/逆时针旋转量。介于 [-180,180] 范围内。

pan_angle

float

偏转角，表示人脸相对于垂直于该图片的垂直平面向左/向右偏转的角度。介于 [-180,180] 范围内。

tilt_angle

float

俯仰角，表示人脸相对于图片的水平面向上/向下倾斜的角度。介于 [-180,180] 范围内。

detection_confidence

float

检测可靠度。 介于 [0, 1] 范围内。
landmarking_confidence

float

脸部标志可靠度。 介于 [0, 1] 范围内。
joy_likelihood

Likelihood

喜乐可能性。
sorrow_likelihood

Likelihood

悲伤可能性。
anger_likelihood

Likelihood

愤怒可能性。
surprise_likelihood

Likelihood

惊喜可能性。
under_exposed_likelihood

Likelihood

曝光不足的可能性。
blurred_likelihood

Likelihood

模糊可能性。
headwear_likelihood

Likelihood

头饰可能性。

地标

脸部特定的标志（例如，脸部特征）。

字段
type

Type

脸部标志类型。

position

Position

脸部标志位置。

类型

面部标志（特征）类型。左和右是根据图片观看者所在的位置定义的，而不考虑照片特有的镜像投影。因此，LEFT_EYE 通常是人的右眼。

枚举
UNKNOWN_LANDMARK 检测到的未知脸部标志。 不应填写。
LEFT_EYE 左眼。
RIGHT_EYE 右眼。
LEFT_OF_LEFT_EYEBROW 左眉毛左侧。
RIGHT_OF_LEFT_EYEBROW 左眉毛右侧。
LEFT_OF_RIGHT_EYEBROW 右眉毛左侧。
RIGHT_OF_RIGHT_EYEBROW 右眉毛右侧。
MIDPOINT_BETWEEN_EYES 两只眼睛的中点。
NOSE_TIP 鼻尖。
UPPER_LIP 上唇。
LOWER_LIP 下唇。
MOUTH_LEFT 嘴巴左侧。
MOUTH_RIGHT 嘴巴右侧。
MOUTH_CENTER 嘴巴中心。
NOSE_BOTTOM_RIGHT 鼻子右下角。
NOSE_BOTTOM_LEFT 鼻子，左下角。
NOSE_BOTTOM_CENTER 鼻子，底部中心。
LEFT_EYE_TOP_BOUNDARY 左眼，顶部边界。
LEFT_EYE_RIGHT_CORNER 左眼，右角。
LEFT_EYE_BOTTOM_BOUNDARY 左眼，底部边界。
LEFT_EYE_LEFT_CORNER 左眼，左角。
RIGHT_EYE_TOP_BOUNDARY 右眼，顶部边界。
RIGHT_EYE_RIGHT_CORNER 右眼，右角。
RIGHT_EYE_BOTTOM_BOUNDARY 右眼，底部边界。
RIGHT_EYE_LEFT_CORNER 右眼，左角。
LEFT_EYEBROW_UPPER_MIDPOINT 左眉毛，中部上方。
RIGHT_EYEBROW_UPPER_MIDPOINT 右眉毛，中部上方。
LEFT_EAR_TRAGION 左耳屏点。
RIGHT_EAR_TRAGION 右耳屏点。
LEFT_EYE_PUPIL 左眼瞳孔。
RIGHT_EYE_PUPIL 右眼瞳孔。
FOREHEAD_GLABELLA 前额眉间。
CHIN_GNATHION 下巴颔下点。
CHIN_LEFT_GONION 下巴左下颌点。
CHIN_RIGHT_GONION 下巴右下颌点。

功能

要执行的 Google Cloud Vision API 检测的类型，以及针对该检测类型返回的结果数上限。可以在 features 列表中指定多个 Feature 对象。

字段
type

Type

特征类型。
max_results

int32

设置此类型结果的数量上限。不适用于 TEXT_DETECTION、DOCUMENT_TEXT_DETECTION 或 CROP_HINTS。
model

string

用于该特征的模型。支持的值：“builtin/stable”（如果未设置，则为默认值）和“builtin/latest”。

类型

要提取的 Google Cloud Vision API 特征的类型。

枚举
TYPE_UNSPECIFIED 未指定的特征类型。
FACE_DETECTION 运行人脸检测。
LANDMARK_DETECTION 运行标志检测。
LOGO_DETECTION 运行徽标检测。
LABEL_DETECTION 运行标签检测。
TEXT_DETECTION 运行文本检测/光学字符识别 (OCR)。文本检测针对较大的图片中的文本区域进行了优化；如果图片是文档，请改用 DOCUMENT_TEXT_DETECTION。
DOCUMENT_TEXT_DETECTION 运行密集文本文档 OCR。如果同时存在 DOCUMENT_TEXT_DETECTION 和 TEXT_DETECTION，则优先考虑。
SAFE_SEARCH_DETECTION 运行安全搜索可检测可能不安全的内容或不良内容。
IMAGE_PROPERTIES 计算一组图片属性，例如图片的主色。
CROP_HINTS 运行剪裁提示。
WEB_DETECTION 运行 Web 检测。
OBJECT_LOCALIZATION 针对对象检测运行定位器。

GcsDestination

将在其中写入输出内容的 Google Cloud Storage 位置。

字段
uri

string

用于存储结果的 Google Cloud Storage URI。结果将采用 JSON 格式，且前面带有对应的输入 URI。此字段可以表示单个文件，也可以表示多个输出的前缀。前缀必须以 / 结尾。

示例：

如果有多个输出，则每个响应仍为 AnnotateFileResponse，每个响应都包含完整 AnnotateImageResponse 列表的一部分。例如，如果输出 JSON 太大并且溢出到多个分片文件中，则可能会发生多个输出。

GcsSource

将从中读取输入的 Google Cloud Storage 位置。

字段
uri

string

输入文件的 Google Cloud Storage URI。此参数只能是 Google Cloud Storage 对象。目前不支持使用通配符。

GetProductRequest

对 GetProduct 方法的请求消息。

字段
name

string

要获取的 Product 的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

GetProductSetRequest

对 GetProductSet 方法的请求消息。

字段
name

string

要获取的 ProductSet 的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

GetReferenceImageRequest

对 GetReferenceImage 方法的请求消息。

字段
name

string

要获取的 ReferenceImage 的资源名称。

格式为：

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID。

图片

用于执行 Google Cloud Vision API 任务的客户端图片。

字段
content

bytes

图片内容，由字节流表示。注意：与所有 bytes 字段一样，协议缓冲区使用纯二进制表示法，而 JSON 表示法使用 Base64。
source

ImageSource

Google Cloud Storage 图片位置或可公开访问的图片网址。如果为图片提供了 content 和 source，则 content 优先，且用于执行图片注释请求。

ImageAnnotationContext

如果图片是通过文件（例如 PDF）生成的，则此消息将提供有关该图片来源的信息。

字段
uri

string

用于生成图片的文件的 URI。
page_number

int32

如果文件是 PDF 或 TIFF，则此字段给出了用于生成图片的文件中的页码。

ImageContext

图片上下文和/或特征专用参数。

字段
lat_long_rect

LatLongRect

未使用。

language_hints[]

string

用于 TEXT_DETECTION 的语言列表。在大多数情况下，使用空值时效果最佳，因为这支持自动检测语言。对于基于拉丁字母的语言，无需设置 language_hints。在极少数情况下，如果图片中文本的语言已知，设置提示将有助于获得更好的效果（尽管提示错误会造成很大的阻碍）。如果已指定语言中有一种或多种不在支持的语言范围内，文本检测将返回错误。

crop_hints_params

CropHintsParams

剪裁提示注释请求的参数。
product_search_params

ProductSearchParams

用于商品搜索的参数。
web_detection_params

WebDetectionParams

用于 Web 检测的参数。

ImageProperties

存储图片属性，例如主色。

字段
dominant_colors

DominantColorsAnnotation

如果有，主色已成功完成。

ImageSource

外来图片来源（Google Cloud Storage 或网址图片位置）。

字段
gcs_image_uri

string

请改用 image_uri。

格式为 gs://bucket_name/object_name 的 Google Cloud Storage URI。不支持对象版本控制。如需了解详情，请参阅 Google Cloud Storage 请求 URI。
image_uri

string

源图片的 URI。这可以是以下任意一项：

  1. 格式为 gs://bucket_name/object_name 的 Google Cloud Storage URI。不支持对象版本控制。如需了解详情，请参阅 Google Cloud Storage 请求 URI。

  2. 可公开访问的图片 HTTP/HTTPS 网址。从 HTTP/HTTPS 网址中提取图片时，Google 无法保证请求将会完成。如果指定的主机拒绝请求（例如，由于请求限制或 DOS 攻击防范），或者如果 Google 为了防止滥用而限制对网站的请求，则您的请求可能会失败。对于生产应用，您不应依赖外部托管的图片。

如果同时指定了 gcs_image_uri 和 image_uri，则以 image_uri 为准。

ImportProductSetsGcsSource

一个 csv 文件的 Google Cloud Storage 位置，其中每行保留一个 ImportProductSetRequests 列表。

字段
csv_file_uri

string

输入 csv 文件的 Google Cloud Storage URI。

URI 必须以 gs:// 开头。

输入 CSV 文件的格式应该是每行一张图片。每行中有 8 列。

  1. image-uri
  2. image-id
  3. product-set-id
  4. product-id
  5. product-category
  6. product-display-name
  7. 标签
  8. bounding-poly

您必须提供 image-uri、product-set-id、product-id 和 product-category 列。其他所有列均为可选字段。

如果 product-set-id 和 product-id 值指定的 ProductSet 或 Product 不存在，则系统将为图片创建新的 ProductSet 或 Product。在本例中，product-display-name 列引用 display_name、product-category 列引用 product_category、labels 列引用 product_labels。

image-id 列是可选列，但提供列必须是唯一的。如果为空，则系统会自动为图片分配唯一 ID。

product-display-name 列是可选列。如果此字段为空，则系统会将商品的 display_name 字段设置为空格（“ ”）。稍后您可以使用 API 更新 display_name。

如果具有指定 product-id 的 Product 已存在，则系统会忽略 product-display-name、product-category 和 labels 列。

labels 列（可选）就是包含英文逗号分隔的键值对列表的一行内容，格式如下：

"key_1=value_1,key_2=value_2,...,key_n=value_n"

bounding-poly 列（可选）用于标识图片中感兴趣的区域，其使用方式与 CreateReferenceImage 相同。如果您未指定 bounding-poly 列，则系统会尝试自动检测相关区域。

每行最多有一个 bounding-poly 列。如果图片包含多个目标区域，请在 CSV 文件中添加一行包含相同商品信息的内容，并为每个目标区域添加 bounding-poly 值。

bounding-poly 列必须包含偶数个以英文逗号分隔的数字，格式为“p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y”。对于绝对边界多边形，应使用非负整数，对于归一化边界多边形，应使用 [0, 1] 范围内的浮点值。

如果图片分辨率过大（超过 2000 万像素），导致系统无法处理图片，则系统将调整图片大小。

ImportProductSetsInputConfig

ImportProductSets 方法的输入内容。

字段
gcs_source

ImportProductSetsGcsSource

一个 csv 文件的 Google Cloud Storage 位置，其中每行保留一个 ImportProductSetRequests 列表。

ImportProductSetsRequest

对 ImportProductSets 方法的请求消息。

字段
parent

string

应在其中导入 ProductSet 的项目。

格式为 projects/PROJECT_ID/locations/LOC_ID。
input_config

ImportProductSetsInputConfig

请求列表的输入内容。

ImportProductSetsResponse

ImportProductSets 方法的响应消息。

此消息由 google.longrunning.Operations.GetOperation 方法在所返回的 google.longrunning.Operation.response 字段中返回。

字段
reference_images[]

ReferenceImage

成功导入的 reference_images 列表。
statuses[]

Status

每个 ImportProductSet 请求的 rpc 状态，包括成功和错误。

此处的状态数量与 csv 文件中的行数一致，statuses[i] 存储处理 csv 的第 i 行的成功或失败状态（从第 0 行开始）。

InputConfig

所需的输入位置和元数据。

字段
gcs_source

GcsSource

要从中读取输入的 Google Cloud Storage 位置。

mime_type

string

文件的类型。目前仅支持“application/pdf”和“image/tiff”。不支持通配符。

LatLongRect

由最小和最大 LatLng 对确定的矩形。

字段
min_lat_lng

LatLng

最小纬度/经度对。
max_lat_lng

LatLng

最大纬度/经度对。

可能性

可能性的范围表示，旨在让客户在模型升级时获得高度稳定的结果。

枚举
UNKNOWN 未知可能性。
VERY_UNLIKELY 图片属于指定类别的可能性极小。
UNLIKELY 图片属于指定类别的可能性较小。
POSSIBLE 图片可能属于指定类别。
LIKELY 图片属于指定类别的可能性较大。
VERY_LIKELY 图片属于指定类别的可能性很大。

ListProductSetsRequest

对 ListProductSets 方法的请求消息。

字段
parent

string

应列出的 ProductSet 所属的项目。

格式为 projects/PROJECT_ID/locations/LOC_ID。
page_size

int32

需要返回的最大项数。 默认值为 10，最大值为 100。
page_token

string

从上一个 List 请求返回的 next_page_token（如果有）。

ListProductSetsResponse

ListProductSets 方法的响应消息。

字段
product_sets[]

ProductSet

ProductSet 的列表。
next_page_token

string

用于检索下一页结果的令牌。如果列表中没有更多结果，则为空。

ListProductsInProductSetRequest

对 ListProductsInProductSet 方法的请求消息。

字段
name

string

要为其检索商品的 ProductSet 资源。

格式为：projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
page_size

int32

需要返回的最大项数。 默认值为 10，最大值为 100。
page_token

string

从上一个 List 请求返回的 next_page_token（如果有）。

ListProductsInProductSetResponse

ListProductsInProductSet 方法的响应消息。

字段
products[]

Product

Product 列表。
next_page_token

string

用于检索下一页结果的令牌。如果列表中没有更多结果，则为空。

ListProductsRequest

对 ListProducts 方法的请求消息。

字段
parent

string

应列出其 Product 的项目或 ProductSet。

格式：projects/PROJECT_ID/locations/LOC_ID
page_size

int32

需要返回的最大项数。 默认值为 10，最大值为 100。
page_token

string

从上一个 List 请求返回的 next_page_token（如果有）。

ListProductsResponse

ListProducts 方法的响应消息。

字段
products[]

Product

商品列表。
next_page_token

string

用于检索下一页结果的令牌。如果列表中没有更多结果，则为空。

ListReferenceImagesRequest

对 ListReferenceImages 方法的请求消息。

字段
parent

string

包含参考图片的商品的资源名称。

格式为 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID。
page_size

int32

需要返回的最大项数。 默认值为 10，最大值为 100。
page_token

string

标识要返回的结果页面的令牌。 这是在之前某个的参考图片列出请求中返回的 nextPageToken 值。

如果未指定，则默认为第 1 页。

ListReferenceImagesResponse

ListReferenceImages 方法的响应消息。

字段
reference_images[]

ReferenceImage

参考图片列表。
page_size

int32

需要返回的最大项数。 默认值为 10，最大值为 100。
next_page_token

string

从上一个 List 请求返回的 next_page_token（如果有）。

LocalizedObjectAnnotation

在边界框内检测到的一组对象。

字段
mid

string

应与 EntityAnnotation mid 保持一致的对象 ID。
language_code

string

BCP-47 语言代码，例如“en-US”或“sr-Latn”。如需了解详情，请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。
name

string

对象名称，以 language_code 语言表示。
score

float

结果的分数。介于 [0, 1] 范围内。
bounding_poly

BoundingPoly

此对象所属的图片区域。必须填充此字段。

LocationInfo

检测到的实体位置信息。

字段
lat_lng

LatLng

纬度/经度位置坐标。

NormalizedVertex

顶点表示图片中的 2D 点。注意：标准化顶点坐标相对于原始图片，范围介于 0 和 1 之间。

字段
x

float

x 坐标。

y

float

y 坐标。

Zero coordinate values


The general format for bounding polys in the JSON response when detected is an array of 4 vertex objects:
  • [{"x": 0.063,"y": 0.018},{"x": 0.123,"y": 0.018},{"x": 0.123,"y": 0.038},{"x": 0.063,"y": 0.038}]
When the API detects a coordinate ("x" or "y") value of 0.0, that coordinate is omitted in the JSON response. For example, a response could take the following form: [{},{"x": 0.028}, {"x": 0.028,"y": 0.043},{"y": 0.043}]. This response shows all three representation possibilities:
  • {} - an empty object when both "x":0.0 and "y":0.0.
  • {"x": 0.028} and {"y": 0.043} - an object with a single key-value pair when one coordinate is 0.0 but the other is a non-zero value.
  • {"x": 0.028,"y": 0.043} - an object with both key-value pairs when both coordinates have a non-zero value.

OperationMetadata

包含 BatchAnnotateImages 操作的元数据。

字段
state

State

批处理操作的当前状态。

create_time

Timestamp

收到批处理请求的时间。

update_time

Timestamp

上次更新操作结果的时间。

状态

批量操作的状态。

枚举
STATE_UNSPECIFIED 无效。
CREATED 已收到请求。
RUNNING 正在处理请求。
DONE 批处理已完成。
CANCELLED 批处理已取消。

OutputConfig

所需的输出位置和元数据。

字段
gcs_destination

GcsDestination

要将输出内容写入的 Google Cloud Storage 位置。
batch_size

int32

可向 Google Cloud Storage 中存储的每个输出 JSON 文件添加的响应 proto 的最大数量。有效范围为 [1, 100]。如果未指定，默认值为 20。

例如，对于一个包含 100 页的 PDF 文件，将生成 100 个响应 proto。如果 batch_size = 20，则各包含 20 个响应 proto 的 5 个 JSON 文件均写入到 gcs_destination.uri 前缀下。

目前，batch_size 仅适用于 GcsDestination，将来可能会支持其他输出配置。

页面

通过 OCR 检测到的页面。

字段
property

TextProperty

在页面上检测到的其他信息。
width

int32

页面宽度。对于 PDF，其单位是点。对于图片（包括 TIFF），其单位是像素。

height

int32

页面高度。对于 PDF，其单位是点。对于图片（包括 TIFF），其单位是像素。

blocks[]

Block

此页面上的文本块、图片等列表。
confidence

float

页面上 OCR 结果的置信度。介于 [0, 1] 范围内。

段落

按一定顺序展示多个字词的结构化文本单元。

字段
property

TextProperty

为段落检测到的其他信息。
bounding_box

BoundingPoly

段落的边界框。顶点的顺序是左上角、右上角、右下角和左下角。检测到边界框发生旋转时，旋转的表示方式就是沿着左上角旋转，就像以“自然”的方向阅读文字时那样。例如：* 文字在水平方向时可能如下所示： 0----1 | | 3----2 * 围绕左上角旋转 180 度时，就会变为： 2----3 | | 1----0 且顶点顺序仍为 (0, 1, 2, 3)。
words[]

Word

此段落中的字词列表。
confidence

float

段落的 OCR 结果置信度。介于 [0, 1] 范围内。

位置

图片中的一个 3D 位置，主要用于人脸检测标志。一个有效的 Position 必须同时具有 x 坐标和 y 坐标。位置的坐标与原始图片采用相同的刻度。

字段
x

float

x 坐标。

y

float

y 坐标。

z

float

z 坐标（或深度）。

产品

Product 包含 ReferenceImages。

字段
name

string

商品的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID。

创建 Product 时，此字段会予以忽略。
display_name

string

此 Product 的用户提供名称。不得为空。长度不得超过 4096 个字符。
description

string

与此商品一起存储的用户提供元数据。长度不得超过 4096 个字符。
product_category

string

由参考图片标识的商品类别。此值应为“homegoods”、“apparel”或“toys”。

该字段不可更改。
product_labels[]

KeyValue

可以附加到一个商品的的键值对。查询时，可以根据 product_label 指定限制条件。

请注意，整数值可以使用字符串的形式提供，例如“1199”。只有带有整数值的字符串可以匹配基于范围的限制（将在不久之后推出对这种限制的支持）。

对于同一个键，可以分配多个值。一件商品最多可包含 100 个 product_label。

KeyValue

以键值对表示的商品标签。

字段
key

string

附加到商品的标签键。不能为空，也不能超过 128 个字节。
value

string

附加到商品的标签值。不能为空，也不能超过 128 个字节。

ProductSearchParams

商品搜索请求的参数。

字段
bounding_poly

BoundingPoly

图片中感兴趣的区域的边界多边形。可选。如果未指定，则应用系统自行决定的设置。

product_set

string

要搜索类似图片的一项 ProductSet 资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID。
product_categories[]

string

要在其中执行搜索的商品类别列表。目前我们只考虑第一个类别，应指定“homegoods”、“apparel”或“toys”。
filter

string

过滤表达式。这可用于根据商品标签限制搜索结果。目前，我们支持对键值对表达式的多个“逻辑或”运算再执行“逻辑与”运算，前提是“逻辑或”运算中涉及到的每个表达式都必须具有相同的键。

例如，可以使用“(color = red OR color = blue) AND brand = Google”，但请勿使用“(color = red OR brand = Google)”或“color: red”。

ProductSearchResults

商品搜索请求的结果。

字段
index_time

Timestamp

提供这些结果的索引的时间戳。在此时间之后所做的更改不会反映在当前结果中。
results[]

Result

结果列表，每个结果对应每个商品匹配项。
product_grouped_results[]

GroupedResult

在查询图片中检测到的依商品分组的结果列表。每个条目均对应于查询图片中的一个边界多边形，并包含特定于该区域的匹配商品。在每种商品的所有结果联合中，可能存在重复的商品匹配项。

GroupedResult

与查询图片中的单件商品类似的商品相关信息。

字段
bounding_poly

BoundingPoly

在查询图片中检测到的商品的边界多边形。
results[]

Result

结果列表，每个结果对应每个商品匹配项。

结果

商品相关信息。

字段
product

Product

商品。
score

float

匹配项的置信度，范围从 0（零置信度）到 1（最高置信度）。
image

string

与查询最匹配的商品中的图片的资源名称。

ProductSet

一个 ProductSet 包含多个 Product。一个 ProductSet 最多可包含 100 万张参考图片。如果超出该限制，则定期索引编制操作将会失败。

字段
name

string

ProductSet 的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID。

创建 ProductSet 时，此字段会予以忽略。
display_name

string

此 ProductSet 的用户提供名称。不得为空。长度不得超过 4096 个字符。
index_time

Timestamp

仅供输出。此 ProductSet 上次编入索引的时间。查询结果将反映此时间之前的所有更新。如果此 ProductSet 从未被编入索引，则此时间戳为默认值“1970-01-01T00:00:00Z”。

创建 ProductSet 时，此字段会予以忽略。
index_error

Status

仅供输出。如果将商品集编入索引时出错，则系统会填充此字段。

创建 ProductSet 时，此字段会予以忽略。

属性

一个 Property 包含由用户提供的一个名称/值对。

字段
name

string

属性的名称。
value

string

属性的值。
uint64_value

uint64

数值属性的值。

ReferenceImage

ReferenceImage 表示商品图片及其关联的元数据，例如边界框。

字段
name

string

参考图片的资源名称。

格式为：

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID。

创建参考图片时，系统会忽略此字段。
uri

string

参考图片的 Google Cloud Storage URI。

URI 必须以 gs:// 开头。

必填。
bounding_polys[]

BoundingPoly

参考图片内感兴趣的区域周围的边界多边形。可选。如果此字段为空，系统将尝试检测感兴趣的区域。最多可使用 10 个边界多边形。

所提供的形状将转换为非旋转式矩形。转换完毕后，矩形的短边必须大于或等于 300 像素。宽高比不得超过 1:4（即 1:3 可接受，1:5 则不可接受）。

RemoveProductFromProductSetRequest

对 RemoveProductFromProductSet 方法的请求消息。

字段
name

string

要修改的 ProductSet 的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product

string

要从此 ProductSet 中移除的 Product 的资源名称。

格式为：projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

SafeSearchAnnotation

计算机视觉方法基于安全搜索类别（例如成人、欺骗、医疗、暴力）计算出的与图片有关的一组特征。

字段
adult

Likelihood

表示图片包含成人内容的概率。成人内容可能包含裸露、色情图片或漫画或性活动等元素。
spoof

Likelihood

包含欺骗性内容的概率。对图片的标准版本进行修改以使其变得有趣或令人反感的概率。
medical

Likelihood

此图片为医学影像的概率。

violence

Likelihood

此图片包含暴力内容的概率。

racy

Likelihood

请求的图片包含少儿不宜内容的概率。少儿不宜内容可能包括（但不限于）单薄或透明的服装、用策略手段遮住的裸体、猥亵或挑逗姿势，或者敏感身体部位的特写镜头。

符号

单个符号表示。

字段
property

TextProperty

为符号检测到的其他信息。
bounding_box

BoundingPoly

符号的边界框。顶点的顺序是左上角、右上角、右下角和左下角。检测到边界框发生旋转时，旋转的表示方式就是沿着左上角旋转，就像以“自然”的方向阅读文字时那样。例如：* 文字在水平方向时可能如下所示： 0----1 | | 3----2 * 围绕左上角旋转 180 度时，就会变为： 2----3 | | 1----0 且顶点顺序仍为 (0, 1, 2, 3)。
text

string

获取符号的实际 UTF-8 表示形式。

confidence

float

符号的 OCR 结果置信度。介于 [0, 1] 范围内。

TextAnnotation

TextAnnotation 包含 OCR 提取的文本的结构化表示。OCR 提取的文本结构的层次结构如下：TextAnnotation -> 页面 -> 块 -> 段落 -> 字词 -> 符号。从“页面”开始，各结构组件均可进一步拥有其自己的属性。属性描述了所检测到的语言、中断符等。如需了解详情，请参阅下面的 TextAnnotation.TextProperty 消息定义。

字段
pages[]

Page

OCR 检测到的页面列表。
text

string

页面上检测到 UTF-8 文本。

DetectedBreak

检测到的结构化组件的开头或结尾。

字段
type

BreakType

检测到的换行符类型。
is_prefix

bool

如果换行符附加在元素前面，则为 true。

BreakType

指示所发现的中断符类型的枚举。包括换行符、空格等。

枚举
UNKNOWN 未知的换行符标签类型。
SPACE 普通空格。
SURE_SPACE 确定空间（非常宽）。
EOL_SURE_SPACE 换行符。
HYPHEN 文本中不存在的结束连字符；无法与 SPACE、LEADER_SPACE 或 LINE_BREAK 共存。
LINE_BREAK 用于终止段落的中断符。

DetectedLanguage

检测到的结构化组件的语言。

字段
language_code

string

BCP-47 语言代码，例如“en-US”或“sr-Latn”。如需了解详情，请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。
confidence

float

所检测到的语言的置信度。介于 [0, 1] 范围内。

TextProperty

在此结构化组件上检测到的其他信息。

字段
detected_languages[]

DetectedLanguage

检测到的语言及对应置信度的列表。
detected_break

DetectedBreak

检测到的一个文本句段的开头或结尾。

UpdateProductRequest

对 UpdateProduct 方法的请求消息。

字段
product

Product

Product 资源，用于替换服务器上的资源。product.name 不可变。
update_mask

FieldMask

用于指定要更新的字段的 FieldMask。如果未指定 update_mask，则所有可变字段都将更新。有效掩码路径包括 product_labels、display_name 和 description。

UpdateProductSetRequest

对 UpdateProductSet 方法的请求消息。

字段
product_set

ProductSet

ProductSet 资源，用于替换服务器上的资源。
update_mask

FieldMask

用于指定要更新的字段的 FieldMask。如果未指定 update_mask，则所有可变字段都将更新。有效掩码路径为 display_name。

Vertex

顶点表示图片中的 2D 点。注意：顶点坐标与原始图片的比例相同。

字段
x

int32

x 坐标。

y

int32

y 坐标。

Zero coordinate values


The general format for bounding polys in the JSON response when detected is an array of 4 vertex objects:
  • [{"x": 63,"y": 18},{"x": 123,"y": 18},{"x": 123,"y": 38},{"x": 63,"y": 38}]
When the API detects a coordinate ("x" or "y") value of 0, that coordinate is omitted in the JSON response. For example, a response could take the following form: [{},{"x": 28}, {"x": 28,"y": 43},{"y": 43}]. This response shows all three representation possibilities:
  • {} - an empty object when both "x":0 and "y":0.
  • {"x": 28} and {"y": 43} - an object with a single key-value pair when one coordinate is 0 but the other is a non-zero value.
  • {"x": 28,"y": 43} - an object with both key-value pairs when both coordinates have a non-zero value.

WebDetection

互联网图片的相关信息。

字段
web_entities[]

WebEntity

从相似的互联网图片中推导出的实体。
full_matching_images[]

WebImage

与互联网完全匹配的图片。可包括查询图片的调整大小后的副本。
partial_matching_images[]

WebImage

与互联网局部匹配的图片。这些图片的相似度足够高，有一些与查询图片相同的关键特征。例如，原始图片与剪裁图片可能会部分匹配。
pages_with_matching_images[]

WebPage

包含匹配的互联网图片的网页。
visually_similar_images[]

WebImage

外观类似的图片结果。
best_guess_labels[]

WebLabel

该服务关于请求图片主题的最佳猜测。根据开放式 Web 上的类似图片推断得出。

WebEntity

从相似的互联网图片中推导出的实体。

字段
entity_id

string

不透明实体 ID。
score

float

实体的总体相关度得分。不同图片查询之间的分数并非归一化分数，也不具有可比性。
description

string

实体的标准说明（采用英文）。

WebImage

在线图片的元数据。

字段
url

string

结果图片网址。
score

float

（已弃用）图片的整体相关性分数。

WebLabel

为网络检测提供额外元数据的标签。

字段
label

string

用于附加元数据的标签。
language_code

string

label 的 BCP-47 语言代码，例如“en-US”或“sr-Latn”。如需了解详情，请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。

WebPage

网页的元数据。

字段
url

string

结果网页的网址。
score

float

（已弃用）网页的整体相关性得分。
page_title

string

网页的标题，可能包含 HTML 标记。
full_matching_images[]

WebImage

与网页上的图片完全匹配。可包括查询图片的调整大小后的副本。
partial_matching_images[]

WebImage

与网页上的图片部分匹配。这些图片的相似度足够高，有一些与查询图片相同的关键特征。例如，原始图片与剪裁图片可能会部分匹配。

WebDetectionParams

Web 检测请求的参数。

字段
include_geo_results

bool

是否包含来自图片的地理信息的结果。

Word

字词表示。

字段
property

TextProperty

为字词检测到的其他信息。
bounding_box

BoundingPoly

字词的边界框。顶点的顺序是左上角、右上角、右下角和左下角。检测到边界框发生旋转时，旋转的表示方式就是沿着左上角旋转，就像以“自然”的方向阅读文字时那样。例如：* 文字在水平方向时可能如下所示： 0----1 | | 3----2 * 围绕左上角旋转 180 度时，就会变为： 2----3 | | 1----0 且顶点顺序仍为 (0, 1, 2, 3)。
symbols[]

Symbol

列出字词中的符号。符号的顺序与自然阅读顺序相同。
confidence

float

字词的 OCR 结果置信度。介于 [0, 1] 范围内。