| <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_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.playbooks.html">playbooks</a> . <a href="dialogflow_v3beta1.projects.locations.agents.playbooks.examples.html">examples</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="#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="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, languageCode=None, 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="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: |
| |
| { |
| "actions": [ |
| { |
| "agentUtterance": { |
| "requireGeneration": True or False, |
| "text": "A String", |
| }, |
| "completeTime": "A String", |
| "displayName": "A String", |
| "event": { |
| "event": "A String", |
| "text": "A String", |
| }, |
| "flowInvocation": { |
| "displayName": "A String", |
| "flow": "A String", |
| "flowState": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { |
| "destination": "A String", |
| "eventType": "A String", |
| "functionCall": { |
| "name": "A String", |
| }, |
| "pageState": { |
| "displayName": "A String", |
| "page": "A String", |
| "status": "A String", |
| }, |
| "updatedParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { |
| "displayName": "A String", |
| "flow": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { |
| "matchedIntents": [ |
| { |
| "displayName": "A String", |
| "generativeFallback": { |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", |
| "score": 3.14, |
| }, |
| ], |
| }, |
| "llmCall": { |
| "model": "A String", |
| "retrievedExamples": [ |
| { |
| "exampleDisplayName": "A String", |
| "exampleId": "A String", |
| "matchedRetrievalLabel": "A String", |
| "retrievalStrategy": "A String", |
| }, |
| ], |
| "temperature": 3.14, |
| "tokenCount": { |
| "conversationContextTokenCount": "A String", |
| "exampleTokenCount": "A String", |
| "totalInputTokenCount": "A String", |
| "totalOutputTokenCount": "A String", |
| }, |
| }, |
| "playbookInvocation": { |
| "displayName": "A String", |
| "playbook": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "playbookState": "A String", |
| }, |
| "playbookTransition": { |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", |
| }, |
| "startTime": "A String", |
| "status": { |
| "exception": { |
| "errorMessage": "A String", |
| }, |
| }, |
| "stt": { |
| }, |
| "subExecutionSteps": [ |
| { |
| "completeTime": "A String", |
| "metrics": [ |
| { |
| "name": "A String", |
| "unit": "A String", |
| "value": "", |
| }, |
| ], |
| "name": "A String", |
| "startTime": "A String", |
| "tags": [ |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { |
| "action": "A String", |
| "dataStoreToolTrace": { |
| "dataStoreConnectionSignals": { |
| "answer": "A String", |
| "answerGenerationModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "answerParts": [ |
| { |
| "supportingIndices": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| ], |
| "citedSnippets": [ |
| { |
| "searchSnippet": { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| "snippetIndex": 42, |
| }, |
| ], |
| "groundingSignals": { |
| "decision": "A String", |
| "score": "A String", |
| }, |
| "rewriterModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "rewrittenQuery": "A String", |
| "safetySignals": { |
| "bannedPhraseMatch": "A String", |
| "decision": "A String", |
| "matchedBannedPhrase": "A String", |
| }, |
| "searchSnippets": [ |
| { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", |
| "webhookToolTrace": { |
| "webhookTag": "A String", |
| "webhookUri": "A String", |
| }, |
| }, |
| "tts": { |
| }, |
| "userUtterance": { |
| "audio": "A String", |
| "audioTokens": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| }, |
| ], |
| "conversationState": "A String", |
| "createTime": "A String", |
| "description": "A String", |
| "displayName": "A String", |
| "languageCode": "A String", |
| "name": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "tokenCount": "A String", |
| "updateTime": "A String", |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "actions": [ |
| { |
| "agentUtterance": { |
| "requireGeneration": True or False, |
| "text": "A String", |
| }, |
| "completeTime": "A String", |
| "displayName": "A String", |
| "event": { |
| "event": "A String", |
| "text": "A String", |
| }, |
| "flowInvocation": { |
| "displayName": "A String", |
| "flow": "A String", |
| "flowState": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { |
| "destination": "A String", |
| "eventType": "A String", |
| "functionCall": { |
| "name": "A String", |
| }, |
| "pageState": { |
| "displayName": "A String", |
| "page": "A String", |
| "status": "A String", |
| }, |
| "updatedParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { |
| "displayName": "A String", |
| "flow": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { |
| "matchedIntents": [ |
| { |
| "displayName": "A String", |
| "generativeFallback": { |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", |
| "score": 3.14, |
| }, |
| ], |
| }, |
| "llmCall": { |
| "model": "A String", |
| "retrievedExamples": [ |
| { |
| "exampleDisplayName": "A String", |
| "exampleId": "A String", |
| "matchedRetrievalLabel": "A String", |
| "retrievalStrategy": "A String", |
| }, |
| ], |
| "temperature": 3.14, |
| "tokenCount": { |
| "conversationContextTokenCount": "A String", |
| "exampleTokenCount": "A String", |
| "totalInputTokenCount": "A String", |
| "totalOutputTokenCount": "A String", |
| }, |
| }, |
| "playbookInvocation": { |
| "displayName": "A String", |
| "playbook": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "playbookState": "A String", |
| }, |
| "playbookTransition": { |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", |
| }, |
| "startTime": "A String", |
| "status": { |
| "exception": { |
| "errorMessage": "A String", |
| }, |
| }, |
| "stt": { |
| }, |
| "subExecutionSteps": [ |
| { |
| "completeTime": "A String", |
| "metrics": [ |
| { |
| "name": "A String", |
| "unit": "A String", |
| "value": "", |
| }, |
| ], |
| "name": "A String", |
| "startTime": "A String", |
| "tags": [ |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { |
| "action": "A String", |
| "dataStoreToolTrace": { |
| "dataStoreConnectionSignals": { |
| "answer": "A String", |
| "answerGenerationModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "answerParts": [ |
| { |
| "supportingIndices": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| ], |
| "citedSnippets": [ |
| { |
| "searchSnippet": { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| "snippetIndex": 42, |
| }, |
| ], |
| "groundingSignals": { |
| "decision": "A String", |
| "score": "A String", |
| }, |
| "rewriterModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "rewrittenQuery": "A String", |
| "safetySignals": { |
| "bannedPhraseMatch": "A String", |
| "decision": "A String", |
| "matchedBannedPhrase": "A String", |
| }, |
| "searchSnippets": [ |
| { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", |
| "webhookToolTrace": { |
| "webhookTag": "A String", |
| "webhookUri": "A String", |
| }, |
| }, |
| "tts": { |
| }, |
| "userUtterance": { |
| "audio": "A String", |
| "audioTokens": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| }, |
| ], |
| "conversationState": "A String", |
| "createTime": "A String", |
| "description": "A String", |
| "displayName": "A String", |
| "languageCode": "A String", |
| "name": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "tokenCount": "A String", |
| "updateTime": "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="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: |
| |
| { |
| "actions": [ |
| { |
| "agentUtterance": { |
| "requireGeneration": True or False, |
| "text": "A String", |
| }, |
| "completeTime": "A String", |
| "displayName": "A String", |
| "event": { |
| "event": "A String", |
| "text": "A String", |
| }, |
| "flowInvocation": { |
| "displayName": "A String", |
| "flow": "A String", |
| "flowState": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { |
| "destination": "A String", |
| "eventType": "A String", |
| "functionCall": { |
| "name": "A String", |
| }, |
| "pageState": { |
| "displayName": "A String", |
| "page": "A String", |
| "status": "A String", |
| }, |
| "updatedParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { |
| "displayName": "A String", |
| "flow": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { |
| "matchedIntents": [ |
| { |
| "displayName": "A String", |
| "generativeFallback": { |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", |
| "score": 3.14, |
| }, |
| ], |
| }, |
| "llmCall": { |
| "model": "A String", |
| "retrievedExamples": [ |
| { |
| "exampleDisplayName": "A String", |
| "exampleId": "A String", |
| "matchedRetrievalLabel": "A String", |
| "retrievalStrategy": "A String", |
| }, |
| ], |
| "temperature": 3.14, |
| "tokenCount": { |
| "conversationContextTokenCount": "A String", |
| "exampleTokenCount": "A String", |
| "totalInputTokenCount": "A String", |
| "totalOutputTokenCount": "A String", |
| }, |
| }, |
| "playbookInvocation": { |
| "displayName": "A String", |
| "playbook": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "playbookState": "A String", |
| }, |
| "playbookTransition": { |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", |
| }, |
| "startTime": "A String", |
| "status": { |
| "exception": { |
| "errorMessage": "A String", |
| }, |
| }, |
| "stt": { |
| }, |
| "subExecutionSteps": [ |
| { |
| "completeTime": "A String", |
| "metrics": [ |
| { |
| "name": "A String", |
| "unit": "A String", |
| "value": "", |
| }, |
| ], |
| "name": "A String", |
| "startTime": "A String", |
| "tags": [ |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { |
| "action": "A String", |
| "dataStoreToolTrace": { |
| "dataStoreConnectionSignals": { |
| "answer": "A String", |
| "answerGenerationModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "answerParts": [ |
| { |
| "supportingIndices": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| ], |
| "citedSnippets": [ |
| { |
| "searchSnippet": { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| "snippetIndex": 42, |
| }, |
| ], |
| "groundingSignals": { |
| "decision": "A String", |
| "score": "A String", |
| }, |
| "rewriterModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "rewrittenQuery": "A String", |
| "safetySignals": { |
| "bannedPhraseMatch": "A String", |
| "decision": "A String", |
| "matchedBannedPhrase": "A String", |
| }, |
| "searchSnippets": [ |
| { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", |
| "webhookToolTrace": { |
| "webhookTag": "A String", |
| "webhookUri": "A String", |
| }, |
| }, |
| "tts": { |
| }, |
| "userUtterance": { |
| "audio": "A String", |
| "audioTokens": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| }, |
| ], |
| "conversationState": "A String", |
| "createTime": "A String", |
| "description": "A String", |
| "displayName": "A String", |
| "languageCode": "A String", |
| "name": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "tokenCount": "A String", |
| "updateTime": "A String", |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| parent: string, A parameter (required) |
| languageCode: string, A parameter |
| 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: |
| |
| { |
| "examples": [ |
| { |
| "actions": [ |
| { |
| "agentUtterance": { |
| "requireGeneration": True or False, |
| "text": "A String", |
| }, |
| "completeTime": "A String", |
| "displayName": "A String", |
| "event": { |
| "event": "A String", |
| "text": "A String", |
| }, |
| "flowInvocation": { |
| "displayName": "A String", |
| "flow": "A String", |
| "flowState": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { |
| "destination": "A String", |
| "eventType": "A String", |
| "functionCall": { |
| "name": "A String", |
| }, |
| "pageState": { |
| "displayName": "A String", |
| "page": "A String", |
| "status": "A String", |
| }, |
| "updatedParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { |
| "displayName": "A String", |
| "flow": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { |
| "matchedIntents": [ |
| { |
| "displayName": "A String", |
| "generativeFallback": { |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", |
| "score": 3.14, |
| }, |
| ], |
| }, |
| "llmCall": { |
| "model": "A String", |
| "retrievedExamples": [ |
| { |
| "exampleDisplayName": "A String", |
| "exampleId": "A String", |
| "matchedRetrievalLabel": "A String", |
| "retrievalStrategy": "A String", |
| }, |
| ], |
| "temperature": 3.14, |
| "tokenCount": { |
| "conversationContextTokenCount": "A String", |
| "exampleTokenCount": "A String", |
| "totalInputTokenCount": "A String", |
| "totalOutputTokenCount": "A String", |
| }, |
| }, |
| "playbookInvocation": { |
| "displayName": "A String", |
| "playbook": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "playbookState": "A String", |
| }, |
| "playbookTransition": { |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", |
| }, |
| "startTime": "A String", |
| "status": { |
| "exception": { |
| "errorMessage": "A String", |
| }, |
| }, |
| "stt": { |
| }, |
| "subExecutionSteps": [ |
| { |
| "completeTime": "A String", |
| "metrics": [ |
| { |
| "name": "A String", |
| "unit": "A String", |
| "value": "", |
| }, |
| ], |
| "name": "A String", |
| "startTime": "A String", |
| "tags": [ |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { |
| "action": "A String", |
| "dataStoreToolTrace": { |
| "dataStoreConnectionSignals": { |
| "answer": "A String", |
| "answerGenerationModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "answerParts": [ |
| { |
| "supportingIndices": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| ], |
| "citedSnippets": [ |
| { |
| "searchSnippet": { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| "snippetIndex": 42, |
| }, |
| ], |
| "groundingSignals": { |
| "decision": "A String", |
| "score": "A String", |
| }, |
| "rewriterModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "rewrittenQuery": "A String", |
| "safetySignals": { |
| "bannedPhraseMatch": "A String", |
| "decision": "A String", |
| "matchedBannedPhrase": "A String", |
| }, |
| "searchSnippets": [ |
| { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", |
| "webhookToolTrace": { |
| "webhookTag": "A String", |
| "webhookUri": "A String", |
| }, |
| }, |
| "tts": { |
| }, |
| "userUtterance": { |
| "audio": "A String", |
| "audioTokens": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| }, |
| ], |
| "conversationState": "A String", |
| "createTime": "A String", |
| "description": "A String", |
| "displayName": "A String", |
| "languageCode": "A String", |
| "name": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "tokenCount": "A String", |
| "updateTime": "A String", |
| }, |
| ], |
| "nextPageToken": "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: |
| |
| { |
| "actions": [ |
| { |
| "agentUtterance": { |
| "requireGeneration": True or False, |
| "text": "A String", |
| }, |
| "completeTime": "A String", |
| "displayName": "A String", |
| "event": { |
| "event": "A String", |
| "text": "A String", |
| }, |
| "flowInvocation": { |
| "displayName": "A String", |
| "flow": "A String", |
| "flowState": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { |
| "destination": "A String", |
| "eventType": "A String", |
| "functionCall": { |
| "name": "A String", |
| }, |
| "pageState": { |
| "displayName": "A String", |
| "page": "A String", |
| "status": "A String", |
| }, |
| "updatedParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { |
| "displayName": "A String", |
| "flow": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { |
| "matchedIntents": [ |
| { |
| "displayName": "A String", |
| "generativeFallback": { |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", |
| "score": 3.14, |
| }, |
| ], |
| }, |
| "llmCall": { |
| "model": "A String", |
| "retrievedExamples": [ |
| { |
| "exampleDisplayName": "A String", |
| "exampleId": "A String", |
| "matchedRetrievalLabel": "A String", |
| "retrievalStrategy": "A String", |
| }, |
| ], |
| "temperature": 3.14, |
| "tokenCount": { |
| "conversationContextTokenCount": "A String", |
| "exampleTokenCount": "A String", |
| "totalInputTokenCount": "A String", |
| "totalOutputTokenCount": "A String", |
| }, |
| }, |
| "playbookInvocation": { |
| "displayName": "A String", |
| "playbook": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "playbookState": "A String", |
| }, |
| "playbookTransition": { |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", |
| }, |
| "startTime": "A String", |
| "status": { |
| "exception": { |
| "errorMessage": "A String", |
| }, |
| }, |
| "stt": { |
| }, |
| "subExecutionSteps": [ |
| { |
| "completeTime": "A String", |
| "metrics": [ |
| { |
| "name": "A String", |
| "unit": "A String", |
| "value": "", |
| }, |
| ], |
| "name": "A String", |
| "startTime": "A String", |
| "tags": [ |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { |
| "action": "A String", |
| "dataStoreToolTrace": { |
| "dataStoreConnectionSignals": { |
| "answer": "A String", |
| "answerGenerationModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "answerParts": [ |
| { |
| "supportingIndices": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| ], |
| "citedSnippets": [ |
| { |
| "searchSnippet": { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| "snippetIndex": 42, |
| }, |
| ], |
| "groundingSignals": { |
| "decision": "A String", |
| "score": "A String", |
| }, |
| "rewriterModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "rewrittenQuery": "A String", |
| "safetySignals": { |
| "bannedPhraseMatch": "A String", |
| "decision": "A String", |
| "matchedBannedPhrase": "A String", |
| }, |
| "searchSnippets": [ |
| { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", |
| "webhookToolTrace": { |
| "webhookTag": "A String", |
| "webhookUri": "A String", |
| }, |
| }, |
| "tts": { |
| }, |
| "userUtterance": { |
| "audio": "A String", |
| "audioTokens": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| }, |
| ], |
| "conversationState": "A String", |
| "createTime": "A String", |
| "description": "A String", |
| "displayName": "A String", |
| "languageCode": "A String", |
| "name": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "tokenCount": "A String", |
| "updateTime": "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: |
| |
| { |
| "actions": [ |
| { |
| "agentUtterance": { |
| "requireGeneration": True or False, |
| "text": "A String", |
| }, |
| "completeTime": "A String", |
| "displayName": "A String", |
| "event": { |
| "event": "A String", |
| "text": "A String", |
| }, |
| "flowInvocation": { |
| "displayName": "A String", |
| "flow": "A String", |
| "flowState": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowStateUpdate": { |
| "destination": "A String", |
| "eventType": "A String", |
| "functionCall": { |
| "name": "A String", |
| }, |
| "pageState": { |
| "displayName": "A String", |
| "page": "A String", |
| "status": "A String", |
| }, |
| "updatedParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "flowTransition": { |
| "displayName": "A String", |
| "flow": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| }, |
| "intentMatch": { |
| "matchedIntents": [ |
| { |
| "displayName": "A String", |
| "generativeFallback": { |
| "a_key": "", # Properties of the object. |
| }, |
| "intentId": "A String", |
| "score": 3.14, |
| }, |
| ], |
| }, |
| "llmCall": { |
| "model": "A String", |
| "retrievedExamples": [ |
| { |
| "exampleDisplayName": "A String", |
| "exampleId": "A String", |
| "matchedRetrievalLabel": "A String", |
| "retrievalStrategy": "A String", |
| }, |
| ], |
| "temperature": 3.14, |
| "tokenCount": { |
| "conversationContextTokenCount": "A String", |
| "exampleTokenCount": "A String", |
| "totalInputTokenCount": "A String", |
| "totalOutputTokenCount": "A String", |
| }, |
| }, |
| "playbookInvocation": { |
| "displayName": "A String", |
| "playbook": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "playbookState": "A String", |
| }, |
| "playbookTransition": { |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "playbook": "A String", |
| }, |
| "startTime": "A String", |
| "status": { |
| "exception": { |
| "errorMessage": "A String", |
| }, |
| }, |
| "stt": { |
| }, |
| "subExecutionSteps": [ |
| { |
| "completeTime": "A String", |
| "metrics": [ |
| { |
| "name": "A String", |
| "unit": "A String", |
| "value": "", |
| }, |
| ], |
| "name": "A String", |
| "startTime": "A String", |
| "tags": [ |
| "A String", |
| ], |
| }, |
| ], |
| "toolUse": { |
| "action": "A String", |
| "dataStoreToolTrace": { |
| "dataStoreConnectionSignals": { |
| "answer": "A String", |
| "answerGenerationModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "answerParts": [ |
| { |
| "supportingIndices": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| ], |
| "citedSnippets": [ |
| { |
| "searchSnippet": { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| "snippetIndex": 42, |
| }, |
| ], |
| "groundingSignals": { |
| "decision": "A String", |
| "score": "A String", |
| }, |
| "rewriterModelCallSignals": { |
| "model": "A String", |
| "modelOutput": "A String", |
| "renderedPrompt": "A String", |
| }, |
| "rewrittenQuery": "A String", |
| "safetySignals": { |
| "bannedPhraseMatch": "A String", |
| "decision": "A String", |
| "matchedBannedPhrase": "A String", |
| }, |
| "searchSnippets": [ |
| { |
| "documentTitle": "A String", |
| "documentUri": "A String", |
| "metadata": { |
| "a_key": "", # Properties of the object. |
| }, |
| "text": "A String", |
| }, |
| ], |
| }, |
| }, |
| "displayName": "A String", |
| "inputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "outputActionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "tool": "A String", |
| "webhookToolTrace": { |
| "webhookTag": "A String", |
| "webhookUri": "A String", |
| }, |
| }, |
| "tts": { |
| }, |
| "userUtterance": { |
| "audio": "A String", |
| "audioTokens": [ |
| 42, |
| ], |
| "text": "A String", |
| }, |
| }, |
| ], |
| "conversationState": "A String", |
| "createTime": "A String", |
| "description": "A String", |
| "displayName": "A String", |
| "languageCode": "A String", |
| "name": "A String", |
| "playbookInput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "precedingConversationSummary": "A String", |
| }, |
| "playbookOutput": { |
| "actionParameters": { |
| "a_key": "", # Properties of the object. |
| }, |
| "executionSummary": "A String", |
| "state": "A String", |
| }, |
| "tokenCount": "A String", |
| "updateTime": "A String", |
| }</pre> |
| </div> |
| |
| </body></html> |
