Skill v1.0.1
Automated scan100/100+3 new
version: "1.0.1" name: vs-item-onboarding description: "onboarding workflow for creating datasets and applications in Viking AI Search. Supports one-time import from local files (JSON, JSONL, CSV) and MySQL databases, plus scheduled incremental sync for append-only JSONL files and MySQL. All sources are first exported to a bootstrap JSONL file; backend-driven schema inference handles detection, and optional background sync keeps the dataset up to date as new data arrives." category: workflow applies_to: codex, agents, external-agent requires_cli: ">=0.2.0" keywords: item onboarding, dataset onboarding, presigned upload, AddInferDatasetSchemaTask, GetInferDatasetSchemaResult, CreateDataset, AttachDatasetToApplication, ProcessConfig, data write, dry-run, attach-dataset, infer-result persistence, render-schema, schema confirmation, vs-schema-confirm, source export, database import, mysql import, jsonl import, file import, connector sync commands: dataset import-url, dataset infer-schema, dataset infer-result, dataset validate-schema, dataset create, dataset ingest, data write, app create, app attach-dataset, connector export, connector init, connector run, connector status, connector stop, connector inspect
Viking Item Onboarding
Language Matching (apply throughout)
Match the language of the user's most recent message in every line of prose you write — confirmation prompts, status notes, hand-off summaries, questions, error explanations, and any internal thinking / reasoning / planning output that the host may surface (e.g. `<thinking>` blocks, "thinking" panels, scratchpad notes, todo descriptions). If the user is writing in Chinese, every prose line and every reasoning line must also be in Chinese; if English, English; same for Japanese, etc. The fact that this skill file is written in English is for documentation only — at runtime translate all prose and reasoning into the user's language. Do not switch back to English mid-flow just because the surrounding skill text is English.
Chinese-user priority (the most common case) — when current_query or the most recent user message is in Chinese:
- All prose you write for the user (confirmation prompts, status notes, error explanations, final hand-off summaries) must be in Chinese.
- All internal thinking / reasoning / planning output (thinking blocks, scratchpad, todo descriptions) must also be in Chinese.
- For workspace artifacts you create, the description / comment portions (excluding CLI-contract English identifiers) should also prefer Chinese.
Do not translate the following — keep them verbatim so the contract stays machine-checkable:
- The verbatim CLI block between
<!-- vs-schema-confirm: BEGIN -->and<!-- vs-schema-confirm: END -->(English section labels**Metadata**/**Fields (N)**/**Field Roles**/**Warnings (N)**and English warning text come straight from the CLI). - CLI command names, flag names, JSON keys, enum values, field names, primary-key BizAttr identifiers (
MultiModalId), dataset IDs / app IDs / TaskIDs, and console URLs. - The single literal token the user must reply to confirm — write it as `
yesin any language so the contract for advancing to step 8 is unambiguous (you may add a parenthetical native-language hint, e.g.回复 \yes\(即"确认")继续`).
If you are unsure which language the user used (e.g. only emoji or only an attachment), default to the language of the very first user turn in the conversation. When the user switches languages mid-flow, switch with them on the next message.
When to Use
Use this skill when the user is operating against the V2 control-plane (/open/*V2) and wants to onboard a dataset (optionally followed by an application) from either:
- a local
JSONLfile, either as a one-time import or with ongoing incremental sync for append-only files (e.g. crawler output where new lines are continuously appended); - a local
JSON(array) orCSVfile, as a one-time import only (ongoing sync is not supported for these formats); - a MySQL database, either as a one-time snapshot import or with ongoing incremental sync.
Supported dataset types:
- `user_event` — user behavior / event logs (click, view, exposure, collect, etc.) used for recommendation and personalization scenarios.
- `multi_modal` — everything else: records that contain image URLs and/or video URLs alongside text fields (e.g. e-commerce goods with images, short-video posts, content with thumbnails, multimodal search corpora), as well as plain-text corpora without media. If the data is not behavior logs, it goes here.
The hallmark of V2 is that schema inference is fully backend-driven: the CLI uploads the file, the backend infers the Schema (with BizAttr already set on the primary-key / title / URL / event-type fields) plus a per-field FieldDescMap, and the agent's only jobs are to (a) persist that inference artifact locally, (b) render it for one round of human confirmation, and (c) drive the remaining persistence + ingest steps without re-inventing field decisions.
Do not use this skill when:
- The customer only wants to ingest more rows into an existing dataset (use
vs data write --dataset-id <id> --fields @items.json).
Do NOT be misled by vs --help top-level QUICK START
vs --help still lists vs item profile / plan / apply at the top of QUICK START for backwards compatibility (annotated [Deprecated]). That is the V1 path; this skill does not use it. The only legal path here is V2 — vs dataset import-url → infer-schema → infer-result → dataset create → data write → app create → app attach-dataset — and any check for a V2 command must be confirmed via vs dataset --help, vs dataset infer-schema --help, vs app --help, or vs app attach-dataset --help, never by falling back to vs item .... The workspace path ./.viking/item-plans/<dataset-name>/ is reused for V2 artifacts only because the directory name happens to match; it does not imply V1 or item type. The moment the user's ask is "create a multi-modal dataset / application from a raw JSONL / JSON / CSV / MySQL source", jump straight to the V2 workflow (steps 3–14 below) without detouring through item plan/apply.
Forbidden in this skill: vs item profile, vs item plan, vs item apply, vs item review, vs item provision, vs item verify, or passing any --type other than multi_modal or user_event to dataset onboarding commands.
Preconditions
vsCLI ≥ 0.2.0 installed, authentication is complete (vs auth statusandvs doctorsucceed).- Input file is
JSON array,JSONL, orCSVand is readable from a local path. - The user has stated a business goal (e.g. "Build catalog search", "Build content search").
- The customer's account is provisioned for the V2 control-plane.
Commands
| Stage | CLI command | Purpose | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Upload URL | vs dataset import-url --file-name <basename> | Request a presigned PUT URL plus FileKey | |||||||||
| PUT upload | curl -X PUT --data-binary @<path> "<FileUrl>" | Upload the local file to TOS (no auth header needed) | |||||||||
| Submit inference | `vs dataset infer-schema --tos-key <FileKey> --type <multi_modal\ | user_event> [--theme <general\ | e_commerce\ | content\ | long_video>] --language <zh\ | en\ | ko\ | ja\ | hi> [--name ...]` | Kick off backend schema inference; returns TaskID. --theme is required for `multi_modal` only (default general); omit it for user_event. The CLI accepts theme aliases such as ecommerce / e-commerce → e_commerce, long-video / longvideo → long_video, common / default → general. | |
| Poll inference | vs dataset infer-result --task-id <TaskID> | Poll until Status=Success; returns Schema + DataFieldConfig (the entire inference artifact). For multi_modal, includes ImageIndexFields / VideoIndexFields / ChatFields. | |||||||||
| Validate schema | `vs dataset validate-schema --input <path/to/infer-result.json> --dataset-type <multi_modal\ | user_event>` | Render the deterministic schema-confirm block (metadata / fields / roles / warnings). Use --dataset-type to toggle validation rules. Save the output as the source-of-truth for schema confirmation. | ||||||||
| Create dataset | vs dataset create --data @dataset-create.json [--dry-run] | Persist (or dry-run) the inferred schema. Do not flip IsPK — backend derives PK from BizAttr. For multi_modal, the payload must include Theme and optionally ProcessConfig; for user_event, omit both. | |||||||||
| Write data | vs data write --dataset-id <DatasetId> --fields @items.json | Push the actual records into the dataset | |||||||||
| Export (MySQL) | vs connector export --source mysql ... | Export a MySQL table snapshot into /tmp/viking/connector/<job>/bootstrap/items.jsonl | |||||||||
| Export (local file) | vs connector export --source jsonl --file <path> | Export a local JSONL file snapshot into the bootstrap directory. For JSON (array) or CSV inputs, convert to JSONL (one object per line) before running this command. | |||||||||
| Sync config | `vs connector init --name <job> --source mysql\ | jsonl --dataset-id <id> ...` | Persist the local sync job config for later incremental runs | ||||||||
| Sync run | vs connector run --job <job> --daemon | Start background incremental sync into the dataset | |||||||||
| Create application | `vs app create --name <name> --industry <industry> --language <lang> [--description ...] [--color cyan\ | blue\ | purple\ | pink] [--risk-check] [--dry-run]` | Optional, only when the user asks for app-level setup. --industry here is an application-level attribute independent of the dataset; it is NOT passed to dataset create / infer-schema. | ||||||
| Attach dataset | vs app attach-dataset --data @attach.json [--dry-run] | Optional, links the created dataset to an application. The DataConfig block is the DataFieldConfig straight out of the persisted infer artifact (must include ImageIndexFields / VideoIndexFields / ChatFields verbatim) |
The "All-in-one" shortcut vs dataset ingest --file <path> --type multi_modal --theme <theme> [--abnormal-image-policy skip|block] [--abnormal-video-policy skip|block] [--video-auto-delete] [--dry-run] orchestrates upload + infer-schema + poll + create + write, without the Schema Confirmation pause. In agent mode you should still drive each step individually so you can pause at step 7 (Schema Confirmation).
Workflow
Run strictly in order. Each step depends on output from the previous one; an inference artifact persisted in step 6 is reused all the way through step 13.
- Confirm dataset type, input source, and mode — first determine the dataset type, then identify the source type, then explicitly ask the user to choose the import mode when multiple options exist. Do not silently pick any of these.
Dataset type resolution — ask the user which dataset type they want to create:
- `multi_modal` — records with image URLs and/or video URLs plus text fields (e-commerce goods, short-video posts, content with thumbnails, etc.).
- `user_event` — user behavior / event logs (click, view, exposure, collect, etc.) for recommendation and personalization.
If the user's request clearly describes behavior logs / event data / recommendation data → user_event; if it clearly describes goods / content with images or video → multi_modal; if ambiguous, ask.
For `multi_modal` only — Theme resolution (mandatory) — the backend requires a valid Theme. Ask the user to pick one:
e_commerce— e-commerce products (with images, price, brand, tags)long_video— long-form video (movies, series; with cover image, language, category)content— general short-form content (posts, news articles with thumbnails, tags, categories)general— other / generic multi-modal (default)
If the user cannot decide, default to general. Record the chosen theme in a local variable and pass it to every subsequent command that accepts --theme.
Source identification:
- If the user provided a database connection or table name → MySQL.
- If the user provided a file path ending in
.jsonlor described a line-delimited/append-only file → JSONL. - If the user provided a file path ending in
.json(JSON array) or.csv→ JSON/CSV (one-time only). - If the source is unclear, ask the user which source type they want to onboard from before proceeding.
Language: ask for language if the user has not already stated it (zh / en / ko / ja / hi); default to zh for Chinese-speaking users, en otherwise.
Import mode selection:
- For MySQL and JSONL, resolve whether the user wants one-time import or one-time + ongoing sync. Only skip the question when the request contains an explicit, unambiguous signal for one side (apply this detection to whatever language the user is writing in — English, Chinese, etc.):
- Explicit one-time: phrases carrying "once", "one-time", "snapshot only", "just this time", or equivalent single-import semantics.
- Explicit ongoing: phrases carrying "sync", "keep in sync", "auto-import", "scheduled", "incremental", "keep updated", or equivalent recurring-sync semantics.
- If the request is neutral — e.g. "import this file", "import this data", bare "import", mentions only a file path with an import verb but says nothing about scheduling/increment/once — you MUST ask the user to choose. The bare import verb is NOT a one-time signal; it is ambiguous. Never silently default to one-time.
- For JSON (array) and CSV, only one-time import is supported. No question needed.
After the dataset type, source type, theme (if multi_modal), language, and mode are confirmed, follow the matching branch:
- MySQL — one-time import: identify the table name, infer dataset name and primary key, and require explicit confirmation before any real write. Continue at step 2.
- MySQL — ongoing sync: same as above, plus the user must explicitly confirm the incremental cursor field itself. After step 10 continue at step 11.
- MySQL — existing dataset — ongoing sync: validate the dataset with
vs dataset get --id <DatasetId> --full, confirm the source config (especially the incremental cursor field), then jump directly to step 11. - JSONL file — one-time import: confirm the file path. Continue at step 2.
- JSONL file — ongoing sync: confirm the file path. You MUST also interactively ask the user to confirm that new records will only be appended to the end of the file (append-only). Present the constraint clearly — sync only supports files that grow by adding new lines; edits or deletions of existing lines are not tracked and may cause duplicate or missing records. Wait for explicit user confirmation before proceeding. After step 10 continue at step 11.
- JSON (array) or CSV file — one-time import: confirm the file path. These formats are one-time import only; ongoing sync is not supported because they do not provide a stable append-only cursor. Convert the input to JSONL (one JSON object per line) before continuing. Continue at step 2.
- Existing dataset + one-time source import: not supported as a single workflow. Explain that the current CLI split supports either source export → new dataset onboarding for a one-time import, or background sync for ongoing updates, then let the user choose which branch to switch to.
Source environment configuration (applies to MySQL branches only; local files require no credentials):
- MySQL uses these environment variables by default:
MYSQL_HOST,MYSQL_PORT,MYSQL_USER,MYSQL_PASSWORD,MYSQL_DATABASE(optional:MYSQL_CHARSET). - Render a bash export template snippet with placeholder values (for example
MYSQL_PASSWORD=your_password) and ask the user to fill in real values in their own terminal or shell session, then runexporton each variable. - Never display actual database credential values in chat. Never ask the user to paste or submit database credentials into the chat dialog.
- Never list "connection config" / "连接配置" blocks with concrete host/user/password values inside the chat. The only allowed format is a bash template with placeholder values.
- The export, init, and run commands read MySQL credentials only from environment variables. They do not accept credentials via flags or chat input.
- This is a human checkpoint. Wait for explicit confirmation that the local source environment is configured before proceeding.
- Export source snapshot to JSONL — run
vs connector exportfor the selected source to produce a bootstrap JSONL file:
- MySQL:
vs connector export --source mysql --source-table <table> --id-field <field> --cursor-field <field> [other flags] - Local file:
vs connector export --source jsonl --file <path/to/items.jsonl> [other flags](convert JSON arrays or CSV to JSONL first if needed)
The bootstrap file is always written to /tmp/viking/connector/<job>/bootstrap/items.jsonl. Do not use --output to try to override that path; --output only redirects the rendered command result. After export, use the emitted items.jsonl as the input file and continue at step 3.
- Get upload URL —
vs dataset import-url --file-name <basename>. CaptureResult.FileUrlandResult.FileKey. KeepFileKeyfor step 5. - PUT upload — upload the raw item file to
FileUrl(e.g.curl -X PUT --data-binary "@<local-path>" "<FileUrl>"). Expect HTTP 200 with empty body. Do not add anAuthorizationheader —FileUrlis already presigned. - Submit inference task —
vs dataset infer-schema --tos-key <FileKey> --type <multi_modal|user_event> --theme <general|e_commerce|content|long_video> --language <lang> --name <dataset-name>. Foruser_event, omit--theme. Formulti_modal,--themeis required (defaultgeneral). Theme values accept alias normalization:ecommerce/e-commerce→e_commerce,long-video/longvideo→long_video,common/default→general. CaptureResult.TaskId. - Poll inference result + persist locally —
vs dataset infer-result --task-id <TaskId>untilResult.Status === "Success"(poll roughly every 5s, max ~3 minutes). Then writeResultverbatim to a workspace-relative artifact file so the rest of the workflow can read from it.
Plan directory rules (important):
- Must write to the workspace-relative path:
./.viking/item-plans/<dataset-name>/infer-result.json(i.e.<cwd>/.viking/item-plans/<dataset-name>/...). - Forbidden to write anywhere under
~/.viking/(i.e.$HOME/.viking/).~/.viking/is thevsCLI's private config / credentials directory (config.json,credentials.json.enc), not a plan dir. Many agent hosts place~/outside the sandbox, so writes there fail withEPERM: operation not permitted; even when they succeed, your plan files end up mixed with the CLI's private files. - If the workspace root is not writable (e.g. the sandbox only allows temp dirs), fallback priority is
${WORKSPACE_DIR}/.viking/item-plans/<dataset-name>/→${TMPDIR}/viking-item-plans/<dataset-name>/→./viking-item-plans/<dataset-name>/. Never redirect to the home directory~/.viking/. - Once the plan dir is decided, store it in a local variable (e.g.
WORK) and reuse the same path across steps 8/9/10/13. Do not switch plan dirs between steps.
This single artifact is the source-of-truth for every subsequent step. Do not regenerate it; do not edit BizAttr (those drive PK / title / URL detection on the backend). If the user requests semantic edits (e.g. tweak a FieldDescMap description, reorder IndexFields), edit this file in place and reuse it.
- Schema Confirmation (mandatory) — show the persisted artifact to the user using the CLI's deterministic renderer, then surface it verbatim. _(Historically called "Stage A".)_
``bash vs dataset validate-schema --input ./.viking/item-plans/<dataset-name>/infer-result.json --dataset-type <multi_modal|user_event> ``
The CLI emits a fixed block (Metadata / Fields / Field Roles / Warnings for multi_modal; Metadata / Fields / Warnings for user_event) wrapped between <!-- vs-schema-confirm: BEGIN --> and <!-- vs-schema-confirm: END --> markers. It uses a real markdown table for fields (with backticked types like ` array<string> so chat UIs do not eat the angle brackets), and fenced code blocks for the other sections. The output tolerates Name/FieldName, Type/FieldType, missing Required/BizAttr/Description, and missing or incomplete DataFieldConfig. The output is byte-stable: re-running the same file with the same --dataset-type` always produces identical bytes.
Your message to the user MUST be exactly this template (BEGIN/END markers included, three parts only):
```` Dataset <Name> · type=<multi_modal|user_event> · <theme=<Theme> if multi_modal>
<verbatim CLI stdout from the BEGIN marker through the END marker, character-for-character>
<one-line confirmation prompt, written in the user's language — see Language Matching above and the templates below> ````
Confirmation prompt — pick the template matching the user's most recent message language. Do not paste the English template verbatim if the user is writing in Chinese.
- 中文(用户说中文时使用,默认):
以上是 Schema 确认块。回复 \yes\ 继续,或说明需要调整的字段(例如:把 \description\ 加入文本检索字段、把 \brand\ 加入 SuggestFields)。
- English (when the user is writing in English):
This is the Schema Confirmation block. Reply \yes\ to continue, or describe which fields to adjust (e.g. "make \description\ searchable", "add \brand\ to SuggestFields").
- 日本語 / その他言語:translate the same intent, keep the token `
yesverbatim and keep field names / JSON keys (description,SuggestFields`, ...) in English.
You MUST:
- Copy the CLI stdout between (and including) the
<!-- vs-schema-confirm: BEGIN -->and<!-- vs-schema-confirm: END -->markers character-for-character. - Surface the one-line metadata header above, the verbatim CLI block in the middle, and the one-line confirmation prompt at the bottom — exactly three parts, in that order.
- Wrap type values in backticks if you ever need to mention them outside the CLI block (e.g. `
array<string>). Chat UIs treat unwrapped<…>` as HTML and silently drop them.
You MUST NOT:
- Re-render the field table yourself (no hand-typed markdown table, no bullet list of fields).
- Replace the CLI block with a summary like "see CLI output above" / "tool result has full details". Tool-call output is collapsed by default in most chat clients — the user only sees what is in your own message.
- Add extra commentary, bullet lists, "key fields are …" highlights, or any interpretation between the BEGIN/END markers.
- Drop or trim the
**Warnings (N)**section even when N is 0; deterministic structure beats brevity.
Wait for an explicit positive confirmation (yes or equivalent) before moving to step 8. If the user requests changes, edit the persisted infer-result.json in place (do not re-run inference) and re-run vs dataset validate-schema --input ./.viking/item-plans/<dataset-name>/infer-result.json --dataset-type <type>, then re-emit the same three-part template so the user sees the same deterministic structure.
- Behavior type confirmation (`user_event` only) — for
multi_modaldatasets, skip this step entirely and go straight to step 9.
For user_event datasets, the event_type field requires an EnumerateMeta array that maps every distinct raw event value found in the data to a standard behavior type (EnumerateBizAttr). Every distinct `event_type` value present in the data MUST have a corresponding entry in `EnumerateMeta` (no blanks, no unbound values). Additionally, the backend requires at least one entry mapped to exposure (Required: true) and at least one non-exposure positive behavior. Without this the create call fails validation.
Every distinct `event_type` value present in the data MUST have a confirmed mapping before proceeding. The agent infers a best-guess mapping semantically, presents it to the user with a standard-type reference labeled in the user's language, and only proceeds after explicit confirmation.
Internal standard types reference (agent uses this to convert user-confirmed labels to `EnumerateBizAttr` codes when serializing the payload):
| 中文标签 | English label | 日本語ラベル | 한국어 라벨 | हिन्दी लेबल | EnumerateBizAttr (code) | Name handling | |
|---|---|---|---|---|---|---|---|
| 曝光 | Exposure / Impression | 露出 / インプレッション | 노출 | इम्प्रेशन / दिखना | exposure | auto — use standard label | |
| 点击 | Click | クリック | 클릭 | क्लिक | click | auto — use standard label | |
| 收藏 | Collect / Favorite / Save | お気に入り / 保存 | 저장 / 즐겨찾기 | सेव / पसंद | collect | auto — use standard label | |
| 分享 | Share | シェア | 공유 | शेयर | share | auto — use standard label | |
| 点赞 | Like / Thumbs-up | いいね | 좋아요 | लाइक | like | auto — use standard label | |
| 加购 | Add to cart | カート追加 | 장바구니 추가 | कार्ट में जोड़ें | add_to_cart | auto — use standard label | |
| 下单 | Place order / Order | 注文 | 주문 | ऑर्डर | order | auto — use standard label | |
| 购买 | Purchase / Buy / Pay | 購入 / 購入完了 | 구매 | खरीद / भुगतान | purchase | auto — use standard label | |
| 访问 | Visit / Detail page view | アクセス / 閲覧 | 방문 / 상세보기 | विज़िट / विवरण देखना | visit | auto — use standard label | |
| 自定义 | Custom (user-defined) | カスタム | 커ス텀 | कस्टम | custom | user must provide a display name |
Procedure:
a. Extract ALL distinct event_type values from the entire bootstrap JSONL file (read the whole file — do NOT sample only the first N lines, every value must be accounted for): ``bash jq -r '.event_type // empty' <bootstrap.jsonl> | sort -u ``
b. Infer a best-guess mapping for each distinct raw value to one of the 10 standard types above. Use semantic understanding of the user's language and data context. Negative-feedback values (e.g. 不喜欢, 差评, dislike, 负反馈) should map to custom.
- Do NOT force a guess. If a value is ambiguous, domain-specific, abbreviated, in an unexpected language, or you are genuinely unsure, mark it as "待确认 / to be confirmed" and leave it for the user to pick — do NOT default it to
customas a lazy fallback.customis only for values that you are confident represent user-defined or negative-feedback behaviors. - It is always better to mark a value as "待确认" and let the user correct it than to force a wrong mapping.
c. Present the confirmation prompt to the user in their language. When rendering labels, use ONLY the column from the reference table that matches the user's language (do NOT dump all five languages unless the user explicitly asks). The prompt MUST contain:
(1) The value-to-type mapping table — left column: every distinct event_type value from the data; right column: your suggested standard type label (natural language in the user's language, not code). Every row must show a suggested type or be explicitly marked as "待确认 / to be confirmed" (do NOT silently guess, and do NOT blindly default uncertain values to custom). For values mapped to "自定义 / Custom", include an additional column for the user to specify a custom display name. At least one value must map to the exposure type. Example for Chinese data:
``` event_type 行为类型映射确认
从数据中检测到 <N> 个不同的 event_type 值。每个值都需要绑定到一个标准行为类型(全部必填),且至少有一个值映射为「曝光」。映射为「自定义」的值还需要提供一个显示名称。请确认以下映射:
| 数据中的 event_type 值 | 映射到的标准行为类型 | 自定义显示名称(仅自定义类型需要填写) | |
|---|---|---|---|
| 曝光 | 曝光 | — | |
| 点击 | 点击 | — | |
| 分享 | 分享 | — | |
| 加购 | 加购 | — | |
| 下单 | 下单 | — | |
| 不喜欢 | 自定义 | 不喜欢 | |
| 点赞 | 点赞 | — | |
| 访问 | 访问 | — | |
| 购买 | 购买 | — | |
| 收藏 | 收藏 | — |
```
(2) The standard types reference (in the user's language only — Chinese example shown; for English/Japanese/Korean/Hindi users, use the corresponding column from the reference table above). Note: every value in the mapping table must be bound to one of these types (i.e. all rows are required); at least one value must be mapped to 曝光 / Exposure; values mapped to 自定义 / Custom require a user-provided display name:
| 标准行为类型 | 说明 | |
|---|---|---|
| 曝光 | 内容/商品曝光、展现、PV、impression(至少需要一个) | |
| 点击 | 点击、tap | |
| 收藏 | 收藏、favorite、save | |
| 分享 | 分享、share | |
| 点赞 | 点赞、like、thumbs-up | |
| 加购 | 加入购物车、add to cart | |
| 下单 | 提交订单、order、checkout | |
| 购买 | 购买、支付、purchase、pay | |
| 访问 | 访问、浏览详情页、visit、detail view | |
| 自定义 | 其他自定义行为(包括负反馈如不喜欢/差评/dislike),需要提供显示名称 |
End the prompt with: "回复 yes 确认以上映射,或告诉我需要修改的项(例如:'把 不喜欢 改成 点赞','xxx 是 曝光','yyy 作为自定义,名称为 zzz')。" (For non-Chinese users, translate the confirmation prompt to their language accordingly.)
d. Wait for explicit user confirmation. If the user provides corrections (including custom names), update the mapping table and re-present it. Do not proceed until every raw value has a confirmed mapping AND every `custom`-mapped value has a user-provided display name. If no value maps to exposure after confirmation, remind the user that at least one exposure-mapped value is required and ask them to re-examine their data.
e. After confirmation, serialize the mapping as the EnumerateMeta array on the event_type field in dataset-create.json (step 9). Convert each confirmed natural language label back to its EnumerateBizAttr code using the internal reference table at the top of this step. Each entry looks like: ``json { "EnumerateValue": "<raw value from data>", "Name": "<display name>", "EnumerateBizAttr": "<canonical code>", "Required": true } ``
- For the 9 standard types (exposure/click/collect/share/like/add_to_cart/order/purchase/visit),
Nameis the standard label in the dataset language (e.g. "曝光" for Chinese, "Click" for English). - For
custom,Nameis the user-provided display name (e.g. "不喜欢", "Dislike"). - The entry with
EnumerateBizAttr: "exposure"must haveRequired: true; all other entries also useRequired: true. - If multiple raw values map to the same
EnumerateBizAttr, include separate entries for each raw value.
- Dry-run create — build
dataset-create.jsondirectly from the persisted artifact: copySchemaas-is (do not flipIsPK; the backend derives PK fromBizAttr), copyDataFieldConfig.FieldDescMapasFieldDescMap, fill inName/Type/Language/Description, then formulti_modalalso setThemeand optionallyProcessConfig. Foruser_event, theevent_typeSchema entry must include the confirmedEnumerateMetaarray from step 8. SetDryRun: true. Runvs dataset create --data @dataset-create.json --dry-run. Surface any validation errors and pause for correction.
For `multi_modal` — standard payload shape:
``json { "Name": "<dataset-name>", "Type": "multi_modal", "Description": "<one-line description>", "Language": "zh", "Theme": "<general|e_commerce|content|long_video>", "Schema": <copy from infer-result.json Schema>, "FieldDescMap": <copy from infer-result.json DataFieldConfig.FieldDescMap> } ``
For `user_event` — omit Theme and ProcessConfig. The event_type field in Schema MUST include the confirmed EnumerateMeta array from step 8:
``json { "Name": "<dataset-name>", "Type": "user_event", "Description": "<one-line description>", "Language": "zh", "Schema": [ ..., { "Name": "event_type", "Type": "string", "BizAttr": "UserEventEventType", "Required": true, "EnumerateMeta": [ { "EnumerateValue": "<raw-exposure-value>", "Name": "曝光", "EnumerateBizAttr": "exposure", "Required": true }, { "EnumerateValue": "<raw-click-value>", "Name": "点击", "EnumerateBizAttr": "click", "Required": true }, ... (one entry per confirmed event type) ] }, ... ], "FieldDescMap": <copy from infer-result.json DataFieldConfig.FieldDescMap> } ``
- Real create — re-run step 9 without
DryRun. CaptureResult.Dataset.IdasDatasetIdand persist it next to the artifact (e.g../.viking/item-plans/<dataset-name>/dataset.json). - Write data —
vs data write --dataset-id <DatasetId> --fields @/tmp/viking/connector/<job>/bootstrap/items.jsonlto push the records from the bootstrap JSONL file. Expect arequest_idin the response. - (Ongoing sync mode only) Start background incremental sync — run
vs connector init --name <job> --source <mysql|jsonl> --dataset-id <DatasetId> ...to persist the job config, thenvs connector run --job <job> --daemonto start the background sync. For MySQL, pass--source-table,--id-field,--cursor-field; for local files, pass--file <path>. In the hand-off, surfacejob,pid,trace.ndjson,imported-records.log,vs connector status --job <job>, andvs connector stop --job <job>. Skip this step for one-time import workflows. - Optional: create application — only if the user explicitly asks for app-level setup:
vs app create --name <app-name> --description "<text>" --industry <alias> --language <lang>. CaptureResult.Application.IdasAppId. - Optional: attach dataset — read
DataFieldConfigstraight from the persisted artifact and assemble:
``json { "ApplicationId": "<AppId>", "DatasetId": "<DatasetId>", "DataConfig": <copy from infer-result.json DataFieldConfig> } ``
Then call vs app attach-dataset --data @attach.json. Empty Result means success. This is the moment where the IndexFields/FilterFields/etc. captured in step 6 are actually applied — never reinvent these arrays from the schema; always pull them from the persisted artifact.
- Hand-off — print console links + readiness reminder (mandatory). After the last successful step (data write, background sync start, or attach when the app branch ran), the agent must render a short summary block telling the user (a) where to monitor readiness in the console, and (b) that runtime APIs (
search,chat, recommend) can only be exercised once readiness reports OK. Pick the console host from the active profile'sbaseUrl/controlPlaneBaseUrl, and assemble URLs using these exact path templates (do not invent other paths like/dataset/detail/<id>or/application/detail/<id>— those are wrong):
- Host contains
volcengineapi.com/volces.com→ Volc Engine, base =https://console.volcengine.com/aisearch/platform/region:aisearch-platform+<region>.<region>is the active profile region (e.g.cn-beijing). - Dataset URL:
<base>/home/dataset/<DatasetId> - App URL:
<base>/app/<AppId> - Host contains
byteplus.com→ BytePlus, base =https://console.byteplus.com/aisearch/region:aisearch+ap-southeast-1(BytePlus today only exposes theap-southeast-1region; do not fabricate other regions). - Dataset URL:
<base>/home/dataset/<DatasetId> - App URL:
<base>/app/<AppId>
Print the URLs only for the resources that actually exist in this run (dataset is always present; app/attach are only present if the user opted in). Render the prose lines (✓ markers, readiness reminder, runtime-API tip) in the user's current language per the Language Matching rule; keep IDs and URLs verbatim.
Template (translate the labels per the table below; keep `DatasetId=...`, `AppId=...`, URLs, and `vs ...` commands verbatim):
``` ✓ <DATASET_LABEL>: DatasetId=<DatasetId> <LINK_LABEL>: <dataset console URL>
✓ <APP_LABEL>: AppId=<AppId> # only when the app branch ran <LINK_LABEL>: <app console URL> # only when the app branch ran
✓ <SYNC_LABEL>: job=<job> pid=<pid> # only when source-backed sync mode ran <TRACE_LABEL>: <trace path> <LOG_LABEL>: <import log path> <STATUS_CMD>: vs connector status --job <job> <STOP_CMD>: vs connector stop --job <job>
<READINESS_NOTE> <RUNTIME_NOTE> ```
Per-language label table:
| Slot | 中文 (default) | English | 日本語 | |
|---|---|---|---|---|
<DATASET_LABEL> | 数据集已创建 | Dataset created | データセットを作成しました | |
<APP_LABEL> | 应用已创建并绑定数据集 | Application created and dataset attached | アプリケーションを作成しデータセットを紐付けました | |
<LINK_LABEL> | 控制台链接 | Console link | コンソールリンク | |
<SYNC_LABEL> | 后台同步已启动 | Background sync started | バックグラウンド同期を開始しました | |
<TRACE_LABEL> | trace 文件 | trace file | トレースファイル | |
<LOG_LABEL> | 导入日志 | import log | インポートログ | |
<STATUS_CMD> | 查看状态 | check status | ステータス確認 | |
<STOP_CMD> | 停止同步 | stop sync | 同期停止 | |
<READINESS_NOTE> | 数据需要后台处理后才能查询。请打开上面链接关注数据集 / 应用的「生效状态」(Ready)。 | Data must finish backend processing before it is queryable. Open the links above and watch for the "Ready" state on the dataset / application. | データが利用可能になるにはバックエンド処理の完了が必要です。上記リンクからデータセット / アプリケーションの「Ready」状態を確認してください。 | |
<RUNTIME_NOTE> | ` 生效之后即可使用 vs search、vs chat、vs recommend 等运行时接口进行体验。 ` | ` Once they report Ready, you can exercise the runtime APIs via vs search, vs chat, vs recommend. ` | ` Ready になると vs search / vs chat / vs recommend などのランタイム API を利用できます。 ` |
For other languages, translate the same intent and keep IDs / URLs / vs ... commands verbatim. The agent must surface this block as the final output of the workflow; do not omit it even if the user has not asked. If only the dataset was created (no app branch, no sync), still print the dataset link and the readiness reminder (chat / search will require attaching to an app afterwards).
Enum Reference
enum fields are strings. Pass the CLI alias (case-insensitive) and let the CLI normalize to the backend wire value.
| Field | CLI alias (recommended) | Backend wire value (snake_case) | |
|---|---|---|---|
Type (dataset) | multi_modal (use multi-modal / multimodal as aliases) | multi_modal | |
Type (dataset) | user_event (use user-event as alias) | user_event | |
Theme | general / common / default | general | |
Theme | ecommerce / e-commerce | e_commerce | |
Theme | content | content | |
Theme | long-video / longvideo | long_video | |
Type (field) | string / int32 / int64 / float / bool / array<string> / array<int64> / array<float> / object / array<object> | identical string |
Do not pass numeric codes to any V2 API. The CLI keeps a one-way alias map and an int→string fallback for legacy payloads, but agents should emit strings only.
Backend-driven Primary Key
In V2, the agent does not set the primary key. The backend computes IsPK from BizAttr (truthy when BizAttr ∈ {MultiModalId}) regardless of the IsPK value on the wire. Schema inference already assigns the right BizAttr, so:
- Forward the inferred
SchematoCreateDatasetV2verbatim.IsPKcan stayfalseeverywhere. - Never strip / rewrite
BizAttr. Doing so will cause the backend'spkCount==1check to fail. - If inference returned no field with a PK-class
BizAttr(very rare; usually means the input file has no obvious identifier column), surface that to the user in the Schema Confirmation block (the CLI's**Warnings (N)**section already calls it out) — they likely need to fix the source data, not patch the schema by hand.
V2 API Surface (reference)
| Stage | OpenAPI | CLI command | |
|---|---|---|---|
| Upload URL | POST /open/GetPresignedImportUrlV2 | vs dataset import-url | |
| Submit inference | POST /open/AddInferDatasetSchemaTaskV2 | vs dataset infer-schema | |
| Poll inference | POST /open/GetInferDatasetSchemaResultV2 | vs dataset infer-result | |
| Create dataset | POST /open/CreateDatasetV2 | vs dataset create | |
| Write data | runtime dataWrite | vs data write | |
| Create app | POST /open/CreateApplicationV2 | vs app create | |
| Attach dataset | POST /open/AttachDatasetToApplicationV2 | vs app attach-dataset |
Customer Environment Principle
- In customer environments, assume repository source code is unavailable.
- Execute tasks using only the installed skills, the packaged
vsCLI surface (--help, command output, observed runtime behavior), and explicit user-provided information. - All HTTP requests issued by
vsautomatically carryUser-Agent: Search-Cli; do not attempt to forge or strip this header.
Constraints
- Persist the inference artifact. Write the entire
Resultfromdataset infer-resultto a local file in step 6 and re-read it in steps 9, 10, and 14. Do not pass field roles inline from memory; always source them from the persisted file so create + attach stay consistent. - Plan dir must live in the workspace. All plan / artifact files (
infer-result.json/dataset-create.json/attach.json, etc.) must be written under the workspace-relative path./.viking/item-plans/<dataset-name>/(or, when the sandbox restricts that, follow the step-6 fallback order:${WORKSPACE_DIR}/.viking/...→${TMPDIR}/viking-item-plans/...→./viking-item-plans/...). Never write to~/.viking/(i.e.$HOME/.viking/) — that is thevsCLI's private config / credentials directory, and most agent sandboxes deny home-directory writes, which surfaces asEPERM: operation not permitted. - Never flip `IsPK`. Backend derives PK from
BizAttr. ModifyingIsPK(or strippingBizAttr) on the wire is a code smell and can fail validation. - Never skip Schema Confirmation (step 7). Schema persistence (step 9 onward) requires an explicit human "yes" on the inferred schema and field roles.
- Never skip Behavior type confirmation (step 8) for `user_event`. Every distinct
event_typevalue found in the data must be mapped to a standardEnumerateBizAttrvia the step 8 confirmation flow. The finalEnumerateMetamust include at least oneexposureentry (Required: true) and at least one non-exposure positive behavior. Values mapped tocustomMUST have a user-provided displayName(do not leave it blank or use "自定义"/"Custom" as the name). Do not proceed to step 9 until the user explicitly confirms the full mapping including all custom names. Do not force or fabricate mappings: if you cannot confidently map a raw value, mark it as "待确认 / to be confirmed" and let the user choose — never silently default uncertain values tocustom, and never proceed with unresolved rows. - Always dry-run once. Run
dataset create --dry-runbefore the real create. Surface backend validation errors to the user before retrying. - String enums only. Pass
Typeas one of"multi_modal"or"user_event". Formulti_modal,Thememust be one ofgeneral|e_commerce|content|long_video. Do not pass numeric enum codes. App-level--industryis only used forvs app create; never pass it to dataset create / infer-schema. - No backtrack flags.
attach-dataset(V2) does not acceptBacktrackReq. If the user needs historical backtrack, treat it as a separate workflow. - Preserve `FieldDescMap` and `DataConfig`. Forward the inferred
FieldDescMaptoCreateDatasetV2, and forward the inferredDataConfigverbatim toAttachDatasetToApplicationV2. Do not regenerate or strip them locally. - No `Authorization` header on the TOS PUT.
FileUrlis presigned; adding auth headers will break the upload. - Always end with the console hand-off block. The agent's final message in this workflow must include the dataset (and app, if created) console URLs derived from the active profile (
volcengine.comfor Volc,byteplus.comfor BytePlus) plus a reminder that runtime APIs (search,chat, recommend) can only be used once the console shows the resource as Ready. Never skip this step — the user has no other clue where to monitor readiness. - All new-dataset onboarding must go through the export step. Both MySQL and local file sources must first be exported to a bootstrap JSONL file via
vs connector export. Do not claimdataset ingest --source ...exists in the supported workflow, and do not bypass the export step by uploading the raw user file directly. After export, reuse the emitted bootstrap file path in the normal V2 onboarding flow. - Ongoing sync must go through the sync lifecycle commands. Use
connector init+connector run --daemon, then surface runtime artifacts (trace.ndjson,imported-records.log,runtime.json,state.json) plus the status/stop commands. This applies to both MySQL and local file sources. - Incremental cursor confirmation is a hard gate for MySQL sync. In MySQL
syncmode, never silently accept an inferred cursor field. Show the basis for the guess and require explicit user confirmation before starting the background job. For local file sync, new lines appended to the file are automatically detected; no cursor field confirmation is needed. - Append-only confirmation is a hard gate for JSONL file sync. In JSONL
ongoing syncmode, you MUST interactively ask the user to confirm that the file will only grow by appending new lines. Explain clearly that edits or deletions of existing lines are not tracked and may cause duplicate or missing records. Do not start the background sync job until the user explicitly confirms this constraint. This confirmation must be an interactive question — never silently assume the file is append-only. - Resolve import mode before proceeding for MySQL and JSONL. Only skip the question when the request contains an explicit one-time or ongoing signal. The bare import verb without further qualification is neutral and you MUST ask. Never silently default to one-time. JSON/CSV are one-time only with no question needed.
- Do not invent a one-shot source import into an existing dataset. If the user wants
existing_dataset + once, explain the current CLI split and let them choose between creating a new dataset from exported JSONL or enabling connector-based sync. - Never block waiting for readiness. After printing the hand-off block, end your turn immediately. Do NOT run
vs app wait-ready,vs dataset wait-ready, or any polling loop. Readiness is an asynchronous backend process; tell the user to check the console links themselves. - Theme is mandatory for `multi_modal`. For
multi_modaldatasets, you MUST pass--theme(one ofgeneral|e_commerce|content|long_video) to bothdataset infer-schemaanddataset create. If the user has no preference, default togeneral. Foruser_event, omit--theme. - Multi-modal BizAttrs are backend-assigned; do not hand-edit them. Schema inference automatically assigns the correct
MultiModal*BizAttr codes (e.g.MultiModalId=80,MultiModalImageUrl=83,MultiModalVideoUrl=84,MultiModalCategory=85,MultiModalPrice=88). Do not add, remove, or remap these BizAttrs manually. If inference returns Warnings about missing required BizAttrs for the chosen Theme, fix the source data (add the missing column) rather than patching BizAttr by hand. - Preserve multi-modal DataFieldConfig sub-fields. When attaching the dataset to an application, the
DataConfiginattach.jsonMUST includeImageIndexFields,VideoIndexFields, andChatFieldsexactly as returned by inference (they may be empty arrays, but must not be dropped). These fields drive image search, video search, and multimodal chat respectively; stripping them silently disables those capabilities. - Do not call GetSchemaTemplate from the CLI. The frontend (DonaldTrump) calls
GetSchemaTemplate(TemplateCode=theme)to get per-theme BizAttrConstraint lists; the CLI does not wrap this API. For CLI-driven onboarding, trust the backend's schema inference to assign required fields correctly; the Schema Confirmation Warnings block will surface any missing required fields, which the agent should relay to the user. Do not add a CLI call to fetch or validate templates.
Recovery Hints
infer-resultreturnsStatus=Failed→ read theError/ErrorCodefields, fix the input file (encoding, JSONL formatting, header row), re-upload via step 3.dataset createrejects withInvalidParameter.PrimaryKeyCount→ check the persisted artifact: at least one field must carry a PK-classBizAttr(MultiModalId). If none does, inference effectively failed; re-run with a cleaner input that includes a stable identifier column.dataset createrejects withInvalidParameter.ThemeorInvalidParameter.UnsupportedTheme→ the--themevalue is invalid; use one ofgeneral|e_commerce|content|long_video.dataset createrejects withInvalidParameter.Request→ most common causes: (a) fieldTypesent as a number instead of a string, (b)BizAttraccidentally stripped during local editing, (c)Themewas missing or empty. Fix locally and dry-run again; no need to re-run inference.dataset createrejects with multi-modal BizAttr errors (e.g. missing requiredMultiModalImageUrlfore_commercetheme) → the inferred schema is missing a required field for the chosen theme. Add the missing column to the source data and re-run from step 3 (re-upload + re-infer); do NOT patch BizAttr by hand.attach-dataseterrors after a successful create → runvs app diagnose --application-id <AppId>to inspect the runtime state before retrying. If the error isOperationDenied.ImageAndVideoDatasetNotSupport(code 340023), the application already has a dataset of a conflicting modality (image-text vs video cannot be bound together); create a separate application instead.attach-dataseterrors withOperationDenied.VideoDatasetFieldsInsufficient(code 340025) → a multi-modal video dataset requires descriptive text/array<string> fields beyond numeric fields; add title/content/description columns to the source data.data writereturns a HTTP error → confirm the dataset is in theReadystate viavs app status --application-id <AppId>(if attached), orvs dataset get --id <DatasetId> --fullfor unattached writes.
Worked Example
See references/worked-example.md for an end-to-end verified bash transcript (10-item apparel goods.jsonl → dataset + app + attach), including the jq recipes used to build dataset-create.json and attach.json from the persisted infer-result.json.