tavily-python 0.7.14__tar.gz → 0.7.16__tar.gz

{tavily_python-0.7.14 → tavily_python-0.7.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tavily-python
-Version: 0.7.14
+Version: 0.7.16
 Summary: Python wrapper for the Tavily API
 Home-page: https://github.com/tavily-ai/tavily-python
 Author: Tavily AI
@@ -136,7 +136,7 @@ for result in response["results"]:
 # Note that URLs that could not be extracted will be stored in response["failed_results"]
 ```
 
-# Tavily Crawl (Open-Access Beta)
+# Tavily Crawl
 
 Crawl lets you traverse a website's content starting from a base URL.
 
@@ -172,7 +172,7 @@ for result in response["results"]:
 
 ```
 
-# Tavily Map (Open-Access Beta)
+# Tavily Map
 
 Map lets you discover and visualize the structure of a website starting from a base URL.
 

{tavily_python-0.7.14 → tavily_python-0.7.16}/README.md

@@ -109,7 +109,7 @@ for result in response["results"]:
 # Note that URLs that could not be extracted will be stored in response["failed_results"]
 ```
 
-# Tavily Crawl (Open-Access Beta)
+# Tavily Crawl
 
 Crawl lets you traverse a website's content starting from a base URL.
 
@@ -145,7 +145,7 @@ for result in response["results"]:
 
 ```
 
-# Tavily Map (Open-Access Beta)
+# Tavily Map
 
 Map lets you discover and visualize the structure of a website starting from a base URL.
 

{tavily_python-0.7.14 → tavily_python-0.7.16}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', 'r', encoding='utf-8') as f:
 
 setup(
     name='tavily-python',
-    version='0.7.14',
+    version='0.7.16',
     url='https://github.com/tavily-ai/tavily-python',
     author='Tavily AI',
     author_email='support@tavily.com',

{tavily_python-0.7.14 → tavily_python-0.7.16}/tavily/async_tavily.py

@@ -17,7 +17,8 @@ class AsyncTavilyClient:
     def __init__(self, api_key: Optional[str] = None,
                  company_info_tags: Sequence[str] = ("news", "general", "finance"),
                  proxies: Optional[dict[str, str]] = None,
-                 api_base_url: Optional[str] = None):
+                 api_base_url: Optional[str] = None,
+                 client_source: Optional[str] = None):
         if api_key is None:
             api_key = os.getenv("TAVILY_API_KEY")
 
@@ -44,7 +45,7 @@ class AsyncTavilyClient:
             headers={
                 "Content-Type": "application/json",
                 "Authorization": f"Bearer {api_key}",
-                "X-Client-Source": "tavily-python"
+                "X-Client-Source": client_source or "tavily-python"
             },
             base_url=self._api_base_url,
             mounts=proxy_mounts
@@ -70,6 +71,7 @@ class AsyncTavilyClient:
             country: str = None,
             auto_parameters: bool = None,
             include_favicon: bool = None,
+            include_usage: bool = None,
             **kwargs,
     ) -> dict:
         """
@@ -92,6 +94,7 @@ class AsyncTavilyClient:
             "country": country,
             "auto_parameters": auto_parameters,
             "include_favicon": include_favicon,
+            "include_usage": include_usage,
         }
 
         data = {k: v for k, v in data.items() if v is not None}
@@ -145,6 +148,7 @@ class AsyncTavilyClient:
                      country: str = None,
                      auto_parameters: bool = None,
                      include_favicon: bool = None,
+                     include_usage: bool = None,
                      **kwargs,  # Accept custom arguments
                      ) -> dict:
         """
@@ -168,6 +172,7 @@ class AsyncTavilyClient:
                                            country=country,
                                            auto_parameters=auto_parameters,
                                            include_favicon=include_favicon,
+                                           include_usage=include_usage,
                                            **kwargs,
                                            )
 
@@ -185,6 +190,9 @@ class AsyncTavilyClient:
             format: Literal["markdown", "text"] = None,
             timeout: float = 30,
             include_favicon: bool = None,
+            include_usage: bool = None,
+            query: str = None,
+            chunks_per_source: int = None,
             **kwargs
     ) -> dict:
         """
@@ -198,6 +206,9 @@ class AsyncTavilyClient:
             "format": format,
             "timeout": timeout,
             "include_favicon": include_favicon,
+            "include_usage": include_usage,
+            "query": query,
+            "chunks_per_source": chunks_per_source,
         }
 
         data = {k: v for k, v in data.items() if v is not None}
@@ -239,6 +250,9 @@ class AsyncTavilyClient:
                       format: Literal["markdown", "text"] = None,
                       timeout: float = 30,
                       include_favicon: bool = None,
+                      include_usage: bool = None,
+                      query: str = None,
+                      chunks_per_source: int = None,
                       **kwargs,  # Accept custom arguments
                       ) -> dict:
         """
@@ -251,6 +265,9 @@ class AsyncTavilyClient:
                                             format,
                                             timeout,
                                             include_favicon=include_favicon,
+                                            include_usage=include_usage,
+                                            query=query,
+                                            chunks_per_source=chunks_per_source,
                                             **kwargs,
                                             )
 
@@ -278,6 +295,8 @@ class AsyncTavilyClient:
                format: Literal["markdown", "text"] = None,
                timeout: float = 150,
                include_favicon: bool = None,
+               include_usage: bool = None,
+               chunks_per_source: int = None,
                **kwargs
                ) -> dict:
         """
@@ -299,6 +318,8 @@ class AsyncTavilyClient:
             "format": format,
             "timeout": timeout,
             "include_favicon": include_favicon,
+            "include_usage": include_usage,
+            "chunks_per_source": chunks_per_source,
         }
 
         if kwargs:
@@ -348,6 +369,8 @@ class AsyncTavilyClient:
                     format: Literal["markdown", "text"] = None,
                     timeout: float = 150,
                     include_favicon: bool = None,
+                    include_usage: bool = None,
+                    chunks_per_source: int = None,
                     **kwargs
                     ) -> dict:
         """
@@ -369,6 +392,8 @@ class AsyncTavilyClient:
                                     format=format,
                                     timeout=timeout,
                                     include_favicon=include_favicon,
+                                    include_usage=include_usage,
+                                    chunks_per_source=chunks_per_source,
                                     **kwargs)
 
         return response_dict
@@ -386,6 +411,7 @@ class AsyncTavilyClient:
                allow_external: bool = None,
                include_images: bool = None,
                timeout: float = 150,
+               include_usage: bool = None,
                **kwargs
                ) -> dict:
         """
@@ -404,6 +430,7 @@ class AsyncTavilyClient:
             "allow_external": allow_external,
             "include_images": include_images,
             "timeout": timeout,
+            "include_usage": include_usage,
         }
 
         if kwargs:
@@ -450,6 +477,7 @@ class AsyncTavilyClient:
                     allow_external: bool = None,
                     include_images: bool = None,
                     timeout: float = 150,
+                    include_usage: bool = None,
                     **kwargs
                     ) -> dict:
         """
@@ -468,6 +496,7 @@ class AsyncTavilyClient:
                                     allow_external=allow_external,
                                     include_images=include_images,
                                     timeout=timeout,
+                                    include_usage=include_usage,
                                     **kwargs)
 
         return response_dict

{tavily_python-0.7.14 → tavily_python-0.7.16}/tavily/errors.py

@@ -1,25 +1,30 @@
-from typing import List, Dict, Any, Optional
-
 class UsageLimitExceededError(Exception):
     def __init__(self, message: str):
         super().__init__(message)
 
+
 class BadRequestError(Exception):
     def __init__(self, message: str):
         super().__init__(message)
 
+
 class ForbiddenError(Exception):
     def __init__(self, message: str):
         super().__init__(message)
 
+
 class InvalidAPIKeyError(Exception):
     def __init__(self, message: str):
         super().__init__(message)
 
+
 class TimeoutError(Exception):
     def __init__(self, timeout: float):
         super().__init__(f"Request timed out after {timeout} seconds.")
 
+
 class MissingAPIKeyError(Exception):
     def __init__(self):
-        super().__init__("No API key provided. Please provide the api_key attribute or set the TAVILY_API_KEY environment variable.")
+        super().__init__(
+            "No API key provided. Please provide the api_key attribute or set the TAVILY_API_KEY environment variable."
+        )

{tavily_python-0.7.14 → tavily_python-0.7.16}/tavily/tavily.py

@@ -1,7 +1,7 @@
 import requests
 import json
-import warnings
 import os
+import warnings
 from typing import Literal, Sequence, Optional, List, Union, Generator
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from .utils import get_max_items_from_list
@@ -12,7 +12,7 @@ class TavilyClient:
     Tavily API client class.
     """
 
-    def __init__(self, api_key: Optional[str] = None, proxies: Optional[dict[str, str]] = None, api_base_url: Optional[str] = None):
+    def __init__(self, api_key: Optional[str] = None, proxies: Optional[dict[str, str]] = None, api_base_url: Optional[str] = None, client_source: Optional[str] = None):
         if api_key is None:
             api_key = os.getenv("TAVILY_API_KEY")
 
@@ -32,7 +32,7 @@ class TavilyClient:
         self.headers = {
             "Content-Type": "application/json",
             "Authorization": f"Bearer {self.api_key}",
-            "X-Client-Source": "tavily-python"
+            "X-Client-Source": client_source or "tavily-python"
         }
 
     def _search(self,
@@ -53,6 +53,7 @@ class TavilyClient:
                 country: str = None,
                 auto_parameters: bool = None,
                 include_favicon: bool = None,
+                include_usage: bool = None,
                 **kwargs
                 ) -> dict:
         """
@@ -76,6 +77,7 @@ class TavilyClient:
             "country": country,
             "auto_parameters": auto_parameters,
             "include_favicon": include_favicon,
+            "include_usage": include_usage,
         }
 
         data = {k: v for k, v in data.items() if v is not None}
@@ -130,6 +132,7 @@ class TavilyClient:
                country: str = None,
                auto_parameters: bool = None,
                include_favicon: bool = None,
+               include_usage: bool = None,
                **kwargs,  # Accept custom arguments
                ) -> dict:
         """
@@ -153,6 +156,7 @@ class TavilyClient:
                                      country=country,
                                      auto_parameters=auto_parameters,
                                      include_favicon=include_favicon,
+                                     include_usage=include_usage,
                                      **kwargs,
                                      )
 
@@ -169,6 +173,9 @@ class TavilyClient:
                  format: Literal["markdown", "text"] = None,
                  timeout: float = 30,
                  include_favicon: bool = None,
+                 include_usage: bool = None,
+                 query: str = None,
+                 chunks_per_source: int = None,
                  **kwargs
                  ) -> dict:
         """
@@ -181,6 +188,9 @@ class TavilyClient:
             "format": format,
             "timeout": timeout,
             "include_favicon": include_favicon,
+            "include_usage": include_usage,
+            "query": query,
+            "chunks_per_source": chunks_per_source,
         }
 
         data = {k: v for k, v in data.items() if v is not None}
@@ -220,6 +230,9 @@ class TavilyClient:
                 format: Literal["markdown", "text"] = None,
                 timeout: float = 30,
                 include_favicon: bool = None,
+                include_usage: bool = None,
+                query: str = None,
+                chunks_per_source: int = None,
                 **kwargs,  # Accept custom arguments
                 ) -> dict:
         """
@@ -231,6 +244,9 @@ class TavilyClient:
                                       format,
                                       timeout,
                                       include_favicon=include_favicon,
+                                      include_usage=include_usage,
+                                      query=query,
+                                      chunks_per_source=chunks_per_source,
                                       **kwargs)
 
         tavily_results = response_dict.get("results", [])
@@ -257,6 +273,8 @@ class TavilyClient:
             format: Literal["markdown", "text"] = None,
             timeout: float = 150,
             include_favicon: bool = None,
+            include_usage: bool = None,
+            chunks_per_source: int = None,
             **kwargs
             ) -> dict:
         """
@@ -279,6 +297,8 @@ class TavilyClient:
             "format": format,
             "timeout": timeout,
             "include_favicon": include_favicon,
+            "include_usage": include_usage,
+            "chunks_per_source": chunks_per_source,
         }
 
         if kwargs:
@@ -328,6 +348,8 @@ class TavilyClient:
               format: Literal["markdown", "text"] = None,
               timeout: float = 150,
               include_favicon: bool = None,
+              include_usage: bool = None,
+              chunks_per_source: int = None,
               **kwargs
               ) -> dict:
         """
@@ -349,6 +371,8 @@ class TavilyClient:
                                     format=format,
                                     timeout=timeout,
                                     include_favicon=include_favicon,
+                                    include_usage=include_usage,
+                                    chunks_per_source=chunks_per_source,
                                     **kwargs)
 
         return response_dict
@@ -366,6 +390,7 @@ class TavilyClient:
             allow_external: bool = None,
             include_images: bool = None,
             timeout: float = 150,
+            include_usage: bool = None,
             **kwargs
             ) -> dict:
         """
@@ -384,6 +409,7 @@ class TavilyClient:
             "allow_external": allow_external,
             "include_images": include_images,
             "timeout": timeout,
+            "include_usage": include_usage,
         }
 
         if kwargs:
@@ -430,6 +456,7 @@ class TavilyClient:
               allow_external: bool = None,
               include_images: bool = None,
               timeout: float = 150,
+              include_usage: bool = None,
               **kwargs
               ) -> dict:
         """
@@ -448,6 +475,7 @@ class TavilyClient:
                                     allow_external=allow_external,
                                     include_images=include_images,
                                     timeout=timeout,
+                                    include_usage=include_usage,
                                     **kwargs)
 
         return response_dict
@@ -474,6 +502,8 @@ class TavilyClient:
 
         Returns a string of JSON containing the search context up to context limit.
         """
+        warnings.warn("get_search_context is deprecated and will be removed in future versions.",
+                      DeprecationWarning, stacklevel=2)
 
         response_dict = self._search(query,
                                      search_depth=search_depth,
@@ -511,6 +541,8 @@ class TavilyClient:
         """
         Q&A search method. Search depth is advanced by default to get the best answer.
         """
+        warnings.warn("qna_search is deprecated and will be removed in future versions.",
+                      DeprecationWarning, stacklevel=2)
         response_dict = self._search(query,
                                      search_depth=search_depth,
                                      topic=topic,
@@ -537,6 +569,8 @@ class TavilyClient:
                          country: str = None,
                          ) -> Sequence[dict]:
         """ Company information search method. Search depth is advanced by default to get the best answer. """
+        warnings.warn("get_company_info is deprecated and will be removed in future versions.",
+                      DeprecationWarning, stacklevel=2)
         def _perform_search(topic):
             return self._search(query,
                                 search_depth=search_depth,

{tavily_python-0.7.14 → tavily_python-0.7.16}/tavily/utils.py

@@ -12,17 +12,6 @@ def get_total_tokens_from_string(string: str, encoding_name: str = DEFAULT_MODEL
     tokens = encoding.encode(string)
     return len(tokens)
 
-
-def get_max_tokens_from_string(string: str, max_tokens: int, encoding_name: str = DEFAULT_MODEL_ENCODING) -> str:
-    """
-        Extract max tokens from string using the specified encoding (based on openai compute)
-    """
-    encoding = tiktoken.encoding_for_model(encoding_name)
-    tokens = encoding.encode(string)
-    token_bytes = [encoding.decode_single_token_bytes(token) for token in tokens[:max_tokens]]
-    return b"".join(token_bytes).decode()
-
-
 def get_max_items_from_list(data: Sequence[dict], max_tokens: int = DEFAULT_MAX_TOKENS) -> List[Dict[str,str]]:
     """
         Get max items from list of items based on defined max tokens (based on openai compute)

{tavily_python-0.7.14 → tavily_python-0.7.16}/tavily_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tavily-python
-Version: 0.7.14
+Version: 0.7.16
 Summary: Python wrapper for the Tavily API
 Home-page: https://github.com/tavily-ai/tavily-python
 Author: Tavily AI
@@ -136,7 +136,7 @@ for result in response["results"]:
 # Note that URLs that could not be extracted will be stored in response["failed_results"]
 ```
 
-# Tavily Crawl (Open-Access Beta)
+# Tavily Crawl
 
 Crawl lets you traverse a website's content starting from a base URL.
 
@@ -172,7 +172,7 @@ for result in response["results"]:
 
 ```
 
-# Tavily Map (Open-Access Beta)
+# Tavily Map
 
 Map lets you discover and visualize the structure of a website starting from a base URL.