- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
Updates a Document
.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
document. |
Immutable. The full resource name of the document. Format: This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
Query parameters
Parameters | |
---|---|
allow |
If set to |
update |
Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body contains an instance of Document
.
Response body
If successful, the response body contains an instance of Document
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
discoveryengine.documents.update
For more information, see the IAM documentation.