fix: types and documentation improvements

src/linkup/client.py

@@ -72,8 +72,7 @@ def search(
             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.
-            include_images: If output_type is "searchResults", specifies if the response can include
-                images. Default to False.
+            include_images: Specify if the search should try and include images.
             exclude_domains: If you want to exclude specific domains from your search.
             include_domains: If you want the search to only return results from certain domains.
             from_date: The date from which the search results should be considered. If None, the
@@ -150,8 +149,7 @@ async def async_search(
             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.
-            include_images: If output_type is "searchResults", specifies if the response can include
-                images. Default to False
+            include_images: Specify if the search should try and include images.
             exclude_domains: If you want to exclude specific domains from your search.
             include_domains: If you want the search to only return results from certain domains.
             from_date: The date from which the search results should be considered. If None, the

src/linkup/types.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Literal, Union
 
 from pydantic import BaseModel
 
@@ -14,7 +14,7 @@ class LinkupSearchTextResult(BaseModel):
         content: The text of the search result.
     """
 
-    type: str
+    type: Literal["text"]
     name: str
     url: str
     content: str
@@ -30,7 +30,7 @@ class LinkupSearchImageResult(BaseModel):
         url: The URL of the image result.
     """
 
-    type: str
+    type: Literal["image"]
     name: str
     url: str
 
@@ -53,12 +53,12 @@ class LinkupSource(BaseModel):
     Attributes:
         name: The name of the source.
         url: The URL of the source.
-        snippet: The text excerpt supporting the Linkup answer.
+        snippet: The text excerpt supporting the Linkup answer. Can be empty for image sources.
     """
 
     name: str
     url: str
-    snippet: str
+    snippet: str = ""
 
 
 class LinkupSourcedAnswer(BaseModel):
@@ -71,4 +71,4 @@ class LinkupSourcedAnswer(BaseModel):
     """
 
     answer: str
-    sources: list[Union[LinkupSource, LinkupSearchTextResult, LinkupSearchImageResult]]
+    sources: list[LinkupSource]

tests/unit/client_test.py

@@ -76,19 +76,17 @@ def test_search_sourced_answer(mocker: MockerFixture, client: LinkupClient) -> N
       "sources": [
         {
           "name": "foo",
-          "url": "https://foo.bar/baz",
-          "snippet": "foo bar baz qux"
+          "url": "https://foo.com",
+          "snippet": "lorem ipsum dolor sit amet"
         },
         {
-          "type": "text",
           "name": "bar",
-          "url": "https://foo.bar/baz",
-          "content": "foo bar baz qux"
+          "url": "https://bar.com",
+          "snippet": "consectetur adipiscing elit"
         },
         {
-          "type": "image",
           "name": "baz",
-          "url": "https://foo.bar/baz"
+          "url": "https://baz.com"
         }
       ]
     }
@@ -108,19 +106,16 @@ def test_search_sourced_answer(mocker: MockerFixture, client: LinkupClient) -> N
     assert isinstance(response.sources[0], LinkupSource)
     assert response.answer == "foo bar baz"
     assert response.sources[0].name == "foo"
-    assert response.sources[0].url == "https://foo.bar/baz"
-    assert response.sources[0].snippet == "foo bar baz qux"
-    assert isinstance(response.sources[1], LinkupSearchTextResult)
-    assert response.answer == "foo bar baz"
-    assert response.sources[1].type == "text"
+    assert response.sources[0].url == "https://foo.com"
+    assert response.sources[0].snippet == "lorem ipsum dolor sit amet"
+    assert isinstance(response.sources[1], LinkupSource)
     assert response.sources[1].name == "bar"
-    assert response.sources[1].url == "https://foo.bar/baz"
-    assert response.sources[1].content == "foo bar baz qux"
-    assert isinstance(response.sources[2], LinkupSearchImageResult)
-    assert response.answer == "foo bar baz"
-    assert response.sources[2].type == "image"
+    assert response.sources[1].url == "https://bar.com"
+    assert response.sources[1].snippet == "consectetur adipiscing elit"
+    assert isinstance(response.sources[2], LinkupSource)
     assert response.sources[2].name == "baz"
-    assert response.sources[2].url == "https://foo.bar/baz"
+    assert response.sources[2].url == "https://baz.com"
+    assert response.sources[2].snippet == ""
 
 
 @pytest.mark.parametrize(
@@ -420,19 +415,17 @@ async def test_async_search_sourced_answer(mocker: MockerFixture, client: Linkup
       "sources": [
         {
           "name": "foo",
-          "url": "https://foo.bar/baz",
-          "snippet": "foo bar baz qux"
+          "url": "https://foo.com",
+          "snippet": "lorem ipsum dolor sit amet"
         },
         {
-          "type": "text",
           "name": "bar",
-          "url": "https://foo.bar/baz",
-          "content": "foo bar baz qux"
+          "url": "https://bar.com",
+          "snippet": "consectetur adipiscing elit"
         },
         {
-          "type": "image",
           "name": "baz",
-          "url": "https://foo.bar/baz"
+          "url": "https://baz.com"
         }
       ]
     }
@@ -454,19 +447,16 @@ async def test_async_search_sourced_answer(mocker: MockerFixture, client: Linkup
     assert isinstance(response.sources[0], LinkupSource)
     assert response.answer == "foo bar baz"
     assert response.sources[0].name == "foo"
-    assert response.sources[0].url == "https://foo.bar/baz"
-    assert response.sources[0].snippet == "foo bar baz qux"
-    assert isinstance(response.sources[1], LinkupSearchTextResult)
-    assert response.answer == "foo bar baz"
-    assert response.sources[1].type == "text"
+    assert response.sources[0].url == "https://foo.com"
+    assert response.sources[0].snippet == "lorem ipsum dolor sit amet"
+    assert isinstance(response.sources[1], LinkupSource)
     assert response.sources[1].name == "bar"
-    assert response.sources[1].url == "https://foo.bar/baz"
-    assert response.sources[1].content == "foo bar baz qux"
-    assert isinstance(response.sources[2], LinkupSearchImageResult)
-    assert response.answer == "foo bar baz"
-    assert response.sources[2].type == "image"
+    assert response.sources[1].url == "https://bar.com"
+    assert response.sources[1].snippet == "consectetur adipiscing elit"
+    assert isinstance(response.sources[2], LinkupSource)
     assert response.sources[2].name == "baz"
-    assert response.sources[2].url == "https://foo.bar/baz"
+    assert response.sources[2].url == "https://baz.com"
+    assert response.sources[2].snippet == ""
 
 
 @pytest.mark.asyncio