API NLP – Spell Checking (Sửa lỗi chính tả)

• URLhttps://viettelgroup.ai/nlp/api/v1/spell-checking
• MethodPOST
• Header Parameters1. header "Content-Type: application/json"2. header "token: token_id"

  Để có "token id" bạn có thể đăng ký tài khoản tại viettelgroup.ai, sau đó login, rồi vào menu token để tạo

Định dạng data gửi lên: Json (default)

{
    "sentence": input text
}

Trong đó: sentence là câu văn cần kiểm tra

Success Response

Code: 200
Content: Json array

Json array, mỗi phần tử là một từ có khả năng bị lỗi, gợi ý sửa lỗi và vị trí của từ này trong câu:

[ 
   { 
      "startIndex":0,
      "endIndex":3,
      "originalText":"Hơm",
      "suggestion":"Hôm",
      "confidence":1
   }
]

Mô tả các tham số

API nhận đầu vào là một câu văn, đưa ra danh sách các từ có khả năng bị lỗi (chính tả, teencode, typo, viết tắt…), đưa ra các gợi ý sửa lỗi

Example Output

Success

{ 
   "code":0,
   "message":"OK",
   "result":{ 
      "suggestions":[ 
         { 
            "startIndex":0,
            "endIndex":3,
            "originalText":"Hơm",
            "suggestion":"Hôm",
            "confidence":1
         },
         { 
            "startIndex":8,
            "endIndex":10,
            "originalText":"lầ",
            "suggestion":"là",
            "confidence":1
         },
         { 
            "startIndex":11,
            "endIndex":14,
            "originalText":"mot",
            "suggestion":"một",
            "confidence":1
         },
         { 
            "startIndex":15,
            "endIndex":19,
            "originalText":"ngay",
            "suggestion":"ngày",
            "confidence":1
         },
         { 
            "startIndex":20,
            "endIndex":23,
            "originalText":"dẹp",
            "suggestion":"đẹp",
            "confidence":1
         },
         { 
            "startIndex":24,
            "endIndex":30,
            "originalText":"trowif",
            "suggestion":"trời",
            "confidence":1
         }
      ]
   }
}

Failure

{ 
   "code":3,
   "message":"Request format is invalid!"
}

API NLP – Name Entity Recognition (Nhận dạng tên thực thể)

• URLhttps://viettelgroup.ai/nlp/api/v1/ner
• MethodPOST
• Header Parameters1. header "Content-Type: application/json"2. header "token: token_id"

  Để có "token id" bạn có thể đăng ký tài khoản tại viettelgroup.ai, sau đó login, rồi vào menu token để tạo

Định dạng data gửi lên: Json (default)

{
    "sentence": "input text"
}

Trong đó: sentence là câu văn cần thực hiện nhận dạng thực thể

Success Response

Code: 200
Content: Json array

Mô tả các tham số

API nhận đầu vào là một câu văn, đưa ra danh sách các thực thể và vị trí của thực thể đó trong câu.

Example Output

Success

{ 
   "code:":0,
   "message":"OK",
   "result":[ 
      { 
         "end_index":7,
         "start_index":0,
         "type":"ORG_Corporation",
         "word":"Viettel"
      },
      { 
         "end_index":51,
         "start_index":18,
         "type":"ORG_Other",
         "word":"trực thuộc Bộ Quốc Phòng Việt Nam"
      },
      { 
         "end_index":74,
         "start_index":68,
         "type":"LOC_GPE",
         "word":"Hà Nội"
      },
      { 
         "end_index":123,
         "start_index":89,
         "type":"MISC",
         "word":"Cộng hòa xã hội chủ nghĩa Việt Nam"
      }
   ]
}

Failure

{ 
   "code":1,
   "message":"Invalid json syntax! Cannot parse request!"
}

API NLP – Part-of-Speech Tagging (Gán nhãn từ loại)

• URLhttps://viettelgroup.ai/nlp/api/v1/postag
• MethodPOST
• Header Parameters1. header "Content-Type: application/json"2. header "token: token_id"

  Để có "token id" bạn có thể đăng ký tài khoản tại viettelgroup.ai, sau đó login, rồi vào menu token để tạo

Định dạng data gửi lên: Json (default)

{
    "sentence": "input text"
}

Trong đó: sentence là câu văn cần kiểm tra

Success Response

Code: 200
Content: Json array

Mô tả các tham số

API nhận đầu vào là một câu văn, đưa ra danh sách các từ cùng nhãn từ loại và vị trí của từ đó trong câu

Example Output

Success

{ 
   "code:":0,
   "message":"OK",
   "result":[ 
      { 
         "end_index":7,
         "start_index":0,
         "type":"Np",
         "word":"Viettel"
      },
      { 
         "end_index":10,
         "start_index":8,
         "type":"V",
         "word":"là"
      },
      { 
         "end_index":17,
         "start_index":11,
         "type":"N",
         "word":"đợn vị"
      },
      { 
         "end_index":28,
         "start_index":18,
         "type":"N",
         "word":"trực thuộc"
      },
      { 
         "end_index":42,
         "start_index":29,
         "type":"N",
         "word":"Bộ Quốc Phòng"
      },
      { 
         "end_index":51,
         "start_index":43,
         "type":"Np",
         "word":"Việt Nam"
      }
   ]
}

Failure

{ 
   "code":1,
   "message":"Invalid json syntax! Cannot parse request!"
}

Word type list

{
    "sentence": "input text"
}

Code: 200
Content: Json array

{ 
   "code:":0,
   "message":"OK",
   "result":[ 
      { 
         "end_index":7,
         "start_index":0,
         "word":"Viettel"
      },
      { 
         "end_index":10,
         "start_index":8,
         "word":"là"
      },
      { 
         "end_index":17,
         "start_index":11,
         "word":"đơn vị"
      },
      { 
         "end_index":28,
         "start_index":18,
         "word":"trực thuộc"
      },
      { 
         "end_index":42,
         "start_index":29,
         "word":"Bộ Quốc Phòng"
      },
      { 
         "end_index":51,
         "start_index":43,
         "word":"Việt Nam"
      }
   ]
}

{ 
  "code": 1,
  "message": "Invalid json syntax! Cannot parse request!"
}