| <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_v3.html">Dialogflow API</a> . <a href="dialogflow_v3.projects.html">projects</a> . <a href="dialogflow_v3.projects.locations.html">locations</a> . <a href="dialogflow_v3.projects.locations.agents.html">agents</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.changelogs.html">changelogs()</a></code> | |
| </p> | |
| <p class="firstline">Returns the changelogs Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.entityTypes.html">entityTypes()</a></code> | |
| </p> | |
| <p class="firstline">Returns the entityTypes Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.environments.html">environments()</a></code> | |
| </p> | |
| <p class="firstline">Returns the environments Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.flows.html">flows()</a></code> | |
| </p> | |
| <p class="firstline">Returns the flows Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.generators.html">generators()</a></code> | |
| </p> | |
| <p class="firstline">Returns the generators Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.intents.html">intents()</a></code> | |
| </p> | |
| <p class="firstline">Returns the intents Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.playbooks.html">playbooks()</a></code> | |
| </p> | |
| <p class="firstline">Returns the playbooks Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.sessions.html">sessions()</a></code> | |
| </p> | |
| <p class="firstline">Returns the sessions Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.testCases.html">testCases()</a></code> | |
| </p> | |
| <p class="firstline">Returns the testCases Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.tools.html">tools()</a></code> | |
| </p> | |
| <p class="firstline">Returns the tools Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.transitionRouteGroups.html">transitionRouteGroups()</a></code> | |
| </p> | |
| <p class="firstline">Returns the transitionRouteGroups Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="dialogflow_v3.projects.locations.agents.webhooks.html">webhooks()</a></code> | |
| </p> | |
| <p class="firstline">Returns the webhooks 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="#create">create(parent, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline"></p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline"></p> | |
| <p class="toc_element"> | |
| <code><a href="#export">export(name, 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="#getGenerativeSettings">getGenerativeSettings(name, languageCode=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline"></p> | |
| <p class="toc_element"> | |
| <code><a href="#getValidationResult">getValidationResult(name, languageCode=None, 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(previous_request, previous_response)</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> | |
| <p class="toc_element"> | |
| <code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline"></p> | |
| <p class="toc_element"> | |
| <code><a href="#updateGenerativeSettings">updateGenerativeSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline"></p> | |
| <p class="toc_element"> | |
| <code><a href="#validate">validate(name, 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="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: | |
| { | |
| "advancedSettings": { | |
| "audioExportGcsDestination": { | |
| "uri": "A String", | |
| }, | |
| "dtmfSettings": { | |
| "enabled": True or False, | |
| "endpointingTimeoutDuration": "A String", | |
| "finishDigit": "A String", | |
| "interdigitTimeoutDuration": "A String", | |
| "maxDigits": 42, | |
| }, | |
| "loggingSettings": { | |
| "enableConsentBasedRedaction": True or False, | |
| "enableInteractionLogging": True or False, | |
| "enableStackdriverLogging": True or False, | |
| }, | |
| "speechSettings": { | |
| "endpointerSensitivity": 42, | |
| "models": { | |
| "a_key": "A String", | |
| }, | |
| "noSpeechTimeout": "A String", | |
| "useTimeoutBasedEndpointing": True or False, | |
| }, | |
| }, | |
| "answerFeedbackSettings": { | |
| "enableAnswerFeedback": True or False, | |
| }, | |
| "avatarUri": "A String", | |
| "clientCertificateSettings": { | |
| "passphrase": "A String", | |
| "privateKey": "A String", | |
| "sslCertificate": "A String", | |
| }, | |
| "defaultLanguageCode": "A String", | |
| "description": "A String", | |
| "displayName": "A String", | |
| "enableMultiLanguageTraining": True or False, | |
| "enableSpellCorrection": True or False, | |
| "enableStackdriverLogging": True or False, | |
| "genAppBuilderSettings": { | |
| "engine": "A String", | |
| }, | |
| "gitIntegrationSettings": { | |
| "githubSettings": { | |
| "accessToken": "A String", | |
| "branches": [ | |
| "A String", | |
| ], | |
| "displayName": "A String", | |
| "repositoryUri": "A String", | |
| "trackingBranch": "A String", | |
| }, | |
| }, | |
| "locked": True or False, | |
| "name": "A String", | |
| "personalizationSettings": { | |
| "defaultEndUserMetadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| "satisfiesPzi": True or False, | |
| "satisfiesPzs": True or False, | |
| "securitySettings": "A String", | |
| "speechToTextSettings": { | |
| "enableSpeechAdaptation": True or False, | |
| }, | |
| "startFlow": "A String", | |
| "startPlaybook": "A String", | |
| "supportedLanguageCodes": [ | |
| "A String", | |
| ], | |
| "textToSpeechSettings": { | |
| "synthesizeSpeechConfigs": { | |
| "a_key": { | |
| "effectsProfileId": [ | |
| "A String", | |
| ], | |
| "pitch": 3.14, | |
| "speakingRate": 3.14, | |
| "voice": { | |
| "name": "A String", | |
| "ssmlGender": "A String", | |
| }, | |
| "volumeGainDb": 3.14, | |
| }, | |
| }, | |
| }, | |
| "timeZone": "A String", | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "advancedSettings": { | |
| "audioExportGcsDestination": { | |
| "uri": "A String", | |
| }, | |
| "dtmfSettings": { | |
| "enabled": True or False, | |
| "endpointingTimeoutDuration": "A String", | |
| "finishDigit": "A String", | |
| "interdigitTimeoutDuration": "A String", | |
| "maxDigits": 42, | |
| }, | |
| "loggingSettings": { | |
| "enableConsentBasedRedaction": True or False, | |
| "enableInteractionLogging": True or False, | |
| "enableStackdriverLogging": True or False, | |
| }, | |
| "speechSettings": { | |
| "endpointerSensitivity": 42, | |
| "models": { | |
| "a_key": "A String", | |
| }, | |
| "noSpeechTimeout": "A String", | |
| "useTimeoutBasedEndpointing": True or False, | |
| }, | |
| }, | |
| "answerFeedbackSettings": { | |
| "enableAnswerFeedback": True or False, | |
| }, | |
| "avatarUri": "A String", | |
| "clientCertificateSettings": { | |
| "passphrase": "A String", | |
| "privateKey": "A String", | |
| "sslCertificate": "A String", | |
| }, | |
| "defaultLanguageCode": "A String", | |
| "description": "A String", | |
| "displayName": "A String", | |
| "enableMultiLanguageTraining": True or False, | |
| "enableSpellCorrection": True or False, | |
| "enableStackdriverLogging": True or False, | |
| "genAppBuilderSettings": { | |
| "engine": "A String", | |
| }, | |
| "gitIntegrationSettings": { | |
| "githubSettings": { | |
| "accessToken": "A String", | |
| "branches": [ | |
| "A String", | |
| ], | |
| "displayName": "A String", | |
| "repositoryUri": "A String", | |
| "trackingBranch": "A String", | |
| }, | |
| }, | |
| "locked": True or False, | |
| "name": "A String", | |
| "personalizationSettings": { | |
| "defaultEndUserMetadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| "satisfiesPzi": True or False, | |
| "satisfiesPzs": True or False, | |
| "securitySettings": "A String", | |
| "speechToTextSettings": { | |
| "enableSpeechAdaptation": True or False, | |
| }, | |
| "startFlow": "A String", | |
| "startPlaybook": "A String", | |
| "supportedLanguageCodes": [ | |
| "A String", | |
| ], | |
| "textToSpeechSettings": { | |
| "synthesizeSpeechConfigs": { | |
| "a_key": { | |
| "effectsProfileId": [ | |
| "A String", | |
| ], | |
| "pitch": 3.14, | |
| "speakingRate": 3.14, | |
| "voice": { | |
| "name": "A String", | |
| "ssmlGender": "A String", | |
| }, | |
| "volumeGainDb": 3.14, | |
| }, | |
| }, | |
| }, | |
| "timeZone": "A String", | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(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: | |
| { | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="export">export(name, body=None, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| name: string, A parameter (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "agentUri": "A String", | |
| "dataFormat": "A String", | |
| "environment": "A String", | |
| "gitDestination": { | |
| "commitMessage": "A String", | |
| "trackingBranch": "A String", | |
| }, | |
| "includeBigqueryExportSettings": True or False, | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "done": True or False, | |
| "error": { | |
| "code": 42, | |
| "details": [ | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", | |
| }, | |
| "metadata": { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", | |
| "response": { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</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: | |
| { | |
| "advancedSettings": { | |
| "audioExportGcsDestination": { | |
| "uri": "A String", | |
| }, | |
| "dtmfSettings": { | |
| "enabled": True or False, | |
| "endpointingTimeoutDuration": "A String", | |
| "finishDigit": "A String", | |
| "interdigitTimeoutDuration": "A String", | |
| "maxDigits": 42, | |
| }, | |
| "loggingSettings": { | |
| "enableConsentBasedRedaction": True or False, | |
| "enableInteractionLogging": True or False, | |
| "enableStackdriverLogging": True or False, | |
| }, | |
| "speechSettings": { | |
| "endpointerSensitivity": 42, | |
| "models": { | |
| "a_key": "A String", | |
| }, | |
| "noSpeechTimeout": "A String", | |
| "useTimeoutBasedEndpointing": True or False, | |
| }, | |
| }, | |
| "answerFeedbackSettings": { | |
| "enableAnswerFeedback": True or False, | |
| }, | |
| "avatarUri": "A String", | |
| "clientCertificateSettings": { | |
| "passphrase": "A String", | |
| "privateKey": "A String", | |
| "sslCertificate": "A String", | |
| }, | |
| "defaultLanguageCode": "A String", | |
| "description": "A String", | |
| "displayName": "A String", | |
| "enableMultiLanguageTraining": True or False, | |
| "enableSpellCorrection": True or False, | |
| "enableStackdriverLogging": True or False, | |
| "genAppBuilderSettings": { | |
| "engine": "A String", | |
| }, | |
| "gitIntegrationSettings": { | |
| "githubSettings": { | |
| "accessToken": "A String", | |
| "branches": [ | |
| "A String", | |
| ], | |
| "displayName": "A String", | |
| "repositoryUri": "A String", | |
| "trackingBranch": "A String", | |
| }, | |
| }, | |
| "locked": True or False, | |
| "name": "A String", | |
| "personalizationSettings": { | |
| "defaultEndUserMetadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| "satisfiesPzi": True or False, | |
| "satisfiesPzs": True or False, | |
| "securitySettings": "A String", | |
| "speechToTextSettings": { | |
| "enableSpeechAdaptation": True or False, | |
| }, | |
| "startFlow": "A String", | |
| "startPlaybook": "A String", | |
| "supportedLanguageCodes": [ | |
| "A String", | |
| ], | |
| "textToSpeechSettings": { | |
| "synthesizeSpeechConfigs": { | |
| "a_key": { | |
| "effectsProfileId": [ | |
| "A String", | |
| ], | |
| "pitch": 3.14, | |
| "speakingRate": 3.14, | |
| "voice": { | |
| "name": "A String", | |
| "ssmlGender": "A String", | |
| }, | |
| "volumeGainDb": 3.14, | |
| }, | |
| }, | |
| }, | |
| "timeZone": "A String", | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getGenerativeSettings">getGenerativeSettings(name, languageCode=None, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| name: string, A parameter (required) | |
| languageCode: 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: | |
| { | |
| "fallbackSettings": { | |
| "promptTemplates": [ | |
| { | |
| "displayName": "A String", | |
| "frozen": True or False, | |
| "promptText": "A String", | |
| }, | |
| ], | |
| "selectedPrompt": "A String", | |
| }, | |
| "generativeSafetySettings": { | |
| "bannedPhrases": [ | |
| { | |
| "languageCode": "A String", | |
| "text": "A String", | |
| }, | |
| ], | |
| "defaultBannedPhraseMatchStrategy": "A String", | |
| "defaultRaiSettings": { | |
| "categoryFilters": [ | |
| { | |
| "category": "A String", | |
| "filterLevel": "A String", | |
| }, | |
| ], | |
| }, | |
| "promptSecuritySettings": { | |
| "enablePromptSecurity": True or False, | |
| }, | |
| "raiSettings": { | |
| "categoryFilters": [ | |
| { | |
| "category": "A String", | |
| "filterLevel": "A String", | |
| }, | |
| ], | |
| }, | |
| }, | |
| "knowledgeConnectorSettings": { | |
| "agent": "A String", | |
| "agentIdentity": "A String", | |
| "agentScope": "A String", | |
| "business": "A String", | |
| "businessDescription": "A String", | |
| "disableDataStoreFallback": True or False, | |
| }, | |
| "languageCode": "A String", | |
| "llmModelSettings": { | |
| "model": "A String", | |
| "promptText": "A String", | |
| }, | |
| "name": "A String", | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getValidationResult">getValidationResult(name, languageCode=None, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| name: string, A parameter (required) | |
| languageCode: 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: | |
| { | |
| "flowValidationResults": [ | |
| { | |
| "name": "A String", | |
| "updateTime": "A String", | |
| "validationMessages": [ | |
| { | |
| "detail": "A String", | |
| "resourceNames": [ | |
| { | |
| "displayName": "A String", | |
| "name": "A String", | |
| }, | |
| ], | |
| "resourceType": "A String", | |
| "resources": [ | |
| "A String", | |
| ], | |
| "severity": "A String", | |
| }, | |
| ], | |
| }, | |
| ], | |
| "name": "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: | |
| { | |
| "agents": [ | |
| { | |
| "advancedSettings": { | |
| "audioExportGcsDestination": { | |
| "uri": "A String", | |
| }, | |
| "dtmfSettings": { | |
| "enabled": True or False, | |
| "endpointingTimeoutDuration": "A String", | |
| "finishDigit": "A String", | |
| "interdigitTimeoutDuration": "A String", | |
| "maxDigits": 42, | |
| }, | |
| "loggingSettings": { | |
| "enableConsentBasedRedaction": True or False, | |
| "enableInteractionLogging": True or False, | |
| "enableStackdriverLogging": True or False, | |
| }, | |
| "speechSettings": { | |
| "endpointerSensitivity": 42, | |
| "models": { | |
| "a_key": "A String", | |
| }, | |
| "noSpeechTimeout": "A String", | |
| "useTimeoutBasedEndpointing": True or False, | |
| }, | |
| }, | |
| "answerFeedbackSettings": { | |
| "enableAnswerFeedback": True or False, | |
| }, | |
| "avatarUri": "A String", | |
| "clientCertificateSettings": { | |
| "passphrase": "A String", | |
| "privateKey": "A String", | |
| "sslCertificate": "A String", | |
| }, | |
| "defaultLanguageCode": "A String", | |
| "description": "A String", | |
| "displayName": "A String", | |
| "enableMultiLanguageTraining": True or False, | |
| "enableSpellCorrection": True or False, | |
| "enableStackdriverLogging": True or False, | |
| "genAppBuilderSettings": { | |
| "engine": "A String", | |
| }, | |
| "gitIntegrationSettings": { | |
| "githubSettings": { | |
| "accessToken": "A String", | |
| "branches": [ | |
| "A String", | |
| ], | |
| "displayName": "A String", | |
| "repositoryUri": "A String", | |
| "trackingBranch": "A String", | |
| }, | |
| }, | |
| "locked": True or False, | |
| "name": "A String", | |
| "personalizationSettings": { | |
| "defaultEndUserMetadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| "satisfiesPzi": True or False, | |
| "satisfiesPzs": True or False, | |
| "securitySettings": "A String", | |
| "speechToTextSettings": { | |
| "enableSpeechAdaptation": True or False, | |
| }, | |
| "startFlow": "A String", | |
| "startPlaybook": "A String", | |
| "supportedLanguageCodes": [ | |
| "A String", | |
| ], | |
| "textToSpeechSettings": { | |
| "synthesizeSpeechConfigs": { | |
| "a_key": { | |
| "effectsProfileId": [ | |
| "A String", | |
| ], | |
| "pitch": 3.14, | |
| "speakingRate": 3.14, | |
| "voice": { | |
| "name": "A String", | |
| "ssmlGender": "A String", | |
| }, | |
| "volumeGainDb": 3.14, | |
| }, | |
| }, | |
| }, | |
| "timeZone": "A String", | |
| }, | |
| ], | |
| "nextPageToken": "A String", | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</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: | |
| { | |
| "advancedSettings": { | |
| "audioExportGcsDestination": { | |
| "uri": "A String", | |
| }, | |
| "dtmfSettings": { | |
| "enabled": True or False, | |
| "endpointingTimeoutDuration": "A String", | |
| "finishDigit": "A String", | |
| "interdigitTimeoutDuration": "A String", | |
| "maxDigits": 42, | |
| }, | |
| "loggingSettings": { | |
| "enableConsentBasedRedaction": True or False, | |
| "enableInteractionLogging": True or False, | |
| "enableStackdriverLogging": True or False, | |
| }, | |
| "speechSettings": { | |
| "endpointerSensitivity": 42, | |
| "models": { | |
| "a_key": "A String", | |
| }, | |
| "noSpeechTimeout": "A String", | |
| "useTimeoutBasedEndpointing": True or False, | |
| }, | |
| }, | |
| "answerFeedbackSettings": { | |
| "enableAnswerFeedback": True or False, | |
| }, | |
| "avatarUri": "A String", | |
| "clientCertificateSettings": { | |
| "passphrase": "A String", | |
| "privateKey": "A String", | |
| "sslCertificate": "A String", | |
| }, | |
| "defaultLanguageCode": "A String", | |
| "description": "A String", | |
| "displayName": "A String", | |
| "enableMultiLanguageTraining": True or False, | |
| "enableSpellCorrection": True or False, | |
| "enableStackdriverLogging": True or False, | |
| "genAppBuilderSettings": { | |
| "engine": "A String", | |
| }, | |
| "gitIntegrationSettings": { | |
| "githubSettings": { | |
| "accessToken": "A String", | |
| "branches": [ | |
| "A String", | |
| ], | |
| "displayName": "A String", | |
| "repositoryUri": "A String", | |
| "trackingBranch": "A String", | |
| }, | |
| }, | |
| "locked": True or False, | |
| "name": "A String", | |
| "personalizationSettings": { | |
| "defaultEndUserMetadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| "satisfiesPzi": True or False, | |
| "satisfiesPzs": True or False, | |
| "securitySettings": "A String", | |
| "speechToTextSettings": { | |
| "enableSpeechAdaptation": True or False, | |
| }, | |
| "startFlow": "A String", | |
| "startPlaybook": "A String", | |
| "supportedLanguageCodes": [ | |
| "A String", | |
| ], | |
| "textToSpeechSettings": { | |
| "synthesizeSpeechConfigs": { | |
| "a_key": { | |
| "effectsProfileId": [ | |
| "A String", | |
| ], | |
| "pitch": 3.14, | |
| "speakingRate": 3.14, | |
| "voice": { | |
| "name": "A String", | |
| "ssmlGender": "A String", | |
| }, | |
| "volumeGainDb": 3.14, | |
| }, | |
| }, | |
| }, | |
| "timeZone": "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: | |
| { | |
| "advancedSettings": { | |
| "audioExportGcsDestination": { | |
| "uri": "A String", | |
| }, | |
| "dtmfSettings": { | |
| "enabled": True or False, | |
| "endpointingTimeoutDuration": "A String", | |
| "finishDigit": "A String", | |
| "interdigitTimeoutDuration": "A String", | |
| "maxDigits": 42, | |
| }, | |
| "loggingSettings": { | |
| "enableConsentBasedRedaction": True or False, | |
| "enableInteractionLogging": True or False, | |
| "enableStackdriverLogging": True or False, | |
| }, | |
| "speechSettings": { | |
| "endpointerSensitivity": 42, | |
| "models": { | |
| "a_key": "A String", | |
| }, | |
| "noSpeechTimeout": "A String", | |
| "useTimeoutBasedEndpointing": True or False, | |
| }, | |
| }, | |
| "answerFeedbackSettings": { | |
| "enableAnswerFeedback": True or False, | |
| }, | |
| "avatarUri": "A String", | |
| "clientCertificateSettings": { | |
| "passphrase": "A String", | |
| "privateKey": "A String", | |
| "sslCertificate": "A String", | |
| }, | |
| "defaultLanguageCode": "A String", | |
| "description": "A String", | |
| "displayName": "A String", | |
| "enableMultiLanguageTraining": True or False, | |
| "enableSpellCorrection": True or False, | |
| "enableStackdriverLogging": True or False, | |
| "genAppBuilderSettings": { | |
| "engine": "A String", | |
| }, | |
| "gitIntegrationSettings": { | |
| "githubSettings": { | |
| "accessToken": "A String", | |
| "branches": [ | |
| "A String", | |
| ], | |
| "displayName": "A String", | |
| "repositoryUri": "A String", | |
| "trackingBranch": "A String", | |
| }, | |
| }, | |
| "locked": True or False, | |
| "name": "A String", | |
| "personalizationSettings": { | |
| "defaultEndUserMetadata": { | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| "satisfiesPzi": True or False, | |
| "satisfiesPzs": True or False, | |
| "securitySettings": "A String", | |
| "speechToTextSettings": { | |
| "enableSpeechAdaptation": True or False, | |
| }, | |
| "startFlow": "A String", | |
| "startPlaybook": "A String", | |
| "supportedLanguageCodes": [ | |
| "A String", | |
| ], | |
| "textToSpeechSettings": { | |
| "synthesizeSpeechConfigs": { | |
| "a_key": { | |
| "effectsProfileId": [ | |
| "A String", | |
| ], | |
| "pitch": 3.14, | |
| "speakingRate": 3.14, | |
| "voice": { | |
| "name": "A String", | |
| "ssmlGender": "A String", | |
| }, | |
| "volumeGainDb": 3.14, | |
| }, | |
| }, | |
| }, | |
| "timeZone": "A String", | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| name: string, A parameter (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "agentContent": "A String", | |
| "agentUri": "A String", | |
| "gitSource": { | |
| "trackingBranch": "A String", | |
| }, | |
| "restoreOption": "A String", | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "done": True or False, | |
| "error": { | |
| "code": 42, | |
| "details": [ | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", | |
| }, | |
| "metadata": { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", | |
| "response": { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="updateGenerativeSettings">updateGenerativeSettings(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: | |
| { | |
| "fallbackSettings": { | |
| "promptTemplates": [ | |
| { | |
| "displayName": "A String", | |
| "frozen": True or False, | |
| "promptText": "A String", | |
| }, | |
| ], | |
| "selectedPrompt": "A String", | |
| }, | |
| "generativeSafetySettings": { | |
| "bannedPhrases": [ | |
| { | |
| "languageCode": "A String", | |
| "text": "A String", | |
| }, | |
| ], | |
| "defaultBannedPhraseMatchStrategy": "A String", | |
| "defaultRaiSettings": { | |
| "categoryFilters": [ | |
| { | |
| "category": "A String", | |
| "filterLevel": "A String", | |
| }, | |
| ], | |
| }, | |
| "promptSecuritySettings": { | |
| "enablePromptSecurity": True or False, | |
| }, | |
| "raiSettings": { | |
| "categoryFilters": [ | |
| { | |
| "category": "A String", | |
| "filterLevel": "A String", | |
| }, | |
| ], | |
| }, | |
| }, | |
| "knowledgeConnectorSettings": { | |
| "agent": "A String", | |
| "agentIdentity": "A String", | |
| "agentScope": "A String", | |
| "business": "A String", | |
| "businessDescription": "A String", | |
| "disableDataStoreFallback": True or False, | |
| }, | |
| "languageCode": "A String", | |
| "llmModelSettings": { | |
| "model": "A String", | |
| "promptText": "A String", | |
| }, | |
| "name": "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: | |
| { | |
| "fallbackSettings": { | |
| "promptTemplates": [ | |
| { | |
| "displayName": "A String", | |
| "frozen": True or False, | |
| "promptText": "A String", | |
| }, | |
| ], | |
| "selectedPrompt": "A String", | |
| }, | |
| "generativeSafetySettings": { | |
| "bannedPhrases": [ | |
| { | |
| "languageCode": "A String", | |
| "text": "A String", | |
| }, | |
| ], | |
| "defaultBannedPhraseMatchStrategy": "A String", | |
| "defaultRaiSettings": { | |
| "categoryFilters": [ | |
| { | |
| "category": "A String", | |
| "filterLevel": "A String", | |
| }, | |
| ], | |
| }, | |
| "promptSecuritySettings": { | |
| "enablePromptSecurity": True or False, | |
| }, | |
| "raiSettings": { | |
| "categoryFilters": [ | |
| { | |
| "category": "A String", | |
| "filterLevel": "A String", | |
| }, | |
| ], | |
| }, | |
| }, | |
| "knowledgeConnectorSettings": { | |
| "agent": "A String", | |
| "agentIdentity": "A String", | |
| "agentScope": "A String", | |
| "business": "A String", | |
| "businessDescription": "A String", | |
| "disableDataStoreFallback": True or False, | |
| }, | |
| "languageCode": "A String", | |
| "llmModelSettings": { | |
| "model": "A String", | |
| "promptText": "A String", | |
| }, | |
| "name": "A String", | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="validate">validate(name, body=None, x__xgafv=None)</code> | |
| <pre> | |
| Args: | |
| name: string, A parameter (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "languageCode": "A String", | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "flowValidationResults": [ | |
| { | |
| "name": "A String", | |
| "updateTime": "A String", | |
| "validationMessages": [ | |
| { | |
| "detail": "A String", | |
| "resourceNames": [ | |
| { | |
| "displayName": "A String", | |
| "name": "A String", | |
| }, | |
| ], | |
| "resourceType": "A String", | |
| "resources": [ | |
| "A String", | |
| ], | |
| "severity": "A String", | |
| }, | |
| ], | |
| }, | |
| ], | |
| "name": "A String", | |
| }</pre> | |
| </div> | |
| </body></html> |