AI APIALPHA

키워드 추출 API

문서를 입력받아 문장으로 분리하고, 각 문장에 나타난 명사를 추출하여 빈도와 함께 반환합니다.

요청정보

이 API를 호출하기 위해서는 사용자에게 할당된 API Key 가 필요합니다. 회원가입 후에 무료로 발급받을 수 있습니다.

요청정보
URL https://api.matgim.ai/54edkvw2hn/api-keyword
METHOD POST
헤더
Content-Type: application/json
x-auth-token: [your-api-key]

입력필드

문서 본문에 json 형태로 입력합니다. document 필드의 1회 최대 호출 가능 글자수는 1,000자입니다.

입력필드
요청변수 값 설명 예제 필수
document string 키워드를 추출할 문서 (최대 1,000자) 데이탄소프트 O

출력필드

출력 결과는 문장과 키워드로 구분되어 반환됩니다.

출력필드
응답변수 값 설명
sentences List of string 분리된 문장 목록
keywords List of object 키워드 관련 객체
keywords.word string 단어
keywords.freq int 단어의 빈도

샘플요청

요청의 본문은 아래와 같이 json 형식으로 이루어집니다.

curl -X POST \
  https://api.matgim.ai/54edkvw2hn/api-keyword \
  -H 'content-type: application/json' \
  -H 'x-auth-token: [your-api-key]' \
  -d '{
	"document": "키워드 추출 API 입니다. 문장을 분리하고 명사룰 추출하여 빈도와 함께 반환합니다."
}'

샘플결과

요청의 결과도 json 형식으로 이루어집니다. 오류가 없을 경우 단어와 빈도의 조합이 반환됩니다.

{
    "sentences": [
        {
            "sentence": "키워드 추출 API 입니다.",
            "keywords": [
                { "word": "키워드", "freq": 1 },
                { "word": "추출", "freq": 1 },
                { "word": "API", "freq": 1 },
            ]
        },
        {
            "sentence" : "문장을 분리하고 명사를 추출하여 빈도와 함께 반환합니다.",
            "keywords": [
                { "word": "문장", "freq": 1 },
                { "word": "분리", "freq": 1 },
                { "word": "명사", "freq": 1 },
                { "word": "추출", "freq": 1 },
                { "word": "빈도", "freq": 1 },
                { "word": "반환", "freq": 1 },
            ]
        }
    ]
}

에러코드

요청 처리에 문제가 생겨서 에러가 발생할 경우, 아래와 같이 HTTP 응답 코드로 반환됩니다.

에러코드
응답코드 설명
400 Bad Request Exception
403 Access Denied Exception
404 Not Found Exception
409 Conflict Exception
429 Limit Exceeded Exception
429 Too Many Requests Exception
500 Unexpected Exception
503 Service Unavailable Exception
504 Endpoint Request Timed-out Exception
목록으로
페이지 상단으로 이동