docs: update generated docs (#981)
diff --git a/docs/dyn/language_v1.documents.html b/docs/dyn/language_v1.documents.html
index 05d96ec..9192397 100644
--- a/docs/dyn/language_v1.documents.html
+++ b/docs/dyn/language_v1.documents.html
@@ -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.
- "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
},
}
@@ -143,6 +143,32 @@
{ # 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.
+ "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.
+ "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.
+ "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",
+ },
+ "type": "A String", # The entity type.
"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
@@ -158,40 +184,14 @@
# 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
- # (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).
},
},
],
- "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",
- },
- "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).
- },
},
],
}</pre>
@@ -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.
- "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
},
}
@@ -239,10 +239,39 @@
An object of the form:
{ # The entity-level sentiment 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.
"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.
+ "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.
+ "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.
+ "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.
+ "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",
+ },
+ "type": "A String", # The entity type.
"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
@@ -258,45 +287,16 @@
# 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
- # (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).
},
},
],
- "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",
- },
- "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>
@@ -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.
- "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
},
}
@@ -343,34 +343,34 @@
{ # The sentiment analysis response message.
"sentences": [ # The sentiment for all the sentences in the 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.
+ "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 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.
},
- "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).
- },
},
],
- "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
- # (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.
+ "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
+ # the text.
+ "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>
@@ -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.
- "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
},
}
@@ -417,30 +417,24 @@
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.
- "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.
- "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).
- },
- },
- ],
"tokens": [ # Tokens, along with their syntactic information, in the input document.
{ # Represents the smallest syntactic building block of the 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
+ "tag": "A String", # The part of speech tag.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "voice": "A String", # The grammatical voice.
+ "person": "A String", # The grammatical person.
+ "tense": "A String", # The grammatical tense.
+ "proper": "A String", # The grammatical properness.
+ "gender": "A String", # The grammatical gender.
+ "form": "A String", # The grammatical form.
+ "aspect": "A String", # The grammatical aspect.
+ "case": "A String", # The grammatical case.
+ "mood": "A String", # The grammatical mood.
+ "number": "A String", # The grammatical number.
+ },
"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.
@@ -457,24 +451,30 @@
"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 # Parts of speech tag for this token.
- # are as defined in
- # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
- "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.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
+ },
+ ],
+ "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.
+ "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 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.
},
},
],
+ "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>
@@ -489,7 +489,6 @@
{ # 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.
#
# Represents the input to API methods.
@@ -505,18 +504,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.
"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.
},
+ "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.
- "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.
+ "extractSyntax": True or False, # Extract syntax information.
+ "extractDocumentSentiment": True or False, # Extract document-level sentiment.
+ "classifyText": True or False, # Classify the full document into categories.
},
}
@@ -529,30 +529,34 @@
An object of the form:
{ # The text annotations response message.
- "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.
- "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.
- "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).
- },
+ "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).
},
],
"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.
+ "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
+ "tag": "A String", # The part of speech tag.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "voice": "A String", # The grammatical voice.
+ "person": "A String", # The grammatical person.
+ "tense": "A String", # The grammatical tense.
+ "proper": "A String", # The grammatical properness.
+ "gender": "A String", # The grammatical gender.
+ "form": "A String", # The grammatical form.
+ "aspect": "A String", # The grammatical aspect.
+ "case": "A String", # The grammatical case.
+ "mood": "A String", # The grammatical mood.
+ "number": "A String", # The grammatical number.
+ },
"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.
@@ -569,41 +573,8 @@
"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 # Parts of speech tag for this token.
- # are as defined in
- # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
- "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.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- },
},
],
- "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.
- "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.
@@ -613,6 +584,32 @@
{ # 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.
+ "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.
+ "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.
+ "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",
+ },
+ "type": "A String", # The entity type.
"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
@@ -628,39 +625,42 @@
# 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
- # (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).
},
},
],
- "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",
- },
- "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.
+ },
+ ],
+ "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.
+ "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.
+ "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).
+ "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
+ # (positive sentiment).
+ },
+ "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.
},
},
],
@@ -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.
- "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
},
}