Skip to content

FIX Replace deprecated piece.role with piece.api_role in doc notebooks #1620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
romanlutz merged 2 commits into from
Apr 16, 2026
Merged

FIX Replace deprecated piece.role with piece.api_role in doc notebooks #1620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0d4a6d
FIX Replace deprecated piece.role with piece.api_role in doc notebooks
romanlutz Apr 15, 2026
7c08843
Fix msg.role -> msg.api_role for Message objects in 11_message_normal…
romanlutz Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 12 additions & 18 deletions doc/code/memory/5_advanced_memory.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"./AppData/Local/Temp/ipykernel_16856/1441526989.py:17: DeprecationWarning: MessagePiece.role getter is deprecated. Use api_role for comparisons. This property will be removed in 0.13.0.\n",
" original_user_prompts = [prompt.original_value for prompt in prompts if prompt.role == \"user\"]\n",
" original_user_prompts = [prompt.original_value for prompt in prompts if prompt.api_role == \"user\"]\n",
"[PromptSendingAttack (ID: 1cb5c9f1)] No response received on attempt 1 (likely filtered)\n"
]
},
Expand Down Expand Up @@ -196,7 +195,7 @@
"print(\"-----------------\")\n",
"\n",
"# These are all original prompts sent previously\n",
"original_user_prompts = [prompt.original_value for prompt in prompts if prompt.role == \"user\"]\n",
"original_user_prompts = [prompt.original_value for prompt in prompts if prompt.api_role == \"user\"]\n",
"\n",
"# we can now send them to a new target, using different converters\n",
"\n",
Expand Down Expand Up @@ -277,8 +276,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"./AppData/Local/Temp/ipykernel_16856/4148307427.py:19: DeprecationWarning: MessagePiece.role getter is deprecated. Use api_role for comparisons. This property will be removed in 0.13.0.\n",
" print(f\" [{piece.role}] {piece.converted_value[:80]}\")\n"
" print(f\" [{piece.api_role}] {piece.converted_value[:80]}\")\n"
]
}
],
Expand All @@ -301,7 +299,7 @@
"\n",
" print(f\"Message pieces to/from {filter_target_class}: {len(target_class_pieces)}\")\n",
" for piece in target_class_pieces:\n",
" print(f\" [{piece.role}] {piece.converted_value[:80]}\")"
" print(f\" [{piece.api_role}] {piece.converted_value[:80]}\")"
]
},
{
Expand Down Expand Up @@ -336,8 +334,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"./AppData/Local/Temp/ipykernel_13356/2793915745.py:15: DeprecationWarning: MessagePiece.role getter is deprecated. Use api_role for comparisons. This property will be removed in 0.13.0.\n",
" print(f\" [{piece.role}] {piece.original_value[:80]}\")\n"
" print(f\" [{piece.api_role}] {piece.original_value[:80]}\")\n"
]
}
],
Expand All @@ -356,7 +353,7 @@
"\n",
"print(f\"Message pieces to/from *OpenAI* targets: {len(openai_pieces)}\")\n",
"for piece in openai_pieces:\n",
" print(f\" [{piece.role}] {piece.original_value[:80]}\")"
" print(f\" [{piece.api_role}] {piece.original_value[:80]}\")"
]
},
{
Expand Down Expand Up @@ -389,8 +386,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"./AppData/Local/Temp/ipykernel_13356/3979432580.py:15: DeprecationWarning: MessagePiece.role getter is deprecated. Use api_role for comparisons. This property will be removed in 0.13.0.\n",
" print(f\" [{piece.role}] original: {piece.original_value[:60]} → converted: {piece.converted_value[:60]}\")\n"
" print(f\" [{piece.api_role}] original: {piece.original_value[:60]} → converted: {piece.converted_value[:60]}\")\n"
]
}
],
Expand All @@ -409,7 +405,7 @@
"\n",
"print(f\"Message pieces that used Base64Converter: {len(base64_pieces)}\")\n",
"for piece in base64_pieces:\n",
" print(f\" [{piece.role}] original: {piece.original_value[:60]} → converted: {piece.converted_value[:60]}\")"
" print(f\" [{piece.api_role}] original: {piece.original_value[:60]} → converted: {piece.converted_value[:60]}\")"
]
},
{
Expand Down Expand Up @@ -442,8 +438,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"./AppData/Local/Temp/ipykernel_13356/814594877.py:13: DeprecationWarning: MessagePiece.role getter is deprecated. Use api_role for comparisons. This property will be removed in 0.13.0.\n",
" print(f\" [{piece.role}] {piece.original_value[:80]}\")\n"
" print(f\" [{piece.api_role}] {piece.original_value[:80]}\")\n"
]
}
],
Expand All @@ -460,7 +455,7 @@
"\n",
"print(f\"Pieces to/from TextTarget AND using Base64Converter: {len(combined_pieces)}\")\n",
"for piece in combined_pieces:\n",
" print(f\" [{piece.role}] {piece.original_value[:80]}\")"
" print(f\" [{piece.api_role}] {piece.original_value[:80]}\")"
]
},
{
Expand Down Expand Up @@ -494,8 +489,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"./AppData/Local/Temp/ipykernel_13356/2461341104.py:9: DeprecationWarning: MessagePiece.role getter is deprecated. Use api_role for comparisons. This property will be removed in 0.13.0.\n",
" print(f\" [{piece.role}] {piece.original_value[:80]}\")\n"
" print(f\" [{piece.api_role}] {piece.original_value[:80]}\")\n"
]
}
],
Expand All @@ -508,7 +502,7 @@
"\n",
"print(f\"Labeled + filtered pieces: {len(labeled_and_filtered)}\")\n",
"for piece in labeled_and_filtered:\n",
" print(f\" [{piece.role}] {piece.original_value[:80]}\")"
" print(f\" [{piece.api_role}] {piece.original_value[:80]}\")"
]
},
{
Expand Down
12 changes: 6 additions & 6 deletions doc/code/memory/5_advanced_memory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
print("-----------------")

# These are all original prompts sent previously
original_user_prompts = [prompt.original_value for prompt in prompts if prompt.role == "user"]
original_user_prompts = [prompt.original_value for prompt in prompts if prompt.api_role == "user"]

# we can now send them to a new target, using different converters

Expand Down Expand Up @@ -149,7 +149,7 @@

print(f"Message pieces to/from {filter_target_class}: {len(target_class_pieces)}")
for piece in target_class_pieces:
print(f" [{piece.role}] {piece.converted_value[:80]}")
print(f" [{piece.api_role}] {piece.converted_value[:80]}")

# %% [markdown]
# ### Filter by target with partial match
Expand All @@ -172,7 +172,7 @@

print(f"Message pieces to/from *OpenAI* targets: {len(openai_pieces)}")
for piece in openai_pieces:
print(f" [{piece.role}] {piece.original_value[:80]}")
print(f" [{piece.api_role}] {piece.original_value[:80]}")

# %% [markdown]
# ### Filter by converter (array column)
Expand All @@ -195,7 +195,7 @@

print(f"Message pieces that used Base64Converter: {len(base64_pieces)}")
for piece in base64_pieces:
print(f" [{piece.role}] original: {piece.original_value[:60]} → converted: {piece.converted_value[:60]}")
print(f" [{piece.api_role}] original: {piece.original_value[:60]} → converted: {piece.converted_value[:60]}")

# %% [markdown]
# ### Combining multiple filters
Expand All @@ -216,7 +216,7 @@

print(f"Pieces to/from TextTarget AND using Base64Converter: {len(combined_pieces)}")
for piece in combined_pieces:
print(f" [{piece.role}] {piece.original_value[:80]}")
print(f" [{piece.api_role}] {piece.original_value[:80]}")

# %% [markdown]
# ### Mixing labels and identifier filters
Expand All @@ -234,7 +234,7 @@

print(f"Labeled + filtered pieces: {len(labeled_and_filtered)}")
for piece in labeled_and_filtered:
print(f" [{piece.role}] {piece.original_value[:80]}")
print(f" [{piece.api_role}] {piece.original_value[:80]}")

# %% [markdown]
# ## Part 3 — Filtering Scores by Scorer Identity
Expand Down
4 changes: 2 additions & 2 deletions doc/code/targets/11_message_normalizer.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"\n",
"print(\"Sample messages created:\")\n",
"for msg in messages:\n",
" print(f\" {msg.role}: {msg.get_piece().converted_value[:50]}...\")"
" print(f\" {msg.api_role}: {msg.get_piece().converted_value[:50]}...\")"
]
},
{
Expand Down Expand Up @@ -502,7 +502,7 @@
" lines = []\n",
" for msg in messages:\n",
" piece = msg.get_piece()\n",
" role = piece.role.capitalize()\n",
" role = piece.api_role.capitalize()\n",
" content = piece.converted_value\n",
" lines.append(f\"**{role}**: {content}\")\n",
" return \"\\n\\n\".join(lines)\n",
Expand Down
4 changes: 2 additions & 2 deletions doc/code/targets/11_message_normalizer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@

print("Sample messages created:")
for msg in messages:
print(f" {msg.role}: {msg.get_piece().converted_value[:50]}...")
print(f" {msg.api_role}: {msg.get_piece().converted_value[:50]}...")

# %% [markdown]
# ## ChatMessageNormalizer
Expand Down Expand Up @@ -215,7 +215,7 @@ async def normalize_string_async(self, messages: list[Message]) -> str:
lines = []
for msg in messages:
piece = msg.get_piece()
role = piece.role.capitalize()
role = piece.api_role.capitalize()
content = piece.converted_value
lines.append(f"**{role}**: {content}")
return "\n\n".join(lines)
Expand Down
Loading