Skip to content

fix(api): align ChatCompletionCustomToolParam structure with API spec #2765

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

Closed
thromel wants to merge 1 commit into from
Closed

fix(api): align ChatCompletionCustomToolParam structure with API spec #2765

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
51 changes: 8 additions & 43 deletions src/openai/types/chat/chat_completion_custom_tool_param.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,22 @@

from __future__ import annotations

from typing import Union
from typing_extensions import Literal, Required, TypeAlias, TypedDict
from typing_extensions import Literal, Required, TypedDict

__all__ = [
"ChatCompletionCustomToolParam",
"Custom",
"CustomFormat",
"CustomFormatText",
"CustomFormatGrammar",
"CustomFormatGrammarGrammar",
]
from ..shared_params.custom_tool_input_format import CustomToolInputFormat

__all__ = ["ChatCompletionCustomToolParam"]

class CustomFormatText(TypedDict, total=False):
type: Required[Literal["text"]]
"""Unconstrained text format. Always `text`."""


class CustomFormatGrammarGrammar(TypedDict, total=False):
definition: Required[str]
"""The grammar definition."""

syntax: Required[Literal["lark", "regex"]]
"""The syntax of the grammar definition. One of `lark` or `regex`."""


class CustomFormatGrammar(TypedDict, total=False):
grammar: Required[CustomFormatGrammarGrammar]
"""Your chosen grammar."""

type: Required[Literal["grammar"]]
"""Grammar format. Always `grammar`."""


CustomFormat: TypeAlias = Union[CustomFormatText, CustomFormatGrammar]


class Custom(TypedDict, total=False):
class ChatCompletionCustomToolParam(TypedDict, total=False):
name: Required[str]
"""The name of the custom tool, used to identify it in tool calls."""

type: Required[Literal["custom"]]
"""The type of the custom tool. Always `custom`."""

description: str
"""Optional description of the custom tool, used to provide more context."""

format: CustomFormat
format: CustomToolInputFormat
"""The input format for the custom tool. Default is unconstrained text."""


class ChatCompletionCustomToolParam(TypedDict, total=False):
custom: Required[Custom]
"""Properties of the custom tool."""

type: Required[Literal["custom"]]
"""The type of the custom tool. Always `custom`."""