docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/language_v1beta2.documents.html b/docs/dyn/language_v1beta2.documents.html
index 2e55c66..326d3d6 100644
--- a/docs/dyn/language_v1beta2.documents.html
+++ b/docs/dyn/language_v1beta2.documents.html
@@ -119,6 +119,8 @@
# 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
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
@@ -127,8 +129,6 @@
# 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.
- "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.
},
}
@@ -180,9 +180,9 @@
{ # 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
# 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
@@ -229,6 +229,8 @@
# 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
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
@@ -237,8 +239,6 @@
# 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.
- "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.
},
}
@@ -287,9 +287,9 @@
{ # 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
# 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
@@ -339,6 +339,8 @@
# 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
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
@@ -347,8 +349,6 @@
# 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.
- "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.
},
}
@@ -361,15 +361,24 @@
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
@@ -384,15 +393,6 @@
},
},
],
- "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).
- },
}</pre>
</div>
@@ -422,6 +422,8 @@
# 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
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
@@ -430,8 +432,6 @@
# 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.
- "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.
},
}
@@ -450,9 +450,9 @@
"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
@@ -469,6 +469,20 @@
],
"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. # 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.
@@ -483,20 +497,6 @@
"proper": "A String", # The grammatical properness.
"case": "A String", # The grammatical case.
},
- "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.
- },
- "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.
},
],
}</pre>
@@ -513,6 +513,18 @@
{ # 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.
#
@@ -528,6 +540,8 @@
# 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
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
@@ -536,20 +550,6 @@
# 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.
- "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.
- },
- "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.
},
}
@@ -562,31 +562,24 @@
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.
- "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.
- # 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).
- },
- },
- ],
"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.
@@ -601,28 +594,14 @@
"proper": "A String", # The grammatical properness.
"case": "A String", # The grammatical case.
},
- "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.
- },
- "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.
},
],
"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.
+ "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
@@ -676,9 +655,9 @@
{ # 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
# 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
@@ -697,6 +676,27 @@
],
},
],
+ "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.
+ # 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>
</div>
@@ -723,6 +723,8 @@
# 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
# automatically detected). Both ISO and BCP-47 language codes are
# accepted.<br>
@@ -731,8 +733,6 @@
# 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.
- "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.
},
}
@@ -747,10 +747,10 @@
{ # The document classification response message.
"categories": [ # Categories representing 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.
+ "name": "A String", # The name of the category representing the document, from the [predefined
+ # taxonomy](https://cloud.google.com/natural-language/docs/categories).
},
],
}</pre>