| 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 |
"conversationProfile": { |
| 103 |
"automatedAgentConfig": { |
| 104 |
"agent": "A String", |
| 105 |
"sessionTtl": "A String", |
| 106 |
}, |
| 107 |
"createTime": "A String", |
| 108 |
"displayName": "A String", |
| 109 |
"humanAgentAssistantConfig": { |
| 110 |
"endUserSuggestionConfig": { |
| 111 |
"disableHighLatencyFeaturesSyncDelivery": True or False, |
| 112 |
"enableAsyncToolCall": True or False, |
| 113 |
"featureConfigs": [ |
| 114 |
{ |
| 115 |
"conversationModelConfig": { |
| 116 |
"baselineModelVersion": "A String", |
| 117 |
"model": "A String", |
| 118 |
}, |
| 119 |
"conversationProcessConfig": { |
| 120 |
"recentSentencesCount": 42, |
| 121 |
}, |
| 122 |
"disableAgentQueryLogging": True or False, |
| 123 |
"disableQuerySearchContext": True or False, |
| 124 |
"enableConversationAugmentedQuery": True or False, |
| 125 |
"enableEventBasedSuggestion": True or False, |
| 126 |
"enableQuerySuggestionOnly": True or False, |
| 127 |
"enableQuerySuggestionWhenNoAnswer": True or False, |
| 128 |
"enableResponseDebugInfo": True or False, |
| 129 |
"queryConfig": { |
| 130 |
"confidenceThreshold": 3.14, |
| 131 |
"contextFilterSettings": { |
| 132 |
"dropHandoffMessages": True or False, |
| 133 |
"dropIvrMessages": True or False, |
| 134 |
"dropVirtualAgentMessages": True or False, |
| 135 |
}, |
| 136 |
"contextSize": 42, |
| 137 |
"dialogflowQuerySource": { |
| 138 |
"agent": "A String", |
| 139 |
"humanAgentSideConfig": { |
| 140 |
"agent": "A String", |
| 141 |
}, |
| 142 |
}, |
| 143 |
"documentQuerySource": { |
| 144 |
"documents": [ |
| 145 |
"A String", |
| 146 |
], |
| 147 |
}, |
| 148 |
"knowledgeBaseQuerySource": { |
| 149 |
"knowledgeBases": [ |
| 150 |
"A String", |
| 151 |
], |
| 152 |
}, |
| 153 |
"maxResults": 42, |
| 154 |
"sections": { |
| 155 |
"sectionTypes": [ |
| 156 |
"A String", |
| 157 |
], |
| 158 |
}, |
| 159 |
}, |
| 160 |
"raiSettings": { |
| 161 |
"raiCategoryConfigs": [ |
| 162 |
{ |
| 163 |
"category": "A String", |
| 164 |
"sensitivityLevel": "A String", |
| 165 |
}, |
| 166 |
], |
| 167 |
}, |
| 168 |
"suggestionFeature": { |
| 169 |
"type": "A String", |
| 170 |
}, |
| 171 |
"suggestionTriggerEvent": "A String", |
| 172 |
"suggestionTriggerSettings": { |
| 173 |
"noSmalltalk": True or False, |
| 174 |
"onlyEndUser": True or False, |
| 175 |
}, |
| 176 |
}, |
| 177 |
], |
| 178 |
"generators": [ |
| 179 |
"A String", |
| 180 |
], |
| 181 |
"groupSuggestionResponses": True or False, |
| 182 |
"skipEmptyEventBasedSuggestion": True or False, |
| 183 |
"useUnredactedConversationData": True or False, |
| 184 |
}, |
| 185 |
"humanAgentSuggestionConfig": { |
| 186 |
"disableHighLatencyFeaturesSyncDelivery": True or False, |
| 187 |
"enableAsyncToolCall": True or False, |
| 188 |
"featureConfigs": [ |
| 189 |
{ |
| 190 |
"conversationModelConfig": { |
| 191 |
"baselineModelVersion": "A String", |
| 192 |
"model": "A String", |
| 193 |
}, |
| 194 |
"conversationProcessConfig": { |
| 195 |
"recentSentencesCount": 42, |
| 196 |
}, |
| 197 |
"disableAgentQueryLogging": True or False, |
| 198 |
"disableQuerySearchContext": True or False, |
| 199 |
"enableConversationAugmentedQuery": True or False, |
| 200 |
"enableEventBasedSuggestion": True or False, |
| 201 |
"enableQuerySuggestionOnly": True or False, |
| 202 |
"enableQuerySuggestionWhenNoAnswer": True or False, |
| 203 |
"enableResponseDebugInfo": True or False, |
| 204 |
"queryConfig": { |
| 205 |
"confidenceThreshold": 3.14, |
| 206 |
"contextFilterSettings": { |
| 207 |
"dropHandoffMessages": True or False, |
| 208 |
"dropIvrMessages": True or False, |
| 209 |
"dropVirtualAgentMessages": True or False, |
| 210 |
}, |
| 211 |
"contextSize": 42, |
| 212 |
"dialogflowQuerySource": { |
| 213 |
"agent": "A String", |
| 214 |
"humanAgentSideConfig": { |
| 215 |
"agent": "A String", |
| 216 |
}, |
| 217 |
}, |
| 218 |
"documentQuerySource": { |
| 219 |
"documents": [ |
| 220 |
"A String", |
| 221 |
], |
| 222 |
}, |
| 223 |
"knowledgeBaseQuerySource": { |
| 224 |
"knowledgeBases": [ |
| 225 |
"A String", |
| 226 |
], |
| 227 |
}, |
| 228 |
"maxResults": 42, |
| 229 |
"sections": { |
| 230 |
"sectionTypes": [ |
| 231 |
"A String", |
| 232 |
], |
| 233 |
}, |
| 234 |
}, |
| 235 |
"raiSettings": { |
| 236 |
"raiCategoryConfigs": [ |
| 237 |
{ |
| 238 |
"category": "A String", |
| 239 |
"sensitivityLevel": "A String", |
| 240 |
}, |
| 241 |
], |
| 242 |
}, |
| 243 |
"suggestionFeature": { |
| 244 |
"type": "A String", |
| 245 |
}, |
| 246 |
"suggestionTriggerEvent": "A String", |
| 247 |
"suggestionTriggerSettings": { |
| 248 |
"noSmalltalk": True or False, |
| 249 |
"onlyEndUser": True or False, |
| 250 |
}, |
| 251 |
}, |
| 252 |
], |
| 253 |
"generators": [ |
| 254 |
"A String", |
| 255 |
], |
| 256 |
"groupSuggestionResponses": True or False, |
| 257 |
"skipEmptyEventBasedSuggestion": True or False, |
| 258 |
"useUnredactedConversationData": True or False, |
| 259 |
}, |
| 260 |
"messageAnalysisConfig": { |
| 261 |
"enableEntityExtraction": True or False, |
| 262 |
"enableSentimentAnalysis": True or False, |
| 263 |
"enableSentimentAnalysisV3": True or False, |
| 264 |
}, |
| 265 |
"notificationConfig": { |
| 266 |
"messageFormat": "A String", |
| 267 |
"topic": "A String", |
| 268 |
}, |
| 269 |
}, |
| 270 |
"humanAgentHandoffConfig": { |
| 271 |
"livePersonConfig": { |
| 272 |
"accountNumber": "A String", |
| 273 |
}, |
| 274 |
"salesforceLiveAgentConfig": { |
| 275 |
"buttonId": "A String", |
| 276 |
"deploymentId": "A String", |
| 277 |
"endpointDomain": "A String", |
| 278 |
"organizationId": "A String", |
| 279 |
}, |
| 280 |
}, |
| 281 |
"languageCode": "A String", |
| 282 |
"loggingConfig": { |
| 283 |
"enableStackdriverLogging": True or False, |
| 284 |
}, |
| 285 |
"name": "A String", |
| 286 |
"newMessageEventNotificationConfig": { |
| 287 |
"messageFormat": "A String", |
| 288 |
"topic": "A String", |
| 289 |
}, |
| 290 |
"newRecognitionResultNotificationConfig": { |
| 291 |
"messageFormat": "A String", |
| 292 |
"topic": "A String", |
| 293 |
}, |
| 294 |
"notificationConfig": { |
| 295 |
"messageFormat": "A String", |
| 296 |
"topic": "A String", |
| 297 |
}, |
| 298 |
"securitySettings": "A String", |
| 299 |
"sipConfig": { |
| 300 |
"allowVirtualAgentInteraction": True or False, |
| 301 |
"copyInboundCallLegHeaders": [ |
| 302 |
"A String", |
| 303 |
], |
| 304 |
"createConversationOnTheFly": True or False, |
| 305 |
"ignoreReinviteMediaDirection": True or False, |
| 306 |
"inactiveStart": True or False, |
| 307 |
"keepConversationRunning": True or False, |
| 308 |
"maxAudioRecordingDuration": "A String", |
| 309 |
}, |
| 310 |
"sttConfig": { |
| 311 |
"audioEncoding": "A String", |
| 312 |
"enableWordInfo": True or False, |
| 313 |
"languageCode": "A String", |
| 314 |
"model": "A String", |
| 315 |
"phraseSets": [ |
| 316 |
"A String", |
| 317 |
], |
| 318 |
"sampleRateHertz": 42, |
| 319 |
"speechModelVariant": "A String", |
| 320 |
"useTimeoutBasedEndpointing": True or False, |
| 321 |
}, |
| 322 |
"timeZone": "A String", |
| 323 |
"ttsConfig": { |
| 324 |
"effectsProfileId": [ |
| 325 |
"A String", |
| 326 |
], |
| 327 |
"pitch": 3.14, |
| 328 |
"pronunciations": [ |
| 329 |
{ |
| 330 |
"phoneticEncoding": "A String", |
| 331 |
"phrase": "A String", |
| 332 |
"pronunciation": "A String", |
| 333 |
}, |
| 334 |
], |
| 335 |
"speakingRate": 3.14, |
| 336 |
"voice": { |
| 337 |
"name": "A String", |
| 338 |
"ssmlGender": "A String", |
| 339 |
}, |
| 340 |
"volumeGainDb": 3.14, |
| 341 |
}, |
| 342 |
"updateTime": "A String", |
| 343 |
}, |
| 344 |
"latestMessage": "A String", |
| 345 |
"maxContextSize": 42, |
| 346 |
"statelessConversation": { |
| 347 |
"messages": [ |
| 348 |
{ |
| 349 |
"content": "A String", |
| 350 |
"createTime": "A String", |
| 351 |
"languageCode": "A String", |
| 352 |
"messageAnnotation": { |
| 353 |
"containEntities": True or False, |
| 354 |
"parts": [ |
| 355 |
{ |
| 356 |
"entityType": "A String", |
| 357 |
"formattedValue": "", |
| 358 |
"text": "A String", |
| 359 |
}, |
| 360 |
], |
| 361 |
}, |
| 362 |
"name": "A String", |
| 363 |
"participant": "A String", |
| 364 |
"participantRole": "A String", |
| 365 |
"sendTime": "A String", |
| 366 |
"sentimentAnalysis": { |
| 367 |
"queryTextSentiment": { |
| 368 |
"magnitude": 3.14, |
| 369 |
"score": 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 |
"contextSize": 42, |
| 387 |
"latestMessage": "A String", |
| 388 |
"summary": { |
| 389 |
"baselineModelVersion": "A String", |
| 390 |
"text": "A String", |
| 391 |
"textSections": { |
| 392 |
"a_key": "A String", |
| 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 |
"conversation": "A String", |
| 409 |
"conversationProfile": "A String", |
| 410 |
"endUserMetadata": { |
| 411 |
"a_key": "", # Properties of the object. |
| 412 |
}, |
| 413 |
"exactSearch": True or False, |
| 414 |
"latestMessage": "A String", |
| 415 |
"parent": "A String", |
| 416 |
"query": { |
| 417 |
"languageCode": "A String", |
| 418 |
"text": "A String", |
| 419 |
}, |
| 420 |
"querySource": "A String", |
| 421 |
"searchConfig": { |
| 422 |
"boostSpecs": [ |
| 423 |
{ |
| 424 |
"dataStores": [ |
| 425 |
"A String", |
| 426 |
], |
| 427 |
"spec": [ |
| 428 |
{ |
| 429 |
"conditionBoostSpecs": [ |
| 430 |
{ |
| 431 |
"boost": 3.14, |
| 432 |
"boostControlSpec": { |
| 433 |
"attributeType": "A String", |
| 434 |
"controlPoints": [ |
| 435 |
{ |
| 436 |
"attributeValue": "A String", |
| 437 |
"boostAmount": 3.14, |
| 438 |
}, |
| 439 |
], |
| 440 |
"fieldName": "A String", |
| 441 |
"interpolationType": "A String", |
| 442 |
}, |
| 443 |
"condition": "A String", |
| 444 |
}, |
| 445 |
], |
| 446 |
}, |
| 447 |
], |
| 448 |
}, |
| 449 |
], |
| 450 |
"filterSpecs": [ |
| 451 |
{ |
| 452 |
"dataStores": [ |
| 453 |
"A String", |
| 454 |
], |
| 455 |
"filter": "A String", |
| 456 |
}, |
| 457 |
], |
| 458 |
}, |
| 459 |
"sessionId": "A String", |
| 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 |
"answers": [ |
| 472 |
{ |
| 473 |
"answer": "A String", |
| 474 |
"answerRecord": "A String", |
| 475 |
"answerSources": [ |
| 476 |
{ |
| 477 |
"metadata": { |
| 478 |
"a_key": "", # Properties of the object. |
| 479 |
}, |
| 480 |
"snippet": "A String", |
| 481 |
"title": "A String", |
| 482 |
"uri": "A String", |
| 483 |
}, |
| 484 |
], |
| 485 |
"answerType": "A String", |
| 486 |
}, |
| 487 |
], |
| 488 |
"rewrittenQuery": "A String", |
| 489 |
"searchKnowledgeDebugInfo": { |
| 490 |
"datastoreResponseReason": "A String", |
| 491 |
"ingestedContextReferenceDebugInfo": { |
| 492 |
"contextReferenceRetrieved": True or False, |
| 493 |
"ingestedParametersDebugInfo": [ |
| 494 |
{ |
| 495 |
"ingestionStatus": "A String", |
| 496 |
"parameter": "A String", |
| 497 |
}, |
| 498 |
], |
| 499 |
"projectNotAllowlisted": True or False, |
| 500 |
}, |
| 501 |
"searchKnowledgeBehavior": { |
| 502 |
"answerGenerationRewriterOn": True or False, |
| 503 |
"endUserMetadataIncluded": True or False, |
| 504 |
"thirdPartyConnectorAllowed": True or False, |
| 505 |
}, |
| 506 |
"serviceLatency": { |
| 507 |
"internalServiceLatencies": [ |
| 508 |
{ |
| 509 |
"completeTime": "A String", |
| 510 |
"latencyMs": 3.14, |
| 511 |
"startTime": "A String", |
| 512 |
"step": "A String", |
| 513 |
}, |
| 514 |
], |
| 515 |
}, |
| 516 |
}, |
| 517 |
}</pre> |
| 518 |
</div> |
| 519 |
|
| 520 |
</body></html> |