Endpoint, Method and Parameter
The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
NER Tagger API
The NER Tagger API is defined as follows:
HTTP Request:
- URL: https://plugin.rchilli.com/RChilliPlugin/rchilli/nerTagger
- Accept: application/json
- Response Type: JSON
API Endpoint
The NER Tagger API endpoint returns the parsed data in the JSON format. The NER Tagger endpoint is mention below:/nerTagger
API Method
The NER Tagger API uses only the POST method.Request Headers
Header | Data Type | Description |
---|---|---|
Content-Type | string | Indicates the input type of the incoming request body. The
only supported value is
application/json . |
API Parameters
The NER Tagger API requires the following parameters in the JSON request
format:
Name | Type | Description | Remarks |
---|---|---|---|
filedata | String | File data in base64 (only support "text/plain" mimetype) | Required |
userkey | String | Valid User Key as provided by RChilli, see How to get user key. | Required |
version | String | Valid version as provided by RChilli | Required |
subuserid | String | Your unique subuser_id Note: Make sure
that there is no space in your subuser_id |
Required |
JSON Request For NER Tagger plugin
Below is the sample API Request in JSON Format:
{
"filedata": "File data in base64",
"userkey": "Your API UserKey",
"version": "1.0.0",
"subuserid": "Use Your subuserid"
}
API Response Parameters
Follow the below table for the NER Tagger API response parameters details.
Name | Type | Description |
---|---|---|
TextLanguage | String | The language code of the input document. |
TaggedText | String | The tagged entity in the text format. |
TaggedData | Follow below rows for the TaggedData parameters: | |
Start | Integer | The start position of the tagged text. |
End | Integer | The end position of the tagged text. |
Id | String | The ID of the tagged text. |
Text | String | The text entity that is tagged. |
Type | String | The entity type of the tagged text. |
JSON Response For NER Tagger plugin
Below is the sample API Response in JSON Format:{
"TextLanguage": "en",
"TaggedText": "Resume: <job>Cosmetic Dentist</job>\nProfessional Summary\nExperienced <job>Cosmetic Dentist</job> with a strong background in dental care and treatment, providing high-quality services to patients. Skilled in cosmetic dentist procedures, patient education, and dental hygiene. Demonstrates excellent communication and interpersonal skills to provide exceptional care.\nKey Skills\n• <skill>Clinical Expertise</skill>\n• <skill>Patient Care</skill> and Education\n• <skill>Treatment Planning</skill>\n• <skill>Dental Procedures</skill>\n• Communication Skills\n• <skill>Dental Equipment</skill> Knowledge\nProfessional Experience\n**Job Title:** <job>Cosmetic Dentist</job>\n**Organization:** Dental Clinic/Hospital\n**Duration:** <dt>Jan 2020</dt> – Present\n**Responsibilities:**\n• Perform dental procedures related to cosmetic dentist.\n• Examine and diagnose dental conditions.\n• Provide treatment plans and patient education.\n• Collaborate with dental team for comprehensive care.\n• <skill>Maintain accurate patient records</skill> and follow-up care.\nEducation\n**Degree:** Relevant Degree\n**Institution:** XYZ University/College\n**Year:** <dt>2019</dt>",
"TaggedData": [
{
"Start": 8,
"End": 23,
"Id": "T1",
"Text": "Cosmetic Dentist",
"Type": "job"
},
{
"Start": 60,
"End": 75,
"Id": "T2",
"Text": "Cosmetic Dentist",
"Type": "job"
},
{
"Start": 362,
"End": 379,
"Id": "T3",
"Text": "Clinical Expertise",
"Type": "skill"
},
{
"Start": 384,
"End": 395,
"Id": "T4",
"Text": "Patient Care",
"Type": "skill"
},
{
"Start": 414,
"End": 431,
"Id": "T5",
"Text": "Treatment Planning",
"Type": "skill"
},
{
"Start": 436,
"End": 452,
"Id": "T6",
"Text": "Dental Procedures",
"Type": "skill"
},
{
"Start": 481,
"End": 496,
"Id": "T7",
"Text": "Dental Equipment",
"Type": "skill"
},
{
"Start": 549,
"End": 564,
"Id": "T8",
"Text": "Cosmetic Dentist",
"Type": "job"
},
{
"Start": 623,
"End": 630,
"Id": "T9",
"Text": "Jan 2020",
"Type": "dt"
},
{
"Start": 875,
"End": 907,
"Id": "T10",
"Text": "Maintain accurate patient records",
"Type": "skill"
},
{
"Start": 1021,
"End": 1024,
"Id": "T11",
"Text": "2019",
"Type": "dt"
}
]
}