docs(profiles): make user-profiles guide and notebook user-only
Remove leftover agent and regenerate references so the docs match the shipped v1 SDK: drop the entity_type settings argument and the agent entities example from the guide, and remove the regenerate demo section and cheat-sheet row from the notebook. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.8
parent
d91d793c52
commit
f29820886a
@@ -149,7 +149,7 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"`enabled` is project-wide; `schema` and `custom_instructions` belong to one entity kind\n",
|
||||
"`enabled` is project-wide; `schema` and `custom_instructions` apply to user profiles\n",
|
||||
"and are stored under `entities`. The SDK takes them flat and nests them for you, so what\n",
|
||||
"you write comes back unchanged from `get_profile_settings()`.\n",
|
||||
"\n",
|
||||
@@ -576,31 +576,7 @@
|
||||
"when you call `generate_profile()` for them.\n",
|
||||
"\n",
|
||||
"A field you **remove** stops being maintained: on the next generation, fields your schema\n",
|
||||
"no longer defines are pruned. Keep a field for as long as you want its value kept.\n",
|
||||
"\n",
|
||||
"Rebuilding a whole project in one call is **not available yet**. Check\n",
|
||||
"`capabilities.full_rebuild` before offering it in your own UI — the cell below expects to\n",
|
||||
"be refused, and that refusal is the feature working.\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"caps = client.get_profile_settings().get(\"capabilities\", {})\n",
|
||||
"print(\"full_rebuild available:\", caps.get(\"full_rebuild\"))\n",
|
||||
"\n",
|
||||
"if caps.get(\"full_rebuild\"):\n",
|
||||
" wait_for_job(client.regenerate_profiles())\n",
|
||||
"else:\n",
|
||||
" try:\n",
|
||||
" client.regenerate_profiles()\n",
|
||||
" print(\"ACCEPTED (unexpected)\")\n",
|
||||
" except Exception as e:\n",
|
||||
" # 409 not_yet_available. It creates nothing, so nothing was charged.\n",
|
||||
" print(\"refused as expected:\", str(e)[:200])\n"
|
||||
"no longer defines are pruned. Keep a field for as long as you want its value kept."
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -629,8 +605,8 @@
|
||||
"Rejections happen on **write**, where you can see and fix them — not silently at\n",
|
||||
"generation time, where you would only notice as an empty profile weeks later.\n",
|
||||
"\n",
|
||||
"The last case matters for storage: both entity kinds live in one JSONB column alongside\n",
|
||||
"the envelope that separates them, so a schema using the envelope's own reserved keys could\n",
|
||||
"The last case matters for storage: the user schema lives in one JSONB column alongside\n",
|
||||
"the envelope that separates it, so a schema using the envelope's own reserved keys could\n",
|
||||
"not be read back unambiguously. It is refused rather than stored.\n"
|
||||
]
|
||||
},
|
||||
@@ -749,7 +725,7 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## 8. Cleanup\n",
|
||||
"## 7. Cleanup\n",
|
||||
"\n",
|
||||
"Removes the demo users. The profile row cascades with the entity.\n"
|
||||
]
|
||||
@@ -781,10 +757,9 @@
|
||||
"| read | `get_profile(user_id)` | free |\n",
|
||||
"| one user now | `generate_profile(user_id)` | 1 LLM call |\n",
|
||||
"| try a schema | `sample_profiles(limit=n)` | ≤10 real generations, kept |\n",
|
||||
"| everyone | `regenerate_profiles()` | **not available yet** — 409 |\n",
|
||||
"| poll a job | `get_profile_job(status_url)` | free |\n",
|
||||
"\n",
|
||||
"**Settings are per entity kind.** The stored shape is:\n",
|
||||
"**Settings apply to user profiles.** The stored shape is:\n",
|
||||
"\n",
|
||||
"```json\n",
|
||||
"{\"enabled\": true,\n",
|
||||
|
||||
Reference in New Issue
Block a user