Method: projects.locations.corpora.indexes.patch

Atualiza um índice no corpus. Os usuários podem realizar uma atualização somente de metadados ou acionar uma recriação completa do índice com diferentes valores de updateMask.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
index.name

string

Apenas saída. Nome do recurso de índice. Formato: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Obrigatório. A máscara de campo é usada para especificar os campos a serem substituídos no recurso de índice pela atualização. Os campos especificados em updateMask são relativos ao recurso, não à solicitação completa. Um campo do recurso será substituído se estiver na máscara. Não é permitido usar uma máscara de campo vazia. Se a máscara for "*", ela vai acionar uma atualização completa do índice e também uma reconstrução completa dos dados do índice.

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

Corpo da solicitação

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

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 saber mais, consulte a Visão geral da autenticação.

Permissões do IAM

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

  • visionai.indexes.update

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