AiTEMSの概要

Prev Next

Classic/VPC環境で利用できます。

AiTEMSは、機械学習(ML)や AIの専門知識がなくても、簡単かつ迅速にユーザーの好みに合った推薦サービスを実装して提供できる NAVERクラウドプラットフォームのサービスです。AiTEMSサービスでは、学習に使用するデータセットとスキーマを作成・管理する機能を RESTful API形式で提供します。

参考

AiTEMS APIを使用するには、まず NAVERクラウドプラットフォームコンソールで AiTEMSサービスを申し込む必要があります。AiTEMSご利用の申し込みをご参照ください。

AiTEMSの共通設定

AiTEMS APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://aitems.apigw.ntruss.com/api/v1

リクエストヘッダ

ヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
    		•
    x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
  • Access Keyの発行と確認: 認証キーの作成を参照
  • サブアカウントの Access Key発行と確認: サブアカウントの作成を参照
    		•
    x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名
  • Secret Keyの発行と確認: 認証キーの作成を参照
  • 署名の作成: シグネチャーの作成を参照
    		•
    Content-type Required リクエストデータの形式
  • application/json
    		•

    レスポンス

    共通レスポンス形式を説明します。

    レスポンスステータスコード

    レスポンスステータスコードの説明は次の通りです。

    HTTPステータスコード コード メッセージ 説明
    201 - Created 作成完了
    400 - Bad Request 無効なリクエスト
    401 - Unauthorized 認証不可
    403 - Forbidden 権限なし
    404 - Not Found リソースが見つからない
    500 - Internal Server Error サーバエラー
    参考

    NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    AiTEMS API

    AiTEMSサービスで提供する APIの説明は次の通りです。

    Service

    Service関連 APIの説明は次の通りです。

    API 説明
    サービスの作成 サービスを作成
    サービスデータセットの更新 サービスデータセットを更新
    サービス更新周期の変更 サービス更新周期を変更
    サービスリストの照会 全サービスリストを照会
    サービスの照会 サービスの詳細情報を照会
    サービス学習のリクエスト 一回きりのサービス学習をリクエスト
    サービス周期学習のリクエスト 定期的なサービス学習をリクエスト
    サービスの更新 サービス情報を更新
    サービスの削除 サービスを削除
    学習リストの照会 学習の全リストを照会
    学習の照会 学習の詳細情報を照会
    更新リストの照会 更新リストを照会
    学習結果のテスト 学習結果確認のためのテスト
    周期学習データのアップロード 周期学習を行うデータをアップロード

    Dataset

    Dataset関連 APIの説明は次の通りです。

    API 説明
    データセットの作成 データセットを作成
    データセットリストの照会 データセットの全リストを照会
    データセットの照会 データセットの詳細情報を照会
    データセットの変更 データセット情報を変更
    データセット説明の変更 データセット説明を変更
    データセットの削除 データセットを削除

    Schema

    Schema関連 APIの説明は次の通りです。

    API 説明
    スキーマの作成 スキーマを作成
    スキーマリストの照会 スキーマの全リストを照会
    スキーマの照会 スキーマの詳細情報を照会
    スキーマ説明の変更 スキーマの説明を変更
    スキーマの削除 スキーマを削除
    スキーマの有効性チェック スキーマ情報が使用可能かどうかを検証
    基本スキーマ情報の照会 必須構成の基本スキーマ情報を照会

    AiTEMS関連リソース

    AiTEMS APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。