This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.

Changes in GA:

Name: Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
All changes: To see what else changed between preview and GA, see Switch from Discovery for Media to media recommendations in the Vertex AI Search documentation.

Method: projects.locations.dataStores.branches.documents.patch

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
IAM Permissions
Try it!

Updates a Document.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1alpha/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`document.name`	`string` 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.

document.name

string

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

Parameters
`allowMissing`	`boolean` If set to true, and the `Document` is not found, a new `Document` will be created.

allowMissing

boolean

If set to true, and the Document is not found, a new Document will be created.

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.