岡崎研究室　
見出し生成API

共通仕様

---

トークンの有効期限は365日です。また、各エンドポイントごとに一日500回までのリクエスト制限があります。

見出しを生成する

---

ニュース記事を入力として受け取り、見出しを生成して返します。トークンが必須です。

HTTPリクエスト

POST https://api.okazakilab.org/generate

ヘッダー

ヘッダー名	値
Content-Type	application/json
Authorization	Bearer {access token}

ボディ

パラメータ名	タイプ	必須	説明
src	String []	○	見出しを生成する記事のリスト。
model	String		使用する見出し生成モデル。通常の見出し生成モデルであるbasicと、見出しの長さを指定できるlength_controlがあります。デフォルトはbasicです。
nbest	Number		生成する見出しの候補の数。デフォルト値は1です。
length	Number		length_controlモデルで生成する見出しの長さ。他のモデルでは無視されます。デフォルト値は30です。

レスポンス

POSTされた記事のリストに対して"0","1",...のプロパティとともに出力が返されます（下に具体例があります）。出力内容は以下の通りです。

プロパティ	タイプ	説明
hypos	String []	生成された見出しのリスト。

リクエストの例

      curl -i -X POST -H "Content-Type: application/json" \
      -H "Authorization: Bearer $TOKEN" \
      -d '{"src": ["ビックカメラは１０日、２０１８年８月期の通期業績予想について、売上高、営業利益、経常利益、純利益をそれぞれ上方修正したと発表した。", "【ニューヨーク時事】２４日のニューヨーク株式相場は 、トランプ大統領に対する弾劾手続き開始を求める動きを嫌気して反落した。"], "model": "length_control", "nbest": 3, "length": 25}' \
      https://api.okazakilab.org/generate
  

レスポンスの例

    {
      "0": {
        "hypos": [
          "ビックカメラ、通期業績予想を上方修正＝１８年８月",
          "ビックカメラ、１８年８月期業績予想を上方修正＝",
          "ビックカメラ、１８年８月通期業績予想を上方修正"
        ]
      },
      "1": {
        "hypos": [
          "〔米株式〕ＮＹダウ、反落＝大統領弾劾で（２４日）",
          "ＮＹ株、反落＝大統領弾劾を嫌気〔米株式〕（２４日）",
          "ＮＹ株、反落＝弾劾手続きを嫌気〔米株式〕（２４日）"
        ]
      }
    }    
  

タスクの一覧を取得する

---

利用可能なモデルのアーキテクチャや設定の一覧を取得します。

HTTPリクエスト

GET https://api.okazakilab.org/tasks

ヘッダー

ヘッダー名	値
Content-Type	application/json