Debian Codegraph @

docs/dyn/dialogflow_v2.projects.suggestions.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.suggestions.html">suggestions</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#generateStatelessSummary">generateStatelessSummary(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline"></p>
83 <p class="toc_element">
84 <code><a href="#searchKnowledge">searchKnowledge(parent, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline"></p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="generateStatelessSummary">generateStatelessSummary(parent, body=None, x__xgafv=None)</code>
94 <pre>
95
96 Args:
97 parent: string, A parameter (required)
98 body: object, The request body.
99 The object takes the form of:
100
101 {
102 &quot;conversationProfile&quot;: {
103 &quot;automatedAgentConfig&quot;: {
104 &quot;agent&quot;: &quot;A String&quot;,
105 &quot;sessionTtl&quot;: &quot;A String&quot;,
106 },
107 &quot;createTime&quot;: &quot;A String&quot;,
108 &quot;displayName&quot;: &quot;A String&quot;,
109 &quot;humanAgentAssistantConfig&quot;: {
110 &quot;endUserSuggestionConfig&quot;: {
111 &quot;disableHighLatencyFeaturesSyncDelivery&quot;: True or False,
112 &quot;enableAsyncToolCall&quot;: True or False,
113 &quot;featureConfigs&quot;: [
114 {
115 &quot;conversationModelConfig&quot;: {
116 &quot;baselineModelVersion&quot;: &quot;A String&quot;,
117 &quot;model&quot;: &quot;A String&quot;,
118 },
119 &quot;conversationProcessConfig&quot;: {
120 &quot;recentSentencesCount&quot;: 42,
121 },
122 &quot;disableAgentQueryLogging&quot;: True or False,
123 &quot;disableQuerySearchContext&quot;: True or False,
124 &quot;enableConversationAugmentedQuery&quot;: True or False,
125 &quot;enableEventBasedSuggestion&quot;: True or False,
126 &quot;enableQuerySuggestionOnly&quot;: True or False,
127 &quot;enableQuerySuggestionWhenNoAnswer&quot;: True or False,
128 &quot;enableResponseDebugInfo&quot;: True or False,
129 &quot;queryConfig&quot;: {
130 &quot;confidenceThreshold&quot;: 3.14,
131 &quot;contextFilterSettings&quot;: {
132 &quot;dropHandoffMessages&quot;: True or False,
133 &quot;dropIvrMessages&quot;: True or False,
134 &quot;dropVirtualAgentMessages&quot;: True or False,
135 },
136 &quot;contextSize&quot;: 42,
137 &quot;dialogflowQuerySource&quot;: {
138 &quot;agent&quot;: &quot;A String&quot;,
139 &quot;humanAgentSideConfig&quot;: {
140 &quot;agent&quot;: &quot;A String&quot;,
141 },
142 },
143 &quot;documentQuerySource&quot;: {
144 &quot;documents&quot;: [
145 &quot;A String&quot;,
146 ],
147 },
148 &quot;knowledgeBaseQuerySource&quot;: {
149 &quot;knowledgeBases&quot;: [
150 &quot;A String&quot;,
151 ],
152 },
153 &quot;maxResults&quot;: 42,
154 &quot;sections&quot;: {
155 &quot;sectionTypes&quot;: [
156 &quot;A String&quot;,
157 ],
158 },
159 },
160 &quot;raiSettings&quot;: {
161 &quot;raiCategoryConfigs&quot;: [
162 {
163 &quot;category&quot;: &quot;A String&quot;,
164 &quot;sensitivityLevel&quot;: &quot;A String&quot;,
165 },
166 ],
167 },
168 &quot;suggestionFeature&quot;: {
169 &quot;type&quot;: &quot;A String&quot;,
170 },
171 &quot;suggestionTriggerEvent&quot;: &quot;A String&quot;,
172 &quot;suggestionTriggerSettings&quot;: {
173 &quot;noSmalltalk&quot;: True or False,
174 &quot;onlyEndUser&quot;: True or False,
175 },
176 },
177 ],
178 &quot;generators&quot;: [
179 &quot;A String&quot;,
180 ],
181 &quot;groupSuggestionResponses&quot;: True or False,
182 &quot;skipEmptyEventBasedSuggestion&quot;: True or False,
183 &quot;useUnredactedConversationData&quot;: True or False,
184 },
185 &quot;humanAgentSuggestionConfig&quot;: {
186 &quot;disableHighLatencyFeaturesSyncDelivery&quot;: True or False,
187 &quot;enableAsyncToolCall&quot;: True or False,
188 &quot;featureConfigs&quot;: [
189 {
190 &quot;conversationModelConfig&quot;: {
191 &quot;baselineModelVersion&quot;: &quot;A String&quot;,
192 &quot;model&quot;: &quot;A String&quot;,
193 },
194 &quot;conversationProcessConfig&quot;: {
195 &quot;recentSentencesCount&quot;: 42,
196 },
197 &quot;disableAgentQueryLogging&quot;: True or False,
198 &quot;disableQuerySearchContext&quot;: True or False,
199 &quot;enableConversationAugmentedQuery&quot;: True or False,
200 &quot;enableEventBasedSuggestion&quot;: True or False,
201 &quot;enableQuerySuggestionOnly&quot;: True or False,
202 &quot;enableQuerySuggestionWhenNoAnswer&quot;: True or False,
203 &quot;enableResponseDebugInfo&quot;: True or False,
204 &quot;queryConfig&quot;: {
205 &quot;confidenceThreshold&quot;: 3.14,
206 &quot;contextFilterSettings&quot;: {
207 &quot;dropHandoffMessages&quot;: True or False,
208 &quot;dropIvrMessages&quot;: True or False,
209 &quot;dropVirtualAgentMessages&quot;: True or False,
210 },
211 &quot;contextSize&quot;: 42,
212 &quot;dialogflowQuerySource&quot;: {
213 &quot;agent&quot;: &quot;A String&quot;,
214 &quot;humanAgentSideConfig&quot;: {
215 &quot;agent&quot;: &quot;A String&quot;,
216 },
217 },
218 &quot;documentQuerySource&quot;: {
219 &quot;documents&quot;: [
220 &quot;A String&quot;,
221 ],
222 },
223 &quot;knowledgeBaseQuerySource&quot;: {
224 &quot;knowledgeBases&quot;: [
225 &quot;A String&quot;,
226 ],
227 },
228 &quot;maxResults&quot;: 42,
229 &quot;sections&quot;: {
230 &quot;sectionTypes&quot;: [
231 &quot;A String&quot;,
232 ],
233 },
234 },
235 &quot;raiSettings&quot;: {
236 &quot;raiCategoryConfigs&quot;: [
237 {
238 &quot;category&quot;: &quot;A String&quot;,
239 &quot;sensitivityLevel&quot;: &quot;A String&quot;,
240 },
241 ],
242 },
243 &quot;suggestionFeature&quot;: {
244 &quot;type&quot;: &quot;A String&quot;,
245 },
246 &quot;suggestionTriggerEvent&quot;: &quot;A String&quot;,
247 &quot;suggestionTriggerSettings&quot;: {
248 &quot;noSmalltalk&quot;: True or False,
249 &quot;onlyEndUser&quot;: True or False,
250 },
251 },
252 ],
253 &quot;generators&quot;: [
254 &quot;A String&quot;,
255 ],
256 &quot;groupSuggestionResponses&quot;: True or False,
257 &quot;skipEmptyEventBasedSuggestion&quot;: True or False,
258 &quot;useUnredactedConversationData&quot;: True or False,
259 },
260 &quot;messageAnalysisConfig&quot;: {
261 &quot;enableEntityExtraction&quot;: True or False,
262 &quot;enableSentimentAnalysis&quot;: True or False,
263 &quot;enableSentimentAnalysisV3&quot;: True or False,
264 },
265 &quot;notificationConfig&quot;: {
266 &quot;messageFormat&quot;: &quot;A String&quot;,
267 &quot;topic&quot;: &quot;A String&quot;,
268 },
269 },
270 &quot;humanAgentHandoffConfig&quot;: {
271 &quot;livePersonConfig&quot;: {
272 &quot;accountNumber&quot;: &quot;A String&quot;,
273 },
274 &quot;salesforceLiveAgentConfig&quot;: {
275 &quot;buttonId&quot;: &quot;A String&quot;,
276 &quot;deploymentId&quot;: &quot;A String&quot;,
277 &quot;endpointDomain&quot;: &quot;A String&quot;,
278 &quot;organizationId&quot;: &quot;A String&quot;,
279 },
280 },
281 &quot;languageCode&quot;: &quot;A String&quot;,
282 &quot;loggingConfig&quot;: {
283 &quot;enableStackdriverLogging&quot;: True or False,
284 },
285 &quot;name&quot;: &quot;A String&quot;,
286 &quot;newMessageEventNotificationConfig&quot;: {
287 &quot;messageFormat&quot;: &quot;A String&quot;,
288 &quot;topic&quot;: &quot;A String&quot;,
289 },
290 &quot;newRecognitionResultNotificationConfig&quot;: {
291 &quot;messageFormat&quot;: &quot;A String&quot;,
292 &quot;topic&quot;: &quot;A String&quot;,
293 },
294 &quot;notificationConfig&quot;: {
295 &quot;messageFormat&quot;: &quot;A String&quot;,
296 &quot;topic&quot;: &quot;A String&quot;,
297 },
298 &quot;securitySettings&quot;: &quot;A String&quot;,
299 &quot;sipConfig&quot;: {
300 &quot;allowVirtualAgentInteraction&quot;: True or False,
301 &quot;copyInboundCallLegHeaders&quot;: [
302 &quot;A String&quot;,
303 ],
304 &quot;createConversationOnTheFly&quot;: True or False,
305 &quot;ignoreReinviteMediaDirection&quot;: True or False,
306 &quot;inactiveStart&quot;: True or False,
307 &quot;keepConversationRunning&quot;: True or False,
308 &quot;maxAudioRecordingDuration&quot;: &quot;A String&quot;,
309 },
310 &quot;sttConfig&quot;: {
311 &quot;audioEncoding&quot;: &quot;A String&quot;,
312 &quot;enableWordInfo&quot;: True or False,
313 &quot;languageCode&quot;: &quot;A String&quot;,
314 &quot;model&quot;: &quot;A String&quot;,
315 &quot;phraseSets&quot;: [
316 &quot;A String&quot;,
317 ],
318 &quot;sampleRateHertz&quot;: 42,
319 &quot;speechModelVariant&quot;: &quot;A String&quot;,
320 &quot;useTimeoutBasedEndpointing&quot;: True or False,
321 },
322 &quot;timeZone&quot;: &quot;A String&quot;,
323 &quot;ttsConfig&quot;: {
324 &quot;effectsProfileId&quot;: [
325 &quot;A String&quot;,
326 ],
327 &quot;pitch&quot;: 3.14,
328 &quot;pronunciations&quot;: [
329 {
330 &quot;phoneticEncoding&quot;: &quot;A String&quot;,
331 &quot;phrase&quot;: &quot;A String&quot;,
332 &quot;pronunciation&quot;: &quot;A String&quot;,
333 },
334 ],
335 &quot;speakingRate&quot;: 3.14,
336 &quot;voice&quot;: {
337 &quot;name&quot;: &quot;A String&quot;,
338 &quot;ssmlGender&quot;: &quot;A String&quot;,
339 },
340 &quot;volumeGainDb&quot;: 3.14,
341 },
342 &quot;updateTime&quot;: &quot;A String&quot;,
343 },
344 &quot;latestMessage&quot;: &quot;A String&quot;,
345 &quot;maxContextSize&quot;: 42,
346 &quot;statelessConversation&quot;: {
347 &quot;messages&quot;: [
348 {
349 &quot;content&quot;: &quot;A String&quot;,
350 &quot;createTime&quot;: &quot;A String&quot;,
351 &quot;languageCode&quot;: &quot;A String&quot;,
352 &quot;messageAnnotation&quot;: {
353 &quot;containEntities&quot;: True or False,
354 &quot;parts&quot;: [
355 {
356 &quot;entityType&quot;: &quot;A String&quot;,
357 &quot;formattedValue&quot;: &quot;&quot;,
358 &quot;text&quot;: &quot;A String&quot;,
359 },
360 ],
361 },
362 &quot;name&quot;: &quot;A String&quot;,
363 &quot;participant&quot;: &quot;A String&quot;,
364 &quot;participantRole&quot;: &quot;A String&quot;,
365 &quot;sendTime&quot;: &quot;A String&quot;,
366 &quot;sentimentAnalysis&quot;: {
367 &quot;queryTextSentiment&quot;: {
368 &quot;magnitude&quot;: 3.14,
369 &quot;score&quot;: 3.14,
370 },
371 },
372 },
373 ],
374 },
375 }
376
377 x__xgafv: string, V1 error format.
378 Allowed values
379 1 - v1 error format
380 2 - v2 error format
381
382 Returns:
383 An object of the form:
384
385 {
386 &quot;contextSize&quot;: 42,
387 &quot;latestMessage&quot;: &quot;A String&quot;,
388 &quot;summary&quot;: {
389 &quot;baselineModelVersion&quot;: &quot;A String&quot;,
390 &quot;text&quot;: &quot;A String&quot;,
391 &quot;textSections&quot;: {
392 &quot;a_key&quot;: &quot;A String&quot;,
393 },
394 },
395 }</pre>
396 </div>
397
398 <div class="method">
399 <code class="details" id="searchKnowledge">searchKnowledge(parent, body=None, x__xgafv=None)</code>
400 <pre>
401
402 Args:
403 parent: string, A parameter (required)
404 body: object, The request body.
405 The object takes the form of:
406
407 {
408 &quot;conversation&quot;: &quot;A String&quot;,
409 &quot;conversationProfile&quot;: &quot;A String&quot;,
410 &quot;endUserMetadata&quot;: {
411 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
412 },
413 &quot;exactSearch&quot;: True or False,
414 &quot;latestMessage&quot;: &quot;A String&quot;,
415 &quot;parent&quot;: &quot;A String&quot;,
416 &quot;query&quot;: {
417 &quot;languageCode&quot;: &quot;A String&quot;,
418 &quot;text&quot;: &quot;A String&quot;,
419 },
420 &quot;querySource&quot;: &quot;A String&quot;,
421 &quot;searchConfig&quot;: {
422 &quot;boostSpecs&quot;: [
423 {
424 &quot;dataStores&quot;: [
425 &quot;A String&quot;,
426 ],
427 &quot;spec&quot;: [
428 {
429 &quot;conditionBoostSpecs&quot;: [
430 {
431 &quot;boost&quot;: 3.14,
432 &quot;boostControlSpec&quot;: {
433 &quot;attributeType&quot;: &quot;A String&quot;,
434 &quot;controlPoints&quot;: [
435 {
436 &quot;attributeValue&quot;: &quot;A String&quot;,
437 &quot;boostAmount&quot;: 3.14,
438 },
439 ],
440 &quot;fieldName&quot;: &quot;A String&quot;,
441 &quot;interpolationType&quot;: &quot;A String&quot;,
442 },
443 &quot;condition&quot;: &quot;A String&quot;,
444 },
445 ],
446 },
447 ],
448 },
449 ],
450 &quot;filterSpecs&quot;: [
451 {
452 &quot;dataStores&quot;: [
453 &quot;A String&quot;,
454 ],
455 &quot;filter&quot;: &quot;A String&quot;,
456 },
457 ],
458 },
459 &quot;sessionId&quot;: &quot;A String&quot;,
460 }
461
462 x__xgafv: string, V1 error format.
463 Allowed values
464 1 - v1 error format
465 2 - v2 error format
466
467 Returns:
468 An object of the form:
469
470 {
471 &quot;answers&quot;: [
472 {
473 &quot;answer&quot;: &quot;A String&quot;,
474 &quot;answerRecord&quot;: &quot;A String&quot;,
475 &quot;answerSources&quot;: [
476 {
477 &quot;metadata&quot;: {
478 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
479 },
480 &quot;snippet&quot;: &quot;A String&quot;,
481 &quot;title&quot;: &quot;A String&quot;,
482 &quot;uri&quot;: &quot;A String&quot;,
483 },
484 ],
485 &quot;answerType&quot;: &quot;A String&quot;,
486 },
487 ],
488 &quot;rewrittenQuery&quot;: &quot;A String&quot;,
489 &quot;searchKnowledgeDebugInfo&quot;: {
490 &quot;datastoreResponseReason&quot;: &quot;A String&quot;,
491 &quot;ingestedContextReferenceDebugInfo&quot;: {
492 &quot;contextReferenceRetrieved&quot;: True or False,
493 &quot;ingestedParametersDebugInfo&quot;: [
494 {
495 &quot;ingestionStatus&quot;: &quot;A String&quot;,
496 &quot;parameter&quot;: &quot;A String&quot;,
497 },
498 ],
499 &quot;projectNotAllowlisted&quot;: True or False,
500 },
501 &quot;searchKnowledgeBehavior&quot;: {
502 &quot;answerGenerationRewriterOn&quot;: True or False,
503 &quot;endUserMetadataIncluded&quot;: True or False,
504 &quot;thirdPartyConnectorAllowed&quot;: True or False,
505 },
506 &quot;serviceLatency&quot;: {
507 &quot;internalServiceLatencies&quot;: [
508 {
509 &quot;completeTime&quot;: &quot;A String&quot;,
510 &quot;latencyMs&quot;: 3.14,
511 &quot;startTime&quot;: &quot;A String&quot;,
512 &quot;step&quot;: &quot;A String&quot;,
513 },
514 ],
515 },
516 },
517 }</pre>
518 </div>
519
520 </body></html>