Skip to main content

spp model apply

Applies (or syncs) a trained document understanding model to a document library

Usage​

m365 spp model apply [options]

Options​

-u, --webUrl <webUrl>

The URL of the web where the library is located.

-c, --contentCenterUrl <contentCenterUrl>

The URL of the content center site where model is located.

-i, --id [id]

The unique ID of the model. Specify either id or title but not both.

-t, --title [title]

The display name of the model. Specify either id or title but not both.

--listTitle [listTitle]

The title of the document library to which the model will be applied. Specify either listTitle, listId, or listUrl but not multiple.

--listId [listId]

The ID of the library to which the model will be applied. Specify either listTitle, listId, or listUrl but not multiple.

--listUrl [listUrl]

Server or web-relative URL of the library to which the model will be applied. Specify either listTitle, listId, or listUrl but not multiple.

--viewOption [viewOption]

Defines whether the model view should be set as the default view for the document library. Allowed values are: NewViewAsDefault, DoNotChangeDefault, TileViewAsDefault. The default value is NewViewAsDefault.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Examples​

Applies a trained document understanding model using its unique ID to a document library, identified by its title.

m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --id "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" --listTitle "Shared Documents"

Applies a trained document understanding model using its display name to a document library, identified by its title.

m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "ModelExample" --listTitle "Shared Documents"

Applies a trained document understanding model using its display name to a document library, identified by its URL.

m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "ModelExample" --listUrl "/Shared Documents"

Applies a trained document understanding model using its display name to a document library, identified by its unique ID.

m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "ModelExample" --listId "b4cfa0d9-b3d7-49ae-a0f0-f14ffdd005f7"

Applies a trained document understanding model using its display name to a document library, identified by its unique ID. Without changing a default document library view.

m365 spp model apply --webUrl "https://contoso.sharepoint.com" --contentCenterUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "ModelExample" --listId "b4cfa0d9-b3d7-49ae-a0f0-f14ffdd005f7" --viewOption "DoNotChangeDefault"

Response​

The command won't return a response on success.