Google Discovery Engine Update Document Error: 3 INVALID_ARGUMENT: Invalid update_mask.paths

Google Cloud Build with AI AI Solutions
1

Hello, I would like to partially update my document inside the discovery engine’s data store without replacing the whole document. I’ve read that you must include update mask in the request to do so.

This is my code:

import { DocumentServiceClient } from '@google-cloud/discoveryengine';
const discoveryengineClient = new DocumentServiceClient();

  const request = {
    document: {
      name: `projects/${await discoveryengineClient.getProjectId()}/locations/global/dataStores/${dataStoreID}/branches/default_branch/documents/${document.id}`,
      jsonData: JSON.stringify({ example: 'field' }),
    },
    allowMissing: false,
    updateMask: {
      paths: ['example']
    }
  };

  const response = await discoveryengineClient.updateDocument(request);

I got Error: 3 INVALID_ARGUMENT: Invalid update_mask.paths: example when I run it.

Can anyone help?

2

Hi @Weshine,

Welcome to Google Cloud Community!

The error you’re encountering, “INVALID_ARGUMENT: Invalid update_mask.paths: example,” suggests that the field you’re trying to update with your ‘updateMask’ might not match the structure of your document. With regard to this, you can consider the following, which might help you answer your current scenario:

  • Ensure the Field Exist: Make sure that the field ‘example’ exists in the document schema. If it doesn’t exist or if the field is not there, the update will fail.
  • Correct Path Format: The path in the ‘updateMask’ should match the exact field name in the document. If ‘example’ is nested, you need to provide the full path. For example, if ‘example’ is inside another object, the path should be ‘parentField.example.’
  • Use Correct JSON Structure: Ensure that the ‘jsonData’ is correctly structured and matches the expected format.

For more detailed information, you can refer to the Google Cloud Discovery Engine documentation.

I hope the above information is helpful.