chore: regens API reference docs (#889)
diff --git a/docs/dyn/language_v1beta2.documents.html b/docs/dyn/language_v1beta2.documents.html
index 9beb69c..b5e734c 100644
--- a/docs/dyn/language_v1beta2.documents.html
+++ b/docs/dyn/language_v1beta2.documents.html
@@ -75,56 +75,61 @@
<h1><a href="language_v1beta2.html">Cloud Natural Language API</a> . <a href="language_v1beta2.documents.html">documents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#analyzeEntities">analyzeEntities(body, x__xgafv=None)</a></code></p>
+ <code><a href="#analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Finds named entities (currently proper names and common nouns) in the text</p>
<p class="toc_element">
- <code><a href="#analyzeEntitySentiment">analyzeEntitySentiment(body, x__xgafv=None)</a></code></p>
+ <code><a href="#analyzeEntitySentiment">analyzeEntitySentiment(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Finds entities, similar to AnalyzeEntities in the text and analyzes</p>
<p class="toc_element">
- <code><a href="#analyzeSentiment">analyzeSentiment(body, x__xgafv=None)</a></code></p>
+ <code><a href="#analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Analyzes the sentiment of the provided text.</p>
<p class="toc_element">
- <code><a href="#analyzeSyntax">analyzeSyntax(body, x__xgafv=None)</a></code></p>
+ <code><a href="#analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Analyzes the syntax of the text and provides sentence boundaries and</p>
<p class="toc_element">
- <code><a href="#annotateText">annotateText(body, x__xgafv=None)</a></code></p>
+ <code><a href="#annotateText">annotateText(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">A convenience method that provides all syntax, sentiment, entity, and</p>
<p class="toc_element">
- <code><a href="#classifyText">classifyText(body, x__xgafv=None)</a></code></p>
+ <code><a href="#classifyText">classifyText(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Classifies a document into categories.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="analyzeEntities">analyzeEntities(body, x__xgafv=None)</code>
+ <code class="details" id="analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</code>
<pre>Finds named entities (currently proper names and common nouns) in the text
along with entity types, salience, mentions for each entity, and
other properties.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The entity analysis request message.
- "document": { # ################################################################ # # Input document.
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
"language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language Support](/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.
+ # 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.
"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.
+ "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
@@ -200,35 +205,40 @@
</div>
<div class="method">
- <code class="details" id="analyzeEntitySentiment">analyzeEntitySentiment(body, x__xgafv=None)</code>
+ <code class="details" id="analyzeEntitySentiment">analyzeEntitySentiment(body=None, x__xgafv=None)</code>
<pre>Finds entities, similar to AnalyzeEntities in the text and analyzes
sentiment associated with each entity and its mentions.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
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": { # ################################################################ # # Input document.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
"language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language Support](/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.
+ # 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.
"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.
+ "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
},
}
@@ -305,35 +315,40 @@
</div>
<div class="method">
- <code class="details" id="analyzeSentiment">analyzeSentiment(body, x__xgafv=None)</code>
+ <code class="details" id="analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</code>
<pre>Analyzes the sentiment of the provided text.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
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": { # ################################################################ # # Input document.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
"language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language Support](/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.
+ # 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.
"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.
+ "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
},
}
@@ -382,36 +397,41 @@
</div>
<div class="method">
- <code class="details" id="analyzeSyntax">analyzeSyntax(body, x__xgafv=None)</code>
+ <code class="details" id="analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</code>
<pre>Analyzes the syntax of the text and provides sentence boundaries and
tokenization along with part of speech tags, dependency trees, and other
properties.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The syntax analysis request message.
"encodingType": "A String", # The encoding type used by the API to calculate offsets.
- "document": { # ################################################################ # # Input document.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
"language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language Support](/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.
+ # 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.
"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.
+ "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
},
}
@@ -426,7 +446,25 @@
{ # 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.
- "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
+ "text": { # Represents an output piece of text. # The token text.
+ "content": "A String", # The content of the output text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ # document according to the EncodingType specified in the API request.
+ },
+ "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
+ "case": "A String", # The grammatical case.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "mood": "A String", # The grammatical mood.
+ "form": "A String", # The grammatical form.
+ "gender": "A String", # The grammatical gender.
+ "number": "A String", # The grammatical number.
+ "person": "A String", # The grammatical person.
+ "tag": "A String", # The part of speech tag.
+ "tense": "A String", # The grammatical tense.
+ "aspect": "A String", # The grammatical aspect.
+ "proper": "A String", # The grammatical properness.
+ "voice": "A String", # The grammatical voice.
+ },
"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.
@@ -435,25 +473,7 @@
# `head_token_index` is its own index.
"label": "A String", # The parse label for the token.
},
- "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
- "case": "A String", # The grammatical case.
- "mood": "A String", # The grammatical mood.
- "form": "A String", # The grammatical form.
- "gender": "A String", # The grammatical gender.
- "aspect": "A String", # The grammatical aspect.
- "number": "A String", # The grammatical number.
- "person": "A String", # The grammatical person.
- "tag": "A String", # The part of speech tag.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- "proper": "A String", # The grammatical properness.
- "voice": "A String", # The grammatical voice.
- },
- "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.
},
],
"language": "A String", # The language of the text, which will be the same as the language specified
@@ -483,47 +503,53 @@
</div>
<div class="method">
- <code class="details" id="annotateText">annotateText(body, x__xgafv=None)</code>
+ <code class="details" id="annotateText">annotateText(body=None, x__xgafv=None)</code>
<pre>A convenience method that provides all syntax, sentiment, entity, and
classification features in one call.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # 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": { # ################################################################ # # Input document.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
"language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language Support](/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.
+ # 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.
"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.
+ "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
},
- "features": { # All available features for sentiment, syntax, and semantic analysis. # The enabled features.
+ "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
- "extractDocumentSentiment": True or False, # Extract document-level sentiment.
"extractEntitySentiment": True or False, # Extract entities and their associated sentiment.
"extractSyntax": True or False, # Extract syntax information.
"extractEntities": True or False, # Extract entities.
+ "extractDocumentSentiment": True or False, # Extract document-level sentiment.
"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](/natural-language/docs/categories).
+ # [predefined
+ # taxonomy](https://cloud.google.com/natural-language/docs/categories).
},
}
@@ -543,7 +569,25 @@
# Populated if the user enables
# AnnotateTextRequest.Features.extract_syntax.
{ # Represents the smallest syntactic building block of the text.
- "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
+ "text": { # Represents an output piece of text. # The token text.
+ "content": "A String", # The content of the output text.
+ "beginOffset": 42, # The API calculates the beginning offset of the content in the original
+ # document according to the EncodingType specified in the API request.
+ },
+ "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
+ "case": "A String", # The grammatical case.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "mood": "A String", # The grammatical mood.
+ "form": "A String", # The grammatical form.
+ "gender": "A String", # The grammatical gender.
+ "number": "A String", # The grammatical number.
+ "person": "A String", # The grammatical person.
+ "tag": "A String", # The part of speech tag.
+ "tense": "A String", # The grammatical tense.
+ "aspect": "A String", # The grammatical aspect.
+ "proper": "A String", # The grammatical properness.
+ "voice": "A String", # The grammatical voice.
+ },
"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.
@@ -552,25 +596,7 @@
# `head_token_index` is its own index.
"label": "A String", # The parse label for the token.
},
- "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
- "case": "A String", # The grammatical case.
- "mood": "A String", # The grammatical mood.
- "form": "A String", # The grammatical form.
- "gender": "A String", # The grammatical gender.
- "aspect": "A String", # The grammatical aspect.
- "number": "A String", # The grammatical number.
- "person": "A String", # The grammatical person.
- "tag": "A String", # The part of speech tag.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- "proper": "A String", # The grammatical properness.
- "voice": "A String", # The grammatical voice.
- },
- "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.
},
],
"entities": [ # Entities, along with their semantic information, in the input document.
@@ -668,40 +694,45 @@
"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](/natural-language/docs/categories).
+ # taxonomy](https://cloud.google.com/natural-language/docs/categories).
},
],
}</pre>
</div>
<div class="method">
- <code class="details" id="classifyText">classifyText(body, x__xgafv=None)</code>
+ <code class="details" id="classifyText">classifyText(body=None, x__xgafv=None)</code>
<pre>Classifies a document into categories.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The document classification request message.
- "document": { # ################################################################ # # Input document.
+ "document": { # ################################################################ # # Required. Input document.
#
# Represents the input to API methods.
- "content": "A String", # The content of the input in string format.
- # Cloud audit logging exempt since it is based on user data.
- "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
- # returns an `INVALID_ARGUMENT` error.
"language": "A String", # The language of the document (if not specified, the language is
# automatically detected). Both ISO and BCP-47 language codes are
- # accepted.<br>
- # [Language Support](/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.
+ # 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.
"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.
+ "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.
+ "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
+ # returns an `INVALID_ARGUMENT` error.
+ "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.
},
}
@@ -719,7 +750,7 @@
"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](/natural-language/docs/categories).
+ # taxonomy](https://cloud.google.com/natural-language/docs/categories).
},
],
}</pre>