Method: projects.locations.collections.patch

Atualiza os parâmetros de uma única coleção.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
collection.name

string

Identificador. Nome do recurso.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Opcional. A máscara de campo é usada para especificar os campos a serem substituídos no recurso "Collection" pela atualização. Os campos especificados em updateMask são relativos ao recurso, não à solicitação completa. Um campo será substituído se estiver na máscara. Se o usuário não fornecer uma máscara, todos os campos presentes na solicitação serão substituídos.

Os seguintes campos podem ser atualizados: displayName, description, labels, dataSchema, vectorSchema. Para dataSchema e vectorSchema, os campos só podem ser adicionados, não excluídos, mas vertexEmbeddingConfig em vectorSchema pode ser adicionado ou removido. Atualizações parciais para dataSchema e vectorSchema também são compatíveis usando caminhos de subcampos em updateMask, por exemplo, dataSchema.properties.foo ou vectorSchema.my_vector_field.

Se * for fornecido em updateMask, uma substituição completa será realizada.

Uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
requestId

string

Opcional. Um ID de solicitação opcional para identificar solicitações. Especifique um ID de solicitação exclusivo para que, se precisar repetir a solicitação, o servidor saberá que é preciso ignorar a solicitação se ela já tiver sido concluída. O servidor vai garantir isso por pelo menos 60 minutos após a primeira solicitação.

Por exemplo, considere uma situação em que você faz uma solicitação inicial e ela expira. Se você fizer a solicitação novamente com o mesmo ID, o servidor poderá verificar se a operação original com o mesmo ID foi recebida e, em caso afirmativo, vai ignorar a segunda solicitação. Isso evita que os clientes criem compromissos duplicados acidentalmente.

O ID da solicitação precisa ser um UUID válido. O valor zero não é aceito (00000000-0000-0000-0000-000000000000).

Corpo da solicitação

O corpo da solicitação contém uma instância de Collection.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • vectorsearch.collections.update

Para mais informações, consulte a documentação do IAM.