Method: documents.annotateText

一种便捷方法，它用于在一次调用中提供 analyzeSentiment、analyzeEntities 和 analyzeSyntax 提供的所有功能。

HTTP 请求

POST https://language.googleapis.com/v1/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)
    }
  ],
  "tokens": [
    {
      object (Token)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "language": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ]
}
字段
sentences[]

object (Sentence)

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

object (Token)

输入文档中的词法单元及其语法信息。当用户启用 AnnotateTextRequest.Features.extract_syntax 时填充。
entities[]

object (Entity)

输入文档中的实体及其语义信息。当用户启用 AnnotateTextRequest.Features.extract_entities 时填充。
documentSentiment

object (Sentiment)

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

string

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

object (ClassificationCategory)

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

object (ClassificationCategory)

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

授权范围

需要以下 OAuth 范围之一：

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

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

特性

所有适用于情感、语法和语义分析的特性。将每个特性设为 true 可对输入启用特定的分析。

JSON 表示法 
{
  "extractSyntax": boolean,
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "extractEntitySentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean,
  "classificationModelOptions": {
    object (ClassificationModelOptions)
  }
}
字段
extractSyntax

boolean

提取语法信息。
extractEntities

boolean

提取实体，
extractDocumentSentiment

boolean

提取文档级情感。
extractEntitySentiment

boolean

提取实体及其关联的情感。
classifyText

boolean

将整个文档分类。
moderateText

boolean

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

object (ClassificationModelOptions)

可选。用于分类的模型选项。如果未指定，则默认为 v1 选项。仅当 classifyText 设为 true 时才会用到此政策。