Method: projects.knowledgeBases.documents.patch

Updates the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

HTTP request

PATCH https://{endpoint}/v2/{document.name=projects/*/knowledgeBases/*/documents/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
document.name

string

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>.

Query parameters

Parameters
updateMask

string (FieldMask format)

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.

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.