Concept Suggestion Request Service
Concept Suggestion Request Service
Description |
|---|
This method allows you to send a string to the service and receive concept suggestions where labels of the concept match the search string. |
URL: /extractor/api/suggest
application/x-www-form-urlencoded
Supported Methods |
|---|
GET |
POST |
Parameter | Type | Required | Description |
|---|---|---|---|
conceptSchemeFilters | Array of String | false | Concept scheme URI filters. |
customAttributes | Array of CustomProperty | false | Filter: List of custom attributes (their URIs and values) to be used as filter for the search request. |
customClasses | Array of String | false | Filter: List of custom classes (their URIs) to be used as filter for the search request. |
customRelations | Array of CustomProperty | false | Filter: List of custom relations (property URI and object URI) to be used as filter for the search request. |
filterOperator | String | false | The operator type (and|or) to connect the different custom class/attribute/property filters (default = or) |
language | String | true | Language of the results (en|de|es|fr|...) |
numberOfConcepts | int | false | Number of results (default = 10) |
offset | int | false | Row offset |
projectId | String | true | Thesaurus projectId |
properties | Array of String | false | Array of custom class attributes and relations that will be fetched by providing their property URIs as input. Set to |
searchParameters | Array of SearchParameter | false | Advanced search parameters allowing to specify the label type, boost factor, and matching strategy. Is used together with searchString. |
searchString | String | false | Text fragment to search concepts for. If searchString and searchParameters are not set, all concepts are returned which can be combined with filters. |
showMatchingDetails | boolean | false | Shows matching details for searchParameters, default = false |
useBlacklisted | boolean | false | Include blacklisted concepts (default = false) |
useCompoundWord | boolean | false | Only include concepts where the searchString is a compound word (default = false) |
useSkosBoost | boolean | false | Use custom scoring for ordering the results. |
Attribute | Type | Comment |
|---|---|---|
property | String | Property |
value | String | Value |
Attribute | Type | Comment |
|---|---|---|
boost | Float | Solr boost factor. (Optional - if boost factor is set, consider to set useCustomScoring to false to disable internal custom sorting) |
customLabel | String | In case labelType CUSTOM_LABEL is used. (Optional) |
labelType | LabelType | Type of the label. Use PREF_LABEL, ALT_LABEL, HIDDEN_LABEL, or ALL (Default: ALL) - use CUSTOM_LABEL for custom properties which requires the parameter customLabel to be set. prefLabel | altLabel | hiddenLabel | customLabel | label |
matchingStrategy | MatchingStrategy | Matching Strategy for indexed fields. Use DEFAULT, REGEX, REGEX_I, SENSITIVE, or EXACT. (Default: DEFAULT) DEFAULT | REGEX | REGEX_I | SENSITIVE | EXACT Use REGEX_I for case insensitive matching. |
searchString | String | Search string. (Mandatory) |
application/json
Attribute | Type | Comment |
|---|---|---|
suggestedConcepts | Array of SuggestedConcepts | Message |
success | boolean | Success |
message | String | Reports the exection time of the query |
total | long | The number of results returned |
Click here to expand...
Attribute | Type | Comment |
|---|---|---|
altLabels | Array of String | Alternative labels |
broaderConcepts | Array of String | URIs of all direct broader concepts. |
conceptSchemes | Array of ThesaurusConceptScheme | The concept schemes this concept resides in. |
corporaScore | double | Relevance score - e.g. when extracted from a text. |
customAttributes | Array of CustomAttribute | Custom attributes |
customRelations | Array of CustomRelation | Custom relations |
customSchemeTypes | Array of CustomSchemeType | URIs of the custom types assigned to the concept. |
frequencyInDocument | int | Frequency of the concept in the text. |
frequencyInDocuments | int | Frequency of the concept in the text. |
hiddenLabels | Array of String | Hidden labels |
highlights | Array of Highlight | The matching text returned by the index. |
id | String | Concept ID |
language | String | Language of the prefLabel, altLabels and hiddenLabels of this localized view of the concept. |
matchingLabel | String | The concept label that has matched the search label. |
matchingLabels | Array of MatchingLabel | Matching labels |
prefLabel | String | Preferred label |
project | String | UUID of the containing PoolParty project. |
relatedConcepts | Array of String | URIs of all related concepts |
score | double | Normalized relevance score - e.g. when extracted from a text |
shadowConceptTerms | Array of ExtractedTerm | |
transitiveBroaderConcepts | Array of String | URIs of all transitive broader concepts. |
transitiveBroaderTopConcepts | Array of String | URIs of all top concepts that this concept is connected to via a transitive broader-chain. |
uri | String | Uniform resource identifier |
wordForms | Array of String | Lemmatized word forms |
Click here to expand...
ConceptScheme from a PoolParty thesaurus project - acts as a container for concepts
Attribute | Type | Comment |
|---|---|---|
title | String | The localized title of this concept scheme |
uri | String | Uniform resource identifier |
Attribute | Type | Comment |
|---|---|---|
literal | Literal | Literal |
property | String | Property |
Attribute | Type | Comment |
|---|---|---|
object | String | Object |
property | String | Property |
(PoolParty) concept scheme - acts as a container for concepts
Attribute | Type | Comment |
|---|---|---|
title | String | The name of this custom scheme type |
uri | String | Uniform resource identifier |
Phrase extracted from a text that does not match any Concepts
Attribute | Type | Comment |
|---|---|---|
corporaScore | double | Corpora score |
frequencyInDocument | int | Frequency within the document where it was extracted |
frequencyInDocuments | int | Frequency within the documents where it was extracted |
score | double | Relevance score |
textValue | String | The term phrase |
Request:
http://test.semantic-web.at/extractor/api/suggest?projectId=1DAB156D-F01F-0001-ABCE-16301D4023C0&language=en&searchString=Aspirin
JSON Result:
{
"success": true,
"suggestedConcepts": [
{
"matchingLabel": "<em>Aspirin</em>-Induced Asthmas",
"score": 10,
"uri": "http://www.nlm.nih.gov/mesh/D055963",
"conceptSchemes": [
{
"title": "Diseases",
"uri": "http://www.nlm.nih.gov/mesh/Diseases"
}
],
"prefLabel": "Asthma, Aspirin-Induced",
"altLabels": [
"Aspirin-Induced Asthmas",
"Asthmas, NSAID-induced",
"Asthma, Aspirin Induced",
"Asthma Syndrome, Aspirin-Induced",
"Induced Asthmas, Aspirin",
"Asthmas, Aspirin-Induced",
"Induced Asthma, Aspirin",
"Syndrome, Aspirin-Induced Asthma",
"Asthma Syndromes, Aspirin-Induced",
"Aspirin Induced Asthma Syndrome",
"Aspirin Induced Asthma",
"Aspirin-Induced Asthma Syndromes",
"Asthma, NSAID-induced",
"Aspirin-Induced Asthma",
"Syndromes, Aspirin-Induced Asthma",
"Aspirin Induced Asthmas",
"Asthmas, Aspirin Induced",
"Aspirin-Induced Asthma Syndrome",
"NSAID-induced Asthmas",
"NSAID-induced Asthma",
"Asthma, NSAID induced"
],
"project": "1DAB156D-F01F-0001-ABCE-16301D4023C0",
"language": "en",
"id": "1DAB156D-F01F-0001-ABCE-16301D4023C0:http://www.nlm.nih.gov/mesh/D055963@en"
},
{
"matchingLabel": "<em>Aspirin</em> Tolerance Tests",
"score": 7,
"uri": "http://www.nlm.nih.gov/mesh/D001760",
"conceptSchemes": [
{
"title": "Phenomena and Processes",
"uri": "http://www.nlm.nih.gov/mesh/Phenomena_and_Processes"
},
{
"title": "Analytical, Diagnostic and Therapeutic Techniques and Equipment",
"uri": "http://www.nlm.nih.gov/mesh/Analytical_Diagnostic_and_Therapeutic_Techniques_and_Equipment"
}
],
"prefLabel": "Bleeding Time",
"altLabels": [
"Bleeding Time, Template",
"Bleeding Times, Template",
"Method, Ivy",
"Bleeding Times",
"Aspirin Tolerance Tests",
"Tolerance Tests, Aspirin",
"Tolerance Test, Aspirin",
"Method, Duke",
"Time, Template Bleeding",
"Template Bleeding Time",
"Times, Template Bleeding",
"Times, Bleeding",
"Time, Bleeding",
"Template Bleeding Times",
"Ivy Method",
"Tests, Aspirin Tolerance",
"Test, Aspirin Tolerance",
"Duke Method",
"Aspirin Tolerance Test"
],
"project": "1DAB156D-F01F-0001-ABCE-16301D4023C0",
"language": "en",
"id": "1DAB156D-F01F-0001-ABCE-16301D4023C0:http://www.nlm.nih.gov/mesh/D001760@en"
},
{
"matchingLabel": "<em>Aspirin</em>",
"score": 4,
"uri": "http://www.nlm.nih.gov/mesh/D001241",
"conceptSchemes": [
{
"title": "Chemicals and Drugs",
"uri": "http://www.nlm.nih.gov/mesh/Chemicals_and_Drugs"
}
],
"prefLabel": "Aspirin",
"altLabels": [
"Micristin",
"Polopirin",
"Magnecyl",
"Zorprin",
"Ecotrin",
"Solupsan",
"Acetylsalicylic Acid",
"Solprin",
"Dispril",
"Acid, Acetylsalicylic",
"Aloxiprimum",
"Endosprin",
"2-(Acetyloxy)benzoic Acid",
"Easprin",
"Polopiryna",
"Acetysal",
"Colfarit",
"Acylpyrin"
],
"project": "1DAB156D-F01F-0001-ABCE-16301D4023C0",
"language": "en",
"id": "1DAB156D-F01F-0001-ABCE-16301D4023C0:http://www.nlm.nih.gov/mesh/D001241@en"
},
{
"matchingLabel": "<em>Aspirin</em> Like Agents",
"score": 3,
"uri": "http://www.nlm.nih.gov/mesh/D000894",
"conceptSchemes": [
{
"title": "Chemicals and Drugs",
"uri": "http://www.nlm.nih.gov/mesh/Chemicals_and_Drugs"
}
],
"prefLabel": "Anti-Inflammatory Agents, Non-Steroidal",
"altLabels": [
"Analgesics, Anti Inflammatory",
"Analgesics, Anti-Inflammatory",
"Non-Steroidal Antirheumatic Agents",
"Agents, Nonsteroidal Anti-Inflammatory",
"Non Steroidal Anti Inflammatory Agents",
"NSAIDs",
"Antiinflammatory Agents, Non Steroidal",
"Agents, Non-Steroidal Anti-Inflammatory",
"Antirheumatic Agents, Non Steroidal",
"Agents, Aspirin-Like",
"Anti Inflammatory Agents, Non Steroidal",
"Nonsteroidal Anti Inflammatory Agents",
"Aspirin-Like Agents",
"Antirheumatic Agents, Non-Steroidal",
"Antiinflammatory Agents, Nonsteroidal",
"Agents, Non-Steroidal Antirheumatic",
"Agents, Nonsteroidal Antiinflammatory",
"Anti-Inflammatory Agents, Nonsteroidal",
"Nonsteroidal Antiinflammatory Agents",
"Nonsteroidal Anti-Inflammatory Agents",
"Anti Inflammatory Agents, Nonsteroidal",
"Anti-Inflammatory Analgesics",
"Anti-Rheumatic Agents, Non-Steroidal",
"Anti Rheumatic Agents, Non Steroidal",
"Agents, Non-Steroidal Anti-Rheumatic",
"Non-Steroidal Anti-Inflammatory Agents",
"Non-Steroidal Anti-Rheumatic Agents",
"Aspirin Like Agents"
],
"project": "1DAB156D-F01F-0001-ABCE-16301D4023C0",
"language": "en",
"id": "1DAB156D-F01F-0001-ABCE-16301D4023C0:http://www.nlm.nih.gov/mesh/D000894@en"
}
],
"total": 4,
"message": "query time: 80 ms"
}