Dialogflow API . projects . locations . companionAgents

Instance Methods

close()

Close httplib2 connections.

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

delete(name, x__xgafv=None)

get(name, x__xgafv=None)

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

list_next(previous_request, previous_response)

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, companionAgentId=None, x__xgafv=None)

Args:
  parent: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{
  "cesToolSpecs": [
    {
      "cesTool": "A String",
      "confirmationRequirement": "A String",
    },
  ],
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "name": "A String",
  "skillConfigs": [
    {
      "guidanceSkillConfig": {
        "guidanceInstructions": [
          {
            "actions": [
              {
                "description": "A String",
              },
            ],
            "condition": "A String",
            "disableSuggestedReply": True or False,
            "displayDetails": "A String",
            "displayName": "A String",
            "triggerEvent": "A String",
          },
        ],
        "knowledgeSource": {
        },
        "overarchingGuidance": "A String",
      },
      "skillTriggeringEvent": "A String",
    },
  ],
  "toolsetTools": [
    {
      "confirmationRequirement": "A String",
      "operationId": "A String",
      "toolset": "A String",
    },
  ],
  "updateTime": "A String",
}

  companionAgentId: 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:

    {
  "cesToolSpecs": [
    {
      "cesTool": "A String",
      "confirmationRequirement": "A String",
    },
  ],
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "name": "A String",
  "skillConfigs": [
    {
      "guidanceSkillConfig": {
        "guidanceInstructions": [
          {
            "actions": [
              {
                "description": "A String",
              },
            ],
            "condition": "A String",
            "disableSuggestedReply": True or False,
            "displayDetails": "A String",
            "displayName": "A String",
            "triggerEvent": "A String",
          },
        ],
        "knowledgeSource": {
        },
        "overarchingGuidance": "A String",
      },
      "skillTriggeringEvent": "A String",
    },
  ],
  "toolsetTools": [
    {
      "confirmationRequirement": "A String",
      "operationId": "A String",
      "toolset": "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:

    {
  "cesToolSpecs": [
    {
      "cesTool": "A String",
      "confirmationRequirement": "A String",
    },
  ],
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "name": "A String",
  "skillConfigs": [
    {
      "guidanceSkillConfig": {
        "guidanceInstructions": [
          {
            "actions": [
              {
                "description": "A String",
              },
            ],
            "condition": "A String",
            "disableSuggestedReply": True or False,
            "displayDetails": "A String",
            "displayName": "A String",
            "triggerEvent": "A String",
          },
        ],
        "knowledgeSource": {
        },
        "overarchingGuidance": "A String",
      },
      "skillTriggeringEvent": "A String",
    },
  ],
  "toolsetTools": [
    {
      "confirmationRequirement": "A String",
      "operationId": "A String",
      "toolset": "A String",
    },
  ],
  "updateTime": "A String",
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)

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:

    {
  "companionAgents": [
    {
      "cesToolSpecs": [
        {
          "cesTool": "A String",
          "confirmationRequirement": "A String",
        },
      ],
      "createTime": "A String",
      "description": "A String",
      "displayName": "A String",
      "name": "A String",
      "skillConfigs": [
        {
          "guidanceSkillConfig": {
            "guidanceInstructions": [
              {
                "actions": [
                  {
                    "description": "A String",
                  },
                ],
                "condition": "A String",
                "disableSuggestedReply": True or False,
                "displayDetails": "A String",
                "displayName": "A String",
                "triggerEvent": "A String",
              },
            ],
            "knowledgeSource": {
            },
            "overarchingGuidance": "A String",
          },
          "skillTriggeringEvent": "A String",
        },
      ],
      "toolsetTools": [
        {
          "confirmationRequirement": "A String",
          "operationId": "A String",
          "toolset": "A String",
        },
      ],
      "updateTime": "A String",
    },
  ],
  "nextPageToken": "A String",
}
list_next(previous_request, previous_response)
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:

{
  "cesToolSpecs": [
    {
      "cesTool": "A String",
      "confirmationRequirement": "A String",
    },
  ],
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "name": "A String",
  "skillConfigs": [
    {
      "guidanceSkillConfig": {
        "guidanceInstructions": [
          {
            "actions": [
              {
                "description": "A String",
              },
            ],
            "condition": "A String",
            "disableSuggestedReply": True or False,
            "displayDetails": "A String",
            "displayName": "A String",
            "triggerEvent": "A String",
          },
        ],
        "knowledgeSource": {
        },
        "overarchingGuidance": "A String",
      },
      "skillTriggeringEvent": "A String",
    },
  ],
  "toolsetTools": [
    {
      "confirmationRequirement": "A String",
      "operationId": "A String",
      "toolset": "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:

    {
  "cesToolSpecs": [
    {
      "cesTool": "A String",
      "confirmationRequirement": "A String",
    },
  ],
  "createTime": "A String",
  "description": "A String",
  "displayName": "A String",
  "name": "A String",
  "skillConfigs": [
    {
      "guidanceSkillConfig": {
        "guidanceInstructions": [
          {
            "actions": [
              {
                "description": "A String",
              },
            ],
            "condition": "A String",
            "disableSuggestedReply": True or False,
            "displayDetails": "A String",
            "displayName": "A String",
            "triggerEvent": "A String",
          },
        ],
        "knowledgeSource": {
        },
        "overarchingGuidance": "A String",
      },
      "skillTriggeringEvent": "A String",
    },
  ],
  "toolsetTools": [
    {
      "confirmationRequirement": "A String",
      "operationId": "A String",
      "toolset": "A String",
    },
  ],
  "updateTime": "A String",
}