Skip to content

fix: update ActionSearchSource type to support specialized API sources #2742

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −8
Open

fix: update ActionSearchSource type to support specialized API sources #2742

Show file tree
Hide file tree
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
11 changes: 7 additions & 4 deletions src/openai/types/responses/response_function_web_search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@


class ActionSearchSource(BaseModel):
type: Literal["url"]
"""The type of source. Always `url`."""
type: Literal["url", "api"]
"""The type of source. Can be 'url' for web sources or 'api' for specialized OpenAI APIs."""

url: str
"""The URL of the source."""
url: Optional[str] = None
"""The URL of the source (present when type='url')."""

name: Optional[str] = None
"""The name/identifier of the specialized API (e.g., 'oai-weather', 'oai-sports', 'oai-finance')."""


class ActionSearch(BaseModel):
Expand Down
11 changes: 7 additions & 4 deletions src/openai/types/responses/response_function_web_search_param.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,14 @@


class ActionSearchSource(TypedDict, total=False):
type: Required[Literal["url"]]
"""The type of source. Always `url`."""
type: Required[Literal["url", "api"]]
"""The type of source. Can be 'url' for web sources or 'api' for specialized OpenAI APIs."""

url: Required[str]
"""The URL of the source."""
url: str
"""The URL of the source (present when type='url')."""

name: str
"""The name/identifier of the specialized API (e.g., 'oai-weather', 'oai-sports', 'oai-finance')."""


class ActionSearch(TypedDict, total=False):
Expand Down