Skip to content

Commit 7f1bb46

Browse files
Merge pull request #839 from FarreltinF/patch-10
Create Start-SPOSiteOpticalCharacterRecognitionBackfill.md
2 parents 18a772d + 71281b4 commit 7f1bb46

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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+
> [!important]
18+
> Optical Character Recognition (OCR) is a pay-as-you-go feature. Running this cmdlet will incur cost for your organization.
19+
20+
Initiates a job to trigger the OCR process for all files for the selected site.
21+
22+
## SYNTAX
23+
24+
```Powershell
25+
26+
Start-SPOSiteOpticalCharacterRecognitionBackfill [-Site] <SpoSitePipeBind>
27+
```
28+
29+
## DESCRIPTION
30+
31+
This cmdlet starts a job to trigger the 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](/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site.
34+
35+
> [!Note]
36+
> Backfilling cancellation is currently under development. Once the cmdlet is triggered, the backfilling process cannot be stopped. Disabling OCR on the selected site will not cancel the ongoing backfilling session.
37+
38+
## EXAMPLES
39+
40+
### EXAMPLE 1
41+
42+
```powershell
43+
44+
Start-SPOSiteOpticalCharacterRecognitionBackfill -Site https://contosoenergy.sharepoint.com/sites/hr
45+
```
46+
47+
Starts OCR process for all content that hasn't been processed before in the selected site.
48+
49+
## PARAMETERS
50+
51+
### -Site
52+
53+
Specifies the site where OCR process should be enabled on.
54+
55+
```yaml
56+
Type: SpoSitePipeBind
57+
Parameter Sets: Default
58+
Aliases:
59+
Applicable: SharePoint Online
60+
61+
Required: True
62+
Position: 1
63+
Default value: None
64+
Accept pipeline input: True
65+
Accept wildcard characters: False
66+
```
67+
68+
### CommonParameters
69+
70+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
71+
72+
## RELATED LINKS
73+
74+
[Overview of optical character recognition in SharePoint](/microsoft-365/syntex/ocr-overview)
75+
76+
[Learn about optical character recognition in Microsoft Purview](/purview/ocr-learn-about?tabs=purview)

sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md

+4
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,10 @@ This cmdlet is not currently active in production and may be removed in the futu
660660

661661
{{Manually Enter Start-SPOSiteContentMove Description Here}}
662662

663+
### [Start-SPOSiteOpticalCharacterRecognitionBackfill](Start-SPOSiteOpticalCharacterRecognitionBackfill.md)
664+
665+
{{Initiates a job to trigger the Optical Character Recognition (OCR) process for all files for the selected site.}}
666+
663667
### [Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md)
664668

665669
{{Manually Enter Start-SPOUserAndContentMove Description Here}}

0 commit comments

Comments
 (0)