api
初心者
自然言語処理
NLP
COTOHA

初心者の私が、ブラウザで自然言語処理API(COTOHA API)を試せるようになるまで【基本ガイド】

はじめに

ブラウザ上でCOTOHA APIを試すまでのやり方です。
アクセストークンの取得とAPIの実行までの超基本ガイドです。

投稿のきっかけ

はじめまして。COTOHA APIのPR担当をしています。
先日COTOHA APIをリリースしたため、エンジニアではない私ですが、言語処理やAPIの理解のため、自分自身でも利用できるようになりたいとおもいました。
ただ、技術に疎い私には、試してみるまでのハードルがかなり高いです。

まずはブラウザ上でCOTOHA APIを利用できるように、RESTClient上でCOTOHA APIにアクセスできるようになるまでの道のりを丁寧に教えてもらったので、その方法をアップします。

章立て

章立ては、のとおりです。

1. REST Clientをインストールする
2. COTOHA APIにログインする
3. REST Clientでアクセストークンを取得する
4. COTOHA APIを実行する

キャプチャをたくさん貼っていたら、けっこう長くなってしまいました。
実際の作業は5分くらいで利用できるようになると思いますので、さくっと試してみてください!

1.REST Clientをインストールする

まずは、REST APIを利用できるRESTクライアントソフトウェアをWEBブラウザの拡張機能として準備します。

ここではFirefoxを利用しました。

こちらにアクセスしてください。
クリックすると、さっそくダウンロード画面です。
firefox.png

+Firefoxへ追加」をクリックすると、
1個のアドオンをダウンロードして検証しています」とダウンロードがはじまります。

10秒ぐらいで、検証完了します。

このサイトはFirefoxに1個のアドオンのインストールを求めています」とインストールの承認

画面がでてきます。
ここで「インストール」を選択します。

すると、3秒くらいで「REST Clientがインストールされました」とのこと。
インストールされるとヘッダーにREST Clientのアイコンが表示されます。
(赤バックにゴールドの太陽マークです)
firefox_2.png

このREST Clientのアイコンをクリックすると、無事にREST Client画面が表示されました。
firefox_3.png

※ちなみに、REST Clientマークが表示されない場合は、アドオンが「無効」になっている可能性があります。その場合は、ブラウザのヘッダーにあるメニュー(三本の横線マーク)から「アドオン」を選択して、「アドオンマネージャー」画面を開いてください。

ここで、REST Clientが有効化しているか確認してください。「有効化」というボタンが表示されていたら、無効化されているため、「有効化」ボタンをクリックします。

firefox_4.png

2. COTOHA APIにログインする

COTOHA APIを試すためにAPI Keyを取得します。
COTOHA APIのfor Developersに会員登録すれば、無償でAPI keyが発行されます。
無償でも各API毎に1000コール/日利用できます。
会員登録は、こちらから。

さて、ログイン後の画面です。
cotoha api login_new.png

ご覧のとおり、

・Developer API Base URL

・Developer Client id

・Developer Client secret

・Access Token Publish URL

がアカウントホームに掲載されています。

こちらを利用してCOTOHA APIにアクセスします。

3. REST Clientでアクセストークンを取得する

API Keyを手元で確認しつつ、REST Client画面で作業を進めます。

まずは、REST Client画面上のRequestの”Method”で「Post」を選択。

restclient_1.png

次に”Method”の隣のURL入力画面に、COTOHA APIのアカウントホームに表示されている「Access Token Publish URL」を入力します。
cotoha api login_new_2.png

入力しました。↓
restclient_3_1.png

次に注目は、REST Clientの画面上部のHeadersです。
クリックすると、「Customer Header」と「Clear Favorites」のタブがでてくるので、「Customer Header」をクリック。
restclient_4.png

すると、こんな画面が表示されます。
restclient_5.png

ここに、それぞれ、以下の赤字のテキストをそのまま入力します。
Nameには、「Content-Type」、Attribute Valueには「application/json」です。

Name: Content-Type
Attribute Value: application/json

※オートコンプリート機能が効くかと思いますので、途中で選択してください。
入力したら、「Okay」をクリックします。

restclient_6.png

Headersに「Content-Type:application/json」と追加されました。

restclient_7.png

次に、Bodyに以下を入力します。

{
  "grantType":"client_credentials",
  "clientId": "ログイン後の画面に表示されるClient ID",
  "clientSecret": "ログイン後の画面に表示される Client Secret"
}

最後の「}」を忘れないでくださいね。

入力しました。
ようやくこれでインプットは終わりです。
赤い「SEND」ボタンをクリックしてください。

restclient_8.png

クリックすると・・・
こんな感じです↓
restclient_9_1.png

こちらのResponseの「Response」タブにお目当てのアクセストークンが出力されています。
Response」タブをクリックしてください。
restclient_10.png

access_token」がありました!
restclient_11.png

ようやくアクセストークンをゲットできました!
アクセストークンは後で利用するので、どこかにメモっておいてください。

※アクセストークンは、”access_Token”:のあと、「”」で囲まれている文字列(文字列のみ)です。
※アクセストークンの有効期限は一日のため、24時間経過したら再取得が必要ですので、ご注意を!

4. COTOHA APIを実行する

さて、これでようやくブラウザでCOTOHA APIを試せるようになりました。

まずは、COTOHA APIのログイン後画面に戻り、「Developer API Base URL」をチェックします。

そして、「Developer API Base URL」の後に試したいAPI名を追加します。
たとえば、構文解析を試したい場合は、「parse」と追加します。
以下のようになります。
https://[Developer API Base URL]/parse

※以下に各APIのAPI名のみ記載します。(2018年9月時点のAPIになります)
- 固有表現抽出 https://[Developer API Base URL]/ne
- 照応解析   https://[Developer API Base URL]/coreference
- キーワード抽出 https://[Developer API Base URL]/keyword
- 類似度算出  https://[Developer API Base URL]/similarity
- 文タイプ判定 https://[Developer API Base URL]/sentence_type
- ユーザー属性推定 https://[Developer API Base URL]/user_attribute

作成したURLを、REST Clientのプラグインに入力します。
※MethodはPOSTのままです。
cotohaapi_1.png

また、Headerに以下を追加します。

Name: Authorization
Attribute Value: Bearer 前章で取得したアクセストークン

先ほどと同じように、ヘッダーの「Headers」で「Customer Request」をクリックします。
Request Headerが表示されるので、上記を記入し、「Okay」をクリックします。
cotohaapi_2.png

Headersには、
Name: Content-Type, Attribute Value: application/json
もすでに追加されているはずですが、もしない場合は、追加するようにしてください。
cotohaapi_3.png

これですべての準備が整いました!
あとは、Bodyに以下の形式で、解析したい文言を記載し、「SEND」をクリックすると、Responseに解析結果が出力されます。

Parserの入力の形式は、

{"sentence":"解析した文章"}

※入力形式は、APIによって違うので、「Reference」をチェックしてください。

ここでは、

{"sentence":"隣の客はよく柿食う客だ。"}

としてみました。
cotohaapi_4.png

「SEND」をクリックすると・・・約3秒くらいでCompleteとなります。

解析結果はResponseの「Preview」タブで確認してください。
今回は、こんな結果でした↓
cotohaapi_5.png

これで、COTOHA APIの解析結果を、ブラウザ上で確認することができるようになりました!「隣の」の”の”が連体の格助詞って解析されてますね。

解析結果の詳しい解説は、ポータルの「Reference」を確認してください。

ブラウザでみられるようになったので、次は活用して何ができるのか、勉強していきたいと思います。

ここまでおつきあいいただいてありがとうございました!
それでは!!