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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
|
<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="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a> . <a href="contactcenterinsights_v1.projects.locations.qaScorecards.html">qaScorecards</a> . <a href="contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html">revisions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="contactcenterinsights_v1.projects.locations.qaScorecards.revisions.qaQuestions.html">qaQuestions()</a></code>
</p>
<p class="firstline">Returns the qaQuestions Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, qaScorecardRevisionId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a QaScorecardRevision.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a QaScorecardRevision.</p>
<p class="toc_element">
<code><a href="#deploy">deploy(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deploy a QaScorecardRevision.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a QaScorecardRevision.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, qaScorecardSources=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all revisions under the parent QaScorecard.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#tuneQaScorecardRevision">tuneQaScorecardRevision(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fine tune one or more QaModels.</p>
<p class="toc_element">
<code><a href="#undeploy">undeploy(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Undeploy a QaScorecardRevision.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, qaScorecardRevisionId=None, x__xgafv=None)</code>
<pre>Creates a QaScorecardRevision.
Args:
parent: string, Required. The parent resource of the QaScorecardRevision. (required)
body: object, The request body.
The object takes the form of:
{ # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
"alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
"A String",
],
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
"snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
"createTime": "A String", # Output only. The time at which this scorecard was created.
"description": "A String", # A text description explaining the intent of the scorecard.
"displayName": "A String", # The user-specified display name of the scorecard.
"isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
"name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
"source": "A String", # Output only. The source of the scorecard.
"updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
},
"state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
}
qaScorecardRevisionId: string, Optional. A unique ID for the new QaScorecardRevision. This ID will become the final component of the QaScorecardRevision's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
"alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
"A String",
],
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
"snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
"createTime": "A String", # Output only. The time at which this scorecard was created.
"description": "A String", # A text description explaining the intent of the scorecard.
"displayName": "A String", # The user-specified display name of the scorecard.
"isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
"name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
"source": "A String", # Output only. The source of the scorecard.
"updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
},
"state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
<pre>Deletes a QaScorecardRevision.
Args:
name: string, Required. The name of the QaScorecardRevision to delete. (required)
force: boolean, Optional. If set to true, all of this QaScorecardRevision's child resources will also be deleted. Otherwise, the request will only succeed if it has none.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="deploy">deploy(name, body=None, x__xgafv=None)</code>
<pre>Deploy a QaScorecardRevision.
Args:
name: string, Required. The name of the QaScorecardRevision to deploy. (required)
body: object, The request body.
The object takes the form of:
{ # The request to deploy a QaScorecardRevision
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
"alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
"A String",
],
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
"snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
"createTime": "A String", # Output only. The time at which this scorecard was created.
"description": "A String", # A text description explaining the intent of the scorecard.
"displayName": "A String", # The user-specified display name of the scorecard.
"isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
"name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
"source": "A String", # Output only. The source of the scorecard.
"updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
},
"state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a QaScorecardRevision.
Args:
name: string, Required. The name of the QaScorecardRevision to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
"alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
"A String",
],
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
"snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
"createTime": "A String", # Output only. The time at which this scorecard was created.
"description": "A String", # A text description explaining the intent of the scorecard.
"displayName": "A String", # The user-specified display name of the scorecard.
"isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
"name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
"source": "A String", # Output only. The source of the scorecard.
"updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
},
"state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, qaScorecardSources=None, x__xgafv=None)</code>
<pre>Lists all revisions under the parent QaScorecard.
Args:
parent: string, Required. The parent resource of the scorecard revisions. To list all revisions of all scorecards, substitute the QaScorecard ID with a '-' character. (required)
filter: string, Optional. A filter to reduce results to a specific subset. Useful for querying scorecard revisions with specific properties.
pageSize: integer, Optional. The maximum number of scorecard revisions to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
pageToken: string, Optional. The value returned by the last `ListQaScorecardRevisionsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecardRevisions` call and that the system should return the next page of data.
qaScorecardSources: string, Optional. The source of scorecards are based on how those Scorecards were created, e.g., a customer-defined scorecard, a predefined scorecard, etc. This field is used to retrieve Scorecards Revisions from Scorecards of one or more sources. (repeated)
Allowed values
QA_SCORECARD_SOURCE_UNSPECIFIED - The source of the scorecard is unspecified. Default to QA_SCORECARD_SOURCE_CUSTOMER_DEFINED.
QA_SCORECARD_SOURCE_CUSTOMER_DEFINED - The scorecard is a custom scorecard created by the user.
QA_SCORECARD_SOURCE_DISCOVERY_ENGINE - The scorecard is a scorecard created through discovery engine deployment.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response from a ListQaScorecardRevisions request.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"qaScorecardRevisions": [ # The QaScorecards under the parent.
{ # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
"alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
"A String",
],
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
"snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
"createTime": "A String", # Output only. The time at which this scorecard was created.
"description": "A String", # A text description explaining the intent of the scorecard.
"displayName": "A String", # The user-specified display name of the scorecard.
"isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
"name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
"source": "A String", # Output only. The source of the scorecard.
"updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
},
"state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="tuneQaScorecardRevision">tuneQaScorecardRevision(parent, body=None, x__xgafv=None)</code>
<pre>Fine tune one or more QaModels.
Args:
parent: string, Required. The parent resource for new fine tuning job instance. (required)
body: object, The request body.
The object takes the form of:
{ # Request for TuneQaScorecardRevision endpoint.
"filter": "A String", # Required. Filter for selecting the feedback labels that needs to be used for training. This filter can be used to limit the feedback labels used for tuning to a feedback labels created or updated for a specific time-window etc.
"validateOnly": True or False, # Optional. Run in validate only mode, no fine tuning will actually run. Data quality validations like training data distributions will run. Even when set to false, the data quality validations will still run but once the validations complete we will proceed with the fine tune, if applicable.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="undeploy">undeploy(name, body=None, x__xgafv=None)</code>
<pre>Undeploy a QaScorecardRevision.
Args:
name: string, Required. The name of the QaScorecardRevision to undeploy. (required)
body: object, The request body.
The object takes the form of:
{ # The request to undeploy a QaScorecardRevision
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A revision of a QaScorecard. Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.
"alternateIds": [ # Output only. Alternative IDs for this revision of the scorecard, e.g., `latest`.
"A String",
],
"createTime": "A String", # Output only. The timestamp that the revision was created.
"name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}
"snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation.
"createTime": "A String", # Output only. The time at which this scorecard was created.
"description": "A String", # A text description explaining the intent of the scorecard.
"displayName": "A String", # The user-specified display name of the scorecard.
"isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector.
"name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
"source": "A String", # Output only. The source of the scorecard.
"updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
},
"state": "A String", # Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.
}</pre>
</div>
</body></html>
|
