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 bucket 中的 JSON 檔案,每個 JSON 檔案都包含 BatchAnnotateImagesResponse proto。

授權範圍

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

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

授權範圍

需要下列其中一種 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 都有一組 ReferenceImage 資源,名為 projects/*/locations/*/products/*/referenceImages/*

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

將產品新增至指定的 ProductSet。如果產品已存在,則不會有任何變更。

一個產品最多可加入 100 個 ProductSet。

可能發生的錯誤:

  • 如果產品或 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)

永久刪除產品及其參考圖片。

產品的中繼資料和所有圖片會立即刪除,但系統重新整理所有相關快取前,針對含有該產品的 ProductSets 進行的搜尋查詢可能仍會運作。

可能發生的錯誤:

  • 如果產品不存在,則傳回 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 中的產品和 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)

取得與產品相關的資訊。

可能發生的錯誤:

  • 如果產品不存在,則傳回 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 不存在,回應的產品欄位會是空白。

可能發生的錯誤:

  • 如果 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_namedescriptionlabels 欄位。

如果更新標籤,變更會在下次建立索引時,才會反映在查詢中。

可能發生的錯誤:

  • 如果產品不存在,則傳回 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 的產品資源名稱。

格式為: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 個網頁。頁數可為負數。

第 1 頁是指第一頁。第 2 頁是指第二個頁面。頁碼 -1 代表最後一頁。-2 頁表示倒數第二頁。

如果檔案是 GIF,而非 PDF 或 TIFF,則「頁面」是指 GIF 影格。

如果這個欄位留空,服務預設會對檔案的前 5 頁執行圖片註解。

註解檔案回應

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

欄位
input_config

InputConfig

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

responses[]

AnnotateImageResponse

檔案中圖片的個別回應。

AnnotateImageRequest

要求對使用者提供的圖片執行 Google Cloud Vision API 工作,並提供使用者要求的功能和情境資訊。

欄位
image

Image

要處理的圖片。

features[]

Feature

要求的功能。

image_context

ImageContext

圖片可能附帶的額外背景資訊。

custom_label_detection_models[]

string

features.type 欄位中提出含有 CUSTOM_LABEL_DETECTION 值的要求時,CustomLabelDetectionModels 欄位必須指定要使用的自訂模型。模型名稱的格式會模仿自訂模型的資源網址:/projects/PROJECT_ID/models/MODEL_ID,如果模型屬於目前專案,則為 /models/MODEL_ID

AnnotateImageResponse

圖片註解要求的回應。

欄位
face_annotations[]

FaceAnnotation

如果存在,表示臉部偵測已順利完成。

landmark_annotations[]

EntityAnnotation

如果存在,代表地標偵測已順利完成。

logo_annotations[]

EntityAnnotation

如果存在,代表標誌偵測已順利完成。

label_annotations[]

EntityAnnotation

如果有的話,標籤偵測作業已順利完成。

localized_object_annotations[]

LocalizedObjectAnnotation

如果存在,表示本地化物件偵測已順利完成。系統會依信賴度分數降序排序。

custom_label_annotations[]

CustomEntityAnnotation

如果存在,自訂註解已順利完成。

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

如有脈絡資訊,則必須瞭解這張圖片的來源。

image_quality_annotation

ImageQuality

如有此欄位,表示影像品質計算已順利完成。

object_attribute_annotations[]

EntityAnnotation

如果存在,表示物件屬性計算已順利完成。屬性值會填入 EntityAnnotation.properties。示例:object_attribute_annotations { properties { name: "color" value: "blue" confidence: 0.1 } properties { name: "color" value: "white" confidence: 0.2 } properties { name: "material" value: "silk" confidence: 0.3 } }

quality_optimization_result

QualityOptimizationResult

如果顯示這項資訊,表示圖片品質最佳化作業已順利完成。

localized_barcode_annotations[]

LocalizedBarcodeAnnotation

如果存在,表示本地化條碼偵測已順利完成。

AsyncAnnotateFileRequest

離線檔案註解要求。

欄位
input_config

InputConfig

這是必要旗標,輸入檔案的相關資訊。

features[]

Feature

這是必要旗標,要求的功能。

image_context

ImageContext

檔案中圖片的額外背景資訊。

output_config

OutputConfig

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

非同步註解檔案回應

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

欄位
output_config

OutputConfig

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

非同步批次註解檔案要求

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

欄位
requests[]

AsyncAnnotateFileRequest

這個批次的個別非同步檔案註解要求。

非同步批次註解檔案回應

對非同步批次檔案註解要求的相關回應。

欄位
responses[]

AsyncAnnotateFileResponse

檔案註解回應清單,每個回應對應 AsyncBatchAnnotateFilesRequest 中的一項要求。

非同步批次註解圖片要求

要求為圖片清單進行非同步圖片註解。

欄位
requests[]

AnnotateImageRequest

這個批次的個別圖片註解要求。

output_config

OutputConfig

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

非同步批次註解圖片回應

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

欄位
output_config

OutputConfig

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

批次註解檔案要求

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

欄位
requests[]

AnnotateFileRequest

檔案註解要求清單。目前 BatchAnnotateFilesRequest 中僅支援一個 AnnotateFileRequest。

BatchAnnotateFilesResponse

檔案註解回應清單。

欄位
responses[]

AnnotateFileResponse

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

批次註解圖片要求

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

欄位
requests[]

AnnotateImageRequest

這個批次的個別圖片註解要求。

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

table

Table

偵測到 TABLE 區塊類型。根據預設,除非透過 TextDetectionParams.table_detection_options 啟用,否則系統不會傳回這個欄位。這個 Block 的 bounding_box 會是這個表格的偵測邊界。

key_value_pair

KeyValuePair

偵測到 KEY_VALUE_PAIR block_type 的配對。除非指定 DocumentType,否則預設不會傳回這個欄位。

merged_text

string

這個區塊中偵測到的所有 UTF-8 文字。除非在 TextDetectionParams.block_filter 中指定,否則預設不會傳回這個欄位。

封鎖類型

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

列舉
UNKNOWN 不明的區塊類型。
TEXT 一般文字區塊。
TABLE 表格區塊。
PICTURE 圖片封鎖。
RULER 水平/垂直線方塊。
BARCODE 條碼區塊。
KEY_VALUE_PAIR 鍵/值組合區塊。

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

要新增的 ReferenceImage 的使用者提供資源 ID。如果已設定,伺服器會嘗試將這個值做為資源 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 個的顯示比例會遭到忽略。

CustomEntityAnnotation

CustomEntityAnnotation 包含使用 Vision 自訂模型預測的註解。

欄位
model

string

用來識別建立這項註解的自訂模型。模型名稱的格式為所查詢自訂模型的資源網址:/projects/PROJECT_ID/models/MODEL_ID,或 /models/MODEL_ID (如果模型屬於目前專案)。

label

string

自訂模型預測的標籤。

score

float

自訂模型給予標籤的可信度分數。

刪除產品要求

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

DocumentParsingParams

DOCUMENT_PARSING 功能的參數。

欄位
disable_orientation_detection

bool

停用方向偵測功能,因此系統不會偵測旋轉的文字。

table_detection_options

TableDetectionOptions

控制表格偵測行為。如果未設定這個欄位,系統會停用表格偵測功能。

document_type

string

指定已知文件類型,以便進行更深入的結構偵測。目前有效值為「invoice」或「general」。

主色註解

一組主要顏色和對應的分數。

欄位
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_DETECTIONDOCUMENT_TEXT_DETECTIONCROP_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_DETECTIONTEXT_DETECTION 同時存在,則優先採用。
SAFE_SEARCH_DETECTION 執行安全搜尋,以偵測可能不安全或不適當的內容。
IMAGE_PROPERTIES 計算一組圖片屬性,例如圖片主色。
CROP_HINTS 執行裁剪提示。
WEB_DETECTION 執行網頁偵測。
CUSTOM_LABEL_DETECTION 執行自訂標籤偵測。
OBJECT_LOCALIZATION 執行物件偵測的定位器。
IMAGE_QUALITY 執行品質評分工具。
OBJECT_ATTRIBUTES 計算圖片中偵測到的物件屬性。系統支援四個物件網域。請透過 Feature.model 選取 (必要):「builtin/apparel」、「builtin/car」、「builtin/food」或「builtin/wildlife」。
QUALITY_OPTIMIZATION 執行品質最佳化演算法。共有三種作業類型:COMPRESSION、ENHANCEMENT 和 QUALITY_SCORE。COMPRESSION 和 ENHANCEMENT 參數,以及 QUALITY_SCORE 模型選項,都可以在 image_context.quality_optimization_params 中指定。
BARCODE_DETECTION 執行條碼偵測和辨識。
DOCUMENT_PARSING 執行文件剖析演算法,擷取表格和表單等結構化資料。結果位於 full_text_annotation -> page -> block,類型為資料表的 TABLE 或表單中鍵/值組合的 KEY_VALUE_PAIR。

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

要取得的產品資源名稱。

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

取得取得產品集要求

GetProductSet 方法的要求訊息。

欄位
name

string

要取得的 ProductSet 資源名稱。

格式為:projects/PROJECT_ID/locations/LOG_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 欄位一樣,Protobuffer 使用純二進位表示法,而 JSON 表示法使用 Base64。

source

ImageSource

Google Cloud Storage 圖片位置或可公開存取的圖片網址。如果圖片同時提供 contentsource,系統會優先採用 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

網頁偵測的參數。

text_detection_params

TextDetectionParams

文件文字偵測的參數。

quality_optimization_params

QualityOptimizationParams

圖片品質最佳化參數。

document_parsing_params

DocumentParsingParams

文件剖析的參數。

圖片屬性

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

欄位
dominant_colors

DominantColorsAnnotation

如果存在,代表主要顏色已順利完成。

ImageQuality

儲存圖片品質分數,可能是美學品質或技術品質。

欄位
quality_score

float

代表圖片美觀/技術品質的分數。分數範圍為 [0, 1]。值越高,相片看起來就越專業。0 代表圖片品質極差,1 代表圖片品質極高。

圖片來源

外部圖片來源 (Google Cloud Storage 或網址圖片位置)。

欄位
gcs_image_uri

string

請改用 image_uri

Google Cloud Storage URI,格式為 gs://bucket_name/object_name。不支援物件版本管理功能。詳情請參閱「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_uriimage_uri,系統會優先採用 image_uri

匯入產品集 GCS 來源

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-uriproduct-set-idproduct-idproduct-category 欄為必填欄位。其他欄位則為選填。

如果 product-set-idproduct-id 值指定的 ProductSetProduct 不存在,系統會為圖片建立新的 ProductSetProduct。在本例中,product-display-name 欄是指 display_nameproduct-category 欄是指 product_categorylabels 欄是指 product_labels

image-id 欄為選填,但如果提供,就不得重複。如果留空,系統會自動為圖片指派專屬 ID。

product-display-name 欄為選用項目。如果為空白,系統會將產品的 display_name 欄位設為空格 (" ")。您之後可以使用 API 更新 display_name

如果已存在具有指定 product-idProduct,系統會忽略 product-display-nameproduct-categorylabels 欄。

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 欄位一樣,Protobuffer 使用純二進位表示法,而 JSON 表示法使用 Base64。

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

mime_type

string

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

KeyValuePair

鍵/值組合的 Proto。

欄位
key

string

鍵字串值。

key_block

Block

包含標準化定界框和鍵文字的鍵區塊。

value_block

Block

包含正規化定界框和值文字的配對值區塊,包括值文字中可能更深層的結構。

value_type

string

值的類型。有效字串如下:

「generic」:對應至值的通用文字。「number」- 適用於數值類型,「id」- 適用於一般 ID。「currency」- 貨幣值。「date」:適用於日期。「time」:適用於時間和持續時間值。「date_range」:適用於日期範圍。「address」:適用於地址值 (可為長度較長的值)。「person」- 用於人名或其他個人 ID。「phone」:電話號碼。

normalized_key

string

(選用) 如果文字常見且已分類,則為正規化鍵文字。

舉例來說,「應付總額」會正規化為「總金額」。

緯度/經度矩形

由最小和最大 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 (如有)。

LocalizedBarcodeAnnotation

偵測到的條碼集,附帶定界框。

欄位
format

string

條碼格式說明條碼的格式。支援的格式包括:CODE_128:Code 128 類型。CODE_39:Code 39 類型。CODE_93:Code 93 類型。CODABAR:Codabar 類型。DATA_MATRIX:2D Data Matrix 類型。ITF:ITF 類型。EAN_13:EAN-13 類型。EAN_8:EAN-8 類型。QR_CODE:2D QR code 類型。UPC_A:UPC-A 類型。UPC_E:UPC-E 類型。PDF417:PDF417 類型。AZTEC:2D Aztec 代碼類型。DATABAR:GS1 DataBar 程式碼類型。

value_format

string

條碼值格式 ID 會說明條碼編碼值的格式。支援的值格式如下:CONTACT_INFO:聯絡資訊。電子郵件:電子郵件地址。ISBN:ISBN 識別碼。電話:電話號碼。產品:產品。簡訊:簡訊。TEXT:文字字串。網址:網址。WIFI:Wi-Fi 資訊。GEO:地理位置 (經緯度)。CALENDAR_EVENT:日曆活動。DRIVER_LICENSE:駕照。

value

string

條碼值,即條碼中擷取的 ASCII 值。條碼可以編碼結構化值,例如「MEBKM:TITLE:Google;URL:https://www.google.com;;'」。

confidence

float

結果的信賴度值。範圍 [0, 1]。

bounding_poly

BoundingPoly

這個條碼所屬的圖片區域。這項屬性必須填入值。

本地化物件註解

一組偵測到的物件,並附上定界框。

欄位
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 個回應 proto。如果 batch_size = 20,則系統會在前置字串 gcs_destination.uri 下寫入 5 個 JSON 檔案,每個檔案都包含 20 個回應原型。

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

頁面

透過 OCR 偵測到的頁面。

欄位
property

TextProperty

在網頁上偵測到額外資訊。

width

int32

頁面寬度。如果是 PDF,單位為點。圖片 (包括 TIFF) 的單位是像素。

height

int32

頁面高度。如果是 PDF,單位為點。圖片 (包括 TIFF) 的單位是像素。

blocks[]

Block

這個頁面上的文字區塊、圖片等清單。

confidence

float

網頁上 OCR 結果的信賴度。範圍 [0, 1]。

merged_text

string

這個頁面中偵測到的所有 UTF-8 文字。除非在 TextDetectionParams.page_filter 中指定,否則預設不會傳回這個欄位。

段落

文字的結構單元,代表特定順序的字詞數量。

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

merged_text

string

這段文字中偵測到的所有 UTF-8 文字。除非在 TextDetectionParams.paragraph_filter 中指定,否則預設不會傳回這個欄位。

位置

圖片中的 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」、「apparel」或「toys」。

這個欄位無法變更。

product_labels[]

KeyValue

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

請注意,整數值可以字串形式提供,例如「1199」。只有整數值的字串可以符合範圍限制,這項功能即將推出。

同一個鍵可以指派多個值。一項產品最多可有 100 個 product_label。

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

要搜尋的產品類別清單。目前我們只會考慮第一個類別,且必須指定「居家用品」、「服飾」或「玩具」。

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 時,系統會忽略這個欄位。

屬性

Property 包含使用者提供的名稱/值組合。

欄位
name

string

房源名稱。

value

string

屬性的值。

uint64_value

uint64

數值屬性的值。

confidence

float

值介於 [0..1] 之間。這個屬性值的信賴度。

mid

string

不透明的屬性值 ID。部分 ID 可能會顯示在 Google Knowledge Graph Search API 中。藍色外套的屬性範例如下:Property { name: 'color' value: 'blue' mid: '/m/01g5v' // For color blue }

QualityOptimizationParams

圖片品質最佳化參數。

欄位
type

Type

選擇一種最佳化類型。

compression_config

CompressionConfig

指定壓縮設定。

enhancement_config

EnhancementConfig

指定自動修圖設定。

quality_score_config

QualityScoreConfig

指定品質分數設定。

CompressionConfig

COMPRESSION 的設定。

欄位
target_quality

float

範圍為 [0, 1]。壓縮後的目標品質。1 代表與輸入圖片相比無失真,0 代表沒有最低品質規定。

EnhancementConfig

ENHANCMENT 的設定。如未指定 enhancement_config,系統會使用預設值,即 sharpening_level 等於 0.5、auto_hdr_level 等於 0.5,以及 upscale_ratio 等於 1。如要自訂這三個參數的任何一個,您必須指定整個 EnhancementConfig。舉例來說,如果您想使用較高的 auto_hdr_level (通常會讓圖片更亮),並將銳利度等級和放大比例維持與預設值相同,可以將設定設為:enhancement_config { sharpening_level: 0.5 auto_hdr_level: 1.0 upscale_ratio: 1 }

欄位
sharpening_level

float

範圍為 [0,1]。銳利度等級,0 表示不銳利化,1 表示最銳利化。預設值為 0.5。

auto_hdr_level

float

範圍為 [0,1]。自動 HDR 程度,0 表示不使用自動 HDR,1 表示使用最大程度的自動 HDR。預設值為 0.5。

upscale_ratio

float

範圍為 [1, 2]。是否要放大,預設值為 1,表示不放大。如果指定了這個值,輸出內容的高度和寬度會等於原始高度和寬度乘以 upscale_ratio。

QualityScoreConfig

品質分數的設定。

欄位
quality_model

string

指定要使用的模型。預設值為空白字串,並會傳回美感分數。另一個支援的品質模型是「builtin/technical-score」,會傳回圖片的技術品質。

類型

品質最佳化類型列舉。

列舉
TYPE_UNSPECIFIED 無效。顧客必須選取一個類型。
COMPRESSION 縮減圖片檔案大小。CompressionConfig 中指定的詳細參數。如果顧客未指定 CompressionConfig,系統會縮減圖片檔案大小,但不會降低圖片品質。如果顧客指定 CompressionConfig,我們會縮減檔案大小,同時保留 CompressionParams.target_quality。
ENHANCEMENT 降噪、銳利化、HDR 和升頻。在 EnhancementConfig 中指定的詳細參數。如果顧客未指定 EnhancmentConfig,系統會使用預設值進行影像強化。如未指定 upscale_ratio,輸出圖片的解析度會與輸入圖片相同。
QUALITY_SCORE 查詢圖片的查詢品質分數。QualityScoreConfig 中指定的詳細參數。如果消費者未指定 QualityScoreConfig,系統會傳回圖片的美觀分數。

QualityOptimizationResult

儲存強化圖片的位元組。

欄位
quality_optimization_type

Type

必要最佳化類型。

image

bytes

最佳化圖片位元組。

mime_type

string

輸出圖片的 MIME 類型。

參考圖片

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 移除的產品資源名稱。

格式為: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]。

資料表

類似 HTML 資料表結構的資料表表示法。

欄位
header_rows[]

TableRow

表格的標題列

body_rows[]

TableRow

表格的內文列

TableCell

表格中的儲存格表示法。

欄位
row_span

int32

這個儲存格跨越的資料列數。

col_span

int32

這個儲存格跨越的欄數。

text_block

Block

這個儲存格的文字區塊,其中也包含儲存格的正規化邊界方塊,以及儲存格內的更深層結構 (如有)。

text

string

這個儲存格的合併文字值,省略任何更深層的結構資訊,與 text_block 不同。這適用於簡單的儲存格。

TableRow

一列表格儲存格。

欄位
cells[]

TableCell

構成這個資料列的儲存格。

TableBoundHint

頁面上資料表邊界方塊的提示,用於剖析資料表。

欄位
page_number

int32

選填頁碼,適用於此提示的多頁輸入內容。如未提供,這項提示預設會套用至所有網頁。這個值是以 1 為索引。

bounding_box

BoundingPoly

這個頁面上的表格邊框提示。座標必須正規化為 [0,1],且邊界框必須是與軸對齊的矩形。

TableDetectionOptions

表格偵測選項。

欄位
table_bound_hints[]

TableBoundHint

選用性表格邊界框提示,適用於演算法無法在複雜情況下找到表格的情況。

文字註解

TextAnnotation 包含 OCR 擷取文字的結構化表示法。OCR 擷取文字結構的階層如下:TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol。從 Page 開始,每個結構化元件可能都有自己的屬性。屬性會說明偵測到的語言、中斷等。詳情請參閱下方的 TextAnnotation.TextProperty 訊息定義。

欄位
pages[]

Page

OCR 偵測到的頁面清單。

text

string

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

DetectedBreak

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

欄位
type

BreakType

偵測到的換行類型。

is_prefix

bool

如果換行符號會加在元素前面,則為 True。

分隔類型

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

列舉
UNKNOWN 不明的休息標籤類型。
SPACE 一般空間。
SURE_SPACE 確定空格 (非常寬)。
EOL_SURE_SPACE 換行符號。
HYPHEN 文字中沒有行尾連字號,且不會與 SPACELEADER_SPACELINE_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

偵測到文字區隔的開頭或結尾。

TextDetectionParams

文字偵測的參數。用於控制 TEXT_DETECTION 和 DOCUMENT_TEXT_DETECTION 功能。

欄位
disable_orientation_detection

bool

停用方向偵測功能,因此系統不會偵測旋轉的文字。這項功能僅支援 DOCUMENT_TEXT_DETECTION。

disable_text_annotations

bool

停用舊的 text_annotations 欄位。系統只會傳回 full_text_annotations。

page_filter

FieldMask

控制在 full_text_annotation 中網頁層級傳回的資料。未設定時的預設值:包含所有欄位

block_filter

FieldMask

控制 full_text_annotation 中區塊層級傳回的資料。如果未設定,預設值為包含所有欄位,但 merged_text 除外。

paragraph_filter

FieldMask

控制 full_text_annotation 中段落層級傳回的資料。未設定時的預設值:包含所有欄位,但 merged_text 除外

word_filter

FieldMask

控制 full_text_annotation 中傳回的字詞層級資料。未設定時的預設值:包含所有欄位,但 merged_text 除外

symbol_filter

FieldMask

控制 full_text_annotation 中符號層級傳回的資料。未設定時的預設值:包含所有欄位,但 bounding_box 除外

更新產品要求

UpdateProduct 方法的要求訊息。

欄位
product

Product

取代伺服器上產品的產品資源。product.name 不可變更。

update_mask

FieldMask

FieldMask,用於指定要更新的欄位。如未指定 update_mask,系統會更新所有可變動的欄位。有效遮罩路徑包括 product_labelsdisplay_namedescription

更新產品集要求

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

merged_text

string

這個字中偵測到的所有 UTF-8 文字。除非在 TextDetectionParams.word_filter 中指定,否則預設不會傳回這個欄位。