Method: projects.locations.collections.patch

Actualiza los parámetros de una sola colección.

Solicitud HTTP

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

Parámetros de ruta

Parámetros
collection.name

string

Identificador. Nombre del recurso

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Es opcional. La máscara de campo se usa para especificar los campos que la actualización reemplazará en el recurso Collection. Los campos especificados en updateMask se relacionan con el recurso, no con la solicitud completa. Un campo se reemplazará si está en la máscara. Si el usuario no proporciona una máscara, se reemplazarán todos los campos presentes en la solicitud.

Los siguientes campos admiten actualizaciones: displayName, description, labels, dataSchema, vectorSchema. En el caso de dataSchema y vectorSchema, los campos solo se pueden agregar, no borrar, pero vertexEmbeddingConfig en vectorSchema se puede agregar o quitar. También se admiten las actualizaciones parciales para dataSchema y vectorSchema con rutas de acceso de subcampos en updateMask, p.ej., dataSchema.properties.foo o vectorSchema.my_vector_field.

Si se proporciona * en updateMask, se realizará el reemplazo completo.

Esta es una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".
requestId

string

Opcional. Un ID de solicitud opcional para identificar solicitudes. Especifica un ID de solicitud único para que, si debes reintentar la solicitud, el servidor sepa que debe ignorarla si ya se completó. El servidor lo garantizará durante, al menos, 60 minutos después de la primera solicitud.

Por ejemplo, imagina una situación en la que haces una solicitud inicial y se agota el tiempo de espera. Si vuelves a hacer la solicitud con el mismo ID, el servidor puede verificar si se recibió la operación original con el mismo ID y, de ser así, ignorar la segunda solicitud. Esto evita que los clientes creen compromisos duplicados por accidente.

El ID de solicitud debe ser un UUID válido, con la excepción de que no se admite ningún UUID cero (00000000-0000-0000-0000-000000000000).

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Collection.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • vectorsearch.collections.update

Para obtener más información, consulta la documentación de IAM.