| <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.agent.html">agent</a> . <a href="dialogflow_v2.projects.locations.agent.environments.html">environments</a> . <a href="dialogflow_v2.projects.locations.agent.environments.users.html">users</a> . <a href="dialogflow_v2.projects.locations.agent.environments.users.sessions.html">sessions</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v2.projects.locations.agent.environments.users.sessions.contexts.html">contexts()</a></code> | |
| </p> | |
| <p class="firstline">Returns the contexts Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v2.projects.locations.agent.environments.users.sessions.entityTypes.html">entityTypes()</a></code> | |
| </p> | |
| <p class="firstline">Returns the entityTypes Resource.</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="#deleteContexts">deleteContexts(parent, x__xgafv=None)</a></code></p> | |
| <p class="firstline"></p> | |
| <p class="toc_element"> | |
| <code><a href="#detectIntent">detectIntent(session, 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="deleteContexts">deleteContexts(parent, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| parent: 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: | |
| { | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="detectIntent">detectIntent(session, body=None, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| session: string, A parameter (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "inputAudio": "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, | |
| }, | |
| }, | |
| "outputAudioConfigMask": "A String", | |
| "queryInput": { | |
| "audioConfig": { | |
| "audioEncoding": "A String", | |
| "disableInterimInputTranscripts": True or False, | |
| "disableNoSpeechRecognizedEvent": True or False, | |
| "enableAutomaticPunctuation": True or False, | |
| "enableVoiceActivityEvents": True or False, | |
| "enableWordInfo": True or False, | |
| "geminiAsrConfig": { | |
| "endOfSpeechSensitivity": "A String", | |
| "prefixPaddingMs": 42, | |
| "silenceDurationMs": 42, | |
| "startOfSpeechSensitivity": "A String", | |
| }, | |
| "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", | |
| ], | |
| }, | |
| ], | |
| "useGeminiAsr": True or False, | |
| }, | |
| "event": { | |
| "languageCode": "A String", | |
| "name": "A String", | |
| "parameters": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| "text": { | |
| "languageCode": "A String", | |
| "text": "A String", | |
| }, | |
| }, | |
| "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", | |
| }, | |
| }, | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "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", | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |