Migration from Semantic Enhancement Server to the Concepts Service

Details of how to achieve functionalities present in the Semantic Enhancement Server are presented here. Note, all Concepts Service requests return json, the ability to return XML is not present in the Concepts Server API.

System-wide commands

• “versions” command - this is a health check functionality. Similar functionality can be obtained using the “status” command. This returns (amongst other things) the version of the concepts server installed.
• “modelslist” command - a list of models available for interrogation. The same functionality is supplied by the “models” command. This returns the models list along with a range of metadata about them.
• “modelversions” command - a list of models available for interrogation along with the version numbers available. This information is supplied with the “models” command within the Concept Server so this functionality is redundant.

Model Specific Commands

• “allterms” command - this returns all the concepts and concepts schemes in the model. The equivalent functionality is available from the “concepts” and the “conceptschemes” methods. Note, the Concepts Server differentiates between Concepts and Concept Schemes in its responses.
• “az” command - this returns either an index of concepts with the “use for AZ flag” set on one of their labels, or the set of Concepts with that flag set on a label with the provide letter as the start character. This functionality is not present in the Concepts Server.
• “concepts” command - to return the concepts that related to a fragment of text, use the conceptMapping parameter

http://<<base url>>/models/SpaceMissions/concepts?conceptMapping=moons&extracts=uri,id,prefLabels&lang=en

• “facets” command - returning all the top level items in the Concept tree is now done using the “concept-schemes” method.
• “hierarchy” command - return all the concepts that are direct descendants of a particular concept is done using the request of the format

http://<<base url>>/models/SpaceMissions/concepts?filter=broaderConcepts/objectId=%221a872cb8-61f1-456e-8238-c03c54e450e3%22&extracts=uri,id,prefLabels&lang=en

This returns the uri, id and preferred labels (in English) for the children of the concept with identifier 1a872cb8-61f1-456e-8238-c03c54e450e3

• “hints” command - to make a search-as-you-type requests

http://<<base url>>/models/SpaceMissions/concepts?hints=neil%20a&extracts=id,prefLabels&lang=en

Notice that you now have a lot more control about what data is returned by this request, so you are free to pick as little or as much as you like.

• “name” comand - to get the details of a concept with a prefered label, the request is done with the format

http://<<base url>>/models/SpaceMissions/concepts?filter=prefLabels/value=%22Cape%20Canaveral%20Air%20Force%20Station%22

This will return all the details of the concept(s) with the name “Cape Canaveral Air Force Station” If you want to include altLabels in the search, then

http://<<base url>>/models/SpaceMissions/concepts?filter=altLabels/value="08030"

These queries can be combined with an OR to look over both preferred and alternative labels.

To match only an alternative label of a particular type, the format is

http://<<base url>>/models/SpaceMissions/concepts?filter=altLabels[value=%2208030%22%20and%20propertyUri=%22http://models.smartlogic.com/SpaceMissions%23scnId%22]

• “structure” command - this has a direct replacement with the “structure” command. This can be filtered to extract only the information required, e.g.
• “relationshipTypes” command - http://<<base url>>/models/SpaceMissions/structure?extracts=conceptRelationships
• “relatedFrom” commmand - like the hierarchy command, the terms related to another can be taken using the “concepts” command -

http://<<base url>>/models/SpaceMissions/concepts?filter=relatedConcepts/objectId="31156c0b-167f-4627-99a7-c842fcb3d405"&extracts=prefLabels&lang=en

If you want the concepts related to your chosen concept by a particular relationship type, then the command is

http://<<base url>>/models/SpaceMissions/concepts?filter=relatedConcepts[objectId=%2231156c0b-167f-4627-99a7-c842fcb3d405%22%20and%20propertyUri=%22http://models.smartlogic.com/SpaceMissions%23crewed%22]&extracts=prefLabels&lang=en

Note, the for non-symmetrical relationsips relationship is as seen by the concept to be returned.

• “termrelationships” - this functionality is not available from the concepts server.
• “terms” - this is replaced by the “concepts” or “concept-schemes” command

Filtering

• Filtering by class can be done using a filter of the form

filter=typeUris="http://models.smartlogic.com/SpaceMissions%23OrbitalVehicle"

Note, the class filter does not respect inheritence.

• Filtering by facet - at present there is no way to return concepts within a particular branch of the hierarchy
• General filters, filtering by any of the properties of the concept is possible, including string values using wildcard matching.

Other SES Parameters

• “callback” is not supported as JSONP is now considered deprecated
• “childLimit” is not supported - all the requested data for a concept will be returned
• “cm_stages” is not supported as concept mapping is done differently
• “hiertype” is implemented as the propertyUri of the relationships being sought in a concepts request filtered by relationship type
• “language” has become “lang” and can be used to filter the returned results to the supplied list of languages.
• “maxResultCount” has been replaced by “limit”
• “minDocs” is not supported
• “relatedConceptLimit” is not supported - all the requested data for a concept will be returned
• “sortField” has been replaced by “sortBy”
• “start” has been replaced by “offset”
• “stop_cm_after_stage” is not supported as concept mapping is done differently
• “timezone” is not supported