Verndale.CognitiveImageTagging
3.0.0.18234
See the version list below for details.
dotnet add package Verndale.CognitiveImageTagging --version 3.0.0.18234
NuGet\Install-Package Verndale.CognitiveImageTagging -Version 3.0.0.18234
<PackageReference Include="Verndale.CognitiveImageTagging" Version="3.0.0.18234" />
paket add Verndale.CognitiveImageTagging --version 3.0.0.18234
#r "nuget: Verndale.CognitiveImageTagging, 3.0.0.18234"
// Install Verndale.CognitiveImageTagging as a Cake Addin #addin nuget:?package=Verndale.CognitiveImageTagging&version=3.0.0.18234 // Install Verndale.CognitiveImageTagging as a Cake Tool #tool nuget:?package=Verndale.CognitiveImageTagging&version=3.0.0.18234
This library can perform the following:
- Using AI, "read" the image and provide a sentence description of what it portrays.
- Using AI, "read" the image and provide series of tags that describe what it portrays.
- Using AI, perform OCR on the image and, if the image has embedded text, extract the text to a string value.
REQUIRED
You must have a subscription to Azure Cognitive Services for Computer Vision. You will need both a Subscription Key and an endpoint URL to use this library. Support for other AI
services are not implemented, but you can see where the extension would occur.
INSTALLATION
Install this package using NuGet.
If used in a plain old .NET application, Configure your app.config file with appropriate AzureServiceConnections.
If used in a web application, your web.config file will point to a config file in /App_Config/.
You need to copy the example config file provided, remove the ".example" extensions and update the settings
with appropriate AzureServiceConnections.
Note that version 2.0 supports multiple, named Azure connections so you can have
different accounts for different server environments as necessary.
In the supplied config example, you will see confidence levels for captions and embedded text. These are set to reasonable defaults, but be aware the AI can be
quirky and unreliable. This tool should be used prime the pump on image descriptions but should not be used unsupervised.
USE
To use Image Tagging, get an instance of IImageTagger through Verndale.CognitiveImageTagging.TagManager.GetImageTagger(nameOfConnection)
The ImageTagger has two methods
IImageTagger.GetImageDescription()
IImageTagger.ExtractTextFromImage()
OCR can be performed simultaneously with GetImageDescription via a parameter flag. Keep in mind you're hitting an external service that not only cost money but
can take some time to complete its evaluation. If you're sending a large batch of images through this utility, expect it to take some time and run up the bill.
Note that OCR tends to be the more expensive operation, both in terms of elapsed time and number of (billed) connections to your AI service.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET Framework | net471 is compatible. net472 was computed. net48 was computed. net481 was computed. |
-
- Microsoft.Azure.CognitiveServices.Vision.ComputerVision (>= 5.0.0)
- Microsoft.Rest.ClientRuntime (>= 2.3.21)
- Microsoft.Rest.ClientRuntime.Azure (>= 3.3.19)
- Newtonsoft.Json (>= 11.0.2)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Verndale.CognitiveImageTagging:
Package | Downloads |
---|---|
Verndale.Feature.CognitiveImageTagging
THIS IS AN EXPERIMENTAL LIBRARY - DO NOT PUBLISH AI-GENERATED ALT TEXT WITHOUT HUMAN REVIEW. This library can perform the following: - Using AI, "read" the image and provide a sentence description of what it portrays. - Using AI, "read" the image and provide series of tags that describe what it portrays. - Using AI, perform OCR on the image and, if the image has embedded text, extract the text to a string value. REQUIRED You must have a subscription to Azure Cognitive Services for Computer Vision. You will need both a Subscription Key and an endpoint URL to use this library. Support for other AI services are not implemented, but you can see where the extension would occur. INSTALLATION Install this package using NuGet. Copy and rename /App_Config/Verndale.CognitiveImageTagging.config.example Remove the "example" suffix. Supply appropriate Azure Cognitive service connection details within the config file. Don't forget to review the Sitecore Feature config file in App_Config/Include/Feature for details on how to activate this library. In the supplied config example, you will see confidence levels for captions and embedded text. These are set to reasonable defaults, but be aware the AI can be quirky and unreliable. This tool should be used prime the pump on image descriptions but should not be used unsupervised. USE Once configured, Images will receive AI-based Alt text when they are uploaded. To add Alt text to existing images, navigate to the image in the media library. The Media tab within the content editor will have new buttons that allow you to retrieve ALT text from AI for the selected Media Item. ALT text will be used in the following order If the image contains text, the text will be written to the Image's Alt field. If the AI returns a high-confidence Caption, that caption will be written to the Image's Alt field. Any descriptive tags returned by the AI will be written to the Image's Alt field in comma-delimited fashion. Keep in mind that AI for image descriptions is relatively experimental. Your descriptive results will depend on image the image. Celebrities tend to get tagged reliably, close-ups, abstract, or heavily filtered photos tend to have less reliable or extermely generic results. DO NOT TRUST AI TO SUPPLY YOU WITH ALT TEXT WITHOUT HUMAN REVIEW. Generated alt text may contain inaccurate descriptions or tags that could be construed as misleading or offensive. Use at your own risk! Do not publish any AI generated content without human review. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
3.0.1.25842 | 2,053 | 9/14/2020 | |
3.0.0.18234 | 827 | 9/14/2020 | |
2.0.2.20618 | 953 | 9/9/2020 | |
2.0.1.20240 | 909 | 9/9/2020 | |
2.0.0.18714 | 890 | 9/9/2020 | |
1.0.0.20589 | 1,000 | 8/6/2019 |
Removed all uses of async to ensure compatibility with CMS UI which doesn't support async calls.