Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ListDocumentsRequest.
Request message for Documents.ListDocuments .
Generated from protobuf message google.cloud.dialogflow.v2.ListDocumentsRequest
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>
.
↳ page_size
int
The maximum number of items to return in a single page. By default 10 and at most 100.
↳ page_token
string
The next_page_token value returned from a previous list request.
↳ filter
string
The filter expression used to filter documents returned by the list method. The expression has the following syntax:
getParent
Required. The knowledge base to list all documents for.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>
.
string
setParent
Required. The knowledge base to list all documents for.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>
.
var
string
$this
getPageSize
The maximum number of items to return in a single page. By default 10 and at most 100.
int
setPageSize
The maximum number of items to return in a single page. By default 10 and at most 100.
var
int
$this
getPageToken
The next_page_token value returned from a previous list request.
string
setPageToken
The next_page_token value returned from a previous list request.
var
string
$this
getFilter
The filter expression used to filter documents returned by the list method.
The expression has the following syntax:
- 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 .
string
setFilter
The filter expression used to filter documents returned by the list method.
The expression has the following syntax:
- 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 .
var
string
$this
static::build
parent
string
Required. The knowledge base to list all documents for.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>
. Please see Google\Cloud\Dialogflow\V2\DocumentsClient::knowledgeBaseName()
for help formatting this field.
