Method: files.annotate

对一批文件执行图片检测和注释的服务。目前仅支持“application/pdf”“image/tiff”和“image/gif”。

此服务最多从每个提供的文件中提取最多 5 个（在 AnnotateFileRequest.pages 框架 (gif) 或网页（pdf 或 tiff）中分别提取 5 个图片，并对提取的每个图片执行检测和注释。

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 个页面。页面可以是负数。

页面 1 是指第一页。页面 2 是指第二页。页面 -1 是指最后一页。页面 -2 是指倒数第二页。

如果文件是 GIF，而不是 PDF 或 TIFF，则页面是指 GIF 帧。

如果此字段为空，则默认情况下，服务会对文件的前 5 页执行图片注释。

AnnotateFileResponse

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

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

object (InputConfig)

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

object (AnnotateImageResponse)

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

totalPages

number

此字段给出了文件中的总页数。