REST Resource: documents

リソース: ドキュメント

API メソッドへの入力を表します。

JSON 表現
{
  "type": enum (Type),
  "language": string,
  "referenceWebUri": string,
  "boilerplateHandling": enum (BoilerplateHandling),

  // Union field source can be only one of the following:
  "content": string,
  "gcsContentUri": string
  // End of list of possible types for union field source.
}
フィールド
type

enum (Type)

必須。型が設定されていないか TYPE_UNSPECIFIED の場合は、INVALID_ARGUMENT エラーを返します。

language

string

ドキュメントの言語(指定されていない場合、言語は自動的に検出されます)。ISO および BCP-47 の両方の言語コードを使用できます。
言語サポートには、現在それぞれの API メソッドでサポートされている言語のリストが記載されています。言語(呼び出し元によって指定された言語、または自動的に検出された言語)が呼び出された API メソッドでサポートされていない場合は、INVALID_ARGUMENT エラーが返されます。

referenceWebUri

string

ドキュメントの取得元のウェブ URI。この URI はコンテンツの取得には使用されず、ドキュメントの分析のヒントとして使用されます。

boilerplateHandling

enum (BoilerplateHandling)

このドキュメントで検出されたボイラープレート(広告、著作権の宣言、バナーなど)をどのように処理するかを示します。指定しない場合、ボイラープレートはコンテンツと同じように扱われます。

共用体フィールド source。ドキュメントのソース(コンテンツが含まれている文字列、または Google Cloud Storage URI)。source は次のいずれかになります。
content

string

入力コンテンツ(文字列形式)。Cloud Audit Logging はユーザーデータに基づいているため、除外されています。

gcsContentUri

string

ファイルのコンテンツが保存されている Google Cloud Storage URI。この URI は、gs://bucketName/object_name 形式にする必要があります。詳細については、https://cloud.google.com/storage/docs/reference-uris をご覧ください。注: Cloud Storage オブジェクトのバージョン管理はサポートされていません。

タイプ

ドキュメント タイプの列挙型。

列挙型
TYPE_UNSPECIFIED コンテンツのタイプは指定しない
PLAIN_TEXT 書式なしテキスト
HTML HTML

BoilerplateHandling

ドキュメントで検出されたボイラープレートを処理する方法

列挙型
BOILERPLATE_HANDLING_UNSPECIFIED ボイラープレートの処理が指定されていません。
SKIP_BOILERPLATE 検出されたボイラープレートは分析しません。ボイラープレートを検出するには、参照ウェブ URI が必要です。
KEEP_BOILERPLATE ボイラープレートをコンテンツと同じように扱う。

メソッド

analyzeEntities

名前付きエンティティ(現時点では固有名詞と普通名詞)をテキスト内で検索し、各エンティティのエンティティ タイプ、顕著性、言及数、その他のプロパティを提供します。

analyzeEntitySentiment

AnalyzeEntities と同様に、エンティティをテキスト内で検索し、各エンティティとエンティティについての言及に関連付けられた感情を分析します。

analyzeSentiment

指定されたテキストの感情を分析します。

analyzeSyntax

テキストの構文を分析し、文の境界とトークン化を品詞タグ、依存関係ツリー、その他のプロパティとともに提供します。

annotateText

構文、感情、エンティティ、分類のすべての機能を 1 回の呼び出しで提供できる便利なメソッドです。

classifyText

ドキュメントをカテゴリに分類します。

moderateText

有害なカテゴリと機密情報のカテゴリについてドキュメントを管理します。