分析手順をAI-APIとして実行する
==============================

.. Contents:: 目次
    :local:
    :depth: 2

.. highlight:: console

はじめに
--------

AI-APIは、分析手順（モデル作成、予測）などの処理内容を記述・デプロイ可能なAPIです。
AI-APIの詳細については *AI-API作成ガイド* を参照してください。

ここでは分析手順（Notebookファイル）をデプロイし、AI-APIとして実行する例を示します。

作成済みのAAClusterがない場合は、:ref:`create_aacluster` に従って作成してください。
作成したら、:ref:`access_jupyter_notebook` を参照し、Jupyter Notebookへ接続してください。

AI-APIをデプロイする
--------------------

Jupyter Notebookのルートディレクトリ配下に :file:`/opt/aapf/1.5.4/docs/getting_started.zip` に含まれる
`examples/getting_started-ai-api.ipynb` を配置します。

#. Jupyter Notebookで :guilabel:`[New]` ボタンを押下し、 :guilabel:`[Terminal]` を選択してください。

#. 下記のコマンドを実行してください。

   .. code-block:: bash

     $ mkdir -p ~/aiapi
     $ unzip /opt/aapf/1.5.4/docs/getting_started.zip -d ~/work
     $ cp -r ~/work/examples/* ~/aiapi/

#. Terminal上で :command:`exit` コマンドを実行した後、Terminalタブを閉じてください。

AI-APIの外部仕様を確認する
--------------------------

Jupyter Notebook上でAI-APIの外部仕様（APIのエンドポイント、パラメーター、実行コード例）を
確認することができます。

Jupyter Notebook上で :guilabel:`[aiapi]` ディレクトリに移動し、
`getting_started-ai-api.ipynb` を開きます。ツールバー右端の歯車ボタンを押します。

.. image:: ./_static/doc_button.bmp

外部仕様書が開きます。

.. image:: ./_static/execution_document.bmp

AI-APIの外部仕様書作成機能の詳細は、 *nbexec User Guide - Execution Document* を参照してください。

AI-APIを実行する
----------------

.. raw:: html
   :file: _build/nbconvert/getting_started-ai-app.html
