Blame - docs/dyn/language_v1beta1.documents.html - platform/external/python/google-api-python-client

2016-08-16 12:44:29 -0700

[diff] [blame]

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

82

<p class="firstline">Analyzes the sentiment of the provided text.</p>

83

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

84

<code><a href="#analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<p class="firstline">Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.</p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#annotateText">annotateText(body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<p class="firstline">A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.</p>

89

90

<code><a href="#close">close()</a></code></p>

91

<p class="firstline">Close httplib2 connections.</p>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

92

<h3>Method Details</h3>

93

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

94

<code class="details" id="analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

95

<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.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

96

97

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

98

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

99

The object takes the form of:

100

101

{ # The entity analysis request message.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

102

"document": { # ################################################################ # Represents the input to API methods. # Input document.

103

"content": "A String", # The content of the input in string format. Cloud audit logging exempt since it is based on user data.

104

"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.

105

"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.

106

"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.

107

},

108

"encodingType": "A String", # The encoding type used by the API to calculate offsets.

109

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

110

111

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

118

119

{ # The entity analysis response message.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

120

"entities": [ # The recognized entities in the input document.

121

{ # 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.

122

"mentions": [ # The mentions of this entity in the input document. The API currently supports proper noun mentions.

123

{ # Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

124

"text": { # Represents an output piece of text. # The mention text.

125

"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.

126

"content": "A String", # The content of the output text.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

127

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

128

"type": "A String", # The type of the entity mention.

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

129

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

130

],

131

"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.

132

"a_key": "A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

133

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

134

"name": "A String", # The representative name for the entity.

135

"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.

136

"type": "A String", # The entity type.

137

},

138

],

139

"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.

140

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

144

<code class="details" id="analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

145

<pre>Analyzes the sentiment of the provided text.

146

147

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

148

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

149

The object takes the form of:

150

151

{ # The sentiment analysis request message.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

152

"document": { # ################################################################ # Represents the input to API methods. # Input document.

153

"content": "A String", # The content of the input in string format. Cloud audit logging exempt since it is based on user data.

154

"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.

155

"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.

156

"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.

157

},

158

"encodingType": "A String", # The encoding type used by the API to calculate sentence offsets for the sentence sentiment.

159

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

160

161

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

168

169

{ # The sentiment analysis response message.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

170

"documentSentiment": { # Represents the feeling associated with the entire text or entities in the text. # The overall sentiment of the input document.

171

"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).

172

"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.

173

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

174

},

175

"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.

176

"sentences": [ # The sentiment for all the sentences in the document.

177

{ # Represents a sentence in the input document.

178

"sentiment": { # Represents the feeling associated with the entire text or entities in the text. # For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence.

179

"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).

180

"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.

181

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

182

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

183

"text": { # Represents an output piece of text. # The sentence text.

184

"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.

185

"content": "A String", # The content of the output text.

186

},

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

187

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

188

],

189

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

193

<code class="details" id="analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

194

<pre>Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

195

196

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

197

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

198

The object takes the form of:

199

200

{ # The syntax analysis request message.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

201

"document": { # ################################################################ # Represents the input to API methods. # Input document.

202

"content": "A String", # The content of the input in string format. Cloud audit logging exempt since it is based on user data.

203

"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.

204

"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.

205

"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.

206

},

207

"encodingType": "A String", # The encoding type used by the API to calculate offsets.

208

}

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

209

210

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

217

218

{ # The syntax analysis response message.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

219

"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.

220

"sentences": [ # Sentences in the input document.

221

{ # Represents a sentence in the input document.

222

"sentiment": { # Represents the feeling associated with the entire text or entities in the text. # For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence.

223

"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).

224

"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.

225

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

226

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

227

"text": { # Represents an output piece of text. # The sentence text.

228

"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.

229

"content": "A String", # The content of the output text.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

230

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

231

},

232

],

233

"tokens": [ # Tokens, along with their syntactic information, in the input document.

234

{ # Represents the smallest syntactic building block of the text.

235

"dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.

236

"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.

237

"label": "A String", # The parse label for the token.

238

},

239

"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.

240

"partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.

241

"aspect": "A String", # The grammatical aspect.

242

"case": "A String", # The grammatical case.

243

"form": "A String", # The grammatical form.

244

"gender": "A String", # The grammatical gender.

245

"mood": "A String", # The grammatical mood.

246

"number": "A String", # The grammatical number.

247

"person": "A String", # The grammatical person.

248

"proper": "A String", # The grammatical properness.

249

"reciprocity": "A String", # The grammatical reciprocity.

250

"tag": "A String", # The part of speech tag.

251

"tense": "A String", # The grammatical tense.

252

"voice": "A String", # The grammatical voice.

253

},

254

"text": { # Represents an output piece of text. # The token text.

255

"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.

256

"content": "A String", # The content of the output text.

},

},

],

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

264

<code class="details" id="annotateText">annotateText(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

265

<pre>A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

266

267

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

268

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

269

The object takes the form of:

270

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

271

{ # The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

272

"document": { # ################################################################ # Represents the input to API methods. # Input document.

273

"content": "A String", # The content of the input in string format. Cloud audit logging exempt since it is based on user data.

274

"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.

275

"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.

276

"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.

277

},

278

"encodingType": "A String", # The encoding type used by the API to calculate offsets.

279

"features": { # All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. # The enabled features.

280

"extractDocumentSentiment": True or False, # Extract document-level sentiment.

281

"extractEntities": True or False, # Extract entities.

282

"extractSyntax": True or False, # Extract syntax information.

283

},

284

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

285

286

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

293

294

{ # The text annotations response message.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

295

"documentSentiment": { # Represents the feeling associated with the entire text or entities in the text. # The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

296

"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).

297

"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.

298

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

299

},

300

"entities": [ # Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities.

301

{ # 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.

302

"mentions": [ # The mentions of this entity in the input document. The API currently supports proper noun mentions.

303

{ # Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

304

"text": { # Represents an output piece of text. # The mention text.

305

"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.

306

"content": "A String", # The content of the output text.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

307

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

308

"type": "A String", # The type of the entity mention.

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

309

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

310

],

311

"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.

312

"a_key": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

313

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

314

"name": "A String", # The representative name for the entity.

315

"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.

316

"type": "A String", # The entity type.

317

},

318

],

319

"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.

320

"sentences": [ # Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

321

{ # Represents a sentence in the input document.

322

"sentiment": { # Represents the feeling associated with the entire text or entities in the text. # For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence.

323

"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).

324

"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.

325

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

326

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

327

"text": { # Represents an output piece of text. # The sentence text.

328

"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.

329

"content": "A String", # The content of the output text.

},

},

],

"tokens": [ # Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

334

{ # Represents the smallest syntactic building block of the text.

335

"dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.

336

"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.

337

"label": "A String", # The parse label for the token.

338

},

339

"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.

340

"partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.

341

"aspect": "A String", # The grammatical aspect.

342

"case": "A String", # The grammatical case.

343

"form": "A String", # The grammatical form.

344

"gender": "A String", # The grammatical gender.

345

"mood": "A String", # The grammatical mood.

346

"number": "A String", # The grammatical number.

347

"person": "A String", # The grammatical person.

348

"proper": "A String", # The grammatical properness.

349

"reciprocity": "A String", # The grammatical reciprocity.

350

"tag": "A String", # The part of speech tag.

351

"tense": "A String", # The grammatical tense.

352

"voice": "A String", # The grammatical voice.

353

},

354

"text": { # Represents an output piece of text. # The token text.

355

"beginOffset": 42, # The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.

356

"content": "A String", # The content of the output text.

},

},

],

}</pre>

Jon Wayne Parrott