Dialogflow API . projects . locations . agents . playbooks . examples

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

delete(name, x__xgafv=None)

get(name, x__xgafv=None)

list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)

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",
}
delete(name, x__xgafv=None)

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:

    {
}
get(name, x__xgafv=None)

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",
}
list(parent, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)

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",
}
list_next()
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.
        
patch(name, body=None, updateMask=None, x__xgafv=None)

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",
}