Method: projects.locations.collections.patch

Aktualisiert die Parameter einer einzelnen Sammlung.

HTTP-Anfrage

PATCH https://vectorsearch.googleapis.com/v1/{collection.name}

Pfadparameter

Parameter
collection.name

string

ID. Der Name der Ressource.

Anfrageparameter

Parameter
updateMask

string (FieldMask format)

Optional. Mit der Feldmaske werden die Felder angegeben, die in der Collection-Ressource durch die Aktualisierung überschrieben werden sollen. Die in „updateMask“ angegebenen Felder beziehen sich auf die Ressource und nicht auf die vollständige Anfrage. Ein Feld wird überschrieben, wenn es in der Maske enthalten ist. Wenn der Nutzer keine Maske angibt, werden alle in der Anfrage enthaltenen Felder überschrieben.

Die folgenden Felder können aktualisiert werden: displayName, description, labels, dataSchema, vectorSchema. Bei dataSchema und vectorSchema können Felder nur hinzugefügt, aber nicht gelöscht werden. vertexEmbeddingConfig in vectorSchema kann jedoch hinzugefügt oder entfernt werden. Teilaktualisierungen für dataSchema und vectorSchema werden auch unterstützt, indem Unterfeldpfade in updateMask verwendet werden, z.B. dataSchema.properties.foo oder vectorSchema.my_vector_field.

Wenn * in der updateMask angegeben ist, wird ein vollständiger Ersatz durchgeführt.

Dies ist eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

requestId

string

Optional. Eine optionale Anfrage-ID zur Identifizierung von Anfragen. Geben Sie eine eindeutige Anfrage-ID an, damit der Server die Anfrage ignoriert, falls sie bereits abgeschlossen wurde und wiederholt wird. Der Server gewährleistet dies für mindestens 60 Minuten nach der ersten Anfrage.

Nehmen wir an, Sie senden eine erste Anfrage, deren Zeitlimit überschritten wird. Wenn Sie die Anfrage mit derselben Anfrage-ID erneut senden, kann der Server prüfen, ob der ursprüngliche Vorgang mit derselben Anfrage-ID empfangen wurde. Ist dies der Fall, wird die zweite Anfrage ignoriert. So wird verhindert, dass Clients versehentlich doppelte Zusicherungen erstellen.

Die Anfrage-ID muss eine gültige UUID sein, es sei denn, UUIDs mit Nullen werden nicht unterstützt (00000000-0000-0000-0000-000000000000).

Anfragetext

Der Anfragetext enthält eine Instanz von Collection.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • vectorsearch.collections.update

Weitere Informationen finden Sie in der IAM-Dokumentation.