Method: documents.annotateText

すべての機能を 1 回の呼び出しで提供できる便利なメソッドです。

HTTP リクエスト

POST https://language.googleapis.com/v2/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 が使用するエンコード タイプ。

レスポンスの本文

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

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

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

省略可。有害またはデリケートなカテゴリについてドキュメントを管理します。