ナレッジベースと商品

API でQ&A、ドキュメント、商品を一括同期。外部IDによる差分更新に対応。

4.1 ナレッジベース

メソッド	パス	説明
POST	`/v1/knowledge/faqs/batch`	Q&Aを一括登録。`{"items": [{"question", "answer", "external_id"}]}`、最大500件。`external_id` に基づいて差分更新され、内容が変わっていないものは再処理されません
POST	`/v1/knowledge/documents`	ドキュメントを新規追加：`{"title", "content"}` でテキストを直接指定するか、`{"url"}` を指定するとYinkeがウェブページを取得します。`external_id` を付けると、同じ ID の古いドキュメントが置き換えられます
POST	`/v1/knowledge/documents/upload`	ファイルをアップロード（multipart、フィールド `file`）。txt、md、html、pdf、docx に対応、最大 20MB
GET	`/v1/knowledge/documents`	ドキュメント一覧、`?page=&limit=&source_type=`
GET	`/v1/knowledge/documents/{id}`	ドキュメントの詳細、`status` は `pending` / `processing` / `ready` / `failed`
DELETE	`/v1/knowledge/documents/{id}`	削除

ドキュメントは書き込み後に非同期で処理され、通常は数秒以内に ready になります。Webhook を設定している場合は document.ready または document.failed を受信します。

4.2 商品

メソッド	パス	説明
POST	`/v1/products/batch`	一括登録、最大500件、`external_id` に基づいて差分更新
GET	`/v1/products`	商品一覧
DELETE	`/v1/products/{external_id}`	削除

商品フィールド：

{
  "external_id": "w-1001",
  "name": "潜水自动机械表",
  "description": "200 米防水，蓝宝石表镜",
  "category": "手表",
  "price": "399.00",
  "currency": "USD",
  "stock": 12,
  "url": "https://shop.example.com/p/w-1001",
  "image_url": "https://shop.example.com/img/w-1001.jpg",
  "attributes": {"材质": "316L 钢", "表径": "39 mm"},
  "variants": [{"sku": "w-1001-blk", "name": "黑色", "price": "399.00", "stock": 5}],
  "status": "active"
}

stock が null の場合は在庫を追跡しないことを意味します。status が inactive の商品はおすすめされません。AI が価格と在庫を回答する際は、ここの値のみを使用します。

このページは役に立ちましたか?

最終更新: 2026年10月31日