1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="commentanalyzer_v1alpha1.html">Perspective Comment Analyzer API</a> . <a href="commentanalyzer_v1alpha1.comments.html">comments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#analyze">analyze(body, x__xgafv=None)</a></code></p>
<p class="firstline">Analyzes the provided text and returns scores for requested attributes.</p>
<p class="toc_element">
<code><a href="#suggestscore">suggestscore(body, x__xgafv=None)</a></code></p>
<p class="firstline">Suggest comment scores as training data.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="analyze">analyze(body, x__xgafv=None)</code>
<pre>Analyzes the provided text and returns scores for requested attributes.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # The comment analysis request message.
"comment": { # Represents a body of text. # The comment to analyze.
"text": "A String", # UTF-8 encoded text.
"type": "A String", # Type of the text field.
},
"doNotStore": True or False, # Do not store the comment or context sent in this request. By default, the
# service may store comments/context for debugging purposes.
"languages": [ # The language(s) of the comment and context (if none are specified, the
# language is automatically detected). If multiple languages are specified,
# the text is checked in all of them that are supported. Both ISO and BCP-47
# language codes are accepted.
# Current Language Restrictions:
# * Only English text ("en") is supported.
# If none of the languages specified by the caller are supported, an
# `UNIMPLEMENTED` error is returned.
"A String",
],
"sessionId": "A String", # Session ID. Used to join related RPCs into a single session. For example,
# an interactive tool that calls both the AnalyzeComment and
# SuggestCommentScore RPCs should set all invocations of both RPCs to the
# same Session ID, typically a random 64-bit integer.
"context": { # Context is typically something that a Comment is referencing or replying to # The context of the comment.
# (such as an article, or previous comment).
# Note: Populate only ONE OF the following fields. The oneof syntax cannot be
# used because that would require nesting entries inside another message and
# breaking backwards compatibility. The server will return an error if more
# than one of the following fields is present.
"articleAndParentComment": { # A type of context specific to a comment left on a single-threaded comment # Information about the source for which the original comment was made, and
# any parent comment info.
# message board, where comments are either a top level comment or the child of
# a top level comment.
"article": { # Represents a body of text. # The source content about which the comment was made (article text, article
# summary, video transcript, etc).
"text": "A String", # UTF-8 encoded text.
"type": "A String", # Type of the text field.
},
"parentComment": { # Represents a body of text. # Refers to text that is a direct parent of the source comment, such as in a
# one-deep threaded message board. This field will only be present for
# comments that are replies to other comments and will not be populated for
# direct comments on the article_text.
"text": "A String", # UTF-8 encoded text.
"type": "A String", # Type of the text field.
},
},
"entries": [ # A list of messages. For example, a linear comments section or forum thread.
{ # Represents a body of text.
"text": "A String", # UTF-8 encoded text.
"type": "A String", # Type of the text field.
},
],
},
"clientToken": "A String", # Opaque token that is echoed from the request to the response.
"requestedAttributes": { # Specification of requested attributes. The AttributeParameters serve as
# configuration for each associated attribute. The map keys are attribute
# names. The following attributes are available:
# "ATTACK_ON_AUTHOR" - Attack on author of original article or post.
# "ATTACK_ON_COMMENTER" - Attack on fellow commenter.
# "ATTACK_ON_PUBLISHER" - Attack on publisher of article/post.
# "INCOHERENT" - Difficult to understand, nonsensical.
# "INFLAMMATORY" - Intending to provoke or inflame.
# "OBSCENE" - Obscene, such as cursing.
# "OFF_TOPIC" - Not related to the original topic.
# "SPAM" - Commercial/advertising spam content.
# "UNSUBSTANTIAL" - Trivial.
"a_key": { # Configurable parameters for attribute scoring.
"scoreThreshold": 3.14, # Don't return scores for this attribute that are below this threshold. If
# unset, a default threshold will be applied. A FloatValue wrapper is used to
# distinguish between 0 vs. default/unset.
"scoreType": "A String", # What type of scores to return. If unset, defaults to probability scores.
},
},
"spanAnnotations": True or False, # An advisory parameter that will return span annotations if the model
# is capable of providing scores with sub-comment resolution. This will
# likely increase the size of the returned message.
"communityId": "A String", # Optional identifier associating this AnalyzeCommentRequest with a
# particular client's community. Different communities may have different
# norms and rules. Specifying this value enables us to explore building
# community-specific models for clients.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The comment analysis response message.
"languages": [ # The language(s) used by CommentAnalyzer service to choose which Model to
# use when analyzing the comment. Might better be called
# "effective_languages". The logic used to make the choice is as follows:
# if Request.languages.empty()
# effective_languages = detected_languages
# else
# effective_languages = Request.languages
"A String",
],
"detectedLanguages": [ # Contains the languages detected from the text content, sorted in order of
# likelihood.
"A String",
],
"attributeScores": { # Scores for the requested attributes. The map keys are attribute names (same
# as the requested_attribute field in AnalyzeCommentRequest, for example
# "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc).
"a_key": { # This holds score values for a single attribute. It contains both per-span
# scores as well as an overall summary score..
"summaryScore": { # Analysis scores are described by a value and a ScoreType. # Overall score for comment as a whole.
"type": "A String", # The type of the above value.
"value": 3.14, # Score value. Semantics described by type below.
},
"spanScores": [ # Per-span scores.
{ # This is a single score for a given span of text.
"begin": 42, # "begin" and "end" describe the span of the original text that the attribute
# score applies to. The values are the UTF-16 codepoint range. "end" is
# exclusive. For example, with the text "Hi there", the begin/end pair (0,2)
# describes the text "Hi".
#
# If "begin" and "end" are unset, the score applies to the full text.
"score": { # Analysis scores are described by a value and a ScoreType. # The score value.
"type": "A String", # The type of the above value.
"value": 3.14, # Score value. Semantics described by type below.
},
"end": 42,
},
],
},
},
"clientToken": "A String", # Same token from the original AnalyzeCommentRequest.
}</pre>
</div>
<div class="method">
<code class="details" id="suggestscore">suggestscore(body, x__xgafv=None)</code>
<pre>Suggest comment scores as training data.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # The comment score suggestion request message.
"comment": { # Represents a body of text. # The comment being scored.
"text": "A String", # UTF-8 encoded text.
"type": "A String", # Type of the text field.
},
"languages": [ # The language(s) of the comment and context (if none are specified, the
# language is automatically detected). If multiple languages are specified,
# the text is checked in all of them that are supported. Both ISO and BCP-47
# language codes are accepted.
# Current Language Restrictions:
# * Only English text ("en") is supported.
# If none of the languages specified by the caller are supported, an
# `UNIMPLEMENTED` error is returned.
"A String",
],
"sessionId": "A String", # Session ID. Used to join related RPCs into a single session. For example,
# an interactive tool that calls both the AnalyzeComment and
# SuggestCommentScore RPCs should set all invocations of both RPCs to the
# same Session ID, typically a random 64-bit integer.
"context": { # Context is typically something that a Comment is referencing or replying to # The context of the comment.
# (such as an article, or previous comment).
# Note: Populate only ONE OF the following fields. The oneof syntax cannot be
# used because that would require nesting entries inside another message and
# breaking backwards compatibility. The server will return an error if more
# than one of the following fields is present.
"articleAndParentComment": { # A type of context specific to a comment left on a single-threaded comment # Information about the source for which the original comment was made, and
# any parent comment info.
# message board, where comments are either a top level comment or the child of
# a top level comment.
"article": { # Represents a body of text. # The source content about which the comment was made (article text, article
# summary, video transcript, etc).
"text": "A String", # UTF-8 encoded text.
"type": "A String", # Type of the text field.
},
"parentComment": { # Represents a body of text. # Refers to text that is a direct parent of the source comment, such as in a
# one-deep threaded message board. This field will only be present for
# comments that are replies to other comments and will not be populated for
# direct comments on the article_text.
"text": "A String", # UTF-8 encoded text.
"type": "A String", # Type of the text field.
},
},
"entries": [ # A list of messages. For example, a linear comments section or forum thread.
{ # Represents a body of text.
"text": "A String", # UTF-8 encoded text.
"type": "A String", # Type of the text field.
},
],
},
"clientToken": "A String", # Opaque token that is echoed from the request to the response.
"communityId": "A String", # Optional identifier associating this comment score suggestion with a
# particular sub-community. Different communities may have different norms
# and rules. Specifying this value enables training community-specific
# models.
"attributeScores": { # Attribute scores for the comment. The map keys are attribute names, same as
# the requested_attribute field in AnalyzeCommentRequest (for example
# "ATTACK_ON_AUTHOR", "INFLAMMATORY", etc.). This field has the same type as
# the `attribute_scores` field in AnalyzeCommentResponse.
#
# To specify an overall attribute score for the entire comment as a whole,
# use the `summary_score` field of the mapped AttributeScores object. To
# specify scores on specific subparts of the comment, use the `span_scores`
# field. All SpanScore objects must have begin and end fields set.
#
# All Score objects must be explicitly set (for binary classification, use
# the score values 0 and 1). If Score objects don't include a ScoreType,
# `PROBABILITY` is assumed.
#
# `attribute_scores` must not be empty. The mapped AttributeScores objects
# also must not be empty. An `INVALID_ARGUMENT` error is returned for all
# malformed requests.
"a_key": { # This holds score values for a single attribute. It contains both per-span
# scores as well as an overall summary score..
"summaryScore": { # Analysis scores are described by a value and a ScoreType. # Overall score for comment as a whole.
"type": "A String", # The type of the above value.
"value": 3.14, # Score value. Semantics described by type below.
},
"spanScores": [ # Per-span scores.
{ # This is a single score for a given span of text.
"begin": 42, # "begin" and "end" describe the span of the original text that the attribute
# score applies to. The values are the UTF-16 codepoint range. "end" is
# exclusive. For example, with the text "Hi there", the begin/end pair (0,2)
# describes the text "Hi".
#
# If "begin" and "end" are unset, the score applies to the full text.
"score": { # Analysis scores are described by a value and a ScoreType. # The score value.
"type": "A String", # The type of the above value.
"value": 3.14, # Score value. Semantics described by type below.
},
"end": 42,
},
],
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The comment score suggestion response message.
"requestedLanguages": [ # The list of languages provided in the request.
"A String",
],
"detectedLanguages": [ # The list of languages detected from the comment text.
"A String",
],
"clientToken": "A String", # Same token from the original SuggestCommentScoreRequest.
}</pre>
</div>
</body></html>
|
