NCLUEの概要

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

NCLUEは、NAVERの大規模言語モデルである HyperCLOVA Xをベースにした NCLUEモデルを活用し、さまざまな機械学習モデルを作成してさまざまなビジネス問題を解決するよう手助けする NAVERクラウドプラットフォームの SaaSサービスです。NCLUEサービスでは、Featureの作成、Taskモデルの作成と実行、ユーザープロファイリング機能を RESTful APIで提供します。

NCLUEの共通設定

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

リクエスト

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

API URL

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

https://nclue.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の発行と確認: 認証キーの作成を参照署名の作成: シグネチャーの作成を参照

注意

NCLUE APIの1秒当たりのリクエスト数は1tps以下に設定してください。

レスポンス

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

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

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

HTTPステータスコード	コード	メッセージ	説明
200	-	success	成功
401	10100	ACCESS_DENIED	無効なアクセス
422	10101	NAME_TOO_LONG	名前に入力可能な文字数を超過解決方法: 40文字以内で入力し、再試行
409	10102	DUPLICATE_NAME	同じ名前が存在
422	10103	INVALID_PATH_CHARACTER	ファイルパスが使用できない記号を含む
422	10104	INVALID_CHARACTER_IN_TRAIN_PATH	Train正解データのファイルパスが使用できない記号を含む
422	10105	INVALID_CHARACTER_IN_TEST_PATH	Test正解データのファイルパスが使用できない記号を含む
404	10106	PATH_NOT_FOUND	データのパスまたはファイルが存在しない
404	10107	TRAIN_PATH_NOT_FOUND	Train正解データのパスまたはファイルが存在しない
404	10108	TEST_PATH_NOT_FOUND	Test正解データのパスまたはファイルが存在しない
422	10109	PERSONAL_DATA_NOT_ALLOWED	ファイルが個人情報を含む
422	10110	PERSONAL_DATA_IN_TRAIN_FILE	Train正解データファイルが個人情報を含む
422	10111	PERSONAL_DATA_IN_TEST_FILE	Test正解データファイルが個人情報を含む
422	10112	TOO_MANY_KEYWORDS	入力可能な属性キーワードの文字列の長さの合計が制限を超過解決方法: 文字列の長さの合計を1000文字以内にして入力し、再試行
409	10113	INCOMPATIBLE_MODEL	Featureと Taskが互換性を持たない
409	10114	FEATURE_PROCESSING	リクエストを処理できない解決方法: Featureの状態が待機中か作成中の場合、作成完了後に再試行
409	10115	TASK_PROCESSING	リクエストを処理できない解決方法: Taskの状態が待機中か作成中の場合、作成完了後に再試行
409	10116	RUN_PROCESSING	リクエストを処理できない解決方法: Runの状態が待機中か作成中の場合、作成完了後に再試行
409	10117	PROFILE_PROCESSING	リクエストを処理できない解決方法: Profileの状態が待機中か作成中の場合、作成完了後に再試行
422	10118	KEYWORD_REQUIRED	キーワードが入力されていない
422	10119	STORAGE_FULL	データの空き容量不足
422	10121	EMPTY_CONTENT_IN_PATH	正解データのパスまたはファイルが空である
422	10122	EMPTY_CONTENT_IN_TRAIN_PATH	Train正解データのパスまたはファイルが空である
422	10123	EMPTY_CONTENT_IN_TEST_PATH	Test正解データのパスまたはファイルが空である
404	10124	PROFILE_NOT_FOUND	プロファイルデータが存在しない
422	10130	INVALID_RESULT_FILE_PATH	異常なファイルパスが入力される
422	10131	OBJECT_STORAGE_ACCESS_DENIED	Object Storageバケットにアクセスできない解決方法: Object Storageバケットへのアクセス権限を付与し、再試行
404	10132	OBJECT_STORAGE_ACCOUNT_REQUIRED	Object Storageサービスご利用の申し込みが必要
422	10133	INVALID_LIMIT	`limit`に入力可能な値を超過解決方法: 1~100以内で入力し、再試行
409	10134	FEATURE_IN_USE	Featureを削除できない解決方法: Featureで作成中の作業を完了し、再試行
409	10135	TASK_IN_USE	Taskを削除できない解決方法: Taskで作成中の作業を完了し、再試行
404	10136	BUCKET_NOT_FOUND	存在しない Object Storageのバケット名が入力される

参考

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

NCLUE API

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

API	説明
Featureの照会	NCLUE Featureの詳細情報を照会
Featureリストの照会	NCLUE Featureリストを照会
Featureの作成	シーケンスデータセットを活用して NCLUE Featureを作成
Featureの削除	NCLUE Featureを削除
Taskの照会	Task Modelの詳細情報を照会
Taskリストの照会	Task Modelリストを照会
Taskの作成	正解データセットを活用して Task Modelを作成
Taskの削除	Task Modelを削除
Task Runの照会	Task Modelの実行結果を照会
Task Runリストの照会	Task Modelの Runリストを照会
Task Runの作成	ユーザー Featureと Task Modelを活用して Runを作成
Task Runの削除	Task Modelの Runを削除
Shopping Intentの照会	Shopping Intentの Profileの詳細情報を照会
Shopping Intentリストの照会	Shopping Intentの Profileリストを照会
Shopping Intentの作成	Shopping Intentの Profileを作成
Shopping Intentの削除	Shopping Intentの Profileを削除
Shopping Intentのダウンロード	Shopping Intentの Profile結果をダウンロード
Custom Attributesの照会	Custom Attributesの Profileの詳細情報を照会
Custom Attributesリストの照会	Custom Attributesの Profileリストを照会
Custom Attributesの作成	Custom Attributesの Profileを作成
Custom Attributesの削除	Custom Attributesの Profileを削除

NCLUE関連リソース

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

Sub Account APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- API Gatewayご利用ガイド: リクエストヘッダに追加する API Keyを発行
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: NCLUEサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
NCLUEサービスの使用方法
- NCLUEご利用ガイド: NAVERクラウドプラットフォームコンソールで NCLUEを使用する方法
- Ncloud使用環境ガイド: VPC、Classic環境とサポート有無に関するガイド
- 料金の紹介、特徴、詳細機能: NCLUEサービスの料金体系、特長と詳細機能のサマリー
- サービス関連の最新のお知らせ: NCLUEサービス関連の最新共有ニュース
- よくある質問: NCLUEサービスユーザーからのよくある質問
- お問い合わせ: APIガイドだけでは不明な点が解消されない場合、直接問い合わせ

この記事は役に立ちましたか?

NCLUEの共通設定
- リクエスト
- レスポンス
NCLUE API
NCLUE関連リソース