docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/language_v1beta1.documents.html b/docs/dyn/language_v1beta1.documents.html
index baa6810..e908dc8 100644
--- a/docs/dyn/language_v1beta1.documents.html
+++ b/docs/dyn/language_v1beta1.documents.html
@@ -102,14 +102,6 @@
"document": { # ################################################################ # # Input document.
#
# Represents the input to API methods.
- "language": "A String", # The language of the document (if not specified, the language is
- # automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language
- # Support](https://cloud.google.com/natural-language/docs/languages) lists
- # currently supported languages for each API method. If the language (either
- # specified by the caller or automatically detected) is not supported by the
- # called API method, an `INVALID_ARGUMENT` error is returned.
"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.
@@ -118,6 +110,14 @@
# This URI must be of the form: gs://bucket_name/object_name. For more
# details, see https://cloud.google.com/storage/docs/reference-uris.
# NOTE: Cloud Storage object versioning is not supported.
+ "language": "A String", # The language of the document (if not specified, the language is
+ # automatically detected). Both ISO and BCP-47 language codes are
+ # accepted.<br>
+ # [Language
+ # Support](https://cloud.google.com/natural-language/docs/languages) lists
+ # currently supported languages for each API method. If the language (either
+ # specified by the caller or automatically detected) is not supported by the
+ # called API method, an `INVALID_ARGUMENT` error is returned.
},
}
@@ -137,6 +137,7 @@
{ # Represents a phrase in the text that is a known entity, such as
# a person, an organization, or location. The API associates information, such
# as salience and mentions, with entities.
+ "name": "A String", # The representative name for the entity.
"type": "A String", # The entity type.
"metadata": { # Metadata associated with the entity.
#
@@ -162,7 +163,6 @@
"type": "A String", # The type of the entity mention.
},
],
- "name": "A String", # The representative name for the entity.
},
],
}</pre>
@@ -182,14 +182,6 @@
"document": { # ################################################################ # # Input document.
#
# Represents the input to API methods.
- "language": "A String", # The language of the document (if not specified, the language is
- # automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language
- # Support](https://cloud.google.com/natural-language/docs/languages) lists
- # currently supported languages for each API method. If the language (either
- # specified by the caller or automatically detected) is not supported by the
- # called API method, an `INVALID_ARGUMENT` error is returned.
"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.
@@ -198,6 +190,14 @@
# This URI must be of the form: gs://bucket_name/object_name. For more
# details, see https://cloud.google.com/storage/docs/reference-uris.
# NOTE: Cloud Storage object versioning is not supported.
+ "language": "A String", # The language of the document (if not specified, the language is
+ # automatically detected). Both ISO and BCP-47 language codes are
+ # accepted.<br>
+ # [Language
+ # Support](https://cloud.google.com/natural-language/docs/languages) lists
+ # currently supported languages for each API method. If the language (either
+ # specified by the caller or automatically detected) is not supported by the
+ # called API method, an `INVALID_ARGUMENT` error is returned.
},
}
@@ -210,17 +210,6 @@
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.
- "polarity": 3.14, # DEPRECATED FIELD - This field is being deprecated in
- # favor of score. Please refer to our documentation at
- # https://cloud.google.com/natural-language/docs for more information.
- "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.
@@ -246,6 +235,17 @@
},
},
],
+ "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
+ # the text.
+ "polarity": 3.14, # DEPRECATED FIELD - This field is being deprecated in
+ # favor of score. Please refer to our documentation at
+ # https://cloud.google.com/natural-language/docs for more information.
+ "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>
@@ -264,14 +264,6 @@
"document": { # ################################################################ # # Input document.
#
# Represents the input to API methods.
- "language": "A String", # The language of the document (if not specified, the language is
- # automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language
- # Support](https://cloud.google.com/natural-language/docs/languages) lists
- # currently supported languages for each API method. If the language (either
- # specified by the caller or automatically detected) is not supported by the
- # called API method, an `INVALID_ARGUMENT` error is returned.
"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.
@@ -280,6 +272,14 @@
# This URI must be of the form: gs://bucket_name/object_name. For more
# details, see https://cloud.google.com/storage/docs/reference-uris.
# NOTE: Cloud Storage object versioning is not supported.
+ "language": "A String", # The language of the document (if not specified, the language is
+ # automatically detected). Both ISO and BCP-47 language codes are
+ # accepted.<br>
+ # [Language
+ # Support](https://cloud.google.com/natural-language/docs/languages) lists
+ # currently supported languages for each API method. If the language (either
+ # specified by the caller or automatically detected) is not supported by the
+ # called API method, an `INVALID_ARGUMENT` error is returned.
},
}
@@ -292,6 +292,38 @@
An object of the form:
{ # The syntax analysis response message.
+ "tokens": [ # Tokens, along with their syntactic information, in the input document.
+ { # Represents the smallest syntactic building block of the text.
+ "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
+ "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.
+ },
+ "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.
+ "label": "A String", # The parse label for the token.
+ "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
+ # This is the index of the token which has an arc going to this token.
+ # The index is the position of the token in the array of tokens returned
+ # by the API method. If this token is a root token, then the
+ # `head_token_index` is its own index.
+ },
+ "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
+ },
+ ],
"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.
@@ -317,38 +349,6 @@
},
},
],
- "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.
- "proper": "A String", # The grammatical properness.
- "case": "A String", # The grammatical case.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- "form": "A String", # The grammatical form.
- "number": "A String", # The grammatical number.
- "voice": "A String", # The grammatical voice.
- "aspect": "A String", # The grammatical aspect.
- "mood": "A String", # The grammatical mood.
- "tag": "A String", # The part of speech tag.
- "gender": "A String", # The grammatical gender.
- "person": "A String", # The grammatical person.
- },
- },
- ],
}</pre>
</div>
@@ -367,14 +367,6 @@
"document": { # ################################################################ # # Input document.
#
# Represents the input to API methods.
- "language": "A String", # The language of the document (if not specified, the language is
- # automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language
- # Support](https://cloud.google.com/natural-language/docs/languages) lists
- # currently supported languages for each API method. If the language (either
- # specified by the caller or automatically detected) is not supported by the
- # called API method, an `INVALID_ARGUMENT` error is returned.
"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.
@@ -383,12 +375,20 @@
# This URI must be of the form: gs://bucket_name/object_name. For more
# details, see https://cloud.google.com/storage/docs/reference-uris.
# NOTE: Cloud Storage object versioning is not supported.
+ "language": "A String", # The language of the document (if not specified, the language is
+ # automatically detected). Both ISO and BCP-47 language codes are
+ # accepted.<br>
+ # [Language
+ # Support](https://cloud.google.com/natural-language/docs/languages) lists
+ # currently supported languages for each API method. If the language (either
+ # specified by the caller or automatically detected) is not supported by the
+ # called API method, an `INVALID_ARGUMENT` error is returned.
},
"features": { # All available features for sentiment, syntax, and semantic analysis. # The enabled features.
# Setting each one to true will enable that specific analysis for the input.
- "extractEntities": True or False, # Extract entities.
"extractSyntax": True or False, # Extract syntax information.
"extractDocumentSentiment": True or False, # Extract document-level sentiment.
+ "extractEntities": True or False, # Extract entities.
},
}
@@ -401,6 +401,74 @@
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.
+ "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
+ "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.
+ },
+ "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.
+ "label": "A String", # The parse label for the token.
+ "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
+ # This is the index of the token which has an arc going to this token.
+ # The index is the position of the token in the array of tokens returned
+ # by the API method. If this token is a root token, then the
+ # `head_token_index` is its own index.
+ },
+ "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
+ },
+ ],
+ "entities": [ # Entities, along with their semantic information, in the input document.
+ # Populated if the user enables
+ # AnnotateTextRequest.Features.extract_entities.
+ { # Represents a phrase in the text that is a known entity, such as
+ # a person, an organization, or location. The API associates information, such
+ # as salience and mentions, with entities.
+ "name": "A String", # The representative name for the entity.
+ "type": "A String", # The entity type.
+ "metadata": { # Metadata associated with the entity.
+ #
+ # Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
+ # available. The associated keys are "wikipedia_url" and "mid", respectively.
+ "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.
+ "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.
+ },
+ ],
+ },
+ ],
"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.
@@ -439,74 +507,6 @@
},
},
],
- "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.
- "proper": "A String", # The grammatical properness.
- "case": "A String", # The grammatical case.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- "form": "A String", # The grammatical form.
- "number": "A String", # The grammatical number.
- "voice": "A String", # The grammatical voice.
- "aspect": "A String", # The grammatical aspect.
- "mood": "A String", # The grammatical mood.
- "tag": "A String", # The part of speech tag.
- "gender": "A String", # The grammatical gender.
- "person": "A String", # The grammatical person.
- },
- },
- ],
- "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.
- "type": "A String", # The entity type.
- "metadata": { # Metadata associated with the entity.
- #
- # Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
- # available. The associated keys are "wikipedia_url" and "mid", respectively.
- "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.
- "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.
- },
- ],
- "name": "A String", # The representative name for the entity.
- },
- ],
}</pre>
</div>