このページは Cloud Translation API によって翻訳されました。

Method: documents.annotateText

HTTP リクエスト
リクエストの本文
- JSON 表現
レスポンスの本文
- JSON 表現
認可スコープ
機能
- JSON 表現
試してみる

analyzeSentiment、analyzeEntities、および analyzeSyntax で提供されるすべての機能を 1 回の呼び出しで提供できる便利なメソッドです。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{ "document": { object (`Document`) }, "features": { object (`Features`) }, "encodingType": enum (`EncodingType`) }

フィールド

フィールド
`document`	`object (Document)` 必須。入力ドキュメント。
`features`	`object (Features)` 必須。有効な機能。
`encodingType`	`enum (EncodingType)` オフセットの計算に API が使用するエンコードタイプ。

document

object (Document)

必須。入力ドキュメント。

features

object (Features)

必須。有効な機能。

encodingType

enum (EncodingType)

オフセットの計算に API が使用するエンコードタイプ。

レスポンスの本文

テキストアノテーションのレスポンスメッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現

JSON 表現
{ "sentences": [ { object (`Sentence`) } ], "tokens": [ { object (`Token`) } ], "entities": [ { object (`Entity`) } ], "documentSentiment": { object (`Sentiment`) }, "language": string, "categories": [ { object (`ClassificationCategory`) } ], "moderationCategories": [ { object (`ClassificationCategory`) } ] }

{
  "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 表現

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)
  }
}

フィールド
`extractSyntax`	`boolean` 構文情報を抽出します。
`extractEntities`	`boolean` エンティティの抽出
`extractDocumentSentiment`	`boolean` ドキュメントレベルで感情を抽出します。
`extractEntitySentiment`	`boolean` エンティティとそれに関連する感情を抽出します。
`classifyText`	`boolean` ドキュメント全体をカテゴリに分類します。
`moderateText`	`boolean` 有害またはデリケートなカテゴリについてドキュメントを管理します。
`classificationModelOptions`	`object (ClassificationModelOptions)` 省略可。分類に使用するモデルオプション。指定しない場合のデフォルトは v1 オプションです。`classifyText` が true に設定されている場合にのみ使用されます。