feat: include_inline_citations parameter for search

Author: cjumel

src/linkup/client.py

@@ -57,6 +57,7 @@ def search(
         include_domains: Union[list[str], None] = None,
         from_date: Union[date, None] = None,
         to_date: Union[date, None] = None,
+        include_inline_citations: bool = False,
     ) -> Any:
         """
         Search for a query in the Linkup API.
@@ -79,6 +80,8 @@ def search(
                 search results will not be filtered by date.
             to_date: The date until which the search results should be considered. If None, the
                 search results will not be filtered by date.
+            include_inline_citations: If output_type is "sourcedAnswer", indicates whether the
+                answer should include inline citations.
 
         Returns:
             The Linkup API search result. If output_type is "searchResults", the result will be a
@@ -106,6 +109,7 @@ def search(
             include_domains=include_domains,
             from_date=from_date,
             to_date=to_date,
+            include_inline_citations=include_inline_citations,
         )
 
         response: httpx.Response = self._request(
@@ -134,6 +138,7 @@ async def async_search(
         include_domains: Union[list[str], None] = None,
         from_date: Union[date, None] = None,
         to_date: Union[date, None] = None,
+        include_inline_citations: bool = False,
     ) -> Any:
         """
         Asynchronously search for a query in the Linkup API.
@@ -156,6 +161,8 @@ async def async_search(
                 search results will not be filtered by date.
             to_date: The date until which the search results should be considered. If None, the
                 search results will not be filtered by date.
+            include_inline_citations: If output_type is "sourcedAnswer", indicates whether the
+                answer should include inline citations.
 
         Returns:
             The Linkup API search result. If output_type is "searchResults", the result will be a
@@ -182,6 +189,7 @@ async def async_search(
             include_domains=include_domains,
             from_date=from_date,
             to_date=to_date,
+            include_inline_citations=include_inline_citations,
         )
 
         response: httpx.Response = await self._async_request(
@@ -316,6 +324,7 @@ def _get_search_params(
         include_domains: Union[list[str], None],
         from_date: Union[date, None],
         to_date: Union[date, None],
+        include_inline_citations: bool,
     ) -> dict[str, Union[str, bool, list[str]]]:
         structured_output_schema_param: str = ""
         if structured_output_schema is not None:
@@ -339,6 +348,7 @@ def _get_search_params(
             includeDomains=include_domains or [],
             fromDate=from_date.isoformat() if from_date is not None else "",
             toDate=to_date.isoformat() if to_date is not None else "",
+            includeInlineCitations=include_inline_citations,
         )
 
     def _validate_search_response(

tests/unit/client_test.py

@@ -44,6 +44,7 @@ class Company(BaseModel):
             "includeDomains": [],
             "fromDate": "",
             "toDate": "",
+            "includeInlineCitations": False,
         },
         b"""
         {
@@ -84,6 +85,7 @@ class Company(BaseModel):
             "to_date": date(2023, 12, 31),
             "include_domains": ["example.com", "example.org"],
             "exclude_domains": ["excluded.com"],
+            "include_inline_citations": True,
         },
         {
             "q": "A long query.",
@@ -95,6 +97,7 @@ class Company(BaseModel):
             "includeDomains": ["example.com", "example.org"],
             "fromDate": "2023-01-01",
             "toDate": "2023-12-31",
+            "includeInlineCitations": True,
         },
         b'{"results": []}',
         LinkupSearchResults(results=[]),
@@ -111,6 +114,7 @@ class Company(BaseModel):
             "includeDomains": [],
             "fromDate": "",
             "toDate": "",
+            "includeInlineCitations": False,
         },
         b"""
         {
@@ -160,6 +164,7 @@ class Company(BaseModel):
             "includeDomains": [],
             "fromDate": "",
             "toDate": "",
+            "includeInlineCitations": False,
         },
         b"""
         {
@@ -193,6 +198,7 @@ class Company(BaseModel):
             "includeDomains": [],
             "fromDate": "",
             "toDate": "",
+            "includeInlineCitations": False,
         },
         b"""
         {