Method: documents.annotateText

一种便捷方法，用于在一次调用中提供所有功能。

HTTP 请求

POST https://language.googleapis.com/v2/documents:annotateText

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "document": {
    object (Document)
  },
  "features": {
    object (Features)
  },
  "encodingType": enum (EncodingType)
}
字段
document

object (Document)

必需。输入文档。
features

object (Features)

必需。已启用的功能。
encodingType

enum (EncodingType)

API 用于计算偏移的编码类型。

响应正文

文本注释响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "sentences": [
    {
      object (Sentence)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "languageCode": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageSupported": boolean
}
字段
sentences[]

object (Sentence)

输入文档中的句子。当用户启用 AnnotateTextRequest.Features.extract_document_sentiment 时填充。
entities[]

object (Entity)

输入文档中的实体及其语义信息。如果用户启用 AnnotateTextRequest.Features.extract_entities 或 AnnotateTextRequest.Features.extract_entity_sentiment，则会填充此值。
documentSentiment

object (Sentiment)

文档的整体情感。当用户启用 AnnotateTextRequest.Features.extract_document_sentiment 时填充。
languageCode

string

文本的语言，与请求中指定的语言相同；如果未指定，则与自动检测到的语言相同。如需了解详情，请参阅 [Document.language][] 字段。
categories[]

object (ClassificationCategory)

输入文档中识别的类别。
moderationCategories[]

object (ClassificationCategory)

输入文档中识别的有害和敏感类别。
languageSupported

boolean

所有请求的功能是否都正式支持相应语言。在语言不受支持的情况下，API 可能仍会返回响应，但只能尽力而为。

授权范围

需要以下 OAuth 范围之一：

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

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

特性

所有可用功能。将每个特性设为 true 可对输入启用特定的分析。

JSON 表示法 
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
字段
extractEntities

boolean

可选。提取实体，
extractDocumentSentiment

boolean

可选。提取文档级情感。
classifyText

boolean

可选。将整个文档分类。
moderateText

boolean

可选。审核文档是否包含有害和敏感内容。