docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/language_v1beta2.documents.html b/docs/dyn/language_v1beta2.documents.html
index b7ce23f..cbe1506 100644
--- a/docs/dyn/language_v1beta2.documents.html
+++ b/docs/dyn/language_v1beta2.documents.html
@@ -105,15 +105,15 @@
The object takes the form of:
{ # The entity analysis request message.
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
"document": { # ################################################################ # Represents the input to API methods. # Required. Input document.
- "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.
+ "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.
"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. [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.
"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.
- "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.
"boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
+ "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.
},
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
}
x__xgafv: string, V1 error format.
@@ -125,13 +125,9 @@
An object of the form:
{ # The entity 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.
{ # 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 the text. Next ID: 6 # 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.
- "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).
- },
+ "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.
"sentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.
@@ -139,20 +135,24 @@
"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
},
"text": { # Represents an output piece of text. # The mention text.
- "content": "A String", # The content of the output text.
"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
},
"type": "A String", # The type of the entity mention.
},
],
+ "type": "A String", # The entity type.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # 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.
+ "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.
"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.
- "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.
},
],
+ "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>
@@ -166,12 +166,12 @@
{ # The entity-level sentiment analysis request message.
"document": { # ################################################################ # Represents the input to API methods. # Required. Input document.
- "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.
+ "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.
"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. [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.
"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.
- "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.
"boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
+ "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.
},
"encodingType": "A String", # The encoding type used by the API to calculate offsets.
}
@@ -185,13 +185,9 @@
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 the text. Next ID: 6 # 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.
- "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).
- },
+ "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.
"sentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.
@@ -199,20 +195,24 @@
"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
},
"text": { # Represents an output piece of text. # The mention text.
- "content": "A String", # The content of the output text.
"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
},
"type": "A String", # The type of the entity mention.
},
],
+ "type": "A String", # The entity type.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # 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.
+ "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.
"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.
- "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.
},
],
+ "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>
@@ -225,15 +225,15 @@
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": { # ################################################################ # Represents the input to API methods. # Required. Input document.
- "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.
+ "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.
"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. [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.
"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.
- "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.
"boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
+ "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.
},
- "encodingType": "A String", # The encoding type used by the API to calculate sentence offsets for the sentence sentiment.
}
x__xgafv: string, V1 error format.
@@ -245,6 +245,11 @@
An object of the form:
{ # The 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.
+ "documentSentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # The overall sentiment of the input document.
+ "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": [ # 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 the text. Next ID: 6 # For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence.
@@ -252,16 +257,11 @@
"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.
- "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.
},
},
],
- "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 text. Next ID: 6 # The overall sentiment of the input document.
- "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>
@@ -274,15 +274,15 @@
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": { # ################################################################ # Represents the input to API methods. # Required. Input document.
- "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.
+ "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.
"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. [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.
"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.
- "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.
"boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
+ "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.
},
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
}
x__xgafv: string, V1 error format.
@@ -294,31 +294,32 @@
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.
"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.
- "tense": "A String", # The grammatical tense.
- "case": "A String", # The grammatical case.
- "proper": "A String", # The grammatical properness.
- "aspect": "A String", # The grammatical aspect.
- "mood": "A String", # The grammatical mood.
- "voice": "A String", # The grammatical voice.
- "reciprocity": "A String", # The grammatical reciprocity.
- "person": "A String", # The grammatical person.
- "tag": "A String", # The part of speech tag.
- "number": "A String", # The grammatical number.
- "form": "A String", # The grammatical form.
- "gender": "A String", # The grammatical gender.
+ "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.
},
+ "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
+ "person": "A String", # The grammatical person.
+ "number": "A String", # The grammatical number.
+ "voice": "A String", # The grammatical voice.
+ "tense": "A String", # The grammatical tense.
+ "gender": "A String", # The grammatical gender.
+ "case": "A String", # The grammatical case.
+ "proper": "A String", # The grammatical properness.
+ "form": "A String", # The grammatical form.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "aspect": "A String", # The grammatical aspect.
+ "mood": "A String", # The grammatical mood.
+ "tag": "A String", # The part of speech tag.
+ },
},
],
"sentences": [ # Sentences in the input document.
@@ -328,12 +329,11 @@
"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.
- "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.
},
},
],
- "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>
@@ -346,21 +346,21 @@
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.
- "features": { # All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 10 # Required. The enabled features.
- "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. 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).
- "extractEntities": True or False, # Extract entities.
- "extractEntitySentiment": True or False, # Extract entities and their associated sentiment.
- },
"document": { # ################################################################ # Represents the input to API methods. # Required. Input document.
- "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.
+ "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.
"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. [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.
"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.
- "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.
"boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
+ "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.
+ },
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
+ "features": { # All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 10 # Required. The enabled features.
+ "extractEntities": True or False, # Extract entities.
+ "extractEntitySentiment": True or False, # Extract entities and their associated sentiment.
+ "extractDocumentSentiment": True or False, # Extract document-level sentiment.
+ "extractSyntax": True or False, # Extract syntax information.
+ "classifyText": True or False, # Classify the full document into categories. If this is true, the API will use the default model which classifies into a [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).
},
}
@@ -373,14 +373,31 @@
An object of the form:
{ # The text annotations response message.
- "documentSentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_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).
- },
- "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.
+ "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.
+ "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.
+ },
+ "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
+ "person": "A String", # The grammatical person.
+ "number": "A String", # The grammatical number.
+ "voice": "A String", # The grammatical voice.
+ "tense": "A String", # The grammatical tense.
+ "gender": "A String", # The grammatical gender.
+ "case": "A String", # The grammatical case.
+ "proper": "A String", # The grammatical properness.
+ "form": "A String", # The grammatical form.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "aspect": "A String", # The grammatical aspect.
+ "mood": "A String", # The grammatical mood.
+ "tag": "A String", # The part of speech tag.
+ },
},
],
"sentences": [ # Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.
@@ -390,17 +407,25 @@
"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.
- "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.
},
},
],
+ "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.
+ "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.
+ },
+ ],
+ "documentSentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_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).
+ },
"entities": [ # Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities.
{ # Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.
- "sentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # 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.
- "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).
- },
+ "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.
"sentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.
@@ -408,48 +433,23 @@
"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
},
"text": { # Represents an output piece of text. # The mention text.
- "content": "A String", # The content of the output text.
"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.
+ "content": "A String", # The content of the output text.
},
"type": "A String", # The type of the entity mention.
},
],
+ "type": "A String", # The entity type.
+ "sentiment": { # Represents the feeling associated with the entire text or entities in the text. Next ID: 6 # 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.
+ "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.
"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.
- "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.
},
],
- "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.
- "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.
- "tense": "A String", # The grammatical tense.
- "case": "A String", # The grammatical case.
- "proper": "A String", # The grammatical properness.
- "aspect": "A String", # The grammatical aspect.
- "mood": "A String", # The grammatical mood.
- "voice": "A String", # The grammatical voice.
- "reciprocity": "A String", # The grammatical reciprocity.
- "person": "A String", # The grammatical person.
- "tag": "A String", # The part of speech tag.
- "number": "A String", # The grammatical number.
- "form": "A String", # The grammatical form.
- "gender": "A String", # The grammatical gender.
- },
- "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.
- },
- },
- ],
- "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>
@@ -463,12 +463,12 @@
{ # The document classification request message.
"document": { # ################################################################ # Represents the input to API methods. # Required. Input document.
- "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.
+ "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.
"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. [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.
"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.
- "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.
"boilerplateHandling": "A String", # Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
+ "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.
},
}
@@ -483,8 +483,8 @@
{ # The document classification response message.
"categories": [ # Categories representing the input document.
{ # Represents a category returned from the text classifier.
- "confidence": 3.14, # The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text.
"name": "A String", # The name of the category representing the document, from the [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).
+ "confidence": 3.14, # The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text.
},
],
}</pre>