Method: projects.locations.corpora.indexes.patch

Aktualisiert einen Index unter dem Korpus. Nutzer können eine Aktualisierung nur der Metadaten ausführen oder mit verschiedenen Werten für „updateMask“ einen vollständigen Indexneuaufbau auslösen.

HTTP-Anfrage

PATCH https://visionai.googleapis.com/v1/{index.name=projects/*/locations/*/corpora/*/indexes/*}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
index.name

string

Nur Ausgabe. Ressourcenname der Indexressource. Format: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}

Suchparameter

Parameter
updateMask

string (FieldMask format)

Pflichtangabe. Mit der Feldmaske werden die Felder angegeben, die durch die Aktualisierung in der Indexressource überschrieben werden sollen. Die in „updateMask“ angegebenen Felder beziehen sich auf die Ressource und nicht auf die gesamte Anfrage. Ein Feld der Ressource wird überschrieben, wenn es sich in der Maske befindet. Eine leere Feldmaske ist nicht zulässig. Wenn die Maske „*“ ist, wird ein vollständiges Update des Index und ein vollständiger Neuaufbau der Indexdaten ausgelöst.

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

Anfragetext

Der Anfragetext enthält eine Instanz von Index.

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 in der Authentifizierungsübersicht.

IAM-Berechtigungen

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

  • visionai.indexes.update

Weitere Informationen finden Sie in der IAM-Dokumentation.