Address PR comments

Author: BruceWouaigne

linkup/client.py

@@ -50,7 +50,7 @@ def search(
         depth: Literal["standard", "deep"],
         output_type: Literal["searchResults", "sourcedAnswer", "structured"],
         structured_output_schema: Union[Type[BaseModel], str, None] = None,
-        include_images: Union[bool, None] = None,
+        include_images: bool = False,
     ) -> Any:
         """
         Search for a query in the Linkup API.
@@ -67,7 +67,7 @@ def search(
                 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.
+                images. Default to False.
 
         Returns:
             The Linkup API search result. If output_type is "searchResults", the result will be a
@@ -114,7 +114,7 @@ async def async_search(
         depth: Literal["standard", "deep"],
         output_type: Literal["searchResults", "sourcedAnswer", "structured"],
         structured_output_schema: Union[Type[BaseModel], str, None] = None,
-        include_images: Union[bool, None] = None,
+        include_images: bool = False,
     ) -> Any:
         """
         Asynchronously search for a query in the Linkup API.
@@ -131,7 +131,7 @@ async def async_search(
                 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.
+                images. Default to False
 
         Returns:
             The Linkup API search result. If output_type is "searchResults", the result will be a
@@ -247,12 +247,13 @@ def _get_search_params(
         depth: Literal["standard", "deep"],
         output_type: Literal["searchResults", "sourcedAnswer", "structured"],
         structured_output_schema: Union[Type[BaseModel], str, None],
-        include_images: Union[bool, None] = None,
+        include_images: bool,
     ) -> Dict[str, Union[str, bool]]:
         params: Dict[str, Union[str, bool]] = dict(
             q=query,
             depth=depth,
             outputType=output_type,
+            includeImages=include_images,
         )
 
         if output_type == "structured" and structured_output_schema is not None:
@@ -266,9 +267,6 @@ def _get_search_params(
                     f"Unexpected structured_output_schema type: '{type(structured_output_schema)}'"
                 )
 
-        if include_images:
-            params["includeImages"] = True
-
         return params
 
     def _validate_search_response(

linkup/types.py

@@ -8,6 +8,7 @@ class LinkupSearchTextResult(BaseModel):
     A text result from a Linkup search.
 
     Attributes:
+        type: The type of the search result, in this case 'text'
         name: The name of the search result.
         url: The URL of the search result.
         content: The text of the search result.
@@ -24,6 +25,7 @@ class LinkupSearchImageResult(BaseModel):
     An image result from a Linkup search.
 
     Attributes:
+        type: The type of the search result, in this case 'image'
         name: The name of the image result.
         url: The URL of the image result.
     """