| <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_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.conversations.html">conversations</a> . <a href="dialogflow_v2beta1.projects.conversations.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="#generate">generate(conversation, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <p class="toc_element"> |
| <code><a href="#searchKnowledge">searchKnowledge(conversation, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <p class="toc_element"> |
| <code><a href="#suggestConversationSummary">suggestConversationSummary(conversation, 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="generate">generate(conversation, body=None, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| conversation: string, A parameter (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "latestMessage": "A String", |
| "triggerEvents": [ |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "generatorSuggestionAnswers": [ |
| { |
| "answerRecord": "A String", |
| "generatorSuggestion": { |
| "agentCoachingSuggestion": { |
| "agentActionSuggestions": [ |
| { |
| "agentAction": "A String", |
| "duplicateCheckResult": { |
| "duplicateSuggestions": [ |
| { |
| "answerRecord": "A String", |
| "similarityScore": 3.14, |
| "sources": { |
| "instructionIndexes": [ |
| 42, |
| ], |
| }, |
| "suggestionIndex": 42, |
| }, |
| ], |
| }, |
| "sources": { |
| "instructionIndexes": [ |
| 42, |
| ], |
| }, |
| }, |
| ], |
| "applicableInstructions": [ |
| { |
| "agentAction": "A String", |
| "condition": "A String", |
| "displayDetails": "A String", |
| "displayName": "A String", |
| "duplicateCheckResult": { |
| "duplicateSuggestions": [ |
| { |
| "answerRecord": "A String", |
| "similarityScore": 3.14, |
| "suggestionIndex": 42, |
| }, |
| ], |
| }, |
| "systemAction": "A String", |
| "triggeringEvent": "A String", |
| }, |
| ], |
| "sampleResponses": [ |
| { |
| "duplicateCheckResult": { |
| "duplicateSuggestions": [ |
| { |
| "answerRecord": "A String", |
| "similarityScore": 3.14, |
| "sources": { |
| "instructionIndexes": [ |
| 42, |
| ], |
| }, |
| "suggestionIndex": 42, |
| }, |
| ], |
| }, |
| "responseText": "A String", |
| "sources": { |
| "instructionIndexes": [ |
| 42, |
| ], |
| }, |
| }, |
| ], |
| }, |
| "freeFormSuggestion": { |
| "response": "A String", |
| }, |
| "summarySuggestion": { |
| "summarySections": [ |
| { |
| "section": "A String", |
| "summary": "A String", |
| }, |
| ], |
| }, |
| "toolCallInfo": [ |
| { |
| "toolCall": { |
| "action": "A String", |
| "answerRecord": "A String", |
| "createTime": "A String", |
| "inputParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "state": "A String", |
| "tool": "A String", |
| "toolDisplayDetails": "A String", |
| "toolDisplayName": "A String", |
| }, |
| "toolCallResult": { |
| "action": "A String", |
| "answerRecord": "A String", |
| "content": "A String", |
| "createTime": "A String", |
| "error": { |
| "message": "A String", |
| }, |
| "rawContent": "A String", |
| "tool": "A String", |
| }, |
| }, |
| ], |
| }, |
| "sourceGenerator": "A String", |
| }, |
| ], |
| "latestMessage": "A String", |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchKnowledge">searchKnowledge(conversation, body=None, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| conversation: 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": { |
| "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> |
| |
| <div class="method"> |
| <code class="details" id="suggestConversationSummary">suggestConversationSummary(conversation, body=None, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| conversation: string, A parameter (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "assistQueryParams": { |
| "documentsMetadataFilters": { |
| "a_key": "A String", |
| }, |
| }, |
| "contextSize": 42, |
| "latestMessage": "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": { |
| "answerRecord": "A String", |
| "baselineModelVersion": "A String", |
| "sortedTextSections": [ |
| { |
| "section": "A String", |
| "summary": "A String", |
| }, |
| ], |
| "text": "A String", |
| "textSections": { |
| "a_key": "A String", |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
