Class ListDocumentsRequest (2.30.0)

ListDocumentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for Documents.ListDocuments.


parent str
Required. The knowledge base to list all documents for. Format: projects/.
page_size int
The maximum number of items to return in a single page. By default 10 and at most 100.
page_token str
The next_page_token value returned from a previous list request.
filter str
The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: - knowledge_types with has(:) operator - display_name with has(:) operator - state with equals(=) operator Examples: - "knowledge_types:FAQ" matches documents with FAQ knowledge type. - "display_name:customer" matches documents whose display name contains "customer". - "state=ACTIVE" matches documents with ACTIVE state. - "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see `API Filtering