- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated; only use projects.knowledgeBases.documents
.
HTTP request
GET https://{endpoint}/v2beta1/{parent=projects/*/knowledgeBases/*}/documents
Where {endpoint}
is one of the supported service endpoints.
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The knowledge base to list all documents for. Format: Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
page |
The maximum number of items to return in a single page. By default 10 and at most 100. |
page |
The nextPageToken value returned from a previous list request. |
filter |
The filter expression used to filter documents returned by the list method. The expression has the following syntax: The following fields and operators are supported:
Examples:
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 ListDocumentsResponse
.
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.