Dialogflow API . projects . knowledgeBases . documents

Instance Methods

close()

Close httplib2 connections.

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

delete(name, x__xgafv=None)

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

get(name, x__xgafv=None)

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

list(parent, filter=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)

reload(name, body=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:

{
  "contentUri": "A String",
  "displayName": "A String",
  "enableAutoReload": True or False,
  "knowledgeTypes": [
    "A String",
  ],
  "latestReloadStatus": {
    "status": {
      "code": 42,
      "details": [
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String",
    },
    "time": "A String",
  },
  "metadata": {
    "a_key": "A String",
  },
  "mimeType": "A String",
  "name": "A String",
  "rawContent": "A String",
  "state": "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.
  },
}
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:

    {
  "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.
  },
}
export(name, body=None, x__xgafv=None)

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

{
  "exportFullContent": True or False,
  "gcsDestination": {
    "uri": "A String",
  },
  "smartMessagingPartialUpdate": True or False,
}

  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:

    {
  "contentUri": "A String",
  "displayName": "A String",
  "enableAutoReload": True or False,
  "knowledgeTypes": [
    "A String",
  ],
  "latestReloadStatus": {
    "status": {
      "code": 42,
      "details": [
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String",
    },
    "time": "A String",
  },
  "metadata": {
    "a_key": "A String",
  },
  "mimeType": "A String",
  "name": "A String",
  "rawContent": "A String",
  "state": "A String",
}
import_(parent, body=None, x__xgafv=None)

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

{
  "documentTemplate": {
    "knowledgeTypes": [
      "A String",
    ],
    "metadata": {
      "a_key": "A String",
    },
    "mimeType": "A String",
  },
  "gcsSource": {
    "uris": [
      "A String",
    ],
  },
  "importGcsCustomMetadata": True or False,
}

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

Args:
  parent: string, A parameter (required)
  filter: 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:

    {
  "documents": [
    {
      "contentUri": "A String",
      "displayName": "A String",
      "enableAutoReload": True or False,
      "knowledgeTypes": [
        "A String",
      ],
      "latestReloadStatus": {
        "status": {
          "code": 42,
          "details": [
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String",
        },
        "time": "A String",
      },
      "metadata": {
        "a_key": "A String",
      },
      "mimeType": "A String",
      "name": "A String",
      "rawContent": "A String",
      "state": "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:

{
  "contentUri": "A String",
  "displayName": "A String",
  "enableAutoReload": True or False,
  "knowledgeTypes": [
    "A String",
  ],
  "latestReloadStatus": {
    "status": {
      "code": 42,
      "details": [
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String",
    },
    "time": "A String",
  },
  "metadata": {
    "a_key": "A String",
  },
  "mimeType": "A String",
  "name": "A String",
  "rawContent": "A String",
  "state": "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:

    {
  "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.
  },
}
reload(name, body=None, x__xgafv=None)

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

{
  "contentUri": "A String",
  "importGcsCustomMetadata": True or False,
  "smartMessagingPartialUpdate": True or False,
}

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