File: contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (320 lines) | stat: -rw-r--r-- 16,477 bytes parent folder | download | duplicates (3)
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
<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.authorizedViewSet.html">authorizedViewSet</a> . <a href="contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.html">authorizedViews</a> . <a href="contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.html">conversations</a> . <a href="contactcenterinsights_v1.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.html">feedbackLabels</a></h1>
<h2>Instance Methods</h2>
<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, feedbackLabelId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create feedback label.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete feedback label.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get feedback label.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List feedback labels.</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">Update feedback label.</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, feedbackLabelId=None, x__xgafv=None)</code>
  <pre>Create feedback label.

Args:
  parent: string, Required. The parent resource of the feedback label. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a conversation, resource, and label provided by the user.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the label.
  &quot;label&quot;: &quot;A String&quot;, # String label.
  &quot;labeledResource&quot;: &quot;A String&quot;, # Resource name of the resource to be labeled.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  &quot;qaAnswerLabel&quot;: { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    &quot;boolValue&quot;: True or False, # Boolean value.
    &quot;key&quot;: &quot;A String&quot;, # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    &quot;naValue&quot;: True or False, # A value of &quot;Not Applicable (N/A)&quot;.
    &quot;normalizedScore&quot;: 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
    &quot;numValue&quot;: 3.14, # Numerical value.
    &quot;potentialScore&quot;: 3.14, # Output only. The maximum potential score of the question.
    &quot;score&quot;: 3.14, # Output only. Numerical score of the answer.
    &quot;strValue&quot;: &quot;A String&quot;, # String value.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of the label.
}

  feedbackLabelId: string, Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a conversation, resource, and label provided by the user.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the label.
  &quot;label&quot;: &quot;A String&quot;, # String label.
  &quot;labeledResource&quot;: &quot;A String&quot;, # Resource name of the resource to be labeled.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  &quot;qaAnswerLabel&quot;: { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    &quot;boolValue&quot;: True or False, # Boolean value.
    &quot;key&quot;: &quot;A String&quot;, # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    &quot;naValue&quot;: True or False, # A value of &quot;Not Applicable (N/A)&quot;.
    &quot;normalizedScore&quot;: 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
    &quot;numValue&quot;: 3.14, # Numerical value.
    &quot;potentialScore&quot;: 3.14, # Output only. The maximum potential score of the question.
    &quot;score&quot;: 3.14, # Output only. Numerical score of the answer.
    &quot;strValue&quot;: &quot;A String&quot;, # String value.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of the label.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Delete feedback label.

Args:
  name: string, Required. The name of the feedback label to delete. (required)
  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>Get feedback label.

Args:
  name: string, Required. The name of the feedback label 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:

    { # Represents a conversation, resource, and label provided by the user.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the label.
  &quot;label&quot;: &quot;A String&quot;, # String label.
  &quot;labeledResource&quot;: &quot;A String&quot;, # Resource name of the resource to be labeled.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  &quot;qaAnswerLabel&quot;: { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    &quot;boolValue&quot;: True or False, # Boolean value.
    &quot;key&quot;: &quot;A String&quot;, # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    &quot;naValue&quot;: True or False, # A value of &quot;Not Applicable (N/A)&quot;.
    &quot;normalizedScore&quot;: 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
    &quot;numValue&quot;: 3.14, # Numerical value.
    &quot;potentialScore&quot;: 3.14, # Output only. The maximum potential score of the question.
    &quot;score&quot;: 3.14, # Output only. Numerical score of the answer.
    &quot;strValue&quot;: &quot;A String&quot;, # String value.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of the label.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List feedback labels.

Args:
  parent: string, Required. The parent resource of the feedback labels. (required)
  filter: string, Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
  pageSize: integer, Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
  pageToken: string, Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for listing feedback labels.
  &quot;feedbackLabels&quot;: [ # The feedback labels that match the request.
    { # Represents a conversation, resource, and label provided by the user.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the label.
      &quot;label&quot;: &quot;A String&quot;, # String label.
      &quot;labeledResource&quot;: &quot;A String&quot;, # Resource name of the resource to be labeled.
      &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
      &quot;qaAnswerLabel&quot;: { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
        &quot;boolValue&quot;: True or False, # Boolean value.
        &quot;key&quot;: &quot;A String&quot;, # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
        &quot;naValue&quot;: True or False, # A value of &quot;Not Applicable (N/A)&quot;.
        &quot;normalizedScore&quot;: 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
        &quot;numValue&quot;: 3.14, # Numerical value.
        &quot;potentialScore&quot;: 3.14, # Output only. The maximum potential score of the question.
        &quot;score&quot;: 3.14, # Output only. Numerical score of the answer.
        &quot;strValue&quot;: &quot;A String&quot;, # String value.
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of the label.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The next page token.
}</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 &#x27;execute()&#x27; 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>Update feedback label.

Args:
  name: string, Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a conversation, resource, and label provided by the user.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the label.
  &quot;label&quot;: &quot;A String&quot;, # String label.
  &quot;labeledResource&quot;: &quot;A String&quot;, # Resource name of the resource to be labeled.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  &quot;qaAnswerLabel&quot;: { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    &quot;boolValue&quot;: True or False, # Boolean value.
    &quot;key&quot;: &quot;A String&quot;, # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    &quot;naValue&quot;: True or False, # A value of &quot;Not Applicable (N/A)&quot;.
    &quot;normalizedScore&quot;: 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
    &quot;numValue&quot;: 3.14, # Numerical value.
    &quot;potentialScore&quot;: 3.14, # Output only. The maximum potential score of the question.
    &quot;score&quot;: 3.14, # Output only. Numerical score of the answer.
    &quot;strValue&quot;: &quot;A String&quot;, # String value.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of the label.
}

  updateMask: string, Required. The list of fields to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a conversation, resource, and label provided by the user.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the label.
  &quot;label&quot;: &quot;A String&quot;, # String label.
  &quot;labeledResource&quot;: &quot;A String&quot;, # Resource name of the resource to be labeled.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  &quot;qaAnswerLabel&quot;: { # Message for holding the value of the answer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    &quot;boolValue&quot;: True or False, # Boolean value.
    &quot;key&quot;: &quot;A String&quot;, # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    &quot;naValue&quot;: True or False, # A value of &quot;Not Applicable (N/A)&quot;.
    &quot;normalizedScore&quot;: 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score iff potential_score != 0 else 0
    &quot;numValue&quot;: 3.14, # Numerical value.
    &quot;potentialScore&quot;: 3.14, # Output only. The maximum potential score of the question.
    &quot;score&quot;: 3.14, # Output only. Numerical score of the answer.
    &quot;strValue&quot;: &quot;A String&quot;, # String value.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of the label.
}</pre>
</div>

</body></html>