docs: update generated docs (#981)
diff --git a/docs/dyn/language_v1beta2.documents.html b/docs/dyn/language_v1beta2.documents.html
index 326d3d6..1e4b29a 100644
--- a/docs/dyn/language_v1beta2.documents.html
+++ b/docs/dyn/language_v1beta2.documents.html
@@ -104,21 +104,9 @@
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.
#
# Represents the input to API methods.
- "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.
- "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
- # declarations, banners) should be handled for this document. If not
- # specified, boilerplate will be treated the same as content.
- "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.
"referenceWebUri": "A String", # The web URI where the document comes from. This URI is not used for
# fetching the content, but as a hint for analyzing the document.
"language": "A String", # The language of the document (if not specified, the language is
@@ -129,7 +117,19 @@
# 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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
+ "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
+ # declarations, banners) should be handled for this document. If not
+ # specified, boilerplate will be treated the same as content.
},
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
}
x__xgafv: string, V1 error format.
@@ -148,7 +148,43 @@
{ # 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.
+ "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.
+ # Next ID: 6
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
"name": "A String", # The representative name for the entity.
+ "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.
+ "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.
+ # Next ID: 6
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
+ "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
+ # document according to the EncodingType specified in the API request.
+ },
+ },
+ ],
"type": "A String", # The entity type.
"metadata": { # Metadata associated with the entity.
#
@@ -163,42 +199,6 @@
# 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.
- # Next ID: 6
- "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).
- },
- "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.
- "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
- # 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.
- # Next ID: 6
- "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).
- },
- },
- ],
},
],
}</pre>
@@ -214,21 +214,9 @@
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.
#
# Represents the input to API methods.
- "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.
- "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
- # declarations, banners) should be handled for this document. If not
- # specified, boilerplate will be treated the same as content.
- "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.
"referenceWebUri": "A String", # The web URI where the document comes from. This URI is not used for
# fetching the content, but as a hint for analyzing the document.
"language": "A String", # The language of the document (if not specified, the language is
@@ -239,7 +227,19 @@
# 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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
+ "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
+ # declarations, banners) should be handled for this document. If not
+ # specified, boilerplate will be treated the same as content.
},
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
}
x__xgafv: string, V1 error format.
@@ -255,7 +255,43 @@
{ # 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.
+ "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.
+ # Next ID: 6
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
"name": "A String", # The representative name for the entity.
+ "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.
+ "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.
+ # Next ID: 6
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
+ "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
+ # document according to the EncodingType specified in the API request.
+ },
+ },
+ ],
"type": "A String", # The entity type.
"metadata": { # Metadata associated with the entity.
#
@@ -270,42 +306,6 @@
# 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.
- # Next ID: 6
- "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).
- },
- "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.
- "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
- # 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.
- # Next ID: 6
- "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
@@ -323,22 +323,9 @@
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 for the
- # sentence sentiment.
"document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "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.
- "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
- # declarations, banners) should be handled for this document. If not
- # specified, boilerplate will be treated the same as content.
- "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.
"referenceWebUri": "A String", # The web URI where the document comes from. This URI is not used for
# fetching the content, but as a hint for analyzing the document.
"language": "A String", # The language of the document (if not specified, the language is
@@ -349,7 +336,20 @@
# 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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
+ "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
+ # declarations, banners) should be handled for this document. If not
+ # specified, boilerplate will be treated the same as content.
},
+ "encodingType": "A String", # The encoding type used by the API to calculate sentence offsets for the
+ # sentence sentiment.
}
x__xgafv: string, V1 error format.
@@ -361,38 +361,38 @@
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.
- # the text.
- # Next ID: 6
- "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.
"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.
- "content": "A String", # The content of the output text.
},
"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.
# Next ID: 6
- "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
},
},
],
+ "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
+ # the text.
+ # Next ID: 6
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
}</pre>
</div>
@@ -411,17 +411,6 @@
"document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "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.
- "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
- # declarations, banners) should be handled for this document. If not
- # specified, boilerplate will be treated the same as content.
- "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.
"referenceWebUri": "A String", # The web URI where the document comes from. This URI is not used for
# fetching the content, but as a hint for analyzing the document.
"language": "A String", # The language of the document (if not specified, the language is
@@ -432,6 +421,17 @@
# 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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
+ "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
+ # declarations, banners) should be handled for this document. If not
+ # specified, boilerplate will be treated the same as content.
},
}
@@ -444,61 +444,61 @@
An object of the form:
{ # The syntax analysis 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.
"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.
- "content": "A String", # The content of the output text.
},
"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.
# Next ID: 6
- "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
},
},
],
"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
# document according to the EncodingType specified in the API request.
- "content": "A String", # The content of the output text.
+ },
+ "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 tag for this token.
+ "voice": "A String", # The grammatical voice.
+ "tag": "A String", # The part of speech tag.
+ "aspect": "A String", # The grammatical aspect.
+ "form": "A String", # The grammatical form.
+ "person": "A String", # The grammatical person.
+ "mood": "A String", # The grammatical mood.
+ "gender": "A String", # The grammatical gender.
+ "tense": "A String", # The grammatical tense.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "proper": "A String", # The grammatical properness.
+ "number": "A String", # The grammatical number.
+ "case": "A String", # The grammatical case.
},
"dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.
+ "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.
- "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
- "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.
- "proper": "A String", # The grammatical properness.
- "case": "A String", # The grammatical case.
},
},
],
+ "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>
@@ -513,33 +513,9 @@
{ # The request message for the text annotation API, which can perform multiple
# analysis types (sentiment, entities, and syntax) in one call.
- "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.
- # Next ID: 10
- "extractEntities": True or False, # Extract entities.
- "classifyText": True or False, # Classify the full document into categories. If this is true,
- # the API will use the default model which classifies into a
- # [predefined
- # taxonomy](https://cloud.google.com/natural-language/docs/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.
- },
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
"document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "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.
- "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
- # declarations, banners) should be handled for this document. If not
- # specified, boilerplate will be treated the same as content.
- "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.
"referenceWebUri": "A String", # The web URI where the document comes from. This URI is not used for
# fetching the content, but as a hint for analyzing the document.
"language": "A String", # The language of the document (if not specified, the language is
@@ -550,6 +526,30 @@
# 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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
+ "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
+ # declarations, banners) should be handled for this document. If not
+ # specified, boilerplate will be treated the same as content.
+ },
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
+ "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.
+ # Next ID: 10
+ "extractEntities": True or False, # Extract entities.
+ "extractDocumentSentiment": True or False, # Extract document-level sentiment.
+ "extractSyntax": True or False, # Extract syntax information.
+ "classifyText": True or False, # Classify the full document into categories. If this is true,
+ # the API will use the default model which classifies into a
+ # [predefined
+ # taxonomy](https://cloud.google.com/natural-language/docs/categories).
+ "extractEntitySentiment": True or False, # Extract entities and their associated sentiment.
},
}
@@ -562,68 +562,49 @@
An object of the form:
{ # The text annotations response message.
- "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. # Dependency tree parse for this 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.
- "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
- "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.
- "proper": "A String", # The grammatical properness.
- "case": "A String", # The grammatical case.
- },
- },
- ],
- "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).
- },
- ],
- "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.
- # Next ID: 6
- "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.
+ "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.
+ # Next ID: 6
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
"name": "A String", # The representative name for the entity.
+ "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.
+ "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.
+ # Next ID: 6
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
+ "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
+ # document according to the EncodingType specified in the API request.
+ },
+ },
+ ],
"type": "A String", # The entity type.
"metadata": { # Metadata associated with the entity.
#
@@ -638,65 +619,84 @@
# 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.
- # Next ID: 6
- "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).
- },
- "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.
- "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
- # 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.
- # Next ID: 6
- "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).
- },
- },
- ],
},
],
+ "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.
+ # Next ID: 6
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
"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.
- "content": "A String", # The content of the output text.
},
"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.
# Next ID: 6
- "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
},
},
],
+ "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.
+ },
+ "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 tag for this token.
+ "voice": "A String", # The grammatical voice.
+ "tag": "A String", # The part of speech tag.
+ "aspect": "A String", # The grammatical aspect.
+ "form": "A String", # The grammatical form.
+ "person": "A String", # The grammatical person.
+ "mood": "A String", # The grammatical mood.
+ "gender": "A String", # The grammatical gender.
+ "tense": "A String", # The grammatical tense.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "proper": "A String", # The grammatical properness.
+ "number": "A String", # The grammatical number.
+ "case": "A String", # The grammatical case.
+ },
+ "dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.
+ "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.
+ },
+ },
+ ],
+ "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.
+ },
+ ],
+ "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>
@@ -712,17 +712,6 @@
"document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "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.
- "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
- # declarations, banners) should be handled for this document. If not
- # specified, boilerplate will be treated the same as content.
- "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.
"referenceWebUri": "A String", # The web URI where the document comes from. This URI is not used for
# fetching the content, but as a hint for analyzing the document.
"language": "A String", # The language of the document (if not specified, the language is
@@ -733,6 +722,17 @@
# 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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
+ "content": "A String", # The content of the input in string format.
+ # Cloud audit logging exempt since it is based on user data.
+ "boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright
+ # declarations, banners) should be handled for this document. If not
+ # specified, boilerplate will be treated the same as content.
},
}
@@ -747,10 +747,10 @@
{ # The document classification response message.
"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
# 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>