Welcome!

.NET Authors: Adine Deford, Srinivasan Sundara Rajan, David Fletcher, Pat Romanski, Tad Anderson

Blog Feed Post

No metadata? No problem! Custom entity extraction in SharePoint 2013

Every organization wants better search results.  However, few have actually spent the time to create file plans, content types, and managed properties to make it happen.  SharePoint 2013 has a feature called entity extraction though that can actually infer values by comparing what it finds in the body of the document to a dictionary.  This feature is Entity Extraction.  If you are familiar with FAST Search for SharePoint or FAST ESP, you know that entity extraction is nothing new.  What it does is gives you the power to infer the values of managed properties in search without having metadata in your site columns.  FS4SP and SharePoint 2013 come with an extraction dictionaries for company names out-of-the-box.  This means when it crawls it will search the contents of the body of your documents and if it recognizes any companies it knows, you can then search and refine on it.  However, the true value comes when you create your own.  SharePoint 2013 makes it really easy to create these custom dictionaries. 

Let me give you a few more examples to help you really understand the significance.  Most companies have a concept of a department or business unit.  We can create a dictionary with all of the company’s departments such as Accounting, Human Resources, IT, Operations, etc.  With entity extraction, if it finds a document and somewhere the text “Human Resources Organization Chart” is found, it then sets the value of the managed property to Human Resources.  Now, when the user does an advanced search and says “show me all Human Resources documents”, that result comes back with more confidence.  By using the extraction dictionary, we get better results that just using a regular keyword search.  Now you may be wondering that’s nothing special, but we can also add other terms, for example, I could add “HR”, and “Benefits” to that dictionary as well and map them to the Human Resources department.  Once I have a property defined like this, I can combine it with others as well.  This will let us issue queries like “show me all documents from Human Resources with a document type of Policy”. 

As another example, you could pre-load SharePoint with a dictionary of product names.  For those of you in the energy industry, you could pre-populate it with a list of wells or names of leases.  Are you starting to see the significance?  In previous versions of SharePoint, we had to set site columns in our document libraries to capture these values either from the user or programmatically.  Now with the right dictionary, we can assume the values with a reasonable degree of confidence.

Alright, enough explanation, let’s see this in action and hopefully it will make sense.  MSDN has a great post on this but I found and error in it so that is why I am writing this post (plus I know you all like screenshots).  For my example, I have a bunch of PowerPoint documents about SharePoint 2013 on my site.  I’ve created a custom entity extraction dictionary that will help me refine these documents by feature in SharePoint (i.e.: Apps, Business Intelligence, Search, Social, etc). 

Before you build your dictionary file though, you need to decide on what type of extraction to use.  You can choose whether you want it to match a word or just part of it.  You can also specify whether it needs to match exactly.  The MSDN article summarizes this well, but here’s a quick recap of your choices.

  • Word Extraction – case-insentive, word has to match, limited to 5 dictionaries
  • Word Part Extraction – case-insensitive, only part of a word has to match, limited to 5 dictionaries
  • Word Exact Extraction – case-sensitive, word has to match, limited to 1 dictionary
  • Word Part Exact Extraction – case-sensitive, only part of a word has to match, limited to 1 dictionary

For today’s example, I am going to use Word Part Extraction as it gives you some of the most flexibility.  You might want to use Word Exact Extraction for extracting IDs from a document.  For example, you could use it to extract part numbers or invoice numbers.  Those aren’t something you would typically want to refine on but you may want to query on them.  FAST Search for SharePoint only provided case-sensitive extraction.  This made the feature less useful as you had to accommodate all possible varieties of case combinations in your dictionary file.

To get started, we need to create a dictionary file. I started with notepad and I also edited with Excel some.  The format is simple “Key,Display form”.  The key is what it matches and the Display form is what gets displayed in the refiner.  Although the Display form is optional, you want to include it as it allows you to control the exact way the text looks in the refiner (including case sensitivity).  Here’s the dictionary file I created.

Key,Display form

bcs,Business Connectivity Services

Business Connectivity Services,Business Connectivity Services

wcm,Web Content Management

Web Content Management,Web Content Management

bi,Business Intelligence

Business Intelligence,Business Intelligence

ecm,Electronic Content Management

Electronic Content Management,Electronic Content Management

Apps,Apps

Analytics,Analytics

Development,Development

Service Application,Service Application

Excel Services,Excel Services

Office Web Apps,Office Web Apps

owa,Office Web Apps

wac,Office Web Apps

PerformancePoint,Business Intelligence

Search,Search

Social,Social

My Sites,My Sites

Communities,Social

Visio Services,Visio Services

Workflow,Workflow

The next step is to use the PowerShell command, Import-SPEnterpriseSearchCustomExtractionDictionary.  The documentation on this page is correct which is how I found the solution to my problem.  The first step is to get a reference to the Search Service Application using Get-SPEnterpriseSearchServiceApplication.  Then for our import command, we pass the service application, the Filename, and the DictionaryName.  Here’s where the complexity comes in.  The Filename requires a UNC path.  That means something like \\servername\path\file.csv.  It won’t take a relative path.  The next tricky part is where I found an issue in the documentation.  I wanted to use the Word Part extraction, it has the case of the word “WordPart” incorrect in the dictionary name.  If you do specify the DictionaryName wrong, it will not work.  Here are the list of valid values which correspond to the extraction types we talked about above.

  • Microsoft.UserDictionaries.EntityExtraction.Custom.Word.n [where n = 1,2,3,4 or 5]
  • Microsoft.UserDictionaries.EntityExtraction.Custom.ExactWord.1
  • Microsoft.UserDictionaries.EntityExtraction.Custom.WordPart.n [where n = 1,2,3,4 or 5]
  • Microsoft.UserDictionaries.EntityExtraction.Custom.ExactWordPart.1

For the non-exact entries, you need to specify a value at the end (1 – 5) which specifies which extraction dictionary it uses.  In the case below, I did number 2 since I already messed up number 1 by specifying the dictionary name incorrectly. :)

$searchApp = Get-SPEnterpriseSearchServiceApplication

Import-SPEnterpriseSearchCustomExtractionDictionary –SearchApplication $searchApp –Filename \\server\c$\folder\WordPartExtraction.csv –DictionaryName Microsoft.UserDictionaries.EntityExtraction.Custom.WordPart.2

When you run the commands, it will look like this.  I put the above in a script file for convenience.

SearchImportCustomEntityExtractorPowerShell

The next part I believe is a little different than the way you did it with FAST Search for SharePoint.  What you need to do is tell search which managed properties to perform entity extraction.  Effectively, what we are doing here is telling search to look at the body of the document and see if anything in there matches items in the dictionary.  To do this, go to your Search Service Application –> Search Schema and edit the property named body

ManagedPropertiesBody

Scroll to the bottom and you will see the Custom entity extraction section.  Now, we just need to check the box next to the dictionary we want to use.  In my case, it is Word Part Extraction – Custom2.  If you have multiple dictionaries you may select them here.  Save the managed property after you make your selection.

ManagedPropertyCustomEntityExtraction

After you save, you need to start a full crawl on your content source, typically Local SharePoint sites

When this finishes, we can now begin to use our new extracted entities in our search center.  The first thing we want to do is add this new extraction to the Refinement web part so that users can refine results by SharePoint feature.  Go to your Search Center and issue a query that is going to get you some results that you know you can refine on.  In my case, I typed the word SharePoint since I knew all of my documents were related to that.  Once you get search results, edit the page.  Then on the left side, edit the Refinement web part.  Now, click the Choose Refiners button. 

RefinementWebPartProperties

This page will list all managed properties marked for refinement.  What’s really nice is that when you click on a managed property, it gives you a preview of the available refiners.

CustomEntityExtractionRefinerProperties

In the list of available refiners, I select WordPartCustomRefiner2.  Below, you see a list of Sample values and the number of times it found a match.  To configure the property, select it and click the Add button.  I also added this new refiner up to the top since I want users to see it first.

CustomEntityExtractionRefinerProperties2

Now, I gave it a Display name and you have the option to choose a different Display template as well as how it is sorted.  You can actually customize how the refiner is rendered on the page with the display template too but that’s outside of the scope of today’s post.  At the bottom of the page there is also a Preview button.  Click on it and you will see what your search results look like before you even save the page.

CustonEntityExtractionRefinementPreview

If you’re happy with the way the refiners look, save the page, check it in, and publish it.  Now issue a query.  I am going to use the same one from before.

CustomEntityExtractionSearchResultsDefault

As you can see, we now see a list of the SharePoint features that we specified in our dictionary.  Let’s try a few refiners.  Let’s start by selecting Electronic Content Management.  I do know that should it read Enterprise, but it was after midnight when I started working on this. :)

CustomEntityExtractionSearchResultsECM

Notice, that in the results, that Word Document 3 comes back and you see “ECM” in it.  That’s the only text in the document and it matched it to that feature since we defined it in the dictionary.  Now let’s try Business Connectivity Services.

CustomEntityExtractionSearchResultsBCS

It returns several slide decks this time because it mentions it in the Intro deck, the BCS deck, UPS, etc.  I’m not sue how Visio Services made a hit to it, but maybe there is something new I need to learn. :)

You can also select multiple refiners.  In this case, I selected Apps and Web Content Management.

CustomEntityExtractionSearchResultsCombined

By now, I am hoping you are seeing the power of entity extraction.  It gives you a new level of classification on documents and the users never had to tag anything manually at all. 

You can issue queries with these dictionaries as well too.  For example, if I want to search for anything tagged with Apps, I would issue the following query.

WordPartCustomRefiner2:"Apps"

CustomEntityExtractionSearchResultsQuery

I hope after reading this post, it has got you started thinking.  Most organizations have next to no metadata on their documents.  This isn’t a replacement for taking the time to classify your documents properly with site columns and content types.  Inferring metadata will never be as good as the users taking the time to classify the documents themselves.  However, it is a great stop-gap in dealing with all of that untagged content you have. 

I think this is one of the most significant feature in SharePoint 2013 that most people will probably never use.  :(  Take the time to set up a few dictionaries and you are going to get immediate value out of search and your users are going to notice.

Read the original blog entry...

More Stories By Corey Roth

Corey Roth, a SharePoint Server MVP, is a consultant at Hitachi Consulting specializing in SharePoint and Office 365 for clients in the energy sector. He has more than ten years of experience delivering solutions in the energy, travel, advertising and consumer electronics verticals.

Corey specializes in delivering ECM and search solutions to clients using SharePoint. Corey has always focused on rapid adoption of new Microsoft technologies including Visual Studio 2013, Office 365, and SharePoint.

He is a member of the .NET Mafia (www.dotnetmafia.com) where he blogs about the latest technology and SharePoint. He is dedicated to the community and speaks regularly at user groups and SharePoint Saturdays.

@ThingsExpo Stories
“In the past year we've seen a lot of stabilization of WebRTC. You can now use it in production with a far greater degree of certainty. A lot of the real developments in the past year have been in things like the data channel, which will enable a whole new type of application," explained Peter Dunkley, Technical Director at Acision, in this SYS-CON.tv interview at @ThingsExpo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
The BPM world is going through some evolution or changes where traditional business process management solutions really have nowhere to go in terms of development of the road map. In this demo at 15th Cloud Expo, Kyle Hansen, Director of Professional Services at AgilePoint, shows AgilePoint’s unique approach to dealing with this market circumstance by developing a rapid application composition or development framework.
The major cloud platforms defy a simple, side-by-side analysis. Each of the major IaaS public-cloud platforms offers their own unique strengths and functionality. Options for on-site private cloud are diverse as well, and must be designed and deployed while taking existing legacy architecture and infrastructure into account. Then the reality is that most enterprises are embarking on a hybrid cloud strategy and programs. In this Power Panel at 15th Cloud Expo (http://www.CloudComputingExpo.com), moderated by Ashar Baig, Research Director, Cloud, at Gigaom Research, Nate Gordon, Director of T...
"BSQUARE is in the business of selling software solutions for smart connected devices. It's obvious that IoT has moved from being a technology to being a fundamental part of business, and in the last 18 months people have said let's figure out how to do it and let's put some focus on it, " explained Dave Wagstaff, VP & Chief Architect, at BSQUARE Corporation, in this SYS-CON.tv interview at @ThingsExpo, held Nov 4-6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Windstream, a leading provider of advanced network and cloud communications, has been named “Silver Sponsor” of SYS-CON's 16th International Cloud Expo®, which will take place on June 9–11, 2015, at the Javits Center in New York, NY. Windstream (Nasdaq: WIN), a FORTUNE 500 and S&P 500 company, is a leading provider of advanced network communications, including cloud computing and managed services, to businesses nationwide. The company also offers broadband, phone and digital TV services to consumers primarily in rural areas.
The Internet of Things is not new. Historically, smart businesses have used its basic concept of leveraging data to drive better decision making and have capitalized on those insights to realize additional revenue opportunities. So, what has changed to make the Internet of Things one of the hottest topics in tech? In his session at @ThingsExpo, Chris Gray, Director, Embedded and Internet of Things, discussed the underlying factors that are driving the economics of intelligent systems. Discover how hardware commoditization, the ubiquitous nature of connectivity, and the emergence of Big Data a...

ARMONK, N.Y., Nov. 20, 2014 /PRNewswire/ --  IBM (NYSE: IBM) today announced that it is bringing a greater level of control, security and flexibility to cloud-based application development and delivery with a single-tenant version of Bluemix, IBM's platform-as-a-service. The new platform enables developers to build ap...

SYS-CON Events announced today that IDenticard will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. IDenticard™ is the security division of Brady Corp (NYSE: BRC), a $1.5 billion manufacturer of identification products. We have small-company values with the strength and stability of a major corporation. IDenticard offers local sales, support and service to our customers across the United States and Canada. Our partner network encompasses some 300 of the world's leading systems integrators and security s...
DevOps Summit 2015 New York, co-located with the 16th International Cloud Expo - to be held June 9-11, 2015, at the Javits Center in New York City, NY - announces that it is now accepting Keynote Proposals. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait for long development cycles that produce software that is obsolete at launch. DevOps may be disruptive, but it is essential.
"People are a lot more knowledgeable about APIs now. There are two types of people who work with APIs - IT people who want to use APIs for something internal and the product managers who want to do something outside APIs for people to connect to them," explained Roberto Medrano, Executive Vice President at SOA Software, in this SYS-CON.tv interview at Cloud Expo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
Nigeria has the largest economy in Africa, at more than US$500 billion, and ranks 23rd in the world. A recent re-evaluation of Nigeria's true economic size doubled the previous estimate, and brought it well ahead of South Africa, which is a member (unlike Nigeria) of the G20 club for political as well as economic reasons. Nigeria's economy can be said to be quite diverse from one point of view, but heavily dependent on oil and gas at the same time. Oil and natural gas account for about 15% of Nigera's overall economy, but traditionally represent more than 90% of the country's exports and as...
The Internet of Things is a misnomer. That implies that everything is on the Internet, and that simply should not be - especially for things that are blurring the line between medical devices that stimulate like a pacemaker and quantified self-sensors like a pedometer or pulse tracker. The mesh of things that we manage must be segmented into zones of trust for sensing data, transmitting data, receiving command and control administrative changes, and peer-to-peer mesh messaging. In his session at @ThingsExpo, Ryan Bagnulo, Solution Architect / Software Engineer at SOA Software, focused on desi...
"At our booth we are showing how to provide trust in the Internet of Things. Trust is where everything starts to become secure and trustworthy. Now with the scaling of the Internet of Things it becomes an interesting question – I've heard numbers from 200 billion devices next year up to a trillion in the next 10 to 15 years," explained Johannes Lintzen, Vice President of Sales at Utimaco, in this SYS-CON.tv interview at @ThingsExpo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
"For over 25 years we have been working with a lot of enterprise customers and we have seen how companies create applications. And now that we have moved to cloud computing, mobile, social and the Internet of Things, we see that the market needs a new way of creating applications," stated Jesse Shiah, CEO, President and Co-Founder of AgilePoint Inc., in this SYS-CON.tv interview at 15th Cloud Expo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Gridstore™, the leader in hyper-converged infrastructure purpose-built to optimize Microsoft workloads, will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. Gridstore™ is the leader in hyper-converged infrastructure purpose-built for Microsoft workloads and designed to accelerate applications in virtualized environments. Gridstore’s hyper-converged infrastructure is the industry’s first all flash version of HyperConverged Appliances that include both compute and storag...
Today’s enterprise is being driven by disruptive competitive and human capital requirements to provide enterprise application access through not only desktops, but also mobile devices. To retrofit existing programs across all these devices using traditional programming methods is very costly and time consuming – often prohibitively so. In his session at @ThingsExpo, Jesse Shiah, CEO, President, and Co-Founder of AgilePoint Inc., discussed how you can create applications that run on all mobile devices as well as laptops and desktops using a visual drag-and-drop application – and eForms-buildi...
We certainly live in interesting technological times. And no more interesting than the current competing IoT standards for connectivity. Various standards bodies, approaches, and ecosystems are vying for mindshare and positioning for a competitive edge. It is clear that when the dust settles, we will have new protocols, evolved protocols, that will change the way we interact with devices and infrastructure. We will also have evolved web protocols, like HTTP/2, that will be changing the very core of our infrastructures. At the same time, we have old approaches made new again like micro-services...
Code Halos - aka "digital fingerprints" - are the key organizing principle to understand a) how dumb things become smart and b) how to monetize this dynamic. In his session at @ThingsExpo, Robert Brown, AVP, Center for the Future of Work at Cognizant Technology Solutions, outlined research, analysis and recommendations from his recently published book on this phenomena on the way leading edge organizations like GE and Disney are unlocking the Internet of Things opportunity and what steps your organization should be taking to position itself for the next platform of digital competition.
The 3rd International Internet of @ThingsExpo, co-located with the 16th International Cloud Expo - to be held June 9-11, 2015, at the Javits Center in New York City, NY - announces that its Call for Papers is now open. The Internet of Things (IoT) is the biggest idea since the creation of the Worldwide Web more than 20 years ago.
As the Internet of Things unfolds, mobile and wearable devices are blurring the line between physical and digital, integrating ever more closely with our interests, our routines, our daily lives. Contextual computing and smart, sensor-equipped spaces bring the potential to walk through a world that recognizes us and responds accordingly. We become continuous transmitters and receivers of data. In his session at @ThingsExpo, Andrew Bolwell, Director of Innovation for HP's Printing and Personal Systems Group, discussed how key attributes of mobile technology – touch input, sensors, social, and ...