FessにバルクAPIを追加

管理APIを使えば、ドキュメントを直接追加とかは今までもできるのだけど、beir-fessで、1件ずつの追加とかだと時間がかかりすぎて、ドキュメントサイズが大きいものだと厳しすぎる…ということで、管理APIに複数件を追加できるエンドポイントを追加しました。

使い方は、/api/admin/documents/bulkにPOSTで以下のように投げる感じです。

$ curl -XPOST -H "Content-Type:application/json" -H "Authorization: <ACCESSTOKEN>" "localhost:8080/api/admin/documents/bulk" -d '{
  "documents": [
    {
      "lang": "en",
      "title": "Test 1",
      "content": "Test Message 1",
      "content_length": 15,
      "url": "http://www.codelibs.org/1.html",
      "host": "www.codelibs.org",
      "site": "www.codelibs.org/1.html",
      "filename": "1.html",
      "mimetype": "text/plain",
      "filetype": "text",
      "click_count": 0,
      "favorite_count": 0,
      "boost": 1.0,
      "last_modified": "1970-01-01T00:00:00.000Z",
      "timestamp": "1970-01-01T00:00:00.000Z",
      "created": "1970-01-01T00:00:00.000Z",
      "role": ["Rguest"]
    },
    {
      "title": "Test 2",
      "content": "Test Message 2",
      "url": "http://www.codelibs.org/2.html"
    }
  ]
}'

アクセストークンは、管理画面からアクセストークンを{role}admin-apiのパーミッションで生成します。

documentsに配列でドキュメントを渡します。urlやtitleなど、必須のフィールドもあります。langフィールドにautoを指定すると、言語判定が行われて、言語用フィールドが追加されます。明示的にlangフィールドを指定していれば、その言語で言語フィールドがインデクシングされます。

レスポンスは以下のように返ってきます。更新であれば、resultはOKになり、失敗していれば、エラーメッセージが含まれます。追加前にバリデーションに引っかかれば、追加せずにエラーが返ってきます。

{
  "response": {
    "items": [
      {
        "result": "CREATED",
        "id": "c7c345e44bc421a66addde52c80d..."
      },
      {
        "result": "CREATED",
        "id": "07929a1cb024b771e1b65b5f6696..."
      }
    ],
    "version": "14.16",
    "status": 0
  }
}%   

という感じで、Fessにドキュメントを効率よく直接追加する手段として利用してみてください。