REST Resource: documents

• Resource: Document
  • JSON representation
• Type
• Methods

Resource: Document

Represents the input to API methods.

JSON representation
{ "type": enum(Type), "language": string, // Union field source can be only one of the following: "content": string, "gcsContentUri": string // End of list of possible types for union field source. }

Fields
type	enum(Type) Required. If the type is not set or is TYPE_UNSPECIFIED, returns an INVALID_ARGUMENT error.
language	string The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted. Language Support lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an INVALID_ARGUMENT error is returned.
Union field source. The source of the document: a string containing the content or a Google Cloud Storage URI. source can be only one of the following:
content	string The content of the input in string format. Cloud audit logging exempt since it is based on user data.
gcsContentUri	string The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.

Type

The document types enum.

Enums
TYPE_UNSPECIFIED	The content type is not specified.
PLAIN_TEXT	Plain text
HTML	HTML

Methods
analyzeEntities	Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.
analyzeEntitySentiment	Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.
analyzeSentiment	Analyzes the sentiment of the provided text.
analyzeSyntax	Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
annotateText	A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.
classifyText	Classifies a document into categories.