API

API概要

N2 SearchではいくつかのAPIを用意しています。APIを利用することで、既存のウェブシステムなどでも、簡単に N2 Searchを検索システムとして利用することが可能です。

検索API

N2 Search に リクエストを送ることで、 N2 Search の検索結果をJSON形式で受け取ることができます。
使用できるリクエストパラメータは以下の通りです。

q 検索語。URLエンコードして渡します。
start 開始する件数位置。0から始まります。
num 表示件数。デフォルトは20件です。100件まで表示できます。
fields.label ラベル値。ラベルを指定する場合に利用します。
callback JSONPを利用する場合のコールバック名。JSONPを利用しない場合は指定する必要はありません。
facet.field ファセットフィールドの指定。
(例) facet.field=label
facet.query ファセットクエリの指定。
(例)facet.query=timestamp:[now/d-1d TO *]
facet.size 取得するファセットの最大件数の指定。facet.field が指定されているとき、有効です。
facet.minDocCount 件数がこの値以上のファセットを取得します。 facet.field が指定されているとき、有効です。
geo.location.point,
geo.location.distance
ジオサーチで用いる値の指定。それぞれ緯度経度と指定した地点を中心とした距離に対応します。 (例) geo.location.point=35.0,139.0&geo.location.distance=10km

レスポンス情報は以下の通りです。

response ルート要素
version フォーマットバージョン。
status レスポンスのステータス。status値は、0:正常、1:検索エラー、2または3:リクエストパラメータエラー、9:サービス停止中、-1:API種別エラーです。
q 検索語。
exec_time 応答時間。単位は秒。
query_time クエリ処理時間。単位はミリ秒。
page_size 表示件数。
page_number ページ番号。
record_count 検索語に対してヒットした件数。
page_count 検索語に対してヒットした件数のページ数。
facet_field 与えられたファセットフィールドにヒットするドキュメントの情報。 (リクエストパラメータに facet.field が与えられた場合のみ)
facet_query 与えられたファセットクエリにヒットするドキュメントの数。 (リクエストパラメータに facet.query が与えられた場合のみ)
geo_distance クエリとして受け取った与えられた地理情報。(リクエストパラメータに geo.location.point, geo.location.distance が与えられた場合のみ)
result 検索結果の親要素。
filetype ファイルの種別。
created ドキュメントの生成日時。
title ドキュメントのタイトル。
doc_id ドキュメントのID。
url ドキュメントのURL。
site サイト名。
contentDescription コンテンツの説明。
host ホスト名。
digest ドキュメントのダイジェスト文字列。
boost ドキュメントのブースト値。
mimetype MIMEタイプ。
last_modified 最終更新日時。
content_length ドキュメントのサイズ。
urlLink 検索結果としてのURL。
timestamp ドキュメントの更新日時。

Google Search Appliance 互換 API

N2 Search は、検索結果をGoogle Search Appliance(GSA)互換のXMLフォーマットで返すAPIも提供しています。 XMLのフォーマットについては、GSAの公式ドキュメントをご覧ください。
N2 Searchにリクエストを送ることで、検索結果を GSA互換XML形式で受け取ることができます。 リクエストパラメータとして指定できる値は、JSON 応答の検索APIと同じです。

お問い合わせ

本製品に関するお問い合わせは以下にお願いいたします。

お問い合わせフォーム

株式会社 エヌツーエスエム 営業本部

〒101-0024
東京都千代田区神田和泉町1-3-10 第一西川ビル3F