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": {
        "text": "A String",
      },
      "flowInvocation": {
        "displayName": "A String",
        "flow": "A String",
        "flowState": "A String",
      },
      "flowTransition": {
        "displayName": "A String",
        "flow": "A String",
      },
      "playbookInvocation": {
        "displayName": "A String",
        "playbook": "A String",
        "playbookInput": {
          "precedingConversationSummary": "A String",
        },
        "playbookOutput": {
          "executionSummary": "A String",
        },
        "playbookState": "A String",
      },
      "playbookTransition": {
        "displayName": "A String",
        "playbook": "A String",
      },
      "toolUse": {
        "action": "A String",
        "displayName": "A String",
        "inputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "outputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "tool": "A String",
      },
      "userUtterance": {
        "text": "A String",
      },
    },
  ],
  "conversationState": "A String",
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "languageCode": "A String",
  "name": "A String",
  "playbookInput": {
    "precedingConversationSummary": "A String",
  },
  "playbookOutput": {
    "executionSummary": "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": {
        "text": "A String",
      },
      "flowInvocation": {
        "displayName": "A String",
        "flow": "A String",
        "flowState": "A String",
      },
      "flowTransition": {
        "displayName": "A String",
        "flow": "A String",
      },
      "playbookInvocation": {
        "displayName": "A String",
        "playbook": "A String",
        "playbookInput": {
          "precedingConversationSummary": "A String",
        },
        "playbookOutput": {
          "executionSummary": "A String",
        },
        "playbookState": "A String",
      },
      "playbookTransition": {
        "displayName": "A String",
        "playbook": "A String",
      },
      "toolUse": {
        "action": "A String",
        "displayName": "A String",
        "inputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "outputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "tool": "A String",
      },
      "userUtterance": {
        "text": "A String",
      },
    },
  ],
  "conversationState": "A String",
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "languageCode": "A String",
  "name": "A String",
  "playbookInput": {
    "precedingConversationSummary": "A String",
  },
  "playbookOutput": {
    "executionSummary": "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": {
        "text": "A String",
      },
      "flowInvocation": {
        "displayName": "A String",
        "flow": "A String",
        "flowState": "A String",
      },
      "flowTransition": {
        "displayName": "A String",
        "flow": "A String",
      },
      "playbookInvocation": {
        "displayName": "A String",
        "playbook": "A String",
        "playbookInput": {
          "precedingConversationSummary": "A String",
        },
        "playbookOutput": {
          "executionSummary": "A String",
        },
        "playbookState": "A String",
      },
      "playbookTransition": {
        "displayName": "A String",
        "playbook": "A String",
      },
      "toolUse": {
        "action": "A String",
        "displayName": "A String",
        "inputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "outputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "tool": "A String",
      },
      "userUtterance": {
        "text": "A String",
      },
    },
  ],
  "conversationState": "A String",
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "languageCode": "A String",
  "name": "A String",
  "playbookInput": {
    "precedingConversationSummary": "A String",
  },
  "playbookOutput": {
    "executionSummary": "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": {
            "text": "A String",
          },
          "flowInvocation": {
            "displayName": "A String",
            "flow": "A String",
            "flowState": "A String",
          },
          "flowTransition": {
            "displayName": "A String",
            "flow": "A String",
          },
          "playbookInvocation": {
            "displayName": "A String",
            "playbook": "A String",
            "playbookInput": {
              "precedingConversationSummary": "A String",
            },
            "playbookOutput": {
              "executionSummary": "A String",
            },
            "playbookState": "A String",
          },
          "playbookTransition": {
            "displayName": "A String",
            "playbook": "A String",
          },
          "toolUse": {
            "action": "A String",
            "displayName": "A String",
            "inputActionParameters": {
              "a_key": "", # Properties of the object.
            },
            "outputActionParameters": {
              "a_key": "", # Properties of the object.
            },
            "tool": "A String",
          },
          "userUtterance": {
            "text": "A String",
          },
        },
      ],
      "conversationState": "A String",
      "createTime": "A String",
      "description": "A String",
      "displayName": "A String",
      "languageCode": "A String",
      "name": "A String",
      "playbookInput": {
        "precedingConversationSummary": "A String",
      },
      "playbookOutput": {
        "executionSummary": "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": {
        "text": "A String",
      },
      "flowInvocation": {
        "displayName": "A String",
        "flow": "A String",
        "flowState": "A String",
      },
      "flowTransition": {
        "displayName": "A String",
        "flow": "A String",
      },
      "playbookInvocation": {
        "displayName": "A String",
        "playbook": "A String",
        "playbookInput": {
          "precedingConversationSummary": "A String",
        },
        "playbookOutput": {
          "executionSummary": "A String",
        },
        "playbookState": "A String",
      },
      "playbookTransition": {
        "displayName": "A String",
        "playbook": "A String",
      },
      "toolUse": {
        "action": "A String",
        "displayName": "A String",
        "inputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "outputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "tool": "A String",
      },
      "userUtterance": {
        "text": "A String",
      },
    },
  ],
  "conversationState": "A String",
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "languageCode": "A String",
  "name": "A String",
  "playbookInput": {
    "precedingConversationSummary": "A String",
  },
  "playbookOutput": {
    "executionSummary": "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": {
        "text": "A String",
      },
      "flowInvocation": {
        "displayName": "A String",
        "flow": "A String",
        "flowState": "A String",
      },
      "flowTransition": {
        "displayName": "A String",
        "flow": "A String",
      },
      "playbookInvocation": {
        "displayName": "A String",
        "playbook": "A String",
        "playbookInput": {
          "precedingConversationSummary": "A String",
        },
        "playbookOutput": {
          "executionSummary": "A String",
        },
        "playbookState": "A String",
      },
      "playbookTransition": {
        "displayName": "A String",
        "playbook": "A String",
      },
      "toolUse": {
        "action": "A String",
        "displayName": "A String",
        "inputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "outputActionParameters": {
          "a_key": "", # Properties of the object.
        },
        "tool": "A String",
      },
      "userUtterance": {
        "text": "A String",
      },
    },
  ],
  "conversationState": "A String",
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "languageCode": "A String",
  "name": "A String",
  "playbookInput": {
    "precedingConversationSummary": "A String",
  },
  "playbookOutput": {
    "executionSummary": "A String",
  },
  "tokenCount": "A String",
  "updateTime": "A String",
}