Method: files.annotate

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

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

HTTP 要求

POST https://vision.googleapis.com/v1p4beta1/files:annotate

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "requests": [
    {
      object (AnnotateFileRequest)
    }
  ]
}
欄位
requests[]

object (AnnotateFileRequest)

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

回應主體

如果成功，回應主體會含有以下結構的資料：

檔案註解回應清單。

JSON 表示法 
{
  "responses": [
    {
      object (AnnotateFileResponse)
    }
  ]
}
欄位
responses[]

object (AnnotateFileResponse)

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

授權範圍

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

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

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

AnnotateFileRequest

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

JSON 表示法 
{
  "inputConfig": {
    object (InputConfig)
  },
  "features": [
    {
      object (Feature)
    }
  ],
  "imageContext": {
    object (ImageContext)
  },
  "pages": [
    number
  ]
}
欄位
inputConfig

object (InputConfig)

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

object (Feature)

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

object (ImageContext)

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

pages[]

number

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

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

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

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

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

註解檔案回應

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

JSON 表示法 
{
  "inputConfig": {
    object (InputConfig)
  },
  "responses": [
    {
      object (AnnotateImageResponse)
    }
  ],
  "totalPages": number
}
欄位
inputConfig

object (InputConfig)

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

responses[]

object (AnnotateImageResponse)

針對檔案內圖片的個別回應。

totalPages

number

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