Custom Attributesの作成

Prev Next

VPC環境で利用できます。

Custom Attributesの Profileを作成します。

Profileの作成をリクエストすると、次の順序で作成が行われます。

順序 作成状態 説明
Step 1 registered: 登録完了 作成作業が NCLUEシステムに登録された状態
Step 2 pending: 待機中 作成作業がシステムキューに登録された状態
Step 3 in_progress: 作成中 作成作業がサーバで実行中の状態
Step 4
  • complete: 使用可能
  • failed: 失敗
 作成作業が完了した状態
参考

Profileの作成にかかる時間は、データ量と利用可能なリソースの状況によります。作成の進行状況は、Custom Attributesの照会 APIを呼び出すとレスポンスボディのstatusフィールドで確認できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /profile/custom-attributes

リクエストヘッダ

NCLUE APIで共通して使用されるヘッダの詳細は、NCLUEのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String Required Profile名
  • 1~100文字
feature_id String Required プロファイリングに適用する Feature ID
keyword_set String Required 対象ユーザーとの類似度を確認する属性キーワードリスト
  • キーワードの合計は1,000文字以内
  • キーワードは「\n」で区切る
  • <例> ランニング\n走り\nマラソン
result_bucket String Required プロファイリング結果を保存する Object Storageのバケット名
result_file_path String Required プロファイリング結果の保存先のresult_bucket内ファイルパス
  • 次の記号を含むファイルパスは入力不可
    • &$@=;:+,?*\{}^%`[]<>~#|"'
    • ASCIIコードが0~31、128~255の文字
  • ファイル名作成ルール
    • 入力文字列が「/」で終わる場合はディレクトリとみなし、ディレクトリ内に「nclue_{乱数}_{年月日時}.tsv」というファイル名で作成
    • それ以外は入力文字列をファイル名とみなし、「{入力文字列}_{乱数}_{年月日時}.tsv」というファイル名で作成

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/profile/custom-attributes' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
    "name": "YOUR_PROFILE_NAME",
    "feature_id": "1be871f6-****-****-****-827671fa8fdb",
    "keyword_set": "ランニング\n走り\nマラソン\nジョギング\nランニングシューズ\nランニングソックス\nランニングアプリ",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename"
}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
profile_id String - Profile ID
profile_name String - Profile名
feature_id String - プロファイリング対象の Feature ID
feature_name String - プロファイリング対象の Feature名
keyword_set String - 属性キーワードリスト
  • キーワードは「,」で区切る
created_at String - Profile作成リクエスト日時(ISO 8601形式)
result_bucket String - プロファイリング結果を保存する Object Storageのバケット名
result_file_path String - プロファイリング結果を保存する result_bucketのファイルパス

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

NCLUEで共通して使用されるレスポンスステータスコードの詳細は、NCLUEのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "profile_id": "a7f4f996-****-****-****-b0531230e17e",
    "profile_name": "YOUR_PROFILE_NAME",
    "feature_id": "1be871f6-****-****-****-827671fa8fdb",
    "feature_name": "YOUR_FEATURE_NAME",
    "keyword_set": "ランニング,走り,マラソン,ジョギング,ランニングシューズ,ランニングソックス,ランニングアプリ",
    "created_at": "2024-11-26T17:25:42+09:00",
    "result_bucket": "YOUR_BUCKET_NAME",
    "result_file_path": "path/filename"
}