Package google.cloud.vision.v1

索引

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

詳情請參閱驗證總覽一文。
AsyncBatchAnnotateImages

rpc AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest) returns (Operation)

針對圖片清單執行非同步圖片偵測和註解。

您可以透過 google.longrunning.Operations 介面擷取進度和結果。Operation.metadata 包含 OperationMetadata (中繼資料)。Operation.response 包含 AsyncBatchAnnotateImagesResponse (結果)。

這項服務會將圖片註解輸出內容寫入客戶 Google Cloud Storage 值區中的 JSON 檔案，每個 JSON 檔案都包含 BatchAnnotateImagesResponse 原型。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽一文。
BatchAnnotateFiles

rpc BatchAnnotateFiles(BatchAnnotateFilesRequest) returns (BatchAnnotateFilesResponse)

這項服務會為一批檔案執行圖片偵測和註解作業。目前僅支援「application/pdf」、「image/tiff」和「image/gif」。

這項服務會從每個提供的檔案中擷取最多 5 個影格 (GIF) 或頁面 (PDF 或 TIF)，並針對每個擷取的圖片執行偵測和註解作業。

授權範圍

需要下列其中一種 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

詳情請參閱驗證總覽一文。

商品搜尋

管理產品和產品集的參考圖片，用於產品搜尋。這個 API 使用下列資源模型：

  • 這個 API 包含名為 projects/*/locations/*/productSets/* 的 ProductSet 資源集合，可用於將不同產品分組，以限制識別。

同時，

  • API 包含名為 projects/*/locations/*/products/* 的 Product 資源集合

  • 每個 Product 都有一組名為 projects/*/locations/*/products/*/referenceImages/* 的 ReferenceImage 資源

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

將產品新增至指定的 ProductSet。如果產品已存在，系統就不會進行任何變更。

一個產品最多可加入 100 個 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 相容的區域。如果指定此值，系統一律會略過偵測作業。系統會將多邊形轉換為未旋轉的矩形。

請注意，如果圖片解析度過大 (超過 5000 萬像素)，管道會調整圖片大小。

可能發生的錯誤：

  • 如果缺少 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 執行的搜尋查詢可能仍會運作，直到所有相關快取都重新整理為止。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽一文。
DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

永久刪除 ProductSet。產品集內的產品和 ReferenceImages 不會遭到刪除。

實際的圖片檔案不會從 Google Cloud Storage 中刪除。

授權範圍

需要下列其中一種 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 中刪除。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽一文。
GetProduct

rpc GetProduct(GetProductRequest) returns (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 中的產品。如果不存在 ProductSet，回應的 products 欄位會為空白。

可能發生的錯誤：

  • 如果 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

詳情請參閱驗證總覽一文。
PurgeProducts

rpc PurgeProducts(PurgeProductsRequest) returns (Operation)

非同步 API，用於刪除 ProductSet 中的所有產品，或不屬於任何 ProductSet 的所有產品。

如果產品是指定 ProductSet 的成員，且屬於其他 ProductSet，系統仍會刪除該產品。

建議您在完成這項作業後再刪除指定的 ProductSet。此外，在執行這項作業時，建議不要將批次刪除作業中涉及的任何產品新增至新的 ProductSet，因為這些產品可能仍會遭到刪除。

您無法復原 PurgeProducts 作業。因此，建議您在啟動「清除產品」前，先保留在匯入產品集時使用的 CSV 檔案 (如果您是透過這種方式建立產品集)，以防刪除後需要重新匯入資料。

如果您打算從 ProductSet 中清除所有產品，然後重新使用空白 ProductSet，並將新的產品重新匯入空白 ProductSet，則必須等待該 ProductSet 的 PurgeProducts 作業完成。

google.longrunning.Operation API 可用來追蹤要求的進度和結果。Operation.metadata 包含 BatchOperationMetadata。(進度)

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽一文。
RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

從指定的 ProductSet 中移除產品。

授權範圍

需要下列其中一種 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 欄位。

如果標籤已更新，則必須等到下次索引時，查詢才會反映出變更。

可能發生的錯誤：

  • 如果產品不存在，則傳回 NOT_FOUND。
  • 如果 update_mask 中包含 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，但要求中缺少該值，或顯示名稱長度超過 4096 個半形字元，就會傳回 INVALID_ARGUMENT。
授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

新增產品至產品集要求

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

AnnotateFileRequest

要求為單一檔案加註，例如 PDF、TIFF 或 GIF 檔案。

欄位
input_config

InputConfig

這是必要旗標，輸入檔案的相關資訊。
features[]

Feature

這是必要旗標，要求的功能。
image_context

ImageContext

檔案中可能隨附的其他背景資訊。

pages[]

int32

要進行圖像註解的檔案頁面。

頁面編號從 1 開始，我們假設檔案的第一頁為第 1 頁。每項要求最多支援 5 個網頁。頁面數量可為負數。

Page 1 代表第一頁。Page 2 代表第二頁。頁面 -1 表示最後一頁。頁面 -2 表示倒數第二頁。

如果檔案是 GIF 而非 PDF 或 TIFF，頁面是指 GIF 影格。

如果這個欄位為空白，服務預設會為檔案的前 5 頁執行圖像註解。

註解檔案回應

回應單一檔案註解要求。檔案可能包含一或多張圖片，每張圖片都有各自的回應。

欄位
input_config

InputConfig

系統產生此回覆時所參照的檔案相關資訊。

responses[]

AnnotateImageResponse

針對檔案內圖片的個別回應。如果已設定 error 欄位，這個欄位會留空。
total_pages

int32

這個欄位會顯示檔案中的頁面總數。
error

Status

如果已設定，則代表失敗要求的錯誤訊息。在這種情況下，系統不會設定 responses 欄位。

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

如果有這個值，表示網頁偵測已順利完成。

product_search_results

ProductSearchResults

如果有此值，代表產品搜尋已順利完成。
error

Status

如果已設定，則代表該作業的錯誤訊息。請注意，即使設定了 error，系統仍可保證填入的圖像註解正確無誤。
context

ImageAnnotationContext

如果有，則需要提供情境資訊，才能瞭解這張圖片的來源。

AsyncAnnotateFileRequest

離線檔案註解要求。

欄位
input_config

InputConfig

這是必要旗標，輸入檔案的相關資訊。
features[]

Feature

這是必要旗標，要求的功能。
image_context

ImageContext

檔案中可能隨附的其他背景資訊。

output_config

OutputConfig

這是必要旗標，所需的輸出位置和中繼資料 (例如格式)。

非同步註解檔案回應

單一離線檔案註解要求的回應。

欄位
output_config

OutputConfig

AsyncAnnotateFileRequest 的輸出位置和中繼資料。

非同步批次註解檔案要求

多個非同步檔案註解要求會批次處理為單一服務呼叫。

欄位
requests[]

AsyncAnnotateFileRequest

這是必要旗標，此批次的個別非同步檔案註解要求。
parent

string

(非必要) 要呼叫的目標專案和位置。

格式：projects/{project-id}/locations/{location-id}。

如果未指定父項，系統會自動選擇區域。

支援的位置 ID：us：僅限美國，asia：日本、臺灣等東亞地區，eu：歐盟。

範例：projects/project-A/locations/eu。

非同步批次註解檔案回應

回應非同步批次檔案註解要求。

欄位
responses[]

AsyncAnnotateFileResponse

檔案註解回應清單，每個 AsyncBatchAnnotateFilesRequest 要求對應一個回應。

非同步批次註解圖片要求

針對圖片清單要求非同步圖片註解。

欄位
requests[]

AnnotateImageRequest

這是必要旗標，此批次的個別圖片註解要求。
output_config

OutputConfig

這是必要旗標，所需的輸出位置和中繼資料 (例如格式)。
parent

string

(非必要) 要呼叫的目標專案和位置。

格式：projects/{project-id}/locations/{location-id}。

如果未指定父項，系統會自動選擇區域。

支援的位置 ID：us：僅限美國，asia：日本、臺灣等東亞地區，eu：歐盟。

範例：projects/project-A/locations/eu。

非同步批次註解圖片回應

回應非同步批次圖片註解要求。

欄位
output_config

OutputConfig

AsyncBatchAnnotateImagesRequest 的輸出位置和中繼資料。

批次註解檔案要求

使用 BatchAnnotateFiles API 為檔案加上註解的要求清單。

欄位
requests[]

AnnotateFileRequest

這是必要旗標，檔案註解要求清單。目前，BatchAnnotateFilesRequest 中僅支援一個 AnnotateFileRequest。

parent

string

(非必要) 要呼叫的目標專案和位置。

格式：projects/{project-id}/locations/{location-id}。

如果未指定父項，系統會自動選擇區域。

支援的位置 ID：us：僅限美國，asia：日本、臺灣等東亞地區，eu：歐盟。

範例：projects/project-A/locations/eu。

BatchAnnotateFilesResponse

檔案註解回應清單。

欄位
responses[]

AnnotateFileResponse

檔案註解回應清單，每個回應都對應至 BatchAnnotateFilesRequest 中的每個 AnnotateFileRequest。

批次註解圖片要求

多個圖片註解要求會批次處理為單一服務呼叫。

欄位
requests[]

AnnotateImageRequest

這是必要旗標，此批次的個別圖片註解要求。
parent

string

(非必要) 要呼叫的目標專案和位置。

格式：projects/{project-id}/locations/{location-id}。

如果未指定父項，系統會自動選擇區域。

支援的位置 ID：us：僅限美國，asia：日本、臺灣等東亞地區，eu：歐盟。

範例：projects/project-A/locations/eu。

BatchAnnotateImagesResponse

回應圖片批註要求。

欄位
responses[]

AnnotateImageResponse

批次中圖片註解要求的個別回應。

批次作業中繼資料

批次作業的中繼資料，例如目前狀態。

這會納入 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 後，要求就會完成。系統會按照要求中指定的方式，輸出在取消指令之前處理的任何記錄。

封鎖

網頁上的邏輯元素。

欄位
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]。

封鎖類型

OCR 辨識的區塊類型 (文字、圖片等)。

列舉
UNKNOWN 不明的區塊類型。
TEXT 一般文字區塊。
TABLE 表格區塊。
PICTURE 圖片區塊。
RULER 水平/垂直線框。
BARCODE 條碼區塊。

BoundingPoly

偵測到的圖片註解的定界多邊形。

欄位
vertices[]

Vertex

定界多邊形頂點。
normalized_vertices[]

NormalizedVertex

界線多邊形的正規頂點。

色彩資訊

色彩資訊包含 RGB 管道、分數，以及顏色在圖像中所占的圖像比例。

欄位
color

Color

色彩的 RGB 元件。
score

float

此顏色的圖片專屬分數。值介於 [0, 1] 之間。
pixel_fraction

float

顏色在圖片中所占的像素比例。值介於 [0, 1] 之間。

建立產品要求

CreateProduct 方法的要求訊息。

欄位
parent

string

這是必要旗標，應建立產品的專案。

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

Product

這是必要旗標，要建立的產品。
product_id

string

使用者提供的此產品資源 ID。如果已設定，伺服器就會嘗試使用這個值做為資源 ID。如果已有人使用，系統會傳回錯誤代碼 ALREADY_EXISTS。長度不得超過 128 個字元。不得包含 / 字元。

建立產品集要求

CreateProductSet 方法的要求訊息。

欄位
parent

string

這是必要旗標，應建立 ProductSet 的專案。

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

ProductSet

這是必要旗標，要建立的 ProductSet。
product_set_id

string

使用者提供的此 ProductSet 資源 ID。如果已設定，伺服器就會嘗試使用這個值做為資源 ID。如果已有人使用，系統會傳回錯誤代碼 ALREADY_EXISTS。長度不得超過 128 個字元。不得包含 / 字元。

建立參考圖片要求

CreateReferenceImage 方法的要求訊息。

欄位
parent

string

這是必要旗標，要建立參考圖片的產品資源名稱。

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

ReferenceImage

這是必要旗標，要建立的參考圖像。如果指定圖片 ID，系統會略過該 ID。
reference_image_id

string

使用者提供的資源 ID，用於新增 ReferenceImage。如果已設定，伺服器就會嘗試使用這個值做為資源 ID。如果已有人使用，系統會傳回錯誤代碼 ALREADY_EXISTS。長度不得超過 128 個字元。不得包含 / 字元。

裁剪提示

單一裁剪提示，用於在提供圖片時產生新的裁剪區域。

欄位
bounding_poly

BoundingPoly

裁剪區域的定界多邊形。邊界框的座標是以原始圖片的比例計算。
confidence

float

此為顯著區域的信賴度。範圍 [0, 1]。
importance_fraction

float

這個顯目區域相對於原始圖片的重要性。

裁剪提示註解

一組裁剪提示，用於在提供圖片時產生新的裁剪圖片。

欄位
crop_hints[]

CropHint

裁剪提示結果。

裁剪提示參數

裁剪提示註解要求的參數。

欄位
aspect_ratios[]

float

浮點值中的顯示比例，代表圖片的寬高比。舉例來說，如果所需的顯示比例為 4/3，對應的浮點值應為 1.33333。如未指定，系統會傳回最佳裁剪結果。提供的顯示比例數量上限為 16；系統會忽略第 16 個之後提供的顯示比例。

刪除產品要求

DeleteProduct 方法的要求訊息。

欄位
name

string

這是必要旗標，要刪除的產品資源名稱。

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

刪除產品集要求

DeleteProductSet 方法的要求訊息。

欄位
name

string

這是必要旗標，要刪除的 ProductSet 資源名稱。

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

刪除參考圖片要求

DeleteReferenceImage 方法的要求訊息。

欄位
name

string

這是必要旗標，要刪除的參考圖片資源名稱。

格式如下：

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

主色註解

主色組合和對應的分數。

欄位
colors[]

ColorInfo

RGB 顏色值及其分數和像素分數。

實體註解

偵測到的實體功能集。

欄位
mid

string

不透明實體 ID。部分 ID 可能會在 Google Knowledge Graph Search API 中提供。

locale

string

實體文字 description 所使用的語言代碼。
description

string

實體文字說明，以 locale 語言表示。
score

float

結果的整體分數。範圍 [0, 1]。
confidence
(deprecated)

float

已淘汰；請改用 score。圖片中實體偵測的準確度。舉例來說，如果系統在圖片中偵測到「艾菲爾鐵塔」實體，這個欄位就會代表系統對查詢圖片中是否有鐵塔的信心程度。範圍 [0, 1]。
topicality

float

ICA (圖片內容註解) 標籤與圖片的相關性。舉例來說，如果圖片中偵測到「艾菲爾鐵塔」，那麼「塔」的相關性可能會高於偵測到遠方高樓的圖片，即使兩者偵測到塔的置信度相同。範圍 [0, 1]。
bounding_poly

BoundingPoly

這個實體所屬的圖片區域。不適用於 LABEL_DETECTION 功能。
locations[]

LocationInfo

所偵測實體的位置資訊。系統可以提供多個 LocationInfo 元素，因為一個位置可能表示圖片中場景的位置，另一個位置則可能表示圖片拍攝地點。地標通常會提供位置資訊。
properties[]

Property

部分實體可能會提供選用的使用者提供 Property (名稱/值) 欄位，例如評分或可用於判定實體的字串。

臉部註解

臉部註解物件包含臉部偵測結果。

欄位
bounding_poly

BoundingPoly

臉孔周圍的定界多邊形。外框的座標是以原始圖片的比例計算。系統會根據人類的期望，計算出符合預期的臉部「邊框」。這項設定會根據地標結果計算。請注意，如果要註解的圖片中只顯示部分臉孔，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 執行網頁偵測。
OBJECT_LOCALIZATION 執行物件偵測的定位器。

GcsDestination

輸出內容的寫入位置 (Google Cloud Storage)。

欄位
uri

string

結果的儲存位置 Google Cloud Storage URI 前置字串。結果會以 JSON 格式顯示，並在前面加上對應的輸入 URI 前置字串。這個欄位可以代表 Google Cloud Storage 檔案前置字串或 Google Cloud Storage 目錄。無論是哪種情況，URI 都必須是唯一的，因為您必須針對您提供的 URI 前置字串，執行 Google Cloud Storage 萬用字元搜尋，才能取得所有輸出檔案。

範例：

如果有多個輸出項目，每個回應仍為 AnnotateFileResponse，且每個回應都包含 AnnotateImageResponse 完整清單的某些子集。舉例來說，如果輸出 JSON 過大，並溢位至多個分割檔案，就可能會產生多個輸出內容。

GcsSource

系統讀取輸入內容的 Google Cloud Storage 位置。

欄位
uri

string

輸入檔案的 Google Cloud Storage URI。這必須是 Google Cloud Storage 物件。目前不支援萬用字元。

GetProductRequest

GetProduct 方法的要求訊息。

欄位
name

string

這是必要旗標，要取得的產品資源名稱。

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

取得取得產品集要求

GetProductSet 方法的要求訊息。

欄位
name

string

這是必要旗標，要取得的 ProductSet 資源名稱。

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

取得參考圖片要求

GetReferenceImage 方法的要求訊息。

欄位
name

string

這是必要旗標，要取得的 ReferenceImage 資源名稱。

格式如下：

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

圖片

用於執行 Google Cloud Vision API 工作之用途的用戶端映像檔。

欄位
content

bytes

圖片內容，以位元組串流表示。注意：與所有 bytes 欄位一樣，protobuffers 會使用純二進位表示法，而 JSON 表示法則會使用 base64。
source

ImageSource

Google Cloud Storage 圖片位置，或可公開存取的圖片網址。如果圖片同時提供 content 和 source，系統會優先採用 content，並用於執行圖片註解要求。

圖片註解內容

如果圖片是從檔案 (例如 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

用於偵測網站的參數。

圖片屬性

儲存圖片屬性，例如主色。

欄位
dominant_colors

DominantColorsAnnotation

如果存在，代表已順利完成主色調。

圖片來源

外部圖片來源 (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 無法保證要求一定能完成。如果指定主機拒絕要求 (例如因要求節流或拒絕服務攻擊防護)，或是 Google 為了防止濫用而節流網站要求，您的要求可能會失敗。正式版應用程式不應依賴外部代管的圖片。

如果同時指定 gcs_image_uri 和 image_uri，則以 image_uri 的效力優先。

匯入產品集 GCS 來源

CSV 檔案的 Google Cloud Storage 位置，其中每行都保留 ImportProductSetRequest 清單。

欄位
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 萬像素)，系統會調整圖片大小。

匯入產品集輸入設定

ImportProductSets 方法的輸入內容。

欄位
gcs_source

ImportProductSetsGcsSource

CSV 檔案的 Google Cloud Storage 位置，其中每行都保留 ImportProductSetRequests 清單。

匯入產品集要求

ImportProductSets 方法的要求訊息。

欄位
parent

string

這是必要旗標，應匯入 ProductSet 的專案。

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

ImportProductSetsInputConfig

這是必要旗標，要求清單的輸入內容。

匯入產品集回應

ImportProductSets 方法的回應訊息。

這則訊息是由傳回的 google.longrunning.Operation.response 欄位中的 google.longrunning.Operations.GetOperation 方法傳回。

欄位
reference_images[]

ReferenceImage

已成功匯入的 reference_images 清單。
statuses[]

Status

每個 ImportProductSet 要求的 RPC 狀態，包括成功和錯誤。

此處的狀態數量與 csv 檔案中的行數量相符，而 statuses[i] 會儲存處理 csv 檔案第 i 行 (從第 0 行開始) 的成功或失敗狀態。

InputConfig

所需的輸入位置和中繼資料。

欄位
gcs_source

GcsSource

要讀取輸入內容的 Google Cloud Storage 位置。
content

bytes

檔案內容，以位元組串流表示。注意：與所有 bytes 欄位一樣，protobuffers 會使用純二進位表示法，而 JSON 表示法則會使用 base64。

目前這個欄位僅適用於 BatchAnnotateFiles 要求。但不適用於 AsyncBatchAnnotateFiles 要求。
mime_type

string

檔案類型。目前僅支援「application/pdf」、「image/tiff」和「image/gif」。而且不支援萬用字元。

緯度/經度矩形

由最小和最大 LatLng 組合決定的矩形。

欄位
min_lat_lng

LatLng

最小經緯度組合。
max_lat_lng

LatLng

最長的緯/經度組合。

可能性

以分桶方式表示可能性，目的是在模型升級時為客戶提供高度穩定的結果。

列舉
UNKNOWN 可能性不明。
VERY_UNLIKELY 這很不可能。
UNLIKELY 不太可能。
POSSIBLE 是的。
LIKELY 很有可能。
VERY_LIKELY 很有可能。

列出產品集要求

ListProductSets 方法的要求訊息。

欄位
parent

string

這是必要旗標，應列出 ProductSet 的專案。

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

int32

傳回的項目數量上限。預設值為 10，上限為 100。

page_token

string

先前的 List 要求 (如果有的話) 傳回的 next_page_token。

列出產品集回應

ListProductSets 方法的回應訊息。

欄位
product_sets[]

ProductSet

ProductSet 清單。
next_page_token

string

用來擷取下一頁結果的符記；如果清單中沒有其他結果，這一欄就會留空。

列出產品集中的產品要求

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。

列出產品集中的產品回應

ListProductsInProductSet 方法的回應訊息。

欄位
products[]

Product

產品清單。
next_page_token

string

用來擷取下一頁結果的符記；如果清單中沒有其他結果，這一欄就會留空。

列出產品要求

ListProducts 方法的要求訊息。

欄位
parent

string

這是必要旗標，應列出產品的專案或 ProductSet。

格式：projects/PROJECT_ID/locations/LOC_ID
page_size

int32

傳回的項目數量上限。預設值為 10，上限為 100。

page_token

string

先前的 List 要求 (如果有的話) 傳回的 next_page_token。

列出產品回應

ListProducts 方法的回應訊息。

欄位
products[]

Product

產品清單。

next_page_token

string

用來擷取下一頁結果的符記；如果清單中沒有其他結果，這一欄就會留空。

列出參考圖片要求

ListReferenceImages 方法的要求訊息。

欄位
parent

string

這是必要旗標，包含參考圖片的產品資源名稱。

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

int32

傳回的項目數量上限。預設值為 10，上限為 100。

page_token

string

用來識別要傳回的結果頁面的符記。這是先前參考圖片清單要求傳回的 nextPageToken 值。

如未指定，預設會使用第一頁。

列出參考圖片回應

ListReferenceImages 方法的回應訊息。

欄位
reference_images[]

ReferenceImage

參考圖片清單。
page_size

int32

傳回的項目數量上限。預設值為 10，上限為 100。

next_page_token

string

先前的 List 要求 (如果有的話) 傳回的 next_page_token。

本地化物件註解

包含定界框的偵測物件集合。

欄位
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

這個物件所屬的圖片區域。必須填入。

地點資訊

偵測到的實體位置資訊。

欄位
lat_lng

LatLng

經緯度座標。

正規化 Vertex

頂點代表圖片中的 2D 點。注意：經過正規化的頂點座標會相對於原始圖片，範圍為 0 到 1。

欄位
x

float

X 座標。
y

float

Y 座標。

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。

舉例來說，如果 PDF 檔案有 100 頁，系統就會產生 100 個回應原型。如果 batch_size = 20，則會在前置字串 gcs_destination.uri 下寫入 5 個 JSON 檔案，每個檔案都包含 20 個回應原型。

目前 batch_size 只適用於 GcsDestination，日後可能會支援其他輸出設定。

頁面

透過光學字元辨識偵測到的頁面。

欄位
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 座標 (或深度)。

產品

產品包含 ReferenceImages。

欄位
name

string

產品的資源名稱。

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

建立產品時，系統會忽略這個欄位。
display_name

string

使用者提供的產品名稱。不得留空。長度不得超過 4096 個半形字元。

description

string

使用者提供的要儲存在本產品中的中繼資料。長度不得超過 4096 個半形字元。

product_category

string

不可變動。參考圖像所識別的產品類別。這個值應為「homegoods-v2」、「apparel-v2」或「toys-v2」。系統仍支援舊版類別「家居用品」、「服飾」和「玩具」，但不應用於新產品。

product_labels[]

KeyValue

這是可以附加至產品的鍵/值組合，在查詢時，您可以根據 product_labels 指定限制。

請注意，整數值可以字串形式提供，例如「1199」。只有含有整數值的字串才能符合範圍限制 (這項限制即將支援)。

同一個鍵可以指派多個值。一個產品最多可有 500 個 product_labels。

請注意，一個 ProductSet 中所有產品的 distinct_product_labels 總數不得超過 100 萬，否則產品搜尋管道將拒絕為該 ProductSet 運作。

KeyValue

以鍵/值組合表示的產品標籤。

欄位
key

string

產品附帶標籤的鍵。不得為空白，且大小不得超過 128 個位元組。

value

string

產品附帶標籤的值。不得為空白，且大小不得超過 128 個位元組。

產品搜尋參數

產品搜尋要求的參數。

欄位
bounding_poly

BoundingPoly

圖片中感興趣區域的邊界多邊形。(非必要) 如未指定，系統會自行判斷。
product_set

string

要搜尋相似圖片的 ProductSet 資源名稱。

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

string

要搜尋的產品類別清單。目前我們只會考慮第一個類別，並且必須指定「homegoods-v2」、「apparel-v2」、「toys-v2」、「packagedgoods-v1」或「general-v1」。系統仍支援舊版類別「家居用品」、「服飾」和「玩具」，但這些類別將淘汰。如要提高產品搜尋的準確度，請針對新產品使用「homegoods-v2」、「apparel-v2」或「toys-v2」。建議你也將現有產品遷移至這些類別。

filter

string

篩選運算式。可用於根據產品標籤限制搜尋結果。我們目前支援鍵值運算式 OR 的 AND，其中 OR 中的每個運算式都必須具有相同的鍵。請使用「=」連結鍵和值。

舉例來說，「(color = red OR color = blue) AND brand = Google」是可接受的條件，但「(color = red OR brand = Google)」則不行。「color: red」不符合規定，因為它使用的是 ':'，而非 '='。

產品搜尋結果

產品搜尋要求的結果。

欄位
index_time

Timestamp

提供這些結果的索引時間戳記。在這個時間點之後新增至產品組合或從產品組合中移除的產品，不會反映在目前的結果中。

results[]

Result

結果清單，每項產品比對結果各一。

product_grouped_results[]

GroupedResult

根據查詢圖片中偵測到的產品分組的結果清單。每個項目都對應至查詢圖片中的一個邊界多邊形，並包含該區域的特定相符產品。所有個別產品結果的聯集可能會出現重複的產品比對結果。

GroupedResult

與查詢圖片中單一產品相似的產品資訊。

欄位
bounding_poly

BoundingPoly

在查詢圖片中偵測到的產品周圍邊界多邊形。
results[]

Result

結果清單，每項產品比對結果各一。

object_annotations[]

ObjectAnnotation

定界框中物件的一般預測結果清單。

ObjectAnnotation

預測定界框內物件的類型。

欄位
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]。

結果

產品資訊。

欄位
product

Product

產品。

score

float

比對結果的信心程度，範圍從 0 (完全沒有信心) 到 1 (完全有信心)。
image

string

與查詢最相符的產品圖片資源名稱。

產品集

產品集包含產品。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 時，系統會忽略這個欄位。

產品集清除設定

設定，用於控管哪個 ProductSet 包含要刪除的產品。

欄位
product_set_id

string

包含要刪除的產品的 ProductSet。如果產品除了是 product_set_id 的組合成員，也是其他 ProductSet 的組合成員，系統仍會刪除該產品。

屬性

Property 由使用者提供的名稱/值組合組成。

欄位
name

string

房源名稱。
value

string

屬性值。
uint64_value

uint64

數值屬性的值。

清除產品要求

PurgeProducts 方法的要求訊息。

欄位
parent

string

這是必要旗標，產品應刪除的專案和位置。

格式為 projects/PROJECT_ID/locations/LOC_ID。
force

bool

預設值為 false。將這個值覆寫為 true，即可實際執行清除作業。
聯集欄位 target。要刪除的產品。target 只能是下列其中一項：
product_set_purge_config

ProductSetPurgeConfig

指定哪個 ProductSet 包含要刪除的產品。
delete_orphan_products

bool

如果 delete_orphan_products 為 true，系統會刪除所有不在任何 ProductSet 中的產品。

參考圖片

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 則不行)。

從產品集要求移除產品

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

安全搜尋註解

與圖片相關的功能集合，透過電腦視覺方法計算出安全搜尋類別 (例如成人、惡搞、醫療、暴力)。

欄位
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 包含 OCR 擷取的文字結構化表示法。OCR 擷取的文字結構階層如下：TextAnnotation -> 頁面 -> 區塊 -> 段落 -> 字 -> 符號。從頁面開始，每個結構元件可能都有各自的屬性。屬性會說明偵測到的語言、中斷點等。詳情請參閱下方的 TextAnnotation.TextProperty 訊息定義。

欄位
pages[]

Page

OCR 偵測到的頁面清單。
text

string

系統在網頁上偵測到 UTF-8 文字。

DetectedBreak

偵測到結構元件的開始或結束。

欄位
type

BreakType

偵測到的符號類型。
is_prefix

bool

如果 break 置於元素之前，則為「是」。

分隔類型

以列舉方式表示所找到的斷點類型。換行、空格等。

列舉
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

偵測到文字片段的開頭或結尾。

更新產品要求

UpdateProduct 方法的要求訊息。

欄位
product

Product

這是必要旗標，取代伺服器上產品資源的產品資源。product.name 無法變更。
update_mask

FieldMask

FieldMask 會指定要更新的欄位。如果未指定 update_mask，系統會更新所有可變動欄位。有效的遮罩路徑包括 product_labels、display_name 和 description。

更新產品集要求

UpdateProductSet 方法的要求訊息。

欄位
product_set

ProductSet

這是必要旗標，取代伺服器上 ProductSet 資源。
update_mask

FieldMask

FieldMask 會指定要更新的欄位。如果未指定 update_mask，系統會更新所有可變動欄位。有效的遮罩路徑為 display_name。

Vertex

頂點代表圖片中的 2D 點。注意：頂點座標與原始圖片的比例相同。

欄位
x

int32

X 座標。
y

int32

Y 座標。

網路偵測

網路上與圖片相關的資訊。

欄位
web_entities[]

WebEntity

從網際網路上的相似圖片中推斷實體。
full_matching_images[]

WebImage

與網際網路上的圖片完全相符。可包含經過調整大小的查詢圖片副本。
partial_matching_images[]

WebImage

部分相符的網路圖片。這些圖片非常相似，因此具有一些共同的關鍵特徵。舉例來說，原始圖片可能會部分符合裁切圖片。
pages_with_matching_images[]

WebPage

含有相符圖片的網頁 (來自網路)。

visually_similar_images[]

WebImage

外觀相似的圖片結果。
best_guess_labels[]

WebLabel

服務對要求圖片主題的最佳推測結果。根據公開網路上的相似圖片推測而得。

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

網頁上部分相符的圖片。這些圖片非常相似，因此具有一些共同的關鍵特徵。舉例來說，原始圖片可能會部分符合裁切圖片。

網路偵測參數

網頁偵測要求的參數。

欄位
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]。