Compartilhar via

Microsoft Syntex API REST do modelo de processamento de documentos não estruturado

  • Artigo

Você pode usar a interface REST do SharePoint para criar um modelo de processamento de documentos não estruturado, aplicar ou remover o modelo para uma ou mais bibliotecas e obter ou atualizar informações sobre o modelo.

O serviço REST do SharePoint Online (e o SharePoint 2016 e posterior no local) dá suporte à combinação de várias solicitações em uma única chamada para o serviço, usando a opção de consulta $batch do OData.

Para obter detalhes e links de amostras de código, confira Fazer solicitações em lote com APIs REST.

Pré-requisitos

Antes de começar, verifique se está familiarizado com o seguinte:

Comandos REST

Os seguintes comandos REST estão disponíveis para trabalhar com modelos de processamento de documentos não estruturados do Syntex:

  • Criar modelo – Cria um modelo e seu tipo de conteúdo associado.
  • GetByUniqueId – Obtém ou atualiza informações sobre um modelo de processamento de documento não estruturado do Syntex.
  • GetByTitle – Obtém ou atualiza informações sobre um modelo de processamento de documento não estruturado do Syntex usando o título do modelo.
  • Aplicar modelo – aplica (ou sincroniza) um modelo de processamento de documento não estruturado treinado a uma ou mais bibliotecas.
  • Obter informações sobre modelos e bibliotecas – Obtém informações sobre um modelo e a biblioteca na qual ele foi aplicado.
  • UpdateModelSettings – Atualizações configurações de modelos disponíveis (rótulo de retenção associado e descrição do modelo) para um modelo de processamento de documento não estruturado do Syntex.
  • BatchDelete – remove um modelo de processamento de documento não estruturado aplicado de uma ou mais bibliotecas.
  • Criar solicitação de classificação – Cria uma solicitação para classificar um arquivo ou arquivos especificados usando o modelo aplicado.
  • Criar solicitação de classificação – Cria uma solicitação para classificar uma pasta inteira utilizando o modelo aplicado.

Cenários

Observe os seguintes exemplos de cenário que não são intuitivos com base no nome do método. Para obter mais informações, consulte cada artigo.

O método criar modelo apenas cria o objeto de modelo e seu tipo de conteúdo associado. Será preciso primeiro treinar o modelo no centro de conteúdo antes que ele possa ser aplicado a uma biblioteca.

O método de modelo de aplicação é usado para configurar o modelo na biblioteca de destino para classificar documentos e, opcionalmente, extrair informações adicionais. Essa API também dá suporte à aplicação em lote do modelo a várias bibliotecas.

O método de remover modelo simplesmente remove o modelo de uma ou mais bibliotecas onde ele foi aplicado anteriormente. Se você quiser excluir o modelo, ele deverá primeiro ser removido de todas as bibliotecas onde ele foi aplicado.

Confira também

Visão geral do processamento de documentos não estruturado