Exports a smart messaging candidate document into the specified destination.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
:KnowledgeOperationMetadata
response
:Document
HTTP request
POST https://{endpoint}/v2/{name=projects/*/locations/*/knowledgeBases/*/documents/*}:export
Where {endpoint}
is one of the supported service endpoints.
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the document to export. Format: Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "exportFullContent": boolean, "smartMessagingPartialUpdate": boolean, // Union field |
Fields | |
---|---|
export |
When enabled, export the full content of the document including empirical probability. |
smart |
When enabled, export the smart messaging allowlist document for partial update. |
Union field destination . Required. The destination for the export. destination can be only one of the following: |
|
gcs |
Cloud Storage file path to export the document. |
Response body
If successful, the response body contains an instance of Operation
.
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.