Required. The name of the document to export. Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.
Authorization requires the following IAM permission on the specified resource name:
dialogflow.documents.get
Request body
The request body contains data with the following structure:
JSON representation
{"exportFullContent": boolean,"smartMessagingPartialUpdate": boolean,// Union field destination can be only one of the following:"gcsDestination": {object (GcsDestination)}// End of list of possible types for union field destination.}
Fields
exportFullContent
boolean
When enabled, export the full content of the document including empirical probability.
smartMessagingPartialUpdate
boolean
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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis endpoint exports a smart messaging candidate document to a specified destination, and it is a long-running operation.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003ePOST\u003c/code\u003e method and requires a specific document name in the path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body allows for specifying full content export and smart messaging partial updates, with the destination for export defined as a Google Cloud Storage file path.\u003c/p\u003e\n"],["\u003cp\u003eThe response body will contain an \u003ccode\u003eOperation\u003c/code\u003e instance if the export is successful.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/dialogflow\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.knowledgeBases.documents.export\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nExports a smart messaging candidate document into the specified destination.\n\nThis method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:\n\n- `metadata`: [KnowledgeOperationMetadata](/dialogflow/es/docs/reference/rest/v2/KnowledgeOperationMetadata)\n- `response`: [Document](/dialogflow/es/docs/reference/rest/v2/projects.agent.knowledgeBases.documents#Document)\n\n### HTTP request\n\n`POST https://{endpoint}/v2/{name=projects/*/knowledgeBases/*/documents/*}:export`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/dialogflow/es/docs/reference/rest#rest_endpoints).\n\nThe URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/dialogflow/es/docs/reference/rest/v2/projects.locations.operations#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/dialogflow`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
