|
| 1 | +--- |
| 2 | +external help file: sharepointonline.xml |
| 3 | +Module Name: Microsoft.Online.SharePoint.PowerShell |
| 4 | +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill |
| 5 | +applicable: SharePoint Online |
| 6 | +title: Start-SPOSiteOpticalCharacterRecognitionBackfill |
| 7 | +schema: 2.0.0 |
| 8 | +author: FarreltinF |
| 9 | +ms.author: fanyi |
| 10 | +ms.reviewer: |
| 11 | +--- |
| 12 | + |
| 13 | +# Start-SPOSiteOpticalCharacterRecognitionBackfill |
| 14 | + |
| 15 | +## SYNOPSIS |
| 16 | + |
| 17 | +> [!NOTE] |
| 18 | +> This feature - Optical Character Recognition (OCR) is a pay-as-you-go feature, triggering this cmdlet will incur cost for your organization |
| 19 | +
|
| 20 | +Initiates a job to trigger the Optical Character Recognition (OCR) process for all files for the selected site. |
| 21 | + |
| 22 | +## SYNTAX |
| 23 | + |
| 24 | +```Powershell |
| 25 | +
|
| 26 | +Start-SPOSiteBackfillOCR [-Site] <string> |
| 27 | +``` |
| 28 | + |
| 29 | +## DESCRIPTION |
| 30 | + |
| 31 | +This command starts a job to trigger the Optical Character Recognition (OCR) process for files that have either never been OCR processed or have been modified since the last OCR process. This ensures all relevant content in the site is recognized and indexed for improved searchability and accessibility. |
| 32 | + |
| 33 | +OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the site, please enable OCR before proceeding with OCR backfilling. Refer to this [article](https://learn.microsoft.com/en-us/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site. |
| 34 | + |
| 35 | +## EXAMPLES |
| 36 | + |
| 37 | +### EXAMPLE 1 |
| 38 | + |
| 39 | +```powershell |
| 40 | +
|
| 41 | +Start-SPOSiteBackfillOCR -Site https://contosoenergy.sharepoint.com/sites/hr |
| 42 | +``` |
| 43 | + |
| 44 | +Starts OCR process for all content hasn't been processed before in the selected site. |
| 45 | + |
| 46 | +### EXAMPLE 2 |
| 47 | + |
| 48 | +```powershell |
| 49 | +
|
| 50 | +$site = Get-SPOSIte -Identity https://contosoenergy.sharepoint.com/sites/hr |
| 51 | +Start-SPOSiteBackfillOCR -Site $site |
| 52 | +``` |
| 53 | + |
| 54 | +Start OCR process for all content hasn't been processed before in the selected site. |
| 55 | + |
| 56 | +## PARAMETERS |
| 57 | + |
| 58 | +### -Site |
| 59 | + |
| 60 | +Specifies the site URL where OCR process should be enabled on. |
| 61 | + |
| 62 | +```yaml |
| 63 | +Type: String |
| 64 | +Parameter Sets: Default |
| 65 | +Aliases: |
| 66 | +Applicable: SharePoint Online |
| 67 | + |
| 68 | +Required: True |
| 69 | +Position: 1 |
| 70 | +Default value: None |
| 71 | +Accept pipeline input: False |
| 72 | +Accept wildcard characters: False |
| 73 | +``` |
| 74 | +
|
| 75 | +### CommonParameters |
| 76 | +
|
| 77 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). |
| 78 | +
|
| 79 | +## RELATED LINKS |
| 80 | +
|
| 81 | +[Overview of optical character recognition in SharePoint](https://learn.microsoft.com/en-us/microsoft-365/syntex/ocr-overview) |
| 82 | +
|
| 83 | +[Learn about optical character recognition in Microsoft Purview](https://learn.microsoft.com/en-us/purview/ocr-learn-about?tabs=purview) |
0 commit comments