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
|
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html">revisions()</a></code>
</p>
<p class="firstline">Returns the revisions 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, qaScorecardId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a QaScorecard.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a QaScorecard.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a QaScorecard.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, qaScorecardSources=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists QaScorecards.</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="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a QaScorecard.</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, qaScorecardId=None, x__xgafv=None)</code>
<pre>Create a QaScorecard.
Args:
parent: string, Required. The parent resource of the QaScorecard. (required)
body: object, The request body.
The object takes the form of:
{ # A QaScorecard represents a collection of questions to be scored during analysis.
"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.
}
qaScorecardId: string, Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard'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 QaScorecard represents a collection of questions to be scored during analysis.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
<pre>Deletes a QaScorecard.
Args:
name: string, Required. The name of the QaScorecard to delete. (required)
force: boolean, Optional. If set to true, all of this QaScorecard'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="get">get(name, x__xgafv=None)</code>
<pre>Gets a QaScorecard.
Args:
name: string, Required. The name of the QaScorecard 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 QaScorecard represents a collection of questions to be scored during analysis.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, qaScorecardSources=None, x__xgafv=None)</code>
<pre>Lists QaScorecards.
Args:
parent: string, Required. The parent resource of the scorecards. (required)
pageSize: integer, Optional. The maximum number of scorecards 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 `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` 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 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 ListQaScorecards 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.
"qaScorecards": [ # The QaScorecards under the parent.
{ # A QaScorecard represents a collection of questions to be scored during analysis.
"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.
},
],
}</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="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a QaScorecard.
Args:
name: string, Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} (required)
body: object, The request body.
The object takes the form of:
{ # A QaScorecard represents a collection of questions to be scored during analysis.
"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.
}
updateMask: string, Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `description` * `display_name`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A QaScorecard represents a collection of questions to be scored during analysis.
"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.
}</pre>
</div>
</body></html>
|
