MatrixFlowマニュアル

※本ページを含む［サービス管理］のセクションは、エンジニア様向けの技術的なご案内が多く含まれます。

MatrixFlowは、SaaS上で提供している各種機能をRESTful APIを介しても実行できます。
RESTful APIをユーザー様がご利用のシステムに組み込むと、MatrixFlowを起動せずに実行できるようになります。

▶「API」とは

Application Programming Interface（アプリケーション・プログラミング・インタフェース）の略で、ごく簡単に説明するとアプリケーションやソフトウェア同士をつなぐものです。
ここでは、お客様が利用されている環境上の「アプリケーションやソフトウェア」とMatrixFlowをつなぐものと言えます。
APIの中でも「RESTful API」はHTTP通信によってWebと対話を行うAPIのため、プログラミング言語による制限を受けずにMatrixFlowの機能を実行することができます。

■ サービス管理画面でできること

サービス管理画面では、RESTful API関連の管理を行います。
具体的に次のことが行えます。

• サービスの作成
  SaaS版で提供している各機能をRESTful API化し、API URLとシークレットキーを発行します。
• サービスの編集
  サービス作成の際に登録した内容（レシピや前処理、学習済みAIなど）を変更できます。
• サービスの削除
  不要になったサービスを削除します。

サービスはベーシックプランご契約ユーザー様のみご利用いただけます。
また、1アカウントあたり30個まで作成できます。

サービス管理画面について詳しくは、サービス管理画面 をご覧ください。

■ 作成したサービスに含まれるもの

作成したサービスには次のものが含まれます。

• API URL
  生成したRESTful API本体にアクセスするためのURL
• シークレットキー
  Web接続する際の認証キー
• パラメータ一覧
  リクエストの実行に必要なパラメータの一覧
• サンプルコード
  外部システムからAPIを実行するためのコード。curlとPython 2通りのサンプル。

■ MatrixFlowのRESTful APIでできること

作成したサービスに含まれるRESTful APIをお客様が利用されているシステムに組み込むと、MatrixFlowを起動せずに次の機能を実行することができます。

＜プロジェクト管理＞
MatrixFlowの各プロジェクト管理機能を実行する
（具体的なできることは プロジェクト管理のサービスAPI仕様 を参照）

＜学　習＞
MatrixFlowでAIモデルの学習を行う、学習の進行状況を取得する、学習を中止する

＜推　論＞
学習済みAIモデルを使ってMatrixFlowで推論（予測）を行う

＜最適化＞
最適化を実行する、最適化を再実行する、最適化の進行状況を取得する、最適化を中止する

■ 外部システムの開発を前提としています

MatrixFlowのRESTful APIでできるのは、外部システムから送信されてきたリクエストを実行し、レスポンス（返り値）を返すところまでです。リクエストの送信やレスポンスの受け取りは、外部システムで行うことを想定していますので、それらはお客様側で開発するなどご用意ください。

■ 外部システムからRESTful APIを実行するには

RESTful APIを利用するには、次の準備を行います。

1. MatrixFlowのサービス管理でサービスを作成する
   MatrixFlowの各機能をRESTful API化するとともに、MatrixFlowにWeb接続するためのAPI URLとシークレットキーを発行します。
2. 作成したサービスを参照して実行コードを作成し、外部システムに組み込む

サービスの作成、実行コードの作成、レスポンス（返り値）、APIの共通仕様については次の各ページをご覧ください。

▶サービス管理でサービスを作成する

・新規サービスを追加（推論）

・新規サービスを追加（学習）

・新規サービスを追加（プロジェクト管理）

・新規サービスを追加（最適化）

▶実行コードを作成する

・サービスの詳細と実行コードの作成（推論）

・サービスの詳細と実行コードの作成（学習）

・サービスの詳細と実行コードの作成（プロジェクト管理）

・サービスの詳細と実行コードの作成（最適化）

▶レスポンス（返り値）の詳細

＜推論＞

・推論APIの返り値（数値データ／文書データcsvの分類）

・推論APIの返り値（回帰）

・推論APIの返り値（画像の分類、ベクトル化、次元圧縮）

・推論APIの返り値（文書データzip/txt/pdfの分類、ベクトル化）

・推論APIの返り値（時系列解析）

＜学習＞

・APIの返り値（学習）

＜プロジェクト管理＞

・機能が多岐に渡るため、プロジェクト管理サービス API仕様でご確認ください。

＜最適化＞

・APIの返り値（最適化）

▶APIの共通仕様（プロジェクト管理を除く）

・APIの共通仕様