API

商品評判要約APIの使い方

2015/06/11

みなさんこんにちは、gooラボスタッフの関口です。いつもgooラボAPIをご利用いただきありがとうございます。

この記事ではgooラボAPIで公開しております商品評判要約APIの使い方を簡単に解説させていただきます。API説明ページに記載の仕様のみでは分かりづらい、商品評判が入ったレビュー記事を要約するにあたっての勘所をご紹介します。

商品評判要約APIを使う手順は以下のようになります。

1. 解析対象となる商品レビュー記事を用意する

最初に、商品評判要約APIで解析する商品レビュー記事を用意します。
この際、以下の点に注意してください。

PC関連商品・AV機器のレビュー記事を用意する

商品評判要約APIはPC関連商品やAV機器向けにチューニングされているので、その分野のレビュー記事を用いるようにしてください。他の分野のレビュー記事でも処理は実行可能ですが精度が低下しますので、商用での個別チューニングなどをご希望の場合はこちらのページからお問い合わせください。

評判が入っている記事を用意する

『値段が安すぎ』といったような評判情報が含まれるレビュー記事をご用意ください。文書中に評判とみなされる情報が含まれていない場合、商品評判要約APIは要約すべき情報がないとみなして空の要約文を出力します。

良い例:

このメーカーは初めての購入です。思っていたよりも到着が早く助かりました。デザインはシンプルでどこに置いてもマッチします。サイズが小さいのも配置しやすく助かります。

悪い例:

ひらがな化APIはリクエストで送られた日本語文字列を、ひらがな もしくは カタカナ による記載に変換します。例えば、"漢字が混ざっている文章"という文字列を、"かんじが まざっている ぶんしょう”と変換します。

レビュー記事にタイトルなどが存在し、タイトル中にも評価に関する記載がある場合は、本文とスペースを挟んで結合したものを用いてください。特にタイトル部分には評価に関する記載が含まれないような場合は、解析対象に含めないほうが望ましいです。

要約を行うレビュー記事の利用について

要約を行うレビュー記事は著作権法により保護されている場合があります。
商品評判要約APIのご利用にあたり、お客様は、ご自身で、レビュー記事の著作権者から当該レビュー記事の利用につき承諾を得るものとします。

2. APIに送信するリクエストデータの作成

商品評判要約APIの解説記事を参考に、送信するリクエストデータを作成します。最低限必要なのはアプリケーションIDと要約対象レビュー記事集合を含んだJSON形式のデータとなります。(application/x-www-form-urlencoded形式も受け付けますが、ここではapplication/json形式で説明いたします。)

gooラボAPIを利用するためのアプリケーションIDは利用登録ページから取得できますので、お持ちでない場合は利用登録をお願いします。

商品評判要約APIは60文字~180文字の要約文を出力するので、レビュー記事は5~10記事程度を入力すると効果が分かりやすいです。あまり大量のレビュー記事を送信されますと、サーバ側での処理がタイムアウトしてレスポンスが戻らないことがありますのでお気をつけください。大量のレビュー記事を纏めて要約されたい場合は、こちらのページから別途お問い合わせください。

レビュー記事は配列形式で格納してください。また、レビュー記事中の改行コード(LFおよびCR)は事前に除去するようにしてください。「機能は限られていますが、必要十分でしょう。価格も安いと思います。お店の対応もよかったです。」「このシリーズを買うの3台目になりました。黒の発色が綺麗です。値段を考えれば十分すぎる性能でしょう。」という2つのレビュー記事を設定したリクエストデータの例は以下になります。

{"app_id":"[発行されたapp_id]", "review_list":["機能は限られていますが、必要十分でしょう。価格も安いと思います。お店の対応もよかったです。","このシリーズを買うの3台目になりました。黒の発色が綺麗です。値段を考えれば十分すぎる性能でしょう。"]}

返却される要約文の長さはレスポンスにlengthパラメータを設定することにより、60文字、120文字、180文字の3種類から選ぶことが出来ます。(省略した場合は120文字で出力されます。)lengthを60文字とした場合のリクエストボディの例は以下になります。

{"app_id":"[発行されたapp_id]", "length":60, "review_list":["機能は限られていますが、必要十分でしょう。価格も安いと思います。お店の対応もよかったです。","このシリーズを買うの3台目になりました。黒の発色が綺麗です。値段を考えれば十分すぎる性能でしょう。"]}

3. APIにアクセスして解析結果を取得する

送信するリクエストデータができたら、application/json形式でのPOSTリクエストをgooラボAPIサーバに送信して解析結果を取得します。

LinuxやMacなどのcurlコマンドをあるPCから送信する場合は、ヘッダ情報(-Hオプション)に"Content-type: application/json"を、リクエストメソッド(-Xオプション)を"POST"として、リクエストデータ(-dオプション)に2で作成したJSONを設定して実行してください。前述のリクエストデータの例を送信する場合は、以下のようなコマンド内容になります。

curl -H "Content-type: application/json" -X POST -d '{"app_id":"[発行されたapp_id]", "length":60, "review_list":["機能は限られていますが、必要十分でしょう。価格も安いと思います。お店の対応もよかったです。","このシリーズを買うの3台目になりました。黒の発色が綺麗です。値段を考えれば十分すぎる性能でしょう。"]}' 'https://labs.goo.ne.jp/api/shortsum' 

レスポンスとして返却される解析結果は以下のようになります。summaryに格納されている文字列がレビュー記事の要約文となります。エラーコードが返却された場合は、リクエスト内容の確認やリクエストサイズの削減などを行ってください。

{"request_id":"labs.goo.ne.jp[タブ文字]リクエスト受付時刻[タブ文字]0","length":60,"summary":"黒の発色が綺麗です。値段を考えれば十分すぎる性能でしょう。価格も安いと思います。"}

以上ステップで商品評判要約APIをお試しいただけると思います。ご利用にあたってのご不明点などありましたら、こちらのページからお問い合わせください。