Optional. The document resource name. The name must be empty when creating a document. Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.
Optional. Not specified means update all. Currently, only displayName can be updated, an InvalidArgument will be returned for attempting to update other fields.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
Request body
The request body contains an instance of Document.
Response body
If successful, the response body contains an instance of Operation.
[[["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 updates a specified document, representing a long-running operation, and returns an \u003ccode\u003eOperation\u003c/code\u003e with metadata and document response fields.\u003c/p\u003e\n"],["\u003cp\u003eThe request uses a \u003ccode\u003ePATCH\u003c/code\u003e HTTP method to the provided endpoint URL, following gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edocument.name\u003c/code\u003e path parameter is required to specify the target document, following the format \u003ccode\u003eprojects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eupdateMask\u003c/code\u003e query parameter, in FieldMask format, is optional and determines which fields to update, currently only supporting \u003ccode\u003edisplayName\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should include a \u003ccode\u003eDocument\u003c/code\u003e instance, while the response, upon success, includes an \u003ccode\u003eOperation\u003c/code\u003e instance, and it requires one of the specified OAuth authorization scopes.\u003c/p\u003e\n"]]],[],null,["# Method: projects.agent.knowledgeBases.documents.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates the specified document.\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`PATCH https://{endpoint}/v2/{document.name=projects/*/agent/knowledgeBases/*/documents/*}`\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### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Document](/dialogflow/es/docs/reference/rest/v2/projects.agent.knowledgeBases.documents#Document).\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)."]]
