콘텐츠로 이동

훑어보기

빨리 써보기

  • bareun.ai에 가입해서 API키를 받습니다. (회원가입 요청 후 이메일 인증을 하고 '로그인-내정보'에서 확인)
  • 설치합니다. 설치 후에 API키를 등록합니다. 이미 설치되어 있는 바른의 설치본을 알고 있으시면, 이 단계는 넘어가도 됩니다.
  • 라이브러리를 설치합니다.
  • API키를 사용하여 코드를 작성합니다.

아래 순서도는 바른을 사용하는 방법을 보여줍니다.

  • 클라우드 서비스를 이용하기(형태소 분석기 및 맞춤법 검사기 지원)
  • 이미 설치된 다른 서버를 사용하기(형태소 분석기만 지원)
  • 다운로드하고 설치하기(형태소 분석기만 지원)
graph TD
  A1[bareun.ai 가입] --> B[API키 자동 발급];
  B --> CR[바른 맞춤법 검사기];
  B --> AN[바른 형태소 분석기];
  CR --> CLOUD[클라우드 서비스 이용하기];
  AN --> CLOUD[클라우드 서비스 이용하기];
  AN --> PREVINST[이미 설치된 다른 서버가 있는 경우];
  AN --> INST[다운로드 및 설치];
  CLOUD --> LIB[라이브러리 설치];
  PREVINST --> LIB[라이브러리 설치];
  INST --> LIB[라이브러리 설치];
  LIB --> KEY[API키 복사 및 서버 적용];
  KEY --> CODE[코드 구현 및 실행];

다운로드하여 설치하기

다운로드하여 설치하는 경우에는 최종적으로 API키를 등록해야 합니다. 아래 과정을 정리하였습니다.

graph TD
  ONPREMISE[설치하여 이용하기];
  ONPREMISE --> C{OS};
  C --->|리눅스/데비안| L[.deb];
  C --->|윈도우| W[.exe];
  C -->|맥OS| M[.pkg];
  M --> INST[다운로드 및 설치];
  L --> INST[다운로드 및 설치];
  W --> INST[다운로드 및 설치];
  INST --> APIKEY[API키 등록];

따라하세요.

먼저 API키를 준비하세요. API키는 koba-ABCDEFG-1234567-LMNOPQR-7654321 처럼 생겼습니다. 여기서는 가상의 이 API키로 설명하겠습니다. koba는 Key of bareun ai를 줄여서 만들었습니다.

클라우드 서비스 이용하기

바른을 설치하는 절차가 까다롭다고 생각하는 경우, 클라우드 서비스를 이용해서 사용할 수 있습니다.

  • 주소: 클라우드에 설치되어 있는 서버는 api.bareun.ai입니다.
  • 포트: 443, 서비스 포트는 로컬 서버와 다르게 443입니다.
  • TLS: 클라우드 서비스는 TLS 암호화를 통해서 전송되는 패킷을 공격자로부터 보호합니다.
  • 다양한 API: grpc, grpc-web, REST 등 3가지 방식으로 사용할 수 있습니다.
  • API: 맞춤법 검사기, 형태소 분석기

클라우드 서비스는 유료

형태소 분석이든 맞춤법 검사 서비스든 둘다 유료 서비스입니다. 원격 컴퓨팅 자원을 사용하기 때문에 해당 자원의 사용료를 부담한다고 보시면 좋을 것 같습니다. 직접 구매한 노트북을 사용하시거나 AWS, Azure, GCP, 네이버 클라우드 등 클라우드 시스템에 머신을 임대하여 사용하는 경우에 발생하는 비용에 비해서는 훨씬 더 저렴할 수 있습니다.

유료로 사용하실 경우, 유료회원 등록 절차를 거치시면 됩니다.

클라우드 무료 구간

클라우드 서비스의 무료 구간은 50,000 어절까지입니다. 이 무료 구간에 대해서도 API를 사용해서 api.bareun.ai를 사용하시면 됩니다. 또한 로그인을 하시면 사용량 통계를 실시간으로 확인할 수 있습니다.

맞춤법 검사기는 클라우드에서만

맞춤법 검사 서비스는 클라우드에서만 서비스 됩니다. 다만, 폐쇄망에서 맞ㅊ무법 검사기를 사용하고 싶으신 경우에는 별도로 설치를 지원해드립니다. 이때도 유료입니다.

연구 목적이라면 무료

형태소 분석이든 맞춤법 검사 서비스든 연구 목적이라면 무료로 사용하실 수 있습니다. 이때 연구명, 연구목적, 연구방법 및 내용, 기대효과, 사사표시, 연구내용 공개 등을 명시하여 신청서를 제출해주시면 심사를 거쳐서 승인을 해줄 수 있습니다.

개발의 절차는 매우 간단합니다.

  1. API 키 복사
  2. 개발 코드 작성
  3. 실행

이미 설치되어 있는 다른 서버에 접속하기

바른이 설치되어 있는 다른 서버를 알고 계신다면, 거기를 이용하는 것도 하나의 방법입니다. 이 경우에는 해당 서버의 주소를 알고 접근하시면 됩니다.

API에 서버의 주소와 포트를 입력하시면 바로 서비스를 사용할 수 있습니다.

다운로드

설치가능한 바른은 형태소 분석기만

무료로 설치 가능한 바른은 형태소 분석기까지만 제공됩니다. 이 경우에는 특별히 상업적인 이용이 아닌 경우에 무료로 사용할 수 있습니다.

유료 계약한 경우에는 바른 맞춤법 검사기 설치 가능

바른 맞춤법 검사기를 온-프레미스로 설치하고자 하는 경우에도 설치가 가능합니다. 다만, 별도의 계약 절차를 거쳐야만 합니다. bareun.license@bareun.ai 로 문의해주시면 됩니다.

  • 리눅스 및 맥OS의 경우에는 wget, curl을 사용해서 설치할 수 있습니다.
  • 윈도우 사용자의 경우, Win+R 키를 누른 다음, cmd를 입력해서 명령창을 실행합니다. 윈도우 10 이상에는 curl이 포함되어 있습니다. 이전 버전의 경우에는 수동으로 다운로드를 하시면 됩니다.
wget -nv --no-check-certificate --content-disposition --header "uname:$(uname -a)" https://bareun.ai/api/get

curl -OLJs -H "uname:$(uname -a)" https://bareun.ai/api/get

curl -OLJs -H "uname: windows, %PROCESSOR_ARCHITECTURE%" https://bareun.ai/api/get

docker pull bareunai/bareun:latest

설치하기

자동 설치

리눅스는 표준 데비안 패키지로 설치합니다. 우분투나 민트에서는 바로 사용가능합니다. 윈도우의 경우에도 설치 프로그램을 통해서 바로 설치를 진행할 수 있습니다.

리눅스는 root 권한으로 실행을 해야 합니다. 윈도우의 경우에는 명령어를 실행하면, 자동으로 관리자 권한으로 상승하게 됩니다.

맥OS의 경우에는 패키지 설치를 통해서 진행됩니다.

수동 설치

수동 설치 환경은 다음 순서로 진행합니다.

  • 홈 디렉터리에서 설치합니다.
  • 환경변수를 설정합니다.
  • 바른 실행파일을 백그라운드로 실행합니다.
sudo apt install bareun-v3.0.0.linux-x86_64.deb
# or
sudo apt install bareun-v3.0.0.linux-arm64.deb

VER="v3.0.0"
tar xf bareun-$VER.linux-x86_64.tar.gz
echo export BAREUN_ROOT=$HOME/bareun-$VER >> ~/.bashrc
echo export PATH=$BAREUN_ROOT/bin:$PATH >> ~/.bashrc
. ~/.bashrc
nohup $BAREUN_ROOT/bin/bareun &

VER="v3.0.0"
tar xf bareun-$VER.linux-arm64.tar.gz
echo export BAREUN_ROOT=$HOME/bareun-$VER >> ~/.bashrc
echo export PATH=$BAREUN_ROOT/bin:$PATH >> ~/.bashrc
. ~/.bashrc
nohup $BAREUN_ROOT/bin/bareun &

VER="v3.0.0"
tar xf bareun-$VER.darwin-x86_64.tar.gz
echo export BAREUN_ROOT=$HOME/bareun-$VER >> ~/.bashrc
echo export PATH=$BAREUN_ROOT/bin:$PATH >> ~/.bashrc
. ~/.bashrc
nohup $BAREUN_ROOT/bin/bareun &

VER="v3.0.0"
tar xf bareun-$VER.darwin-arm64.tar.gz
echo export BAREUN_ROOT=$HOME/bareun-$VER >> ~/.bashrc
echo export PATH=$BAREUN_ROOT/bin:$PATH >> ~/.bashrc
. ~/.bashrc
nohup $BAREUN_ROOT/bin/bareun &

bareun-v3.0.0.windows-x86_64.exe

mkdir -p ~/bareun/var
docker run -d -p 5757:5757 -v:~/bareun/var:/bareun/var  bareunai/bareun:latest

API키 등록

API키를 등록하려면 설치된 시스템에서 http://localhost:5656으로 접속하시면 됩니다.

또는 다음과 같이 명령어로 설치하는 것도 가능합니다.

/opt/bareun/bin/bareun -reg koba-ABCDEFG-1234567-LMNOPQR-7654321

$BAREUN_ROOT/bin/bareun -reg koba-ABCDEFG-1234567-LMNOPQR-7654321

$BAREUN_ROOT/bin/bareun -reg koba-ABCDEFG-1234567-LMNOPQR-7654321

c:\Program Files\bareun\bin\bareun -reg koba-ABCDEFG-1234567-LMNOPQR-7654321

docker exec bareun /bareun/bin/bareun -reg koba-ABCDEFG-1234567-LMNOPQR-7654321

여기 있는 API키를 복사하지 마세요.

여기에서 예시로 든 API키 koba-ABCDEFG-1234567-LMNOPQR-7654321는 bareun.ai에서 발급받은 자신의 API키로 바꾸셔야 합니다.

파이썬 라이브러리 설치하기

python -m venv venv
. venv/bin/activate
pip install bareunpy

코드 생성

import sys
from bareunpy import Tagger

# 아래에 "https://bareun.ai/"에서 이메일 인증 후 발급받은 API KEY("koba-...")를 입력해주세요. "로그인-내정보 확인"
API_KEY="koba-ABCDEFG-1234567-LMNOPQR-7654321" # <- 본인의 API KEY로 교체 

# 방금 설치한 자신의 호스트에 접속합니다.
tagger = Tagger(API_KEY, 'localhost')
# 결과를 가져옵니다.
res = tagger.tags(["안녕하세요.", "바른을 사용해서 새로운 경험을 해보세요."])

결과 출력

  • pos(): 형태소, 태그를 출력합니다.
# 결과에서 형태소를 뽑아냅니다.
pa = res.pos()
print(pa)

[('안녕하', 'VA'), ('시', 'EP'), ('어요', 'EF'), ('.', 'SF'),
('바른', 'NNP'), ('을', 'JKO'), ('사용하', 'VV'), ('아서', 'EC'),
('새롭', 'VA'), ('ㄴ', 'ETM'), ('경험', 'NNG'), ('을', 'JKO'),
('하', 'VV'), ('아', 'EC'), ('보', 'VX'), ('시', 'EP'),
('어요', 'EF'), ('.', 'SF')]
  • morphs(): 형태소만 찾아냅니다.
# 모든 형태소를 뽑아냅니다.
ma = res.morphs()
print(ma)

['안녕하', '시', '어요', '.', '바른', '을', '사용하', '아서',
 '새롭', 'ㄴ', '경험', '을', '하', '아', '보', '시', '어요', '.']
  • nouns(): 체언만 출력합니다.
# 체언만 뽑아냅니다.
va = res.nouns()
print(va)

['바른', '경험']
  • verbs(): 용언만 출력합니다.
# 용어만 뽑아냅니다.
va = res.verbs()
print(va)

['사용하', '하']
  • msg() or as_json_str(): 형태소 분석 결과 전체를 보여줍니다.
# 전체 분석 결과를 뽑아냅니다.
m = print(res.as_json_str())
print(m)

{
"sentences": [
    {
    "text": {
        "content": "안녕하세요.",
        "length": 6,
        "beginOffset": 0
    },
    "tokens": [
        {
        "text": {
            "content": "안녕하세요.",
            "length": 6,
            "beginOffset": 0
        },
        "morphemes": [
            {
            "text": {
                "content": "안녕하",
                "length": 3,
                "beginOffset": 0
            },
            "tag": "VA",
            "outOfVocab": "IN_BUILTIN_DICT",
            "probability": 0.0
            },
            {
            "text": {
                "content": "시",
                "beginOffset": 3,
                "length": 1
            },
            "tag": "EP",
            "probability": 0.9936437,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": "어요",
                "beginOffset": 3,
                "length": 2
            },
            "tag": "EF",
            "probability": 0.992555,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": ".",
                "beginOffset": 5,
                "length": 1
            },
            "tag": "SF",
            "probability": 0.9979541,
            "outOfVocab": "IN_WORD_EMBEDDING"
            }
        ],
        "lemma": "안녕하",
        "tagged": "안녕하/VA+시/EP+어요/EF+./SF"
        }
    ],
    "refined": "안녕하세요."
    },
    {
    "text": {
        "content": "바른을 사용해서 새로운 경험을 해보세요.",
        "beginOffset": 7,
        "length": 22
    },
    "tokens": [
        {
        "text": {
            "content": "바른을",
            "beginOffset": 7,
            "length": 3
        },
        "morphemes": [
            {
            "text": {
                "content": "바른",
                "beginOffset": 7,
                "length": 2
            },
            "tag": "NNP",
            "probability": 0.7029643,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": "을",
                "beginOffset": 9,
                "length": 1
            },
            "tag": "JKO",
            "probability": 0.9985147,
            "outOfVocab": "IN_WORD_EMBEDDING"
            }
        ],
        "lemma": "바른",
        "tagged": "바른/NNP+을/JKO"
        },
        {
        "text": {
            "content": "사용해서",
            "beginOffset": 11,
            "length": 4
        },
        "morphemes": [
            {
            "text": {
                "content": "사용하",
                "beginOffset": 11,
                "length": 3
            },
            "tag": "VV",
            "outOfVocab": "IN_BUILTIN_DICT",
            "probability": 0.0
            },
            {
            "text": {
                "content": "아서",
                "beginOffset": 13,
                "length": 2
            },
            "tag": "EC",
            "probability": 0.97633106,
            "outOfVocab": "IN_WORD_EMBEDDING"
            }
        ],
        "lemma": "사용하",
        "tagged": "사용하/VV+아서/EC"
        },
        {
        "text": {
            "content": "새로운",
            "beginOffset": 16,
            "length": 3
        },
        "morphemes": [
            {
            "text": {
                "content": "새롭",
                "beginOffset": 16,
                "length": 2
            },
            "tag": "VA",
            "probability": 0.9798353,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": "ㄴ",
                "beginOffset": 18,
                "length": 1
            },
            "tag": "ETM",
            "probability": 0.99809676,
            "outOfVocab": "IN_WORD_EMBEDDING"
            }
        ],
        "lemma": "새롭",
        "tagged": "새롭/VA+ㄴ/ETM"
        },
        {
        "text": {
            "content": "경험을",
            "beginOffset": 20,
            "length": 3
        },
        "morphemes": [
            {
            "text": {
                "content": "경험",
                "beginOffset": 20,
                "length": 2
            },
            "tag": "NNG",
            "probability": 0.97490656,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": "을",
                "beginOffset": 22,
                "length": 1
            },
            "tag": "JKO",
            "probability": 0.9992314,
            "outOfVocab": "IN_WORD_EMBEDDING"
            }
        ],
        "lemma": "경험",
        "tagged": "경험/NNG+을/JKO"
        },
        {
        "text": {
            "content": "해",
            "beginOffset": 24,
            "length": 1
        },
        "morphemes": [
            {
            "text": {
                "content": "하",
                "beginOffset": 24,
                "length": 1
            },
            "tag": "VV",
            "probability": 0.9053459,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": "아",
                "beginOffset": 24,
                "length": 1
            },
            "tag": "EC",
            "probability": 0.9838363,
            "outOfVocab": "IN_WORD_EMBEDDING"
            }
        ],
        "lemma": "하",
        "tagged": "하/VV+아/EC"
        },
        {
        "text": {
            "content": "보세요.",
            "beginOffset": 25,
            "length": 4
        },
        "morphemes": [
            {
            "text": {
                "content": "보",
                "beginOffset": 25,
                "length": 1
            },
            "tag": "VX",
            "probability": 0.90671366,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": "시",
                "beginOffset": 26,
                "length": 1
            },
            "tag": "EP",
            "probability": 0.9977518,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": "어요",
                "beginOffset": 26,
                "length": 2
            },
            "tag": "EF",
            "probability": 0.9904806,
            "outOfVocab": "IN_WORD_EMBEDDING"
            },
            {
            "text": {
                "content": ".",
                "beginOffset": 28,
                "length": 1
            },
            "tag": "SF",
            "probability": 0.99819946,
            "outOfVocab": "IN_WORD_EMBEDDING"
            }
        ],
        "lemma": "보",
        "tagged": "보/VX+시/EP+어요/EF+./SF"
        }
    ],
    "refined": "바른을 사용해서 새로운 경험을 해 보세요."
    }
],
"language": "ko_KR"
}

도움이 되었나요?