Method: projects.locations.dataStores.patch

Aggiorna i parametri di un singolo datastore.

dataStores.patch, dataStores.importDocuments e dataStores.purgeDocuments vengono eseguiti uno alla volta per DataStore. Mentre una è in esecuzione, un'altra può attendere; qualsiasi ulteriore richiesta non va a buon fine con ABORTED finché l'operazione in esecuzione non termina.

Richiesta HTTP

PATCH https://vectorsearch.googleapis.com/v1beta/{dataStore.name}

Parametri di percorso

Parametri
dataStore.name

string

Identificatore. Il nome completo della risorsa del datastore.

Formato: projects/{project}/locations/{location}/dataStores/{dataStoreId}

Parametri di query

Parametri
updateMask

string (FieldMask format)

Facoltativo. La maschera del campo viene utilizzata per specificare i campi da sovrascrivere nella risorsa DataStore con l'aggiornamento. I campi specificati in updateMask si riferiscono alla risorsa, non all'intera richiesta. Un campo verrà sovrascritto se si trova nella maschera. Un percorso che assegna un nome a un messaggio sostituisce l'intero messaggio: i campi secondari omessi dalla richiesta vengono cancellati e, in processingConfig, vengono reimpostati sui valori predefiniti.

Se l'utente non fornisce una maschera, viene sovrascritto ogni campo che la richiesta imposta su un valore non predefinito. I messaggi inviati vuoti (ad esempio layoutParsingConfig: {}) e i campi impostati sul valore predefinito (ad esempio false) non vengono applicati; specificali invece nella maschera.

I seguenti campi supportano l'aggiornamento: displayName, description, labels, processingConfig e documentMetadataSchema. documentMetadataSchema deve essere aggiornato nel suo complesso (il percorso della maschera è documentMetadataSchema) e solo aggiungendo proprietà: le proprietà esistenti non possono essere rimosse o modificate.

Se in updateMask viene fornito *, verrà eseguita la sostituzione completa.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

requestId

string

Facoltativo. Un ID richiesta facoltativo per identificare le richieste. Specifica un ID richiesta univoco in modo che, se devi riprovare a inviare la richiesta, il server sappia che deve ignorarla se è già stata completata. Il server garantirà di ignorare la seconda richiesta per almeno 60 minuti dopo la prima.

Ad esempio, considera una situazione in cui effettui una richiesta iniziale e questa scade. Se effettui nuovamente la richiesta con lo stesso ID richiesta, il server può verificare se l'operazione originale con lo stesso ID richiesta è stata ricevuta e, in caso affermativo, ignorerà la seconda richiesta. In questo modo, i client non creano impegni duplicati per errore.

L'ID richiesta deve essere un UUID valido, ad eccezione dell'UUID zero, che non è supportato (00000000-0000-0000-0000-000000000000).

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di DataStore.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/vectorsearch

Per saperne di più, consulta la Authentication Overview.