| <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.locations.html">locations</a> . <a href="dialogflow_v2.projects.locations.conversations.html">conversations</a> . <a href="dialogflow_v2.projects.locations.conversations.participants.html">participants</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="dialogflow_v2.projects.locations.conversations.participants.suggestions.html">suggestions()</a></code> |
| </p> |
| <p class="firstline">Returns the suggestions Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#analyzeContent">analyzeContent(participant, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <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, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline"></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"></p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="analyzeContent">analyzeContent(participant, body=None, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| participant: string, A parameter (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "assistQueryParams": { |
| "documentsMetadataFilters": { |
| "a_key": "A String", |
| }, |
| }, |
| "audioInput": { |
| "audio": "A String", |
| "config": { |
| "audioEncoding": "A String", |
| "disableNoSpeechRecognizedEvent": True or False, |
| "enableAutomaticPunctuation": True or False, |
| "enableWordInfo": True or False, |
| "languageCode": "A String", |
| "model": "A String", |
| "modelVariant": "A String", |
| "optOutConformerModelMigration": True or False, |
| "phraseHints": [ |
| "A String", |
| ], |
| "phraseSets": [ |
| "A String", |
| ], |
| "sampleRateHertz": 42, |
| "singleUtterance": True or False, |
| "speechContexts": [ |
| { |
| "boost": 3.14, |
| "phrases": [ |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| }, |
| "cxParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "eventInput": { |
| "languageCode": "A String", |
| "name": "A String", |
| "parameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "queryParams": { |
| "contexts": [ |
| { |
| "lifespanCount": 42, |
| "name": "A String", |
| "parameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| ], |
| "geoLocation": { |
| "latitude": 3.14, |
| "longitude": 3.14, |
| }, |
| "payload": { |
| "a_key": "", # Properties of the object. |
| }, |
| "platform": "A String", |
| "resetContexts": True or False, |
| "sentimentAnalysisRequestConfig": { |
| "analyzeQueryTextSentiment": True or False, |
| }, |
| "sessionEntityTypes": [ |
| { |
| "entities": [ |
| { |
| "synonyms": [ |
| "A String", |
| ], |
| "value": "A String", |
| }, |
| ], |
| "entityOverrideMode": "A String", |
| "name": "A String", |
| }, |
| ], |
| "timeZone": "A String", |
| "webhookHeaders": { |
| "a_key": "A String", |
| }, |
| }, |
| "replyAudioConfig": { |
| "audioEncoding": "A String", |
| "sampleRateHertz": 42, |
| "synthesizeSpeechConfig": { |
| "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, |
| }, |
| }, |
| "requestId": "A String", |
| "suggestionInput": { |
| "action": "A String", |
| "answerRecord": "A String", |
| "parameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "sendTime": "A String", |
| }, |
| "textInput": { |
| "languageCode": "A String", |
| "text": "A String", |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "automatedAgentReply": { |
| "allowCancellation": True or False, |
| "automatedAgentReplyType": "A String", |
| "cxCurrentPage": "A String", |
| "detectIntentResponse": { |
| "outputAudio": "A String", |
| "outputAudioConfig": { |
| "audioEncoding": "A String", |
| "sampleRateHertz": 42, |
| "synthesizeSpeechConfig": { |
| "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, |
| }, |
| }, |
| "queryResult": { |
| "action": "A String", |
| "allRequiredParamsPresent": True or False, |
| "cancelsSlotFilling": True or False, |
| "diagnosticInfo": { |
| "a_key": "", # Properties of the object. |
| }, |
| "fulfillmentMessages": [ |
| { |
| "basicCard": { |
| "buttons": [ |
| { |
| "openUriAction": { |
| "uri": "A String", |
| }, |
| "title": "A String", |
| }, |
| ], |
| "formattedText": "A String", |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "subtitle": "A String", |
| "title": "A String", |
| }, |
| "browseCarouselCard": { |
| "imageDisplayOptions": "A String", |
| "items": [ |
| { |
| "description": "A String", |
| "footer": "A String", |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "openUriAction": { |
| "url": "A String", |
| "urlTypeHint": "A String", |
| }, |
| "title": "A String", |
| }, |
| ], |
| }, |
| "card": { |
| "buttons": [ |
| { |
| "postback": "A String", |
| "text": "A String", |
| }, |
| ], |
| "imageUri": "A String", |
| "subtitle": "A String", |
| "title": "A String", |
| }, |
| "carouselSelect": { |
| "items": [ |
| { |
| "description": "A String", |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "info": { |
| "key": "A String", |
| "synonyms": [ |
| "A String", |
| ], |
| }, |
| "title": "A String", |
| }, |
| ], |
| }, |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "linkOutSuggestion": { |
| "destinationName": "A String", |
| "uri": "A String", |
| }, |
| "listSelect": { |
| "items": [ |
| { |
| "description": "A String", |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "info": { |
| "key": "A String", |
| "synonyms": [ |
| "A String", |
| ], |
| }, |
| "title": "A String", |
| }, |
| ], |
| "subtitle": "A String", |
| "title": "A String", |
| }, |
| "mediaContent": { |
| "mediaObjects": [ |
| { |
| "contentUrl": "A String", |
| "description": "A String", |
| "icon": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "largeImage": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "name": "A String", |
| }, |
| ], |
| "mediaType": "A String", |
| }, |
| "payload": { |
| "a_key": "", # Properties of the object. |
| }, |
| "platform": "A String", |
| "quickReplies": { |
| "quickReplies": [ |
| "A String", |
| ], |
| "title": "A String", |
| }, |
| "simpleResponses": { |
| "simpleResponses": [ |
| { |
| "displayText": "A String", |
| "ssml": "A String", |
| "textToSpeech": "A String", |
| }, |
| ], |
| }, |
| "suggestions": { |
| "suggestions": [ |
| { |
| "title": "A String", |
| }, |
| ], |
| }, |
| "tableCard": { |
| "buttons": [ |
| { |
| "openUriAction": { |
| "uri": "A String", |
| }, |
| "title": "A String", |
| }, |
| ], |
| "columnProperties": [ |
| { |
| "header": "A String", |
| "horizontalAlignment": "A String", |
| }, |
| ], |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "rows": [ |
| { |
| "cells": [ |
| { |
| "text": "A String", |
| }, |
| ], |
| "dividerAfter": True or False, |
| }, |
| ], |
| "subtitle": "A String", |
| "title": "A String", |
| }, |
| "text": { |
| "text": [ |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "fulfillmentText": "A String", |
| "intent": { |
| "action": "A String", |
| "defaultResponsePlatforms": [ |
| "A String", |
| ], |
| "displayName": "A String", |
| "endInteraction": True or False, |
| "events": [ |
| "A String", |
| ], |
| "followupIntentInfo": [ |
| { |
| "followupIntentName": "A String", |
| "parentFollowupIntentName": "A String", |
| }, |
| ], |
| "inputContextNames": [ |
| "A String", |
| ], |
| "isFallback": True or False, |
| "liveAgentHandoff": True or False, |
| "messages": [ |
| { |
| "basicCard": { |
| "buttons": [ |
| { |
| "openUriAction": { |
| "uri": "A String", |
| }, |
| "title": "A String", |
| }, |
| ], |
| "formattedText": "A String", |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "subtitle": "A String", |
| "title": "A String", |
| }, |
| "browseCarouselCard": { |
| "imageDisplayOptions": "A String", |
| "items": [ |
| { |
| "description": "A String", |
| "footer": "A String", |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "openUriAction": { |
| "url": "A String", |
| "urlTypeHint": "A String", |
| }, |
| "title": "A String", |
| }, |
| ], |
| }, |
| "card": { |
| "buttons": [ |
| { |
| "postback": "A String", |
| "text": "A String", |
| }, |
| ], |
| "imageUri": "A String", |
| "subtitle": "A String", |
| "title": "A String", |
| }, |
| "carouselSelect": { |
| "items": [ |
| { |
| "description": "A String", |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "info": { |
| "key": "A String", |
| "synonyms": [ |
| "A String", |
| ], |
| }, |
| "title": "A String", |
| }, |
| ], |
| }, |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "linkOutSuggestion": { |
| "destinationName": "A String", |
| "uri": "A String", |
| }, |
| "listSelect": { |
| "items": [ |
| { |
| "description": "A String", |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "info": { |
| "key": "A String", |
| "synonyms": [ |
| "A String", |
| ], |
| }, |
| "title": "A String", |
| }, |
| ], |
| "subtitle": "A String", |
| "title": "A String", |
| }, |
| "mediaContent": { |
| "mediaObjects": [ |
| { |
| "contentUrl": "A String", |
| "description": "A String", |
| "icon": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "largeImage": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "name": "A String", |
| }, |
| ], |
| "mediaType": "A String", |
| }, |
| "payload": { |
| "a_key": "", # Properties of the object. |
| }, |
| "platform": "A String", |
| "quickReplies": { |
| "quickReplies": [ |
| "A String", |
| ], |
| "title": "A String", |
| }, |
| "simpleResponses": { |
| "simpleResponses": [ |
| { |
| "displayText": "A String", |
| "ssml": "A String", |
| "textToSpeech": "A String", |
| }, |
| ], |
| }, |
| "suggestions": { |
| "suggestions": [ |
| { |
| "title": "A String", |
| }, |
| ], |
| }, |
| "tableCard": { |
| "buttons": [ |
| { |
| "openUriAction": { |
| "uri": "A String", |
| }, |
| "title": "A String", |
| }, |
| ], |
| "columnProperties": [ |
| { |
| "header": "A String", |
| "horizontalAlignment": "A String", |
| }, |
| ], |
| "image": { |
| "accessibilityText": "A String", |
| "imageUri": "A String", |
| }, |
| "rows": [ |
| { |
| "cells": [ |
| { |
| "text": "A String", |
| }, |
| ], |
| "dividerAfter": True or False, |
| }, |
| ], |
| "subtitle": "A String", |
| "title": "A String", |
| }, |
| "text": { |
| "text": [ |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "mlDisabled": True or False, |
| "name": "A String", |
| "outputContexts": [ |
| { |
| "lifespanCount": 42, |
| "name": "A String", |
| "parameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| ], |
| "parameters": [ |
| { |
| "defaultValue": "A String", |
| "displayName": "A String", |
| "entityTypeDisplayName": "A String", |
| "isList": True or False, |
| "mandatory": True or False, |
| "name": "A String", |
| "prompts": [ |
| "A String", |
| ], |
| "value": "A String", |
| }, |
| ], |
| "parentFollowupIntentName": "A String", |
| "priority": 42, |
| "resetContexts": True or False, |
| "rootFollowupIntentName": "A String", |
| "trainingPhrases": [ |
| { |
| "name": "A String", |
| "parts": [ |
| { |
| "alias": "A String", |
| "entityType": "A String", |
| "text": "A String", |
| "userDefined": True or False, |
| }, |
| ], |
| "timesAddedCount": 42, |
| "type": "A String", |
| }, |
| ], |
| "webhookState": "A String", |
| }, |
| "intentDetectionConfidence": 3.14, |
| "languageCode": "A String", |
| "outputContexts": [ |
| { |
| "lifespanCount": 42, |
| "name": "A String", |
| "parameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| ], |
| "parameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "queryText": "A String", |
| "sentimentAnalysisResult": { |
| "queryTextSentiment": { |
| "magnitude": 3.14, |
| "score": 3.14, |
| }, |
| }, |
| "speechRecognitionConfidence": 3.14, |
| "webhookPayload": { |
| "a_key": "", # Properties of the object. |
| }, |
| "webhookSource": "A String", |
| }, |
| "responseId": "A String", |
| "webhookStatus": { |
| "code": 42, |
| "details": [ |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", |
| }, |
| }, |
| }, |
| "dtmfParameters": { |
| "acceptsDtmfInput": True or False, |
| }, |
| "endUserSuggestionResults": [ |
| { |
| "error": { |
| "code": 42, |
| "details": [ |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", |
| }, |
| "generateSuggestionsResponse": { |
| "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", |
| "cesApp": "A String", |
| "cesTool": "A String", |
| "cesToolset": "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", |
| "cesApp": "A String", |
| "cesTool": "A String", |
| "cesToolset": "A String", |
| "content": "A String", |
| "createTime": "A String", |
| "error": { |
| "message": "A String", |
| }, |
| "rawContent": "A String", |
| "tool": "A String", |
| }, |
| }, |
| ], |
| }, |
| "sourceGenerator": "A String", |
| }, |
| ], |
| "latestMessage": "A String", |
| }, |
| "suggestArticlesResponse": { |
| "articleAnswers": [ |
| { |
| "answerRecord": "A String", |
| "confidence": 3.14, |
| "metadata": { |
| "a_key": "A String", |
| }, |
| "snippets": [ |
| "A String", |
| ], |
| "title": "A String", |
| "uri": "A String", |
| }, |
| ], |
| "contextSize": 42, |
| "latestMessage": "A String", |
| }, |
| "suggestFaqAnswersResponse": { |
| "contextSize": 42, |
| "faqAnswers": [ |
| { |
| "answer": "A String", |
| "answerRecord": "A String", |
| "confidence": 3.14, |
| "metadata": { |
| "a_key": "A String", |
| }, |
| "question": "A String", |
| "source": "A String", |
| }, |
| ], |
| "latestMessage": "A String", |
| }, |
| "suggestKnowledgeAssistResponse": { |
| "additionalSuggestedQueryResults": [ |
| { |
| "answerRecord": "A String", |
| "suggestedQuery": { |
| "queryText": "A String", |
| "searchContexts": [ |
| { |
| "key": "A String", |
| "value": "A String", |
| }, |
| ], |
| }, |
| }, |
| ], |
| "contextSize": 42, |
| "knowledgeAssistAnswer": { |
| "answerRecord": "A String", |
| "knowledgeAssistDebugInfo": { |
| "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, |
| }, |
| "knowledgeAssistBehavior": { |
| "answerGenerationRewriterOn": True or False, |
| "appendedSearchContextCount": 42, |
| "conversationTranscriptHasMixedLanguages": True or False, |
| "disableSyncDelivery": True or False, |
| "endUserMetadataIncluded": True or False, |
| "invalidItemsQuerySuggestionSkipped": True or False, |
| "multipleQueriesGenerated": True or False, |
| "previousQueriesIncluded": True or False, |
| "primaryQueryRedactedAndReplaced": True or False, |
| "queryContainedSearchContext": True or False, |
| "queryGenerationAgentLanguageMismatch": True or False, |
| "queryGenerationEndUserLanguageMismatch": True or False, |
| "returnQueryOnly": True or False, |
| "thirdPartyConnectorAllowed": True or False, |
| "useCustomSafetyFilterLevel": True or False, |
| "usePubsubDelivery": True or False, |
| "useTranslatedMessage": True or False, |
| }, |
| "queryCategorizationFailureReason": "A String", |
| "queryGenerationDebugInfo": { |
| "candidatesTokenCount": 42, |
| "promptTokenCount": 42, |
| "totalTokenCount": 42, |
| }, |
| "queryGenerationFailureReason": "A String", |
| "serviceLatency": { |
| "internalServiceLatencies": [ |
| { |
| "completeTime": "A String", |
| "latencyMs": 3.14, |
| "startTime": "A String", |
| "step": "A String", |
| }, |
| ], |
| }, |
| }, |
| "suggestedQuery": { |
| "queryText": "A String", |
| "searchContexts": [ |
| { |
| "key": "A String", |
| "value": "A String", |
| }, |
| ], |
| }, |
| "suggestedQueryAnswer": { |
| "answerText": "A String", |
| "eventSource": { |
| "event": "A String", |
| "snippets": { |
| "snippets": [ |
| { |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| "title": "A String", |
| "uri": "A String", |
| }, |
| ], |
| }, |
| }, |
| "faqSource": { |
| "question": "A String", |
| }, |
| "generativeSource": { |
| "snippets": [ |
| { |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| "title": "A String", |
| "uri": "A String", |
| }, |
| ], |
| }, |
| "playbookSource": { |
| "snippets": [ |
| { |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| "title": "A String", |
| "uri": "A String", |
| }, |
| ], |
| }, |
| }, |
| }, |
| "latestMessage": "A String", |
| }, |
| "suggestSmartRepliesResponse": { |
| "contextSize": 42, |
| "latestMessage": "A String", |
| "smartReplyAnswers": [ |
| { |
| "answerRecord": "A String", |
| "confidence": 3.14, |
| "reply": "A String", |
| }, |
| ], |
| }, |
| }, |
| ], |
| "humanAgentSuggestionResults": [ |
| { |
| "error": { |
| "code": 42, |
| "details": [ |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", |
| }, |
| "generateSuggestionsResponse": { |
| "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", |
| "cesApp": "A String", |
| "cesTool": "A String", |
| "cesToolset": "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", |
| "cesApp": "A String", |
| "cesTool": "A String", |
| "cesToolset": "A String", |
| "content": "A String", |
| "createTime": "A String", |
| "error": { |
| "message": "A String", |
| }, |
| "rawContent": "A String", |
| "tool": "A String", |
| }, |
| }, |
| ], |
| }, |
| "sourceGenerator": "A String", |
| }, |
| ], |
| "latestMessage": "A String", |
| }, |
| "suggestArticlesResponse": { |
| "articleAnswers": [ |
| { |
| "answerRecord": "A String", |
| "confidence": 3.14, |
| "metadata": { |
| "a_key": "A String", |
| }, |
| "snippets": [ |
| "A String", |
| ], |
| "title": "A String", |
| "uri": "A String", |
| }, |
| ], |
| "contextSize": 42, |
| "latestMessage": "A String", |
| }, |
| "suggestFaqAnswersResponse": { |
| "contextSize": 42, |
| "faqAnswers": [ |
| { |
| "answer": "A String", |
| "answerRecord": "A String", |
| "confidence": 3.14, |
| "metadata": { |
| "a_key": "A String", |
| }, |
| "question": "A String", |
| "source": "A String", |
| }, |
| ], |
| "latestMessage": "A String", |
| }, |
| "suggestKnowledgeAssistResponse": { |
| "additionalSuggestedQueryResults": [ |
| { |
| "answerRecord": "A String", |
| "suggestedQuery": { |
| "queryText": "A String", |
| "searchContexts": [ |
| { |
| "key": "A String", |
| "value": "A String", |
| }, |
| ], |
| }, |
| }, |
| ], |
| "contextSize": 42, |
| "knowledgeAssistAnswer": { |
| "answerRecord": "A String", |
| "knowledgeAssistDebugInfo": { |
| "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, |
| }, |
| "knowledgeAssistBehavior": { |
| "answerGenerationRewriterOn": True or False, |
| "appendedSearchContextCount": 42, |
| "conversationTranscriptHasMixedLanguages": True or False, |
| "disableSyncDelivery": True or False, |
| "endUserMetadataIncluded": True or False, |
| "invalidItemsQuerySuggestionSkipped": True or False, |
| "multipleQueriesGenerated": True or False, |
| "previousQueriesIncluded": True or False, |
| "primaryQueryRedactedAndReplaced": True or False, |
| "queryContainedSearchContext": True or False, |
| "queryGenerationAgentLanguageMismatch": True or False, |
| "queryGenerationEndUserLanguageMismatch": True or False, |
| "returnQueryOnly": True or False, |
| "thirdPartyConnectorAllowed": True or False, |
| "useCustomSafetyFilterLevel": True or False, |
| "usePubsubDelivery": True or False, |
| "useTranslatedMessage": True or False, |
| }, |
| "queryCategorizationFailureReason": "A String", |
| "queryGenerationDebugInfo": { |
| "candidatesTokenCount": 42, |
| "promptTokenCount": 42, |
| "totalTokenCount": 42, |
| }, |
| "queryGenerationFailureReason": "A String", |
| "serviceLatency": { |
| "internalServiceLatencies": [ |
| { |
| "completeTime": "A String", |
| "latencyMs": 3.14, |
| "startTime": "A String", |
| "step": "A String", |
| }, |
| ], |
| }, |
| }, |
| "suggestedQuery": { |
| "queryText": "A String", |
| "searchContexts": [ |
| { |
| "key": "A String", |
| "value": "A String", |
| }, |
| ], |
| }, |
| "suggestedQueryAnswer": { |
| "answerText": "A String", |
| "eventSource": { |
| "event": "A String", |
| "snippets": { |
| "snippets": [ |
| { |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| "title": "A String", |
| "uri": "A String", |
| }, |
| ], |
| }, |
| }, |
| "faqSource": { |
| "question": "A String", |
| }, |
| "generativeSource": { |
| "snippets": [ |
| { |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| "title": "A String", |
| "uri": "A String", |
| }, |
| ], |
| }, |
| "playbookSource": { |
| "snippets": [ |
| { |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| "title": "A String", |
| "uri": "A String", |
| }, |
| ], |
| }, |
| }, |
| }, |
| "latestMessage": "A String", |
| }, |
| "suggestSmartRepliesResponse": { |
| "contextSize": 42, |
| "latestMessage": "A String", |
| "smartReplyAnswers": [ |
| { |
| "answerRecord": "A String", |
| "confidence": 3.14, |
| "reply": "A String", |
| }, |
| ], |
| }, |
| }, |
| ], |
| "message": { |
| "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", |
| "sendTime": "A String", |
| "sentimentAnalysis": { |
| "queryTextSentiment": { |
| "magnitude": 3.14, |
| "score": 3.14, |
| }, |
| }, |
| }, |
| "replyAudio": { |
| "audio": "A String", |
| "config": { |
| "audioEncoding": "A String", |
| "sampleRateHertz": 42, |
| "synthesizeSpeechConfig": { |
| "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, |
| }, |
| }, |
| }, |
| "replyText": "A String", |
| }</pre> |
| </div> |
| |
| <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, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| parent: string, A parameter (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "agentDesktopSource": "A String", |
| "documentsMetadataFilters": { |
| "a_key": "A String", |
| }, |
| "name": "A String", |
| "obfuscatedExternalUserId": "A String", |
| "role": "A String", |
| "sipRecordingMediaLabel": "A String", |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "agentDesktopSource": "A String", |
| "documentsMetadataFilters": { |
| "a_key": "A String", |
| }, |
| "name": "A String", |
| "obfuscatedExternalUserId": "A String", |
| "role": "A String", |
| "sipRecordingMediaLabel": "A String", |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| name: string, A parameter (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "agentDesktopSource": "A String", |
| "documentsMetadataFilters": { |
| "a_key": "A String", |
| }, |
| "name": "A String", |
| "obfuscatedExternalUserId": "A String", |
| "role": "A String", |
| "sipRecordingMediaLabel": "A String", |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| parent: string, A parameter (required) |
| pageSize: integer, A parameter |
| pageToken: string, A parameter |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "nextPageToken": "A String", |
| "participants": [ |
| { |
| "agentDesktopSource": "A String", |
| "documentsMetadataFilters": { |
| "a_key": "A String", |
| }, |
| "name": "A String", |
| "obfuscatedExternalUserId": "A String", |
| "role": "A String", |
| "sipRecordingMediaLabel": "A String", |
| }, |
| ], |
| }</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 'execute()' 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> |
| |
| Args: |
| name: string, A parameter (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "agentDesktopSource": "A String", |
| "documentsMetadataFilters": { |
| "a_key": "A String", |
| }, |
| "name": "A String", |
| "obfuscatedExternalUserId": "A String", |
| "role": "A String", |
| "sipRecordingMediaLabel": "A String", |
| } |
| |
| updateMask: string, A parameter |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "agentDesktopSource": "A String", |
| "documentsMetadataFilters": { |
| "a_key": "A String", |
| }, |
| "name": "A String", |
| "obfuscatedExternalUserId": "A String", |
| "role": "A String", |
| "sipRecordingMediaLabel": "A String", |
| }</pre> |
| </div> |
| |
| </body></html> |