SharePoint Syntex document understanding model REST API

You can use the SharePoint REST interface to create a document understanding model, apply or remove the model to one or more libraries, and obtain or update information about the model.

The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option.

For details and links to code samples, see Make batch requests with the REST APIs.

Prerequisites

Before you get started, make sure that you're familiar with the following:

REST commands

The following REST commands are available for working with Syntex document understanding models:

  • Create model – Creates a model and its associated content type.
  • GetByUniqueId – Gets or updates information about a SharePoint Syntex document understanding model.
  • GetByTitle – Gets or updates information about a SharePoint Syntex document understanding model using the model title.
  • Apply model – Applies (or syncs) a trained document understanding model to one or more libraries.
  • Get model and library information – Gets information about a model and the library where it has been applied.
  • UpdateModelSettings – Updates available models settings (associated retention label and model description) for a SharePoint Syntex document understanding model.
  • BatchDelete – Removes an applied document understanding model from one or more libraries.
  • Create classification request – Creates a request to classify a specified file or files using the applied model.

Scenarios

Note the following scenario examples that aren't intuitive from the method name. For more information, see each article.

The create model method only creates the model object and its associated content type. You'll need to first train the model in the content center before it can be applied to a library.

The apply model method is used to configure the model on the target library to classify documents and optionally extract additional information. This API also supports batch applying the model to multiple libraries.

The remove model method just removes the model from one or more libraries where it was previously applied. If you want to delete the model, it must first be removed from all the libraries where it was applied.

See also

Document understanding overview