개발 가이드

어휘 정보 API 란?

다양한 어휘지식을 통합한 WiseWordNet 어휘 지식베이스에 기반하여 어휘의 정보를 분석하는 기술로서 입력된 어휘에 대한 관련 제공합니다. 어휘 정보 API는 HTTP 기반의 REST API 인터페이스로 JSON 포맷 기반의 입력 및 출력을 지원하며 ETRI에서 제공하는 Access Key 인증을 통해 사용할 수 있는 Open API 입니다.

사전 준비 사항

어휘 정보 API를 사용하려면 ETRI 인공지능 Open API 서비스에서 개발자 계정 등록을 해야 합니다. 개발자 계정 등록 이후 API 사용 신청을 통해 API 사용시 필요한 인증 정보를 획득해야 합니다.

  1. “ETRI AI” 홈페이지의 [Open API 사용신청] 페이지로 이동합니다.
  2. [Open API 사용신청] 페이지의 키 발급 신청하기 버튼을 클릭합니다.
  3. Open API의 Access Key 발급에 필요한 사용 신청 정보를 입력 후 등록하기 버튼을 클릭합니다.
    (등록된 사용 신청은 “ETRI AI” 관리자에 의해서 승인이 필요합니다.)
  4. [Open API 사용신청] 페이지의 키 발급 신청확인 버튼을 클릭합니다.
  5. 키 발급 신청에 입력한 “이메일”와 “패스워드”를 입력 후 API KEY 확인하기 버튼을 클릭합니다.
  6. 발급된 Open API의 Access Key를 확인합니다.
어휘 정보 API 사용하기

어휘 정보 API는 REST API이며, 어휘 정보를 수행할 어휘 데이터를 HTTP 통신으로 ETRI Open API 서버에 전달하면 됩니다. 서버가 제공하는 REST API의 URI는 다음과 같으며 POST 방식으로 호출해야 합니다.

http://aiopen.etri.re.kr:8000/WiseWWN/Word

HTTP 요청으로 언어 분석을 요청할 때 사전 준비 사항에서 발급받은 Access key 정보를 요청하는 본문에 포함시켜야 합니다. 다음은 HTTP 요청 메시지 예입니다.

[HTTP Request Body]
{
    "request_id": "reserved field",
    "access_key": “YOUR_ACCESS_KEY”,
    "argument": {
        "word": “YOUR_WORD”
    }
}
                            

위와 같은 HTTP 요청을 ETRI Open API 서버로 전달하면 서버는 JSON 형태의 Text 데이터를 HTTP 응답 메시지로 반환합니다. 다음은 HTTP 응답 예제 입니다.

[HTTP Response Header]
Access-Control-Allow-Origin:*
Connection:close
Content-Length:0
Content-Type:application/json; charset=UTF-8

[HTTP Response Body]
{
    "request_id": "reserved field",
    "result": 0,
    "return_type": "com.google.gson.internal.LinkedTreeMap",
    "return_object": {어휘 관계분석 결과 JSON}
}
                            
구현 예제
Java

JSON parsing을 위해 Gson 라이브러리를 사용하여 제공하고 있습니다. Gson 라이브러리에 대한 자세한 설명은 https://github.com/google/gson 에서 확인 하실 수 있습니다.

import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;

import com.google.gson.Gson;

public class Example {

    static public void main ( String[] args ) {
        String openApiURL = "http://aiopen.etri.re.kr:8000/WiseWWN/Word";
        String accessKey = "YOUR_ACCESS_KEY";    // 발급받은 Access Key
        String word = "YOUR_WORD";                // 정보를 조회할 어휘 데이터
        Gson gson = new Gson();

        Map<String, Object> request = new HashMap<>();
        Map<String, String> argument = new HashMap<>();

        argument.put("word", word);

        request.put("access_key", accessKey);
        request.put("argument", argument);


        URL url;
        Integer responseCode = null;
        String responBody = null;
        try {
            url = new URL(openApiURL);
            HttpURLConnection con = (HttpURLConnection)url.openConnection();
            con.setRequestMethod("POST");
            con.setDoOutput(true);

            DataOutputStream wr = new DataOutputStream(con.getOutputStream());
            wr.write(gson.toJson(request).getBytes("UTF-8"));
            wr.flush();
            wr.close();

            responseCode = con.getResponseCode();
            InputStream is = con.getInputStream();
            byte[] buffer = new byte[is.available()];
            int byteRead = is.read(buffer);
            responBody = new String(buffer);

            System.out.println("[responseCode] " + responseCode);
            System.out.println("[responBody]");
            System.out.println(responBody);

        } catch (MalformedURLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
                                        
PHP
<?php
$openApiURL = "http://aiopen.etri.re.kr:8000/WiseWWN/Word";
$accessKey = "YOUR_ACCESS_KEY";
$word = "YOUR_WORD";

$request = array(
    "access_key" => $accessKey,
    "argument" => array (
        "word" => $word
    )
);

try {
    $server_output = "";
    $ch = curl_init();
    $header = array(
        "Content-Type:application/json; charset=UTF-8",
    );
    curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
    curl_setopt($ch, CURLOPT_URL, $openApiURL);
    curl_setopt($ch, CURLOPT_VERBOSE, true);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode ( $request) );

    $server_output = curl_exec ($ch);
    if($server_output === false) {
        echo "Error Number:".curl_errno($ch)."\n";
        echo "Error String:".curl_error($ch)."\n";
    }

    curl_close ($ch);
} catch ( Exception $e ) {
    echo $e->getMessage ();
}

echo "result = " . var_dump($server_output);
?>
                                       
C++

JSON parsing을 위해 jsoncpp 라이브러리를 사용하여 제공하고 있습니다. jsoncpp 라이브러리에 대한 자세한 설명은 https://github.com/open-source-parsers/jsoncpp 에서 확인 하실 수 있습니다.

HTTP 통신을 위해 curl 라이브러리를 사용하여 제공하고 있습니다. curl 라이브러리에 대한 자세한 설명은 https://curl.haxx.se/libcurl 에서 확인 하실 수 있습니다.

컴파일을 위해서는 아래와 같이 추가된 LIB에 대한 옵션을 추가해야 합니다.
g++ (c++파일명) (JOSNCPP)/json/json.h (JOSNCPP)/json/json-forwards.h (JOSNCPP)/jsoncpp.cpp ?I(CURL)/include -lcurl

#include <curl/curl.h>
#include <json/json.h>
#include <iostream>
#include <string>

using namespace std;

size_t writeDataFunc(void *ptr, size_t size, size_t nmemb, std::string stream);

int main() {
    char* openApiURL = (char*)"http://aiopen.etri.re.kr:8000/WiseWWN/Word";
    string accessKey = "YOUR_ACCESS_KEY";
    string word = "YOUR_WORD";

    Json::Value request;
    Json::Value argument;

    argument["word"] = word;

    request["access_key"] = accessKey;
    request["argument"] = argument;

    CURL *curl;
    curl_slist* responseHeaders = NULL;
    curl = curl_easy_init();

    if( curl == NULL ) {
        cout << "Unable to initialize cURL interface" << endl ;
    } else {
        responseHeaders = curl_slist_append( responseHeaders , "Content-Type: application/json; charset=UTF-8" ) ;
        string requestJson = request.toStyledString();
        long statusCode;
        string response;

        curl_easy_setopt(curl, CURLOPT_URL, openApiURL);
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, responseHeaders ) ;
        curl_easy_setopt(curl, CURLOPT_TIMEOUT, 5);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, requestJson.c_str());
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, writeDataFunc);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

        curl_easy_perform(curl);

        curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &statusCode);
        curl_easy_cleanup(curl);

        cout << "[responseCode] " << statusCode << endl;
        cout << "[responBody]" << endl;
        cout << response << endl;
    }

    return 0;
}

size_t writeDataFunc(void *ptr, size_t size, size_t nmemb, std::string stream) {
    size_t realsize = size * nmemb;
    std::string temp(static_cast<const char*>(ptr), realsize);
    stream.append(temp);
    return realsize;
}
                                       
Python

python 3.0을 기준으로 작성되었습니다.

HTTP 통신을 위해 urllib3 라이브러리를 사용하여 제공하고 있습니다. Python 3.0 이하의 버전에서 예제를 실행하기 위해서는 별도로 urllib3의 설치가 필요합니다. 설치에 대한 설명은 https://pypi.python.org/pypi/urllib3 를 참고하시기 바랍니다. urllib3 라이브러리에 대한 자세한 설명은 https://urllib3.readthedocs.io/en/latest/ 에서 확인 하실 수 있습니다.

#-*- coding:utf-8 -*-
import urllib3
import json

openApiURL = "http://aiopen.etri.re.kr:8000/WiseWWN/Word"
accessKey = "YOUR_ACCESS_KEY"
word = "YOUR_WORD"

requestJson = {
    "access_key": accessKey,
    "argument": {
        "word": word
    }
}

http = urllib3.PoolManager()
response = http.request(
    "POST",
    openApiURL,
    headers={"Content-Type": "application/json; charset=UTF-8"},
    body=json.dumps(requestJson)
)

print("[responseCode] " + str(response.status))
print("[responBody]")
print(str(response.data,"utf-8"))
                                       
Node.js
var openApiURL = 'http://aiopen.etri.re.kr:8000/WiseWWN/Word';
var access_key = 'YOUR_ACCESS_KEY';
var word = 'YOUR_WORD';

var requestJson = {
    'access_key': access_key,
    'argument': {
        'word': word
    }
};

var request = require('request');
var options = {
    url: openApiURL,
    body: JSON.stringify(requestJson),
    headers: {'Content-Type':'application/json; charset=UTF-8'}
};
request.post(options, function (error, response, body) {
    console.log('responseCode = ' + response.statusCode);
    console.log('responseBody = ' + body);
});
                                        
어휘 정보 API 레퍼런스
요청 파라미터

언어 분석 API에 필요한 요청 본문에 다음과 같은 파라미터를 작성해야 합니다.

[HTTP Request Body]
{
    “access_key”: “YOUR_ACCESS_KEY”,
    “argument”: {
        “word”: “YOUR_WORD”
    }
}
                                        

다음은 파라미터에 대한 설명입니다.

Field 명 타입 필수 여부 설명
access_key String API 사용을 위해 ETRI에서 발급한 사용자 Access Key
argument Object API 사용 요청 시 분석을 위해 전달할 내용
word String 분석할 어휘 Text 로서 UTF-8 인코딩된 텍스트만 지원
응답

어휘 정보 API는 요청된 어휘의 분석된 결과를 JSON 형태의 Text 데이터로 반환합니다.
다음은 정상적인 요청 처리에 대한 HTTP 응답 예입니다.

[HTTP Response Header]
Access-Control-Allow-Origin:*
Connection:close
Content-Length:0
Content-Type:application/json; charset=UTF-8

[HTTP Response Body]
{
    "request_id": "reserved field",
    "result": 0,
    "return_type": "com.google.gson.internal.LinkedTreeMap",
    "return_object": {어휘 정보 결과 JSON}
}
                                        

다음은 오류가 발생한 요청 처리에 대한 HTTP 응답 예입니다.

[HTTP Response Header]
Access-Control-Allow-Origin:*
Connection:close
Content-Length:0
Content-Type:application/json; charset=UTF-8

[HTTP Response Body]
{
    "request_id": "reserved field",
    "result": -1,
    "reason": {오류 메시지}
}
                                        

분석된 결과는 다음과 같은 내용이 포함되어 있습니다.

구분 JSON Key 이름 설명
MetaInfo Title Open APIs의 타이틀 명
Link 해당 Open APIs를 사용하기 위한 URL 정보
WWN WordInfo Word 어휘의 원문자열
HomonymCode 어휘의 동음이의어 코드 (2자리 숫자)
WordInfo 어휘의 상세 정보
  PolysemyCode 어휘의 다의어 코드 (2자리 숫자)
  Definition 어휘의 의미 정보
  POS 어휘의 품사
명사 : “n”
동사 : “v”
  Hypernym 어휘의 상위 어휘 정보
  Hypornym 어휘의 하위 어휘 정보
Synonym 어휘의 유의어 어휘 정보
Antonym 어휘의 반의어 어휘 정보
오류 코드

언어 분석 API의 오류 코드 목록은 다음과 같습니다.

http status code result reason 설명
400 -1 Required arguments is empty 필수 파라미터의 값이 없는 경우
400 -1 One or more arguments are not valid 파라미터의 값이 유효하지 않는 경우
413 -1 Request Entity Too Large 요청 문장 또는 어휘의 크기가 서버가 처리 할 수 있는 것보다 큰 경우
429 -1 Too Many Requests 사용자가 주어진 시간 내에 서버에 너무 많은 요청을 하는 경우
404 -1 Unknown Handler 등록되지 않는 서비스를 요청한 경우
408 -1 Handler Timeout 서버의 요청 대기가 시간을 초과한 경우
500 -1 ETRI service server connection refused ETRI 분석 서버에서 요청을 받지 못하는 경우
500 -1 ETRI service server is not exists 수행 가능한 ETRI 분석 서버가 없는 경우
500 -1 Recipient Failure ETRI 분석 서버에서 요청을 처리하지 못하는 경우
500 -1 Unknown ReplyFailure API 요청에 알 수 없는 내부 오류가 발생한 경우
500 -1 Unknown Exception 알 수 없는 내부 오류가 발생한 경우