Method: projects.agent.knowledgeBases.list

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

HTTP request

GET https://{endpoint}/v2/{parent=projects/*/agent}/knowledgeBases

Where {endpoint} is one of the supported service endpoints .

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project to list of knowledge bases for. Format: projects/<Project ID>/locations/<Location ID> .

Authorization requires the following IAM permission on the specified resource parent :

  • dialogflow.knowledgeBases.list

Query parameters

Parameters
pageSize

integer

The maximum number of items to return in a single page. By default 10 and at most 100.

pageToken

string

The nextPageToken value returned from a previous list request.

filter

string

The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax:

[AND ] ...

The following fields and operators are supported:

  • displayName with has(:) operator
  • languageCode with equals(=) operator

Examples:

  • 'languageCode=en-us' matches knowledge bases with en-us language code.
  • 'displayName:articles' matches knowledge bases whose display name contains "articles".
  • 'displayName:"Best Articles"' matches knowledge bases whose display name contains "Best Articles".
  • 'languageCode=en-gb AND displayName=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb".

Note: An empty filter string (i.e. "") is a no-op and will result in no filtering.

For more information about filtering, see API Filtering .

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListKnowledgeBasesResponse .

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview .

Create a Mobile Website
View Site in Mobile | Classic
Share by: