-
Notifications
You must be signed in to change notification settings - Fork 196
Create Start-SPOSiteOpticalCharacterRecognitionBackfill.md #839
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
12d4318
1e83b41
ecbb5e6
01d34e3
1bb71bd
7403d7e
fffa482
1271c90
71281b4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| external help file: sharepointonline.xml | ||
| Module Name: Microsoft.Online.SharePoint.PowerShell | ||
| online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill | ||
| applicable: SharePoint Online | ||
| title: Start-SPOSiteOpticalCharacterRecognitionBackfill | ||
| schema: 2.0.0 | ||
| author: FarreltinF | ||
| ms.author: fanyi | ||
| ms.reviewer: | ||
| --- | ||
|
|
||
| # Start-SPOSiteOpticalCharacterRecognitionBackfill | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| > [!NOTE] | ||
| > This feature - Optical Character Recognition (OCR) is a pay-as-you-go feature, triggering this cmdlet will incur cost for your organization | ||
|
|
||
| Initiates a job to trigger the Optical Character Recognition (OCR) process for all files for the selected site. | ||
|
FarreltinF marked this conversation as resolved.
Outdated
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```Powershell | ||
|
|
||
| Start-SPOSiteBackfillOCR [-Site] <string> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this doesn't match the cmdlet name line 13. also, be sure to use platyPS to generate the template for your documentation. |
||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| 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. | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
|
|
||
| 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. | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### EXAMPLE 1 | ||
|
|
||
| ```powershell | ||
|
|
||
| Start-SPOSiteBackfillOCR -Site https://contosoenergy.sharepoint.com/sites/hr | ||
| ``` | ||
|
|
||
| Starts OCR process for all content hasn't been processed before in the selected site. | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### EXAMPLE 2 | ||
|
|
||
| ```powershell | ||
|
|
||
| $site = Get-SPOSIte -Identity https://contosoenergy.sharepoint.com/sites/hr | ||
| Start-SPOSiteBackfillOCR -Site $site | ||
| ``` | ||
|
|
||
| Start OCR process for all content hasn't been processed before in the selected site. | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Site | ||
|
|
||
| Specifies the site URL where OCR process should be enabled on. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| ```yaml | ||
| Type: String | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
| Parameter Sets: Default | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
|
|
||
| Required: True | ||
| Position: 1 | ||
| Default value: None | ||
| Accept pipeline input: False | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### CommonParameters | ||
|
|
||
| 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). | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Overview of optical character recognition in SharePoint](https://learn.microsoft.com/en-us/microsoft-365/syntex/ocr-overview) | ||
|
|
||
| [Learn about optical character recognition in Microsoft Purview](https://learn.microsoft.com/en-us/purview/ocr-learn-about?tabs=purview) | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
Uh oh!
There was an error while loading. Please reload this page.