Skip to content

fix(types): add optional name field to ChatCompletionToolMessageParam #2945

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

Open
DanielDerefaka wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −1
Open

fix(types): add optional name field to ChatCompletionToolMessageParam #2945

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion src/openai/types/chat/chat_completion_tool_message_param.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from __future__ import annotations

from typing import Union, Iterable
from typing import Optional, Union, Iterable
from typing_extensions import Literal, Required, TypedDict

from .chat_completion_content_part_text_param import ChatCompletionContentPartTextParam
Expand All @@ -19,3 +19,13 @@ class ChatCompletionToolMessageParam(TypedDict, total=False):

tool_call_id: Required[str]
"""Tool call that this message is responding to."""

name: Optional[str]
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Type name as non-null when present

ChatCompletionToolMessageParam is a TypedDict(total=False), so marking name as Optional[str] makes type checkers accept an explicit "name": None payload, not just omission. That widens the request type beyond the rest of chat message params (which model optional string fields as name: str) and can lead users to send null for name, which is likely rejected where a string is expected. The field should be optional-by-presence only, i.e. name: str.

Useful? React with 👍 / 👎.

"""The name of the tool that was called.

This field is optional and mirrors the `name` field present on other message
types (e.g. ``ChatCompletionFunctionMessageParam``). Including the tool name
can improve clarity when multiple tools are used in a single conversation turn,
and is consistent with OpenAI's own documentation examples for parallel
function calling.
"""