Skip to content

fix: allow structured output schema to be a dict #71

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
cjumel merged 2 commits into from
May 21, 2026
Merged

fix: allow structured output schema to be a dict #71

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
0809657
chore: upgrade semantic release action
cjumel May 21, 2026
7b7841f
fix: allow structured output schema to be a dict
cjumel May 21, 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
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:

- name: Action | Semantic Version Release
id: release
uses: python-semantic-release/python-semantic-release@v10.4.1
uses: python-semantic-release/python-semantic-release@v10.5.3
with:
github_token: ${{ secrets.GH_TOKEN_FOR_SEMANTIC_RELEASE }}
git_committer_name: "github-actions"
Expand Down
2 changes: 0 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Homepage = "https://github.com/LinkupPlatform/linkup-python-sdk"
Source = "https://github.com/LinkupPlatform/linkup-python-sdk"
Tracker = "https://github.com/LinkupPlatform/linkup-python-sdk/issues"


[dependency-groups]
dev = [
"prek>=0.3.5",
Expand Down Expand Up @@ -140,7 +139,6 @@ parse_squash_commits = false
exclude-newer = "2 weeks" # Reduce risks of supply chain attacks
required-version = ">=0.10.0,<0.11.0"


[build-system]
build-backend = "hatchling.build"
requires = ["hatchling"]
44 changes: 22 additions & 22 deletions src/linkup/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def search(
query: str,
depth: Literal["standard", "deep"],
output_type: Literal["searchResults", "sourcedAnswer", "structured"],
structured_output_schema: type[BaseModel] | str | None = None,
structured_output_schema: type[BaseModel] | dict[str, Any] | str | None = None,
include_images: bool | None = None,
from_date: date | None = None,
to_date: date | None = None,
Expand All @@ -118,8 +118,8 @@ def search(
supporting it, and "structured" will base the output on the format provided in
structured_output_schema.
structured_output_schema: If output_type is "structured", specify the schema of the
output. Supported formats are a pydantic.BaseModel or a string representing a
valid object JSON schema.
output. Supported formats are a pydantic.BaseModel, a Python dictionary containing a
valid object JSON schema, or a string representing a valid object JSON schema.
include_images: Indicate whether images should be included during the search.
from_date: The date from which the search results should be considered. If None, the
search results will not be filtered by date.
Expand All @@ -146,8 +146,8 @@ def search(
True

Raises:
TypeError: If structured_output_schema is not provided or is not a string or a
pydantic.BaseModel when output_type is "structured".
TypeError: If structured_output_schema is not provided or is not a string, dictionary,
or pydantic.BaseModel when output_type is "structured".
LinkupInvalidRequestError: If structured_output_schema doesn't represent a valid object
JSON schema when output_type is "structured".
LinkupAuthenticationError: If the Linkup API key is invalid.
Expand Down Expand Up @@ -189,7 +189,7 @@ async def async_search(
query: str,
depth: Literal["standard", "deep"],
output_type: Literal["searchResults", "sourcedAnswer", "structured"],
structured_output_schema: type[BaseModel] | str | None = None,
structured_output_schema: type[BaseModel] | dict[str, Any] | str | None = None,
include_images: bool | None = None,
from_date: date | None = None,
to_date: date | None = None,
Expand All @@ -215,8 +215,8 @@ async def async_search(
supporting it, and "structured" will base the output on the format provided in
structured_output_schema.
structured_output_schema: If output_type is "structured", specify the schema of the
output. Supported formats are a pydantic.BaseModel or a string representing a
valid object JSON schema.
output. Supported formats are a pydantic.BaseModel, a Python dictionary containing a
valid object JSON schema, or a string representing a valid object JSON schema.
include_images: Indicate whether images should be included during the search.
from_date: The date from which the search results should be considered. If None, the
search results will not be filtered by date.
Expand All @@ -243,8 +243,8 @@ async def async_search(
True

Raises:
TypeError: If structured_output_schema is not provided or is not a string or a
pydantic.BaseModel when output_type is "structured".
TypeError: If structured_output_schema is not provided or is not a string, dictionary,
or pydantic.BaseModel when output_type is "structured".
LinkupInvalidRequestError: If structured_output_schema doesn't represent a valid object
JSON schema when output_type is "structured".
LinkupAuthenticationError: If the Linkup API key is invalid.
Expand Down Expand Up @@ -287,7 +287,7 @@ def research(
output_type: Literal["sourcedAnswer", "structured"],
reasoning_depth: Literal["S", "M", "L", "XL"] | None = None,
mode: Literal["answer", "auto", "investigate", "research"] | None = None,
structured_output_schema: type[BaseModel] | str | None = None,
structured_output_schema: type[BaseModel] | dict[str, Any] | str | None = None,
from_date: date | None = None,
to_date: date | None = None,
exclude_domains: list[str] | None = None,
Expand All @@ -307,8 +307,8 @@ def research(
is used.
mode: The research mode to use. If None, the Linkup API default is used.
structured_output_schema: If output_type is "structured", specify the output schema.
Supported formats are a pydantic.BaseModel or a string representing a valid object
JSON schema.
Supported formats are a pydantic.BaseModel, a Python dictionary containing a valid
object JSON schema, or a string representing a valid object JSON schema.
from_date: The date from which the research sources should be considered. If None,
sources will not be filtered by a start date.
to_date: The date until which the research sources should be considered. If None,
Expand All @@ -322,8 +322,8 @@ def research(
The created research task.

Raises:
TypeError: If structured_output_schema is not a string or pydantic.BaseModel when
provided.
TypeError: If structured_output_schema is not a string, dictionary, or
pydantic.BaseModel when provided.
LinkupInvalidRequestError: If the request parameters are invalid.
LinkupAuthenticationError: If the Linkup API key is invalid.
LinkupInsufficientCreditError: If you have run out of credit.
Expand Down Expand Up @@ -356,7 +356,7 @@ async def async_research(
output_type: Literal["sourcedAnswer", "structured"],
reasoning_depth: Literal["S", "M", "L", "XL"] | None = None,
mode: Literal["answer", "auto", "investigate", "research"] | None = None,
structured_output_schema: type[BaseModel] | str | None = None,
structured_output_schema: type[BaseModel] | dict[str, Any] | str | None = None,
from_date: date | None = None,
to_date: date | None = None,
exclude_domains: list[str] | None = None,
Expand All @@ -376,8 +376,8 @@ async def async_research(
is used.
mode: The research mode to use. If None, the Linkup API default is used.
structured_output_schema: If output_type is "structured", specify the output schema.
Supported formats are a pydantic.BaseModel or a string representing a valid object
JSON schema.
Supported formats are a pydantic.BaseModel, a Python dictionary containing a valid
object JSON schema, or a string representing a valid object JSON schema.
from_date: The date from which the research sources should be considered. If None,
sources will not be filtered by a start date.
to_date: The date until which the research sources should be considered. If None,
Expand All @@ -391,8 +391,8 @@ async def async_research(
The created research task.

Raises:
TypeError: If structured_output_schema is not a string or pydantic.BaseModel when
provided.
TypeError: If structured_output_schema is not a string, dictionary, or
pydantic.BaseModel when provided.
LinkupInvalidRequestError: If the request parameters are invalid.
LinkupAuthenticationError: If the Linkup API key is invalid.
LinkupInsufficientCreditError: If you have run out of credit.
Expand Down Expand Up @@ -1352,7 +1352,7 @@ def _parse_search_response(
self,
response: httpx.Response,
output_type: Literal["searchResults", "sourcedAnswer", "structured"],
structured_output_schema: type[BaseModel] | str | None,
structured_output_schema: type[BaseModel] | dict[str, Any] | str | None,
include_sources: bool | None,
) -> Any: # noqa: ANN401
return self._parse_search_response_data(
Expand All @@ -1366,7 +1366,7 @@ def _parse_search_response_data(
self,
response_data: Any, # noqa: ANN401
output_type: Literal["searchResults", "sourcedAnswer", "structured"],
structured_output_schema: type[BaseModel] | str | dict[str, Any] | None,
structured_output_schema: type[BaseModel] | dict[str, Any] | str | None,
include_sources: bool | None,
) -> Any: # noqa: ANN401
if output_type == "searchResults":
Expand Down
28 changes: 28 additions & 0 deletions tests/unit/client_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,34 @@ class Company(BaseModel):
"website_url": "https://www.linkup.so/",
},
),
(
{
"query": "query",
"depth": "standard",
"output_type": "structured",
"structured_output_schema": Company.model_json_schema(),
},
{
"q": "query",
"depth": "standard",
"outputType": "structured",
"structuredOutputSchema": json.dumps(Company.model_json_schema()),
},
b"""
{
"name": "Linkup",
"founders_names": ["Philippe Mizrahi", "Denis Charrier", "Boris Toledano"],
"creation_date": "2024",
"website_url": "https://www.linkup.so/"
}
""",
{
"name": "Linkup",
"founders_names": ["Philippe Mizrahi", "Denis Charrier", "Boris Toledano"],
"creation_date": "2024",
"website_url": "https://www.linkup.so/",
},
),
(
{
"query": "query",
Expand Down
Loading