Request-PnPSyntexClassifyAndExtract

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Request-PnPSyntexClassifyAndExtract.md to change this file.

Requests for a file, folder or all files in a library to be classified and extracted via the published SharePoint Syntex models on the libraries hosting the files.

Syntax

Request-PnPSyntexClassifyAndExtract
       -FileUrl <string>
       [-Batch <PnPBatch>]
        [-Connection <PnPConnection>]
       [<CommonParameters>]
Request-PnPSyntexClassifyAndExtract
       -Folder <FolderPipeBind>
       [-Connection <PnPConnection>]
       [<CommonParameters>]
Request-PnPSyntexClassifyAndExtract
       -List <ListPipeBind>
       [-OffPeak <SwitchParameter>]
       [-Force <SwitchParameter>]
       [-Connection <PnPConnection>]
       [<CommonParameters>]

Description

This command requests for all files in a library, folder or individual files to be classified and extracted via the published SharePoint Syntex models on the libraries hosting the files. When using with the OffPeak switch then the files are send to the off peak Syntex content processing queue, this way there's no need to enumerate all files in the library and submit them to the regular queue. When using the Force switch without setting OffPeak then all files are enumerated and sent to the regular queue, regardless of whether they were processed in the past.

When the list contains more than 5000 files or when using the folder parameter the cmdlet will use the off peak SharePoint Syntex queue.

Examples

EXAMPLE 1

Request-PnPSyntexClassifyAndExtract -FileUrl "/sites/finance/invoices/invoice1.docx"

Requests the classification and extraction of invoice1.docx in library "Invoices".

EXAMPLE 2

Request-PnPSyntexClassifyAndExtract -List "Invoices"

Requests the classification and extraction of all files in library "Invoices" that never were classified and extracted before.

EXAMPLE 3

Request-PnPSyntexClassifyAndExtract -Folder (Get-PnPFolder -Url "invoices/Q1/jan")

Requests the classification and extraction of all files in the folder "jan" in library "invoices" that never were classified and extracted before.

Parameters

-Batch

The batch to add this file classification and extraction request to.

Type:PnPBatch
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:PnPConnection
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-FileUrl

The server relative URL of the file to be classified and extracted.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Folder

The folder holding the files to classify and extract. When using this parameter, files will be send to the off peak queue.

Type:FolderPipeBind
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Force

If set, then all files (even if classified and extracted before) are classified and extracted. If the list contains more than 5000 items this option will not apply and off-peak processing is used.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-List

The name or list holding the files to classify and extract

Type:ListPipeBind
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-OffPeak

If set, then the files to classify are sent to the off peak queue without enumerating them. If the list contains more than 5000 items then off-peak processing is always used.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False