Dialogflow API . projects . locations . agents . tools

Instance Methods

versions()

Returns the versions Resource.

close()

Close httplib2 connections.

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

delete(name, force=None, x__xgafv=None)

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

get(name, x__xgafv=None)

list(parent, 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:

{
  "connectorSpec": {
    "actions": [
      {
        "connectionActionId": "A String",
        "entityOperation": {
          "entityId": "A String",
          "operation": "A String",
        },
        "inputFields": [
          "A String",
        ],
        "outputFields": [
          "A String",
        ],
      },
    ],
    "endUserAuthConfig": {
      "oauth2AuthCodeConfig": {
        "oauthToken": "A String",
      },
      "oauth2JwtBearerConfig": {
        "clientKey": "A String",
        "issuer": "A String",
        "subject": "A String",
      },
    },
    "name": "A String",
  },
  "dataStoreSpec": {
    "dataStoreConnections": [
      {
        "dataStore": "A String",
        "dataStoreType": "A String",
        "documentProcessingMode": "A String",
      },
    ],
    "fallbackPrompt": {
    },
  },
  "description": "A String",
  "displayName": "A String",
  "extensionSpec": {
    "name": "A String",
  },
  "functionSpec": {
    "inputSchema": {
      "a_key": "", # Properties of the object.
    },
    "outputSchema": {
      "a_key": "", # Properties of the object.
    },
  },
  "name": "A String",
  "openApiSpec": {
    "authentication": {
      "apiKeyConfig": {
        "apiKey": "A String",
        "keyName": "A String",
        "requestLocation": "A String",
        "secretVersionForApiKey": "A String",
      },
      "bearerTokenConfig": {
        "secretVersionForToken": "A String",
        "token": "A String",
      },
      "oauthConfig": {
        "clientId": "A String",
        "clientSecret": "A String",
        "oauthGrantType": "A String",
        "scopes": [
          "A String",
        ],
        "secretVersionForClientSecret": "A String",
        "tokenEndpoint": "A String",
      },
      "serviceAccountAuthConfig": {
        "serviceAccount": "A String",
      },
      "serviceAgentAuthConfig": {
        "serviceAgentAuth": "A String",
      },
    },
    "serviceDirectoryConfig": {
      "service": "A String",
    },
    "textSchema": "A String",
    "tlsConfig": {
      "caCerts": [
        {
          "cert": "A String",
          "displayName": "A String",
        },
      ],
    },
  },
  "toolType": "A String",
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "connectorSpec": {
    "actions": [
      {
        "connectionActionId": "A String",
        "entityOperation": {
          "entityId": "A String",
          "operation": "A String",
        },
        "inputFields": [
          "A String",
        ],
        "outputFields": [
          "A String",
        ],
      },
    ],
    "endUserAuthConfig": {
      "oauth2AuthCodeConfig": {
        "oauthToken": "A String",
      },
      "oauth2JwtBearerConfig": {
        "clientKey": "A String",
        "issuer": "A String",
        "subject": "A String",
      },
    },
    "name": "A String",
  },
  "dataStoreSpec": {
    "dataStoreConnections": [
      {
        "dataStore": "A String",
        "dataStoreType": "A String",
        "documentProcessingMode": "A String",
      },
    ],
    "fallbackPrompt": {
    },
  },
  "description": "A String",
  "displayName": "A String",
  "extensionSpec": {
    "name": "A String",
  },
  "functionSpec": {
    "inputSchema": {
      "a_key": "", # Properties of the object.
    },
    "outputSchema": {
      "a_key": "", # Properties of the object.
    },
  },
  "name": "A String",
  "openApiSpec": {
    "authentication": {
      "apiKeyConfig": {
        "apiKey": "A String",
        "keyName": "A String",
        "requestLocation": "A String",
        "secretVersionForApiKey": "A String",
      },
      "bearerTokenConfig": {
        "secretVersionForToken": "A String",
        "token": "A String",
      },
      "oauthConfig": {
        "clientId": "A String",
        "clientSecret": "A String",
        "oauthGrantType": "A String",
        "scopes": [
          "A String",
        ],
        "secretVersionForClientSecret": "A String",
        "tokenEndpoint": "A String",
      },
      "serviceAccountAuthConfig": {
        "serviceAccount": "A String",
      },
      "serviceAgentAuthConfig": {
        "serviceAgentAuth": "A String",
      },
    },
    "serviceDirectoryConfig": {
      "service": "A String",
    },
    "textSchema": "A String",
    "tlsConfig": {
      "caCerts": [
        {
          "cert": "A String",
          "displayName": "A String",
        },
      ],
    },
  },
  "toolType": "A String",
}
delete(name, force=None, x__xgafv=None)

Args:
  name: string, A parameter (required)
  force: boolean, A parameter
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
}
export(parent, body=None, x__xgafv=None)

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

{
  "dataFormat": "A String",
  "tools": [
    "A String",
  ],
  "toolsContentInline": True or False,
  "toolsUri": "A String",
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "done": True or False,
  "error": {
    "code": 42,
    "details": [
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String",
  },
  "metadata": {
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String",
  "response": {
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
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:

    {
  "connectorSpec": {
    "actions": [
      {
        "connectionActionId": "A String",
        "entityOperation": {
          "entityId": "A String",
          "operation": "A String",
        },
        "inputFields": [
          "A String",
        ],
        "outputFields": [
          "A String",
        ],
      },
    ],
    "endUserAuthConfig": {
      "oauth2AuthCodeConfig": {
        "oauthToken": "A String",
      },
      "oauth2JwtBearerConfig": {
        "clientKey": "A String",
        "issuer": "A String",
        "subject": "A String",
      },
    },
    "name": "A String",
  },
  "dataStoreSpec": {
    "dataStoreConnections": [
      {
        "dataStore": "A String",
        "dataStoreType": "A String",
        "documentProcessingMode": "A String",
      },
    ],
    "fallbackPrompt": {
    },
  },
  "description": "A String",
  "displayName": "A String",
  "extensionSpec": {
    "name": "A String",
  },
  "functionSpec": {
    "inputSchema": {
      "a_key": "", # Properties of the object.
    },
    "outputSchema": {
      "a_key": "", # Properties of the object.
    },
  },
  "name": "A String",
  "openApiSpec": {
    "authentication": {
      "apiKeyConfig": {
        "apiKey": "A String",
        "keyName": "A String",
        "requestLocation": "A String",
        "secretVersionForApiKey": "A String",
      },
      "bearerTokenConfig": {
        "secretVersionForToken": "A String",
        "token": "A String",
      },
      "oauthConfig": {
        "clientId": "A String",
        "clientSecret": "A String",
        "oauthGrantType": "A String",
        "scopes": [
          "A String",
        ],
        "secretVersionForClientSecret": "A String",
        "tokenEndpoint": "A String",
      },
      "serviceAccountAuthConfig": {
        "serviceAccount": "A String",
      },
      "serviceAgentAuthConfig": {
        "serviceAgentAuth": "A String",
      },
    },
    "serviceDirectoryConfig": {
      "service": "A String",
    },
    "textSchema": "A String",
    "tlsConfig": {
      "caCerts": [
        {
          "cert": "A String",
          "displayName": "A String",
        },
      ],
    },
  },
  "toolType": "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:

    {
  "nextPageToken": "A String",
  "tools": [
    {
      "connectorSpec": {
        "actions": [
          {
            "connectionActionId": "A String",
            "entityOperation": {
              "entityId": "A String",
              "operation": "A String",
            },
            "inputFields": [
              "A String",
            ],
            "outputFields": [
              "A String",
            ],
          },
        ],
        "endUserAuthConfig": {
          "oauth2AuthCodeConfig": {
            "oauthToken": "A String",
          },
          "oauth2JwtBearerConfig": {
            "clientKey": "A String",
            "issuer": "A String",
            "subject": "A String",
          },
        },
        "name": "A String",
      },
      "dataStoreSpec": {
        "dataStoreConnections": [
          {
            "dataStore": "A String",
            "dataStoreType": "A String",
            "documentProcessingMode": "A String",
          },
        ],
        "fallbackPrompt": {
        },
      },
      "description": "A String",
      "displayName": "A String",
      "extensionSpec": {
        "name": "A String",
      },
      "functionSpec": {
        "inputSchema": {
          "a_key": "", # Properties of the object.
        },
        "outputSchema": {
          "a_key": "", # Properties of the object.
        },
      },
      "name": "A String",
      "openApiSpec": {
        "authentication": {
          "apiKeyConfig": {
            "apiKey": "A String",
            "keyName": "A String",
            "requestLocation": "A String",
            "secretVersionForApiKey": "A String",
          },
          "bearerTokenConfig": {
            "secretVersionForToken": "A String",
            "token": "A String",
          },
          "oauthConfig": {
            "clientId": "A String",
            "clientSecret": "A String",
            "oauthGrantType": "A String",
            "scopes": [
              "A String",
            ],
            "secretVersionForClientSecret": "A String",
            "tokenEndpoint": "A String",
          },
          "serviceAccountAuthConfig": {
            "serviceAccount": "A String",
          },
          "serviceAgentAuthConfig": {
            "serviceAgentAuth": "A String",
          },
        },
        "serviceDirectoryConfig": {
          "service": "A String",
        },
        "textSchema": "A String",
        "tlsConfig": {
          "caCerts": [
            {
              "cert": "A String",
              "displayName": "A String",
            },
          ],
        },
      },
      "toolType": "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:

{
  "connectorSpec": {
    "actions": [
      {
        "connectionActionId": "A String",
        "entityOperation": {
          "entityId": "A String",
          "operation": "A String",
        },
        "inputFields": [
          "A String",
        ],
        "outputFields": [
          "A String",
        ],
      },
    ],
    "endUserAuthConfig": {
      "oauth2AuthCodeConfig": {
        "oauthToken": "A String",
      },
      "oauth2JwtBearerConfig": {
        "clientKey": "A String",
        "issuer": "A String",
        "subject": "A String",
      },
    },
    "name": "A String",
  },
  "dataStoreSpec": {
    "dataStoreConnections": [
      {
        "dataStore": "A String",
        "dataStoreType": "A String",
        "documentProcessingMode": "A String",
      },
    ],
    "fallbackPrompt": {
    },
  },
  "description": "A String",
  "displayName": "A String",
  "extensionSpec": {
    "name": "A String",
  },
  "functionSpec": {
    "inputSchema": {
      "a_key": "", # Properties of the object.
    },
    "outputSchema": {
      "a_key": "", # Properties of the object.
    },
  },
  "name": "A String",
  "openApiSpec": {
    "authentication": {
      "apiKeyConfig": {
        "apiKey": "A String",
        "keyName": "A String",
        "requestLocation": "A String",
        "secretVersionForApiKey": "A String",
      },
      "bearerTokenConfig": {
        "secretVersionForToken": "A String",
        "token": "A String",
      },
      "oauthConfig": {
        "clientId": "A String",
        "clientSecret": "A String",
        "oauthGrantType": "A String",
        "scopes": [
          "A String",
        ],
        "secretVersionForClientSecret": "A String",
        "tokenEndpoint": "A String",
      },
      "serviceAccountAuthConfig": {
        "serviceAccount": "A String",
      },
      "serviceAgentAuthConfig": {
        "serviceAgentAuth": "A String",
      },
    },
    "serviceDirectoryConfig": {
      "service": "A String",
    },
    "textSchema": "A String",
    "tlsConfig": {
      "caCerts": [
        {
          "cert": "A String",
          "displayName": "A String",
        },
      ],
    },
  },
  "toolType": "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:

    {
  "connectorSpec": {
    "actions": [
      {
        "connectionActionId": "A String",
        "entityOperation": {
          "entityId": "A String",
          "operation": "A String",
        },
        "inputFields": [
          "A String",
        ],
        "outputFields": [
          "A String",
        ],
      },
    ],
    "endUserAuthConfig": {
      "oauth2AuthCodeConfig": {
        "oauthToken": "A String",
      },
      "oauth2JwtBearerConfig": {
        "clientKey": "A String",
        "issuer": "A String",
        "subject": "A String",
      },
    },
    "name": "A String",
  },
  "dataStoreSpec": {
    "dataStoreConnections": [
      {
        "dataStore": "A String",
        "dataStoreType": "A String",
        "documentProcessingMode": "A String",
      },
    ],
    "fallbackPrompt": {
    },
  },
  "description": "A String",
  "displayName": "A String",
  "extensionSpec": {
    "name": "A String",
  },
  "functionSpec": {
    "inputSchema": {
      "a_key": "", # Properties of the object.
    },
    "outputSchema": {
      "a_key": "", # Properties of the object.
    },
  },
  "name": "A String",
  "openApiSpec": {
    "authentication": {
      "apiKeyConfig": {
        "apiKey": "A String",
        "keyName": "A String",
        "requestLocation": "A String",
        "secretVersionForApiKey": "A String",
      },
      "bearerTokenConfig": {
        "secretVersionForToken": "A String",
        "token": "A String",
      },
      "oauthConfig": {
        "clientId": "A String",
        "clientSecret": "A String",
        "oauthGrantType": "A String",
        "scopes": [
          "A String",
        ],
        "secretVersionForClientSecret": "A String",
        "tokenEndpoint": "A String",
      },
      "serviceAccountAuthConfig": {
        "serviceAccount": "A String",
      },
      "serviceAgentAuthConfig": {
        "serviceAgentAuth": "A String",
      },
    },
    "serviceDirectoryConfig": {
      "service": "A String",
    },
    "textSchema": "A String",
    "tlsConfig": {
      "caCerts": [
        {
          "cert": "A String",
          "displayName": "A String",
        },
      ],
    },
  },
  "toolType": "A String",
}