Skip to content

使用者資料集 (User Dataset)

同一開發帳號下可存在複數個使用者資料集，同一使用者資料集可供複數個專案使用，避免重複上傳的工作。

建立使用者資料集 (/create-user-dataset)

使用範例

呼叫 API：

curl --request POST 'https://api.raas.kklab.com/create-user-dataset' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "example-users",
    "num_shards": 10,
    "attribute_schema": {
        "age": "NUMERICAL",
        "gender": "CATEGORICAL"
    },
}'

import json
import requests
from pprint import pprint

headers = create_headers(scopes=["/create-user-dataset"])

url = "https://api.raas.kklab.com/create-user-dataset"

data={
    "name": "example-users",
    "num_shards": 10,
    "attribute_schema": {
        "age": "NUMERICAL",
        "gender": "CATEGORICAL"
    }
}

response = requests.request("POST", url, headers=headers, data=json.dumps(data))

pprint(response.json())

回傳值：

{
    "user_dataset_id": "$USER_DATASET_ID",
    "name": "example-users",
    "attribute_schema": {
        "age": "NUMERICAL",
        "gender": "CATEGORICAL"
    },
    "num_shards": 10
}

資料集大小 (num_shards)

根據開發帳號的付費方案內容，每個開發帳號的所有使用者與商品資料集的 num_shards 數值加總有上限，開發者上傳的資料會平均的分散在不同的 shard 中，單一 shard 中無法存在超過 100,000 筆資料，故一個資料集的 num_shards 設定建議設定為該資料集的大小除以 100,000。

目前版本暫時不支援修改資料集的 num_shards 設定。

資料規格 (attribute_schema)

描述每一筆資料欄位的處理方式，預設的開發帳號支援以下格式：

  • NUMERICAL: 數字類型，其大小有意義。
  • CATEGORICAL: 分類類型，若值為陣列，該使用者視為有多個類別。

Recommend HQ 對企業方案支援客製化的資料處理方式，細節請聯絡我們。

修改使用者資料集設定 (/update-user-dataset)

使用範例

呼叫 API：

curl --request PUT 'https://api.raas.kklab.com/update-user-dataset' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_dataset_id": "$USER_DATASET_ID",
    "name": "new user dataset name"
}'

import json
import requests
from pprint import pprint

headers = create_headers(scopes=["/update-user-dataset"])

url = "https://api.raas.kklab.com/update-user-dataset"

data={
    "user_dataset_id": "$USER_DATASET_ID",
    "name": "new user dataset name"
}

response = requests.request("PUT", url, headers=headers, data=json.dumps(data))

pprint(response.json())

回傳值：

{
    "user_dataset_id": "$USER_DATASET_ID",
    "name": "new user dataset name",
    "attribute_schema": {
        "age": "NUMERICAL",
        "gender": "CATEGORICAL"
    },
    "num_shards": 10
}

可更新欄位

  • name
  • attribute_schema

取得單一使用者資料集設定 (/get-user-dataset)

使用範例

呼叫 API：

curl --request GET 'https://api.raas.kklab.com/get-user-dataset?user_dataset_id=$USER_DATASET_ID' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY'

import requests
from pprint import pprint

headers = create_headers(scopes=["/get-user-dataset"])

url = "https://api.raas.kklab.com/get-user-dataset"

params = {
    "user_dataset_id": "$USER_DATASET_ID"
}

response = requests.request("GET", url, headers=headers, params=params)

pprint(response.json())

回傳值：

{
    "user_dataset_id": "$USER_DATASET_ID",
    "name": "example-users",
    "attribute_schema": {
        "age": "NUMERICAL",
        "gender": "CATEGORICAL"
    },
    "num_shards": 10
}

列出所有使用者資料集 (/list-user-datasets)

使用範例

呼叫 API：

curl --request GET 'https://api.raas.kklab.com/list-user-datasets' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY'

import requests
from pprint import pprint

headers = create_headers(scopes=["/list-user-datasets"])

url = "https://api.raas.kklab.com/list-user-datasets"

response = requests.request("GET", url, headers=headers)

pprint(response.json())

回傳值：

{
    "user_datasets": [
        {
            "user_dataset_id": "$USER_DATASET_ID",
            "name": "example-users",
            "attribute_schema": {
                "age": "NUMERICAL",
                "gender": "CATEGORICAL"
            },
            "num_shards": 10
        }
    ]
}

刪除使用者資料集 (/delete-user-dataset)

使用範例

呼叫 API：

curl --request DELETE 'https://api.raas.kklab.com/delete-user-dataset' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_dataset_id": "$USER_DATASET_ID"
}'

import json
import requests
from pprint import pprint

headers = create_headers(scopes=["/delete-user-dataset"])

url = "https://api.raas.kklab.com/delete-user-dataset"

data={
    "user_dataset_id": "$USER_DATASET_ID"
}

response = requests.request("DELETE", url, headers=headers, data=json.dumps(data))

pprint(response.json())

回傳值：

{
    "user_dataset_id": "$USER_DATASET_ID",
    "name": "example-users",
    "attribute_schema": {
        "age": "NUMERICAL",
        "gender": "CATEGORICAL"
    },
    "num_shards": 10
}

API 回傳該使用者資料集被刪除前的最後設定。

匯入使用者資料 (/upsert-dataset-users)

使用範例

匯入兩筆使用者資料，呼叫 API：

curl --request POST 'https://api.raas.kklab.com/upsert-dataset-users' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_dataset_id": "$USER_DATASET_ID",
    "users": [
        {
            "user_id": "1",
            "attributes": {
                "age": 22,
                "gender": "female"
            }
        },
        {
            "user_id": "2",
            "attributes": {
                "age": 30,
                "name": "test user"
            }
        }
    ]
}'

import json
import requests
from pprint import pprint

headers = create_headers(scopes=["/upsert-dataset-users"])

url = "https://api.raas.kklab.com/upsert-dataset-users"

data={
    "user_dataset_id": "$USER_DATASET_ID",
    "users": [
        {
            "user_id": "1",
            "attributes": {
                "age": 22,
                "gender": "female"
            }
        },
        {
            "user_id": "2",
            "attributes": {
                "age": 30,
                "name": "test user"
            }
        }
    ]
}

response = requests.request("POST", url, headers=headers, data=json.dumps(data))

pprint(response.json())

回傳值：

{
    "user_dataset_id": "$USER_DATASET_ID",
    "succeed_ids": ["1", "2"],
    "failed_ids": []
}

如以上範例，使用者的 attributes 並不需要與 attribute schema 完全一致，可支援缺少的欄位，亦可支援未定義的欄位。

批次大小

由於通常需要上傳大量資料，每一筆匯入資料 API 支援一次上傳多筆資料，一次建議上傳1000筆資料，以達到最大上傳效率。如需要更快速的上傳，建議使用多線程 (multithreading) 進行上傳。

壓縮

Recommend HQ 的所有 API 皆支援 gzip 壓縮，實際使用時建議使用 gzip 壓縮的 API 請求來減少資料傳輸大小，提升資料交換效率。

限制

  • 每一筆使用者資料大小最大為 20 kb。
  • 一次 API 呼叫最多含有1000筆資料。

刪除使用者資料 (/delete-dataset-users)

使用範例

呼叫 API：

curl --request DELETE 'https://api.raas.kklab.com/delete-dataset-users' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_dataset_id": "$USER_DATASET_ID",
    "user_ids": [
        "1",
        "2"
    ]
}'

import json
import requests
from pprint import pprint

headers = create_headers(scopes=["/delete-dataset-users"])

url = "https://api.raas.kklab.com/delete-dataset-users"

data={
    "user_dataset_id": "$USER_DATASET_ID",
    "user_ids": [
        "1",
        "2"
    ]
}

response = requests.request("DELETE", url, headers=headers, data=json.dumps(data))

pprint(response.json())

回傳值：

{
    "user_dataset_id": "$USER_DATASET_ID",
    "succeed_ids": ["1", "2"],
    "failed_ids": []
}

批次大小

同匯入使用者的 API，刪除使用者的 API 亦支援批次刪除。

限制

  • 一次 API 呼叫最多刪除1000筆使用者資料。

刪除特定時間內未更新的使用者資料 (/delete-dataset-users-before-ts)

由於是大量刪除資料，並不會即時生效。根據資料集的大小，須等待10~120分鐘陸續生效。

使用範例

呼叫 API：

curl --request DELETE 'https://api.raas.kklab.com/delete-dataset-users-before-ts' \
--header 'Authorization: Bearer $TOKEN' \
--header 'APIKey: $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_dataset_id": "$USER_DATASET_ID",
    "ts": 1634201445000
}'

回傳值：

{
    "user_dataset_id": "$USER_DATASET_ID",
    "ts": 1634201445000
}