Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Query parameters
Parameters
allowMissing
boolean
If set to true and the Document is not found, a new Document is be created.
[[["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 page details how to update a Document resource via a PATCH HTTP request to a specified URL.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edocument.name\u003c/code\u003e path parameter is required, following a specific format for the document's full resource name and must be under 1024 characters.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eallowMissing\u003c/code\u003e and \u003ccode\u003eupdateMask\u003c/code\u003e query parameters can be used to control document creation and specify fields for updating respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe request and response bodies both involve an instance of the Document resource, with the request body providing the updated content and the response body reflecting the updated document.\u003c/p\u003e\n"],["\u003cp\u003eUpdating a document requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003ediscoveryengine.documents.update\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.dataStores.branches.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- [IAM Permissions](#body.aspect_1)\n\nUpdates a [Document](/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.branches.documents#Document).\n\n### HTTP request\n\n`PATCH https://discoveryengine.googleapis.com/v1alpha/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}`\n\nThe URL uses [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](/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.branches.documents#Document).\n\n### Response body\n\nIf successful, the response body contains an instance of [Document](/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.branches.documents#Document).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `discoveryengine.documents.update`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
