| <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="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.suggestions.html">suggestions</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="#generateStatelessSummary">generateStatelessSummary(parent, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline"></p> | |
| <p class="toc_element"> | |
| <code><a href="#searchKnowledge">searchKnowledge(parent, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline"></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="generateStatelessSummary">generateStatelessSummary(parent, body=None, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| parent: string, A parameter (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "conversationProfile": { | |
| "automatedAgentConfig": { | |
| "agent": "A String", | |
| "sessionTtl": "A String", | |
| }, | |
| "createTime": "A String", | |
| "displayName": "A String", | |
| "humanAgentAssistantConfig": { | |
| "endUserSuggestionConfig": { | |
| "companionAgent": "A String", | |
| "disableHighLatencyFeaturesSyncDelivery": True or False, | |
| "enableAsyncToolCall": True or False, | |
| "featureConfigs": [ | |
| { | |
| "conversationModelConfig": { | |
| "baselineModelVersion": "A String", | |
| "model": "A String", | |
| }, | |
| "conversationProcessConfig": { | |
| "recentSentencesCount": 42, | |
| }, | |
| "disableAgentQueryLogging": True or False, | |
| "disableQuerySearchContext": True or False, | |
| "enableConversationAugmentedQuery": True or False, | |
| "enableEventBasedSuggestion": True or False, | |
| "enableQuerySuggestionOnly": True or False, | |
| "enableQuerySuggestionWhenNoAnswer": True or False, | |
| "enableResponseDebugInfo": True or False, | |
| "queryConfig": { | |
| "confidenceThreshold": 3.14, | |
| "contextFilterSettings": { | |
| "dropHandoffMessages": True or False, | |
| "dropIvrMessages": True or False, | |
| "dropVirtualAgentMessages": True or False, | |
| }, | |
| "contextSize": 42, | |
| "dialogflowQuerySource": { | |
| "agent": "A String", | |
| "humanAgentSideConfig": { | |
| "agent": "A String", | |
| }, | |
| }, | |
| "documentQuerySource": { | |
| "documents": [ | |
| "A String", | |
| ], | |
| }, | |
| "knowledgeBaseQuerySource": { | |
| "knowledgeBases": [ | |
| "A String", | |
| ], | |
| }, | |
| "maxResults": 42, | |
| "sections": { | |
| "sectionTypes": [ | |
| "A String", | |
| ], | |
| }, | |
| }, | |
| "raiSettings": { | |
| "raiCategoryConfigs": [ | |
| { | |
| "category": "A String", | |
| "sensitivityLevel": "A String", | |
| }, | |
| ], | |
| }, | |
| "suggestionFeature": { | |
| "type": "A String", | |
| }, | |
| "suggestionTriggerEvent": "A String", | |
| "suggestionTriggerSettings": { | |
| "noSmalltalk": True or False, | |
| "onlyEndUser": True or False, | |
| }, | |
| }, | |
| ], | |
| "generators": [ | |
| "A String", | |
| ], | |
| "groupSuggestionResponses": True or False, | |
| "skipEmptyEventBasedSuggestion": True or False, | |
| "useUnredactedConversationData": True or False, | |
| }, | |
| "humanAgentSuggestionConfig": { | |
| "companionAgent": "A String", | |
| "disableHighLatencyFeaturesSyncDelivery": True or False, | |
| "enableAsyncToolCall": True or False, | |
| "featureConfigs": [ | |
| { | |
| "conversationModelConfig": { | |
| "baselineModelVersion": "A String", | |
| "model": "A String", | |
| }, | |
| "conversationProcessConfig": { | |
| "recentSentencesCount": 42, | |
| }, | |
| "disableAgentQueryLogging": True or False, | |
| "disableQuerySearchContext": True or False, | |
| "enableConversationAugmentedQuery": True or False, | |
| "enableEventBasedSuggestion": True or False, | |
| "enableQuerySuggestionOnly": True or False, | |
| "enableQuerySuggestionWhenNoAnswer": True or False, | |
| "enableResponseDebugInfo": True or False, | |
| "queryConfig": { | |
| "confidenceThreshold": 3.14, | |
| "contextFilterSettings": { | |
| "dropHandoffMessages": True or False, | |
| "dropIvrMessages": True or False, | |
| "dropVirtualAgentMessages": True or False, | |
| }, | |
| "contextSize": 42, | |
| "dialogflowQuerySource": { | |
| "agent": "A String", | |
| "humanAgentSideConfig": { | |
| "agent": "A String", | |
| }, | |
| }, | |
| "documentQuerySource": { | |
| "documents": [ | |
| "A String", | |
| ], | |
| }, | |
| "knowledgeBaseQuerySource": { | |
| "knowledgeBases": [ | |
| "A String", | |
| ], | |
| }, | |
| "maxResults": 42, | |
| "sections": { | |
| "sectionTypes": [ | |
| "A String", | |
| ], | |
| }, | |
| }, | |
| "raiSettings": { | |
| "raiCategoryConfigs": [ | |
| { | |
| "category": "A String", | |
| "sensitivityLevel": "A String", | |
| }, | |
| ], | |
| }, | |
| "suggestionFeature": { | |
| "type": "A String", | |
| }, | |
| "suggestionTriggerEvent": "A String", | |
| "suggestionTriggerSettings": { | |
| "noSmalltalk": True or False, | |
| "onlyEndUser": True or False, | |
| }, | |
| }, | |
| ], | |
| "generators": [ | |
| "A String", | |
| ], | |
| "groupSuggestionResponses": True or False, | |
| "skipEmptyEventBasedSuggestion": True or False, | |
| "useUnredactedConversationData": True or False, | |
| }, | |
| "messageAnalysisConfig": { | |
| "enableEntityExtraction": True or False, | |
| "enableSentimentAnalysis": True or False, | |
| "enableSentimentAnalysisV3": True or False, | |
| }, | |
| "notificationConfig": { | |
| "messageFormat": "A String", | |
| "topic": "A String", | |
| }, | |
| }, | |
| "humanAgentHandoffConfig": { | |
| "livePersonConfig": { | |
| "accountNumber": "A String", | |
| }, | |
| "salesforceLiveAgentConfig": { | |
| "buttonId": "A String", | |
| "deploymentId": "A String", | |
| "endpointDomain": "A String", | |
| "organizationId": "A String", | |
| }, | |
| }, | |
| "languageCode": "A String", | |
| "loggingConfig": { | |
| "enableStackdriverLogging": True or False, | |
| }, | |
| "name": "A String", | |
| "newMessageEventNotificationConfig": { | |
| "messageFormat": "A String", | |
| "topic": "A String", | |
| }, | |
| "newRecognitionResultNotificationConfig": { | |
| "messageFormat": "A String", | |
| "topic": "A String", | |
| }, | |
| "notificationConfig": { | |
| "messageFormat": "A String", | |
| "topic": "A String", | |
| }, | |
| "securitySettings": "A String", | |
| "sipConfig": { | |
| "allowVirtualAgentInteraction": True or False, | |
| "copyInboundCallLegHeaders": [ | |
| "A String", | |
| ], | |
| "createConversationOnTheFly": True or False, | |
| "ignoreReinviteMediaDirection": True or False, | |
| "inactiveStart": True or False, | |
| "keepConversationRunning": True or False, | |
| "maxAudioRecordingDuration": "A String", | |
| }, | |
| "sttConfig": { | |
| "alternativeLanguageCodes": [ | |
| "A String", | |
| ], | |
| "audioEncoding": "A String", | |
| "disableInterimInputTranscripts": True or False, | |
| "enableWordInfo": True or False, | |
| "geminiAsrConfig": { | |
| "endOfSpeechSensitivity": "A String", | |
| "prefixPaddingMs": 42, | |
| "silenceDurationMs": 42, | |
| "startOfSpeechSensitivity": "A String", | |
| }, | |
| "languageCode": "A String", | |
| "model": "A String", | |
| "phraseSets": [ | |
| "A String", | |
| ], | |
| "profanityFilter": True or False, | |
| "sampleRateHertz": 42, | |
| "speechModelVariant": "A String", | |
| "useGeminiAsr": True or False, | |
| "useTimeoutBasedEndpointing": True or False, | |
| }, | |
| "timeZone": "A String", | |
| "ttsConfig": { | |
| "effectsProfileId": [ | |
| "A String", | |
| ], | |
| "pitch": 3.14, | |
| "pronunciations": [ | |
| { | |
| "phoneticEncoding": "A String", | |
| "phrase": "A String", | |
| "pronunciation": "A String", | |
| }, | |
| ], | |
| "speakingRate": 3.14, | |
| "voice": { | |
| "name": "A String", | |
| "ssmlGender": "A String", | |
| }, | |
| "volumeGainDb": 3.14, | |
| }, | |
| "updateTime": "A String", | |
| }, | |
| "latestMessage": "A String", | |
| "maxContextSize": 42, | |
| "statelessConversation": { | |
| "messages": [ | |
| { | |
| "content": "A String", | |
| "createTime": "A String", | |
| "languageCode": "A String", | |
| "messageAnnotation": { | |
| "containEntities": True or False, | |
| "parts": [ | |
| { | |
| "entityType": "A String", | |
| "formattedValue": "", | |
| "text": "A String", | |
| }, | |
| ], | |
| }, | |
| "name": "A String", | |
| "participant": "A String", | |
| "participantRole": "A String", | |
| "responseMessages": [ | |
| { | |
| "endInteraction": { | |
| }, | |
| "liveAgentHandoff": { | |
| "metadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| "mixedAudio": { | |
| "segments": [ | |
| { | |
| "allowPlaybackInterruption": True or False, | |
| "audio": "A String", | |
| "uri": "A String", | |
| }, | |
| ], | |
| }, | |
| "payload": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| "telephonyTransferCall": { | |
| "phoneNumber": "A String", | |
| "sipUri": "A String", | |
| }, | |
| "text": { | |
| "text": [ | |
| "A String", | |
| ], | |
| }, | |
| }, | |
| ], | |
| "sendTime": "A String", | |
| "sentimentAnalysis": { | |
| "queryTextSentiment": { | |
| "magnitude": 3.14, | |
| "score": 3.14, | |
| }, | |
| "status": { | |
| "code": 42, | |
| "details": [ | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", | |
| }, | |
| }, | |
| }, | |
| ], | |
| }, | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "contextSize": 42, | |
| "latestMessage": "A String", | |
| "summary": { | |
| "baselineModelVersion": "A String", | |
| "text": "A String", | |
| "textSections": { | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="searchKnowledge">searchKnowledge(parent, body=None, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| parent: string, A parameter (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "conversation": "A String", | |
| "conversationProfile": "A String", | |
| "endUserMetadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| "exactSearch": True or False, | |
| "latestMessage": "A String", | |
| "parent": "A String", | |
| "query": { | |
| "languageCode": "A String", | |
| "text": "A String", | |
| }, | |
| "querySource": "A String", | |
| "searchConfig": { | |
| "boostSpecs": [ | |
| { | |
| "dataStores": [ | |
| "A String", | |
| ], | |
| "spec": [ | |
| { | |
| "conditionBoostSpecs": [ | |
| { | |
| "boost": 3.14, | |
| "boostControlSpec": { | |
| "attributeType": "A String", | |
| "controlPoints": [ | |
| { | |
| "attributeValue": "A String", | |
| "boostAmount": 3.14, | |
| }, | |
| ], | |
| "fieldName": "A String", | |
| "interpolationType": "A String", | |
| }, | |
| "condition": "A String", | |
| }, | |
| ], | |
| }, | |
| ], | |
| }, | |
| ], | |
| "filterSpecs": [ | |
| { | |
| "dataStores": [ | |
| "A String", | |
| ], | |
| "filter": "A String", | |
| }, | |
| ], | |
| }, | |
| "sessionId": "A String", | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "answers": [ | |
| { | |
| "answer": "A String", | |
| "answerRecord": "A String", | |
| "answerSources": [ | |
| { | |
| "metadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| "snippet": "A String", | |
| "title": "A String", | |
| "uri": "A String", | |
| }, | |
| ], | |
| "answerType": "A String", | |
| }, | |
| ], | |
| "rewrittenQuery": "A String", | |
| "searchKnowledgeDebugInfo": { | |
| "cesDebugInfo": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| "datastoreResponseReason": "A String", | |
| "ingestedContextReferenceDebugInfo": { | |
| "contextReferenceRetrieved": True or False, | |
| "ingestedParametersDebugInfo": [ | |
| { | |
| "ingestionStatus": "A String", | |
| "parameter": "A String", | |
| }, | |
| ], | |
| "projectNotAllowlisted": True or False, | |
| }, | |
| "searchKnowledgeBehavior": { | |
| "answerGenerationRewriterOn": True or False, | |
| "endUserMetadataIncluded": True or False, | |
| "thirdPartyConnectorAllowed": True or False, | |
| }, | |
| "serviceLatency": { | |
| "internalServiceLatencies": [ | |
| { | |
| "completeTime": "A String", | |
| "latencyMs": 3.14, | |
| "startTime": "A String", | |
| "step": "A String", | |
| }, | |
| ], | |
| }, | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |