Method: projects.agent.knowledgeBases.documents.patch

Updates the specified document. Operation <response: Document, metadata: KnowledgeOperationMetadata>

HTTP request

PATCH https://dialogflow.googleapis.com/v2beta1/{document.name=projects/*/agent/knowledgeBases/*/documents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
document.name

string

The document resource name. The name must be empty when creating a document. Format: projects/<Project 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.

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.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Dialogflow Enterprise Edition