Dialogflow API . projects . agent . knowledgeBases

Instance Methods

documents()

Returns the documents Resource.

create(parent, body, x__xgafv=None)

Creates a knowledge base.

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

Deletes the specified knowledge base.

get(name, x__xgafv=None)

Retrieves the specified knowledge base.

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

Returns the list of all knowledge bases of the specified agent.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

Updates the specified knowledge base.

Method Details

create(parent, body, x__xgafv=None)
Creates a knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated;
only use `projects.knowledgeBases`.

Args:
  parent: string, Required. The project to create a knowledge base for.
Format: `projects/`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents knowledge base resource.
      # 
      # Note: The `projects.agent.knowledgeBases` resource is deprecated;
      # only use `projects.knowledgeBases`.
    "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024
        # bytes or less; otherwise, the creation request fails.
    "name": "A String", # The knowledge base resource name.
        # The name must be empty when creating a knowledge base.
        # Format: `projects//knowledgeBases/`.
  }

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

Returns:
  An object of the form:

    { # Represents knowledge base resource.
        #
        # Note: The `projects.agent.knowledgeBases` resource is deprecated;
        # only use `projects.knowledgeBases`.
      "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024
          # bytes or less; otherwise, the creation request fails.
      "name": "A String", # The knowledge base resource name.
          # The name must be empty when creating a knowledge base.
          # Format: `projects//knowledgeBases/`.
    }
delete(name, force=None, x__xgafv=None)
Deletes the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated;
only use `projects.knowledgeBases`.

Args:
  name: string, Required. The name of the knowledge base to delete.
Format: `projects//knowledgeBases/`. (required)
  force: boolean, Optional. Force deletes the knowledge base. When set to true, any documents
in the knowledge base are also deleted.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None)
Retrieves the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated;
only use `projects.knowledgeBases`.

Args:
  name: string, Required. The name of the knowledge base to retrieve.
Format `projects//knowledgeBases/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents knowledge base resource.
        #
        # Note: The `projects.agent.knowledgeBases` resource is deprecated;
        # only use `projects.knowledgeBases`.
      "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024
          # bytes or less; otherwise, the creation request fails.
      "name": "A String", # The knowledge base resource name.
          # The name must be empty when creating a knowledge base.
          # Format: `projects//knowledgeBases/`.
    }
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all knowledge bases of the specified agent.

Note: The `projects.agent.knowledgeBases` resource is deprecated;
only use `projects.knowledgeBases`.

Args:
  parent: string, Required. The project to list of knowledge bases for.
Format: `projects/`. (required)
  pageSize: integer, Optional. The maximum number of items to return in a single page. By
default 10 and at most 100.
  pageToken: string, Optional. The next_page_token value returned from a previous list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for KnowledgeBases.ListKnowledgeBases.
    "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
        # more results in the list.
    "knowledgeBases": [ # The list of knowledge bases.
      { # Represents knowledge base resource.
            #
            # Note: The `projects.agent.knowledgeBases` resource is deprecated;
            # only use `projects.knowledgeBases`.
          "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024
              # bytes or less; otherwise, the creation request fails.
          "name": "A String", # The knowledge base resource name.
              # The name must be empty when creating a knowledge base.
              # Format: `projects//knowledgeBases/`.
        },
    ],
  }
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, updateMask=None, x__xgafv=None)
Updates the specified knowledge base.

Note: The `projects.agent.knowledgeBases` resource is deprecated;
only use `projects.knowledgeBases`.

Args:
  name: string, The knowledge base resource name.
The name must be empty when creating a knowledge base.
Format: `projects//knowledgeBases/`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents knowledge base resource.
      # 
      # Note: The `projects.agent.knowledgeBases` resource is deprecated;
      # only use `projects.knowledgeBases`.
    "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024
        # bytes or less; otherwise, the creation request fails.
    "name": "A String", # The knowledge base resource name.
        # The name must be empty when creating a knowledge base.
        # Format: `projects//knowledgeBases/`.
  }

  updateMask: string, Optional. Not specified means `update all`.
Currently, only `display_name` can be updated, an InvalidArgument will be
returned for attempting to update other fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents knowledge base resource.
        #
        # Note: The `projects.agent.knowledgeBases` resource is deprecated;
        # only use `projects.knowledgeBases`.
      "displayName": "A String", # Required. The display name of the knowledge base. The name must be 1024
          # bytes or less; otherwise, the creation request fails.
      "name": "A String", # The knowledge base resource name.
          # The name must be empty when creating a knowledge base.
          # Format: `projects//knowledgeBases/`.
    }