<commit_before>============
DbeE API仕様
============

DbeEでは認証、バージョンは意識しない。上位のプロキシで認証およびバージョンによる振り分けを行なう。

RESTful APIを目指す。

API概要
=======

APIは4つのコンポーネントから構成される。

DbeE Webインターフェース
    DbeE自身の設定や自身のRESTful APIを使った管理画面を提供する。

DbeE リクエスト管理API
    DbeEの分散バッチエンコードリクエストを管理するためのRESTful APIを提供する。

DbeE キュー管理API
    ジョブ修正、ジョブ削除、ジョブ一覧取得用のRESTful APIを提供する。

DbeE materials API
    素材動画のダウンロード用のRESTful APIを提供する。

DbeE Storage API
    成果物のアップロード用のS3互換APIを提供する。内部はboardwalkを使用している。

RESTful APIはすべてJSON形式で情報を交換する。

DBEE::App
=========

DbeE Webインターフェースを提供する。

DBEE::App::Request
==================

DbeEの分散バッチエンコードリクエストを管理するためのRESTful API。

一応、コンフリクトしないようにレスポンス毎にハッシュ値を入れておく。

公開リソース
------------

* /request/

  POST
    リクエスト内容に応じて新規リクエストを生成し、run_listに沿ってResque.enqueueする。
  GET
    これまでの全リクエストのリストを返す。<commit_msg>docs: cleanup<commit_after>============
DbeE API仕様
============

DbeEでは認証、バージョンは意識しない。上位のプロキシで認証およびバージョンによる振り分けを行なう。

RESTful APIを目指す。

API概要
=======

APIは4つのコンポーネントから構成される。

DbeE Webインターフェース
    DbeE自身の設定や自身のRESTful APIを使った管理画面を提供する。

DbeE リクエスト管理API
    DbeEの分散バッチエンコードリクエストを管理するためのRESTful APIを提供する。

DbeE キュー管理API
    ジョブ修正、ジョブ削除、ジョブ一覧取得用のRESTful APIを提供する。

DbeE materials API
    素材動画のダウンロード用のRESTful APIを提供する。

DbeE Storage API
    成果物のアップロード用のS3互換APIを提供する。内部はboardwalkを使用している。
    boardwalkはRackableではないので独立したサーバにする。

RESTful APIはすべてJSON形式で情報を交換する。

DBEE::App
=========

DbeE Webインターフェースを提供する。

DBEE::App::Request
==================

DbeEの分散バッチエンコードリクエストを管理するためのRESTful API。

一応、コンフリクトしないようにレスポンス毎にハッシュ値を入れておく。

公開リソース
------------

* /request/

  POST
    リクエスト内容に応じて新規リクエストを生成し、run_listに沿ってResque.enqueueする。
  GET
    これまでの全リクエストのリストを返す。
{'fraction_non_alphanumeric': 0.12727272727272726, 'fraction_numerical': 0.0024242424242424242, 'mean_word_length': 6.025531914893617, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '47971', 'n_tokens_mistral': 1142, 'n_tokens_neox': 1088, 'n_words': 89}