docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/language_v1.documents.html b/docs/dyn/language_v1.documents.html
index a43da71..16793be 100644
--- a/docs/dyn/language_v1.documents.html
+++ b/docs/dyn/language_v1.documents.html
@@ -104,15 +104,15 @@
The object takes the form of:
{ # The entity analysis request message.
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
- "document": { # ################################################################ # # Required. Input document.
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
- "language": "A String", # The language of the document (if not specified, the language is
+ "gcsContentUri": "A 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.
+ "language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
# [Language
@@ -120,10 +120,10 @@
# 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.
- "gcsContentUri": "A 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": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
},
}
@@ -136,64 +136,64 @@
An object of the form:
{ # The entity analysis response message.
- "entities": [ # The recognized entities in the input document.
+ "language": "A String", # The language of the text, which will be the same as the language specified
+ # in the request or, if not specified, the automatically-detected language.
+ # See Document.language field for more details.
+ "entities": [ # The recognized entities in the input document.
{ # Represents a phrase in the text that is a known entity, such as
# a person, an organization, or location. The API associates information, such
# as salience and mentions, with entities.
- "name": "A String", # The representative name for the entity.
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
- # AnnotateTextRequest.Features.extract_entity_sentiment is set to
- # true, this field will contain the aggregate sentiment expressed for this
- # entity in the provided document.
- # the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
- # (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
- # the absolute magnitude of sentiment regardless of score (positive or
- # negative).
- },
- "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
- #
- # The salience score for an entity provides information about the
- # importance or centrality of that entity to the entire document text.
- # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
- # salient.
- "mentions": [ # The mentions of this entity in the input document. The API currently
+ "mentions": [ # The mentions of this entity in the input document. The API currently
# supports proper noun mentions.
{ # Represents a mention for an entity in the text. Currently, proper noun
# mentions are supported.
- "text": { # Represents an output piece of text. # The mention text.
- "content": "A String", # The content of the output text.
- "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ "text": { # Represents an output piece of text. # The mention text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
# document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
},
- "type": "A String", # The type of the entity mention.
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
+ "type": "A String", # The type of the entity mention.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
# AnnotateTextRequest.Features.extract_entity_sentiment is set to
# true, this field will contain the sentiment expressed for this mention of
# the entity in the provided document.
# the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
# (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
# the absolute magnitude of sentiment regardless of score (positive or
# negative).
},
},
],
- "type": "A String", # The entity type.
- "metadata": { # Metadata associated with the entity.
+ "name": "A String", # The representative name for the entity.
+ "type": "A String", # The entity type.
+ "metadata": { # Metadata associated with the entity.
#
# For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
# and Knowledge Graph MID (`mid`), if they are available. For the metadata
# associated with other entity types, see the Type table below.
- "a_key": "A String",
+ "a_key": "A String",
+ },
+ "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
+ #
+ # The salience score for an entity provides information about the
+ # importance or centrality of that entity to the entire document text.
+ # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
+ # salient.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
+ # AnnotateTextRequest.Features.extract_entity_sentiment is set to
+ # true, this field will contain the aggregate sentiment expressed for this
+ # entity in the provided document.
+ # the text.
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ # the absolute magnitude of sentiment regardless of score (positive or
+ # negative).
},
},
],
- "language": "A String", # The language of the text, which will be the same as the language specified
- # in the request or, if not specified, the automatically-detected language.
- # See Document.language field for more details.
}</pre>
</div>
@@ -207,15 +207,15 @@
The object takes the form of:
{ # The entity-level sentiment analysis request message.
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
- "document": { # ################################################################ # # Required. Input document.
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
- "language": "A String", # The language of the document (if not specified, the language is
+ "gcsContentUri": "A 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.
+ "language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
# [Language
@@ -223,10 +223,10 @@
# 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.
- "gcsContentUri": "A 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": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
},
}
@@ -239,64 +239,64 @@
An object of the form:
{ # The entity-level sentiment analysis response message.
- "entities": [ # The recognized entities in the input document with associated sentiments.
+ "language": "A String", # The language of the text, which will be the same as the language specified
+ # in the request or, if not specified, the automatically-detected language.
+ # See Document.language field for more details.
+ "entities": [ # The recognized entities in the input document with associated sentiments.
{ # Represents a phrase in the text that is a known entity, such as
# a person, an organization, or location. The API associates information, such
# as salience and mentions, with entities.
- "name": "A String", # The representative name for the entity.
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
- # AnnotateTextRequest.Features.extract_entity_sentiment is set to
- # true, this field will contain the aggregate sentiment expressed for this
- # entity in the provided document.
- # the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
- # (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
- # the absolute magnitude of sentiment regardless of score (positive or
- # negative).
- },
- "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
- #
- # The salience score for an entity provides information about the
- # importance or centrality of that entity to the entire document text.
- # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
- # salient.
- "mentions": [ # The mentions of this entity in the input document. The API currently
+ "mentions": [ # The mentions of this entity in the input document. The API currently
# supports proper noun mentions.
{ # Represents a mention for an entity in the text. Currently, proper noun
# mentions are supported.
- "text": { # Represents an output piece of text. # The mention text.
- "content": "A String", # The content of the output text.
- "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ "text": { # Represents an output piece of text. # The mention text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
# document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
},
- "type": "A String", # The type of the entity mention.
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
+ "type": "A String", # The type of the entity mention.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
# AnnotateTextRequest.Features.extract_entity_sentiment is set to
# true, this field will contain the sentiment expressed for this mention of
# the entity in the provided document.
# the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
# (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
# the absolute magnitude of sentiment regardless of score (positive or
# negative).
},
},
],
- "type": "A String", # The entity type.
- "metadata": { # Metadata associated with the entity.
+ "name": "A String", # The representative name for the entity.
+ "type": "A String", # The entity type.
+ "metadata": { # Metadata associated with the entity.
#
# For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
# and Knowledge Graph MID (`mid`), if they are available. For the metadata
# associated with other entity types, see the Type table below.
- "a_key": "A String",
+ "a_key": "A String",
+ },
+ "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
+ #
+ # The salience score for an entity provides information about the
+ # importance or centrality of that entity to the entire document text.
+ # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
+ # salient.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
+ # AnnotateTextRequest.Features.extract_entity_sentiment is set to
+ # true, this field will contain the aggregate sentiment expressed for this
+ # entity in the provided document.
+ # the text.
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ # the absolute magnitude of sentiment regardless of score (positive or
+ # negative).
},
},
],
- "language": "A String", # The language of the text, which will be the same as the language specified
- # in the request or, if not specified, the automatically-detected language.
- # See Document.language field for more details.
}</pre>
</div>
@@ -309,15 +309,15 @@
The object takes the form of:
{ # The sentiment analysis request message.
- "encodingType": "A String", # The encoding type used by the API to calculate sentence offsets.
- "document": { # ################################################################ # # Required. Input document.
+ "encodingType": "A String", # The encoding type used by the API to calculate sentence offsets.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
- "language": "A String", # The language of the document (if not specified, the language is
+ "gcsContentUri": "A 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.
+ "language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
# [Language
@@ -325,10 +325,10 @@
# 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.
- "gcsContentUri": "A 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": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
},
}
@@ -341,34 +341,34 @@
An object of the form:
{ # The sentiment analysis response message.
- "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
+ "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
# the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
# (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
# the absolute magnitude of sentiment regardless of score (positive or
# negative).
},
- "language": "A String", # The language of the text, which will be the same as the language specified
+ "language": "A String", # The language of the text, which will be the same as the language specified
# in the request or, if not specified, the automatically-detected language.
# See Document.language field for more details.
- "sentences": [ # The sentiment for all the sentences in the document.
+ "sentences": [ # The sentiment for all the sentences in the document.
{ # Represents a sentence in the input document.
- "text": { # Represents an output piece of text. # The sentence text.
- "content": "A String", # The content of the output text.
- "beginOffset": 42, # The API calculates the beginning offset of the content in the original
- # document according to the EncodingType specified in the API request.
- },
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
# AnnotateTextRequest.Features.extract_document_sentiment is set to
# true, this field will contain the sentiment for the sentence.
# the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
# (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
# the absolute magnitude of sentiment regardless of score (positive or
# negative).
},
+ "text": { # Represents an output piece of text. # The sentence text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ # document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
+ },
},
],
}</pre>
@@ -385,15 +385,15 @@
The object takes the form of:
{ # The syntax analysis request message.
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
- "document": { # ################################################################ # # Required. Input document.
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
- "language": "A String", # The language of the document (if not specified, the language is
+ "gcsContentUri": "A 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.
+ "language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
# [Language
@@ -401,10 +401,10 @@
# 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.
- "gcsContentUri": "A 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": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
},
}
@@ -417,61 +417,61 @@
An object of the form:
{ # The syntax analysis response message.
- "tokens": [ # Tokens, along with their syntactic information, in the input document.
- { # Represents the smallest syntactic building block of the text.
- "text": { # Represents an output piece of text. # The token text.
- "content": "A String", # The content of the output text.
- "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ "language": "A String", # The language of the text, which will be the same as the language specified
+ # in the request or, if not specified, the automatically-detected language.
+ # See Document.language field for more details.
+ "sentences": [ # Sentences in the input document.
+ { # Represents a sentence in the input document.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
+ # AnnotateTextRequest.Features.extract_document_sentiment is set to
+ # true, this field will contain the sentiment for the sentence.
+ # the text.
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ # the absolute magnitude of sentiment regardless of score (positive or
+ # negative).
+ },
+ "text": { # Represents an output piece of text. # The sentence text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
# document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
},
- "partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
- # are as defined in
- # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
- "case": "A String", # The grammatical case.
- "aspect": "A String", # The grammatical aspect.
- "form": "A String", # The grammatical form.
- "gender": "A String", # The grammatical gender.
- "number": "A String", # The grammatical number.
- "person": "A String", # The grammatical person.
- "tag": "A String", # The part of speech tag.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- "proper": "A String", # The grammatical properness.
- "voice": "A String", # The grammatical voice.
- "mood": "A String", # The grammatical mood.
+ },
+ ],
+ "tokens": [ # Tokens, along with their syntactic information, in the input document.
+ { # Represents the smallest syntactic building block of the text.
+ "text": { # Represents an output piece of text. # The token text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ # document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
},
- "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
+ "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
# information on dependency labels, see
# http://www.aclweb.org/anthology/P13-2017
- "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
+ "label": "A String", # The parse label for the token.
+ "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
# This is the index of the token which has an arc going to this token.
# The index is the position of the token in the array of tokens returned
# by the API method. If this token is a root token, then the
# `head_token_index` is its own index.
- "label": "A String", # The parse label for the token.
},
- "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
- },
- ],
- "language": "A String", # The language of the text, which will be the same as the language specified
- # in the request or, if not specified, the automatically-detected language.
- # See Document.language field for more details.
- "sentences": [ # Sentences in the input document.
- { # Represents a sentence in the input document.
- "text": { # Represents an output piece of text. # The sentence text.
- "content": "A String", # The content of the output text.
- "beginOffset": 42, # The API calculates the beginning offset of the content in the original
- # document according to the EncodingType specified in the API request.
- },
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
- # AnnotateTextRequest.Features.extract_document_sentiment is set to
- # true, this field will contain the sentiment for the sentence.
- # the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
- # (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
- # the absolute magnitude of sentiment regardless of score (positive or
- # negative).
+ "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
+ "partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
+ # are as defined in
+ # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
+ "proper": "A String", # The grammatical properness.
+ "case": "A String", # The grammatical case.
+ "tense": "A String", # The grammatical tense.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "form": "A String", # The grammatical form.
+ "number": "A String", # The grammatical number.
+ "voice": "A String", # The grammatical voice.
+ "aspect": "A String", # The grammatical aspect.
+ "mood": "A String", # The grammatical mood.
+ "tag": "A String", # The part of speech tag.
+ "gender": "A String", # The grammatical gender.
+ "person": "A String", # The grammatical person.
},
},
],
@@ -489,15 +489,23 @@
{ # The request message for the text annotation API, which can perform multiple
# analysis types (sentiment, entities, and syntax) in one call.
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
- "document": { # ################################################################ # # Required. Input document.
+ "features": { # All available features for sentiment, syntax, and semantic analysis. # Required. The enabled features.
+ # Setting each one to true will enable that specific analysis for the input.
+ "classifyText": True or False, # Classify the full document into categories.
+ "extractSyntax": True or False, # Extract syntax information.
+ "extractDocumentSentiment": True or False, # Extract document-level sentiment.
+ "extractEntitySentiment": True or False, # Extract entities and their associated sentiment.
+ "extractEntities": True or False, # Extract entities.
+ },
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
- "language": "A String", # The language of the document (if not specified, the language is
+ "gcsContentUri": "A 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.
+ "language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
# [Language
@@ -505,18 +513,10 @@
# 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.
- "gcsContentUri": "A 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.
- },
- "features": { # All available features for sentiment, syntax, and semantic analysis. # Required. The enabled features.
- # Setting each one to true will enable that specific analysis for the input.
- "extractDocumentSentiment": True or False, # Extract document-level sentiment.
- "extractEntitySentiment": True or False, # Extract entities and their associated sentiment.
- "extractSyntax": True or False, # Extract syntax information.
- "extractEntities": True or False, # Extract entities.
- "classifyText": True or False, # Classify the full document into categories.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
},
}
@@ -529,139 +529,139 @@
An object of the form:
{ # The text annotations response message.
- "language": "A String", # The language of the text, which will be the same as the language specified
- # in the request or, if not specified, the automatically-detected language.
- # See Document.language field for more details.
- "tokens": [ # Tokens, along with their syntactic information, in the input document.
- # Populated if the user enables
- # AnnotateTextRequest.Features.extract_syntax.
- { # Represents the smallest syntactic building block of the text.
- "text": { # Represents an output piece of text. # The token text.
- "content": "A String", # The content of the output text.
- "beginOffset": 42, # The API calculates the beginning offset of the content in the original
- # document according to the EncodingType specified in the API request.
- },
- "partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
- # are as defined in
- # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
- "case": "A String", # The grammatical case.
- "aspect": "A String", # The grammatical aspect.
- "form": "A String", # The grammatical form.
- "gender": "A String", # The grammatical gender.
- "number": "A String", # The grammatical number.
- "person": "A String", # The grammatical person.
- "tag": "A String", # The part of speech tag.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- "proper": "A String", # The grammatical properness.
- "voice": "A String", # The grammatical voice.
- "mood": "A String", # The grammatical mood.
- },
- "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
- # information on dependency labels, see
- # http://www.aclweb.org/anthology/P13-2017
- "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
- # This is the index of the token which has an arc going to this token.
- # The index is the position of the token in the array of tokens returned
- # by the API method. If this token is a root token, then the
- # `head_token_index` is its own index.
- "label": "A String", # The parse label for the token.
- },
- "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
+ "categories": [ # Categories identified in the input document.
+ { # Represents a category returned from the text classifier.
+ "name": "A String", # The name of the category representing the document, from the [predefined
+ # taxonomy](https://cloud.google.com/natural-language/docs/categories).
+ "confidence": 3.14, # The classifier's confidence of the category. Number represents how certain
+ # the classifier is that this category represents the given text.
},
],
- "entities": [ # Entities, along with their semantic information, in the input document.
+ "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment for the document. Populated if the user enables
+ # AnnotateTextRequest.Features.extract_document_sentiment.
+ # the text.
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ # the absolute magnitude of sentiment regardless of score (positive or
+ # negative).
+ },
+ "language": "A String", # The language of the text, which will be the same as the language specified
+ # in the request or, if not specified, the automatically-detected language.
+ # See Document.language field for more details.
+ "entities": [ # Entities, along with their semantic information, in the input document.
# Populated if the user enables
# AnnotateTextRequest.Features.extract_entities.
{ # Represents a phrase in the text that is a known entity, such as
# a person, an organization, or location. The API associates information, such
# as salience and mentions, with entities.
- "name": "A String", # The representative name for the entity.
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
- # AnnotateTextRequest.Features.extract_entity_sentiment is set to
- # true, this field will contain the aggregate sentiment expressed for this
- # entity in the provided document.
- # the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
- # (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
- # the absolute magnitude of sentiment regardless of score (positive or
- # negative).
- },
- "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
- #
- # The salience score for an entity provides information about the
- # importance or centrality of that entity to the entire document text.
- # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
- # salient.
- "mentions": [ # The mentions of this entity in the input document. The API currently
+ "mentions": [ # The mentions of this entity in the input document. The API currently
# supports proper noun mentions.
{ # Represents a mention for an entity in the text. Currently, proper noun
# mentions are supported.
- "text": { # Represents an output piece of text. # The mention text.
- "content": "A String", # The content of the output text.
- "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ "text": { # Represents an output piece of text. # The mention text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
# document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
},
- "type": "A String", # The type of the entity mention.
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
+ "type": "A String", # The type of the entity mention.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
# AnnotateTextRequest.Features.extract_entity_sentiment is set to
# true, this field will contain the sentiment expressed for this mention of
# the entity in the provided document.
# the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
# (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
# the absolute magnitude of sentiment regardless of score (positive or
# negative).
},
},
],
- "type": "A String", # The entity type.
- "metadata": { # Metadata associated with the entity.
+ "name": "A String", # The representative name for the entity.
+ "type": "A String", # The entity type.
+ "metadata": { # Metadata associated with the entity.
#
# For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
# and Knowledge Graph MID (`mid`), if they are available. For the metadata
# associated with other entity types, see the Type table below.
- "a_key": "A String",
+ "a_key": "A String",
},
- },
- ],
- "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment for the document. Populated if the user enables
- # AnnotateTextRequest.Features.extract_document_sentiment.
- # the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
- # (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
- # the absolute magnitude of sentiment regardless of score (positive or
- # negative).
- },
- "sentences": [ # Sentences in the input document. Populated if the user enables
- # AnnotateTextRequest.Features.extract_syntax.
- { # Represents a sentence in the input document.
- "text": { # Represents an output piece of text. # The sentence text.
- "content": "A String", # The content of the output text.
- "beginOffset": 42, # The API calculates the beginning offset of the content in the original
- # document according to the EncodingType specified in the API request.
- },
- "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
- # AnnotateTextRequest.Features.extract_document_sentiment is set to
- # true, this field will contain the sentiment for the sentence.
+ "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
+ #
+ # The salience score for an entity provides information about the
+ # importance or centrality of that entity to the entire document text.
+ # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
+ # salient.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
+ # AnnotateTextRequest.Features.extract_entity_sentiment is set to
+ # true, this field will contain the aggregate sentiment expressed for this
+ # entity in the provided document.
# the text.
- "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
# (positive sentiment).
- "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
# the absolute magnitude of sentiment regardless of score (positive or
# negative).
},
},
],
- "categories": [ # Categories identified in the input document.
- { # Represents a category returned from the text classifier.
- "confidence": 3.14, # The classifier's confidence of the category. Number represents how certain
- # the classifier is that this category represents the given text.
- "name": "A String", # The name of the category representing the document, from the [predefined
- # taxonomy](https://cloud.google.com/natural-language/docs/categories).
+ "sentences": [ # Sentences in the input document. Populated if the user enables
+ # AnnotateTextRequest.Features.extract_syntax.
+ { # Represents a sentence in the input document.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
+ # AnnotateTextRequest.Features.extract_document_sentiment is set to
+ # true, this field will contain the sentiment for the sentence.
+ # the text.
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
+ # the absolute magnitude of sentiment regardless of score (positive or
+ # negative).
+ },
+ "text": { # Represents an output piece of text. # The sentence text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ # document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
+ },
+ },
+ ],
+ "tokens": [ # Tokens, along with their syntactic information, in the input document.
+ # Populated if the user enables
+ # AnnotateTextRequest.Features.extract_syntax.
+ { # Represents the smallest syntactic building block of the text.
+ "text": { # Represents an output piece of text. # The token text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ # document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
+ },
+ "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
+ # information on dependency labels, see
+ # http://www.aclweb.org/anthology/P13-2017
+ "label": "A String", # The parse label for the token.
+ "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
+ # This is the index of the token which has an arc going to this token.
+ # The index is the position of the token in the array of tokens returned
+ # by the API method. If this token is a root token, then the
+ # `head_token_index` is its own index.
+ },
+ "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
+ "partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
+ # are as defined in
+ # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
+ "proper": "A String", # The grammatical properness.
+ "case": "A String", # The grammatical case.
+ "tense": "A String", # The grammatical tense.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "form": "A String", # The grammatical form.
+ "number": "A String", # The grammatical number.
+ "voice": "A String", # The grammatical voice.
+ "aspect": "A String", # The grammatical aspect.
+ "mood": "A String", # The grammatical mood.
+ "tag": "A String", # The part of speech tag.
+ "gender": "A String", # The grammatical gender.
+ "person": "A String", # The grammatical person.
+ },
},
],
}</pre>
@@ -676,14 +676,14 @@
The object takes the form of:
{ # The document classification request message.
- "document": { # ################################################################ # # Required. Input document.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
- "language": "A String", # The language of the document (if not specified, the language is
+ "gcsContentUri": "A 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.
+ "language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
# [Language
@@ -691,10 +691,10 @@
# 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.
- "gcsContentUri": "A 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": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
},
}
@@ -707,12 +707,12 @@
An object of the form:
{ # The document classification response message.
- "categories": [ # Categories representing the input document.
+ "categories": [ # Categories representing the input document.
{ # Represents a category returned from the text classifier.
- "confidence": 3.14, # The classifier's confidence of the category. Number represents how certain
- # the classifier is that this category represents the given text.
- "name": "A String", # The name of the category representing the document, from the [predefined
+ "name": "A String", # The name of the category representing the document, from the [predefined
# taxonomy](https://cloud.google.com/natural-language/docs/categories).
+ "confidence": 3.14, # The classifier's confidence of the category. Number represents how certain
+ # the classifier is that this category represents the given text.
},
],
}</pre>