AI APIALPHA

주제어 추출 API

문서 내 존재하는 고유명사와 주제어구를 추출하여 반환합니다.

요청정보

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

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

입력필드

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

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

출력필드

추출 키워드의 텍스트와 시작, 종료 지점 오프셋 목록을 반환합니다.

출력필드
응답변수 값 설명
data List of objects 추출 키워드 목록
data.text string 추출 키워드 텍스트
data.category string 추출 키워드 종류 (proper_noun, topic)
data.start_offset int 분석 대상 텍스트 내 시작 지점
data.end_offset int 분석 대상 텍스트 내 종료 지점

샘플요청

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

curl -X POST \
  https://api.matgim.ai/54edkvw2hn/api-keyword-topic \
  -H 'content-type: application/json' \
  -H 'x-auth-token: [your-api-key]' \
  -d '{
	"document": "고유명사, 주제어구를 추출할 대상 텍스트가 들어갈 자리입니다."
}'

샘플결과

요청의 결과도 json 형식으로 이루어집니다. 데이터 포맷 설명을 위한 예시이며 실제 응답은 대상 텍스트의 분석 결과로 이루어집니다.

{
    "data": [
        {
            "text": "고유명사",
            "category": "proper_noun",
            "start_offset": 0,
            "end_offset": 4
        },
        {
            "text" : "주제어구",
            "category": "topic",
            "start_offset": 6,
            "end_offset": 10
        }
    ]
}

에러코드

요청 처리에 문제가 생겨서 에러가 발생할 경우, 아래와 같이 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
목록으로
페이지 상단으로 이동