tavily-python 0.3.6__tar.gz → 0.3.8__tar.gz

{tavily_python-0.3.6/tavily_python.egg-info → tavily_python-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tavily-python
-Version: 0.3.6
+Version: 0.3.8
 Summary: Python wrapper for the Tavily API
 Home-page: https://github.com/tavily-ai/tavily-python
 Author: Tavily AI
@@ -89,18 +89,18 @@ Once you do so, you're ready to search the Web in one line of code! All you need
 ### Methods
 * **`search`**(query, **kwargs)
   * Performs a Tavily Search query and returns the response as a well-structured `dict`.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `include_answer`, `include_raw_content`, `include_images`, `use_cache`. 
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `include_answer`, `include_raw_content`, `include_images`. 
   * **Returns** a `dict` with all related response fields. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `dict`. The details of the exact response format are given in the Search Responses section further down.
   
 * **`get_search_context`**(query, **kwargs)
   * Performs a Tavily Search query and returns a `str` of content and sources within the provided token limit. It's useful for getting only related content from retrieved websites without having to deal with context extraction and token management.
   * The **core parameter** for this function is `max_tokens`, an `int`. It defaults to `4000`. It is provided as a keyword argument.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `use_cache`.
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`.
   * **Returns** a `str` containing the content and sources of the results. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `str`.
 
 * **`qna_search`**(query, **kwargs)
   * Performs a search and returns a string containing an answer to the original query. This is optimal to be used as a tool for AI agents.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth` (defaults to `"advanced"`), `topic`, `max_results`, `include_domains`, `exclude_domains`, `use_cache`, 
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth` (defaults to `"advanced"`), `topic`, `max_results`, `include_domains`, `exclude_domains`. 
   * **Returns** a `str` containing a short answer to the search query. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `str`.
 
 ### Keyword Arguments (optional)
@@ -121,8 +121,6 @@ Once you do so, you're ready to search the Web in one line of code! All you need
 
 * **`exclude_domains`: list[str]** -  A list of domains to specifically exclude from the search results. Default is `None`, which doesn't exclude any domains. Please note that this feature is only available when using the `"general"` search `topic`.
 
-* **`use_cache`: bool** -  Use the cached web search results. Default is `True`. If `False` is passed, a new web search will be done before generating your search results.
-
 ### Search Responses
 
 * **`answer`: str**- The answer to your search query. This will be `None` unless `include_answer` is set to `True`.

{tavily_python-0.3.6 → tavily_python-0.3.8}/README.md

@@ -72,18 +72,18 @@ Once you do so, you're ready to search the Web in one line of code! All you need
 ### Methods
 * **`search`**(query, **kwargs)
   * Performs a Tavily Search query and returns the response as a well-structured `dict`.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `include_answer`, `include_raw_content`, `include_images`, `use_cache`. 
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `include_answer`, `include_raw_content`, `include_images`. 
   * **Returns** a `dict` with all related response fields. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `dict`. The details of the exact response format are given in the Search Responses section further down.
   
 * **`get_search_context`**(query, **kwargs)
   * Performs a Tavily Search query and returns a `str` of content and sources within the provided token limit. It's useful for getting only related content from retrieved websites without having to deal with context extraction and token management.
   * The **core parameter** for this function is `max_tokens`, an `int`. It defaults to `4000`. It is provided as a keyword argument.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `use_cache`.
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`.
   * **Returns** a `str` containing the content and sources of the results. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `str`.
 
 * **`qna_search`**(query, **kwargs)
   * Performs a search and returns a string containing an answer to the original query. This is optimal to be used as a tool for AI agents.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth` (defaults to `"advanced"`), `topic`, `max_results`, `include_domains`, `exclude_domains`, `use_cache`, 
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth` (defaults to `"advanced"`), `topic`, `max_results`, `include_domains`, `exclude_domains`. 
   * **Returns** a `str` containing a short answer to the search query. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `str`.
 
 ### Keyword Arguments (optional)
@@ -104,8 +104,6 @@ Once you do so, you're ready to search the Web in one line of code! All you need
 
 * **`exclude_domains`: list[str]** -  A list of domains to specifically exclude from the search results. Default is `None`, which doesn't exclude any domains. Please note that this feature is only available when using the `"general"` search `topic`.
 
-* **`use_cache`: bool** -  Use the cached web search results. Default is `True`. If `False` is passed, a new web search will be done before generating your search results.
-
 ### Search Responses
 
 * **`answer`: str**- The answer to your search query. This will be `None` unless `include_answer` is set to `True`.

{tavily_python-0.3.6 → tavily_python-0.3.8}/setup.py

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

{tavily_python-0.3.6 → tavily_python-0.3.8}/tavily/__init__.py

@@ -1,3 +1,4 @@
 from .async_tavily import AsyncTavilyClient
 from .tavily import Client, TavilyClient
-from .errors import InvalidAPIKeyError, UsageLimitExceededError, MissingAPIKeyError
+from .errors import InvalidAPIKeyError, UsageLimitExceededError, MissingAPIKeyError
+from .hybrid_rag import TavilyHybridClient

tavily_python-0.3.8/tavily/hybrid_rag/__init__.py

@@ -0,0 +1 @@
+from .hybrid_rag import TavilyHybridClient

tavily_python-0.3.6/tavily/hybrid_search/hybrid_search.py → tavily_python-0.3.8/tavily/hybrid_rag/hybrid_rag.py

@@ -1,14 +1,14 @@
-'''
-WARNING
-Tavily Hybrid Search, as it is currently known internally, is a work-in-progress feature and may change in the future.
-Use at your own risk.
-'''
-
 import os
+from typing import Union, Optional, Literal
+
+from pymongo.collection import Collection
 from tavily import TavilyClient
-import cohere
 
-co = cohere.Client(os.getenv("COHERE_API_KEY"))
+try:
+    import cohere
+    co = cohere.Client()
+except:
+    co = None
 
 def _validate_index(client):
     """
@@ -68,8 +68,31 @@ def _cohere_rerank(query, documents, top_n):
     ]
 
 class TavilyHybridClient():
-    def __init__(self, api_key, db_provider, collection, index, embeddings_field='embeddings',
-                 content_field='content'):
+    def __init__(
+            self,
+            api_key: Union[str, None],
+            db_provider: Literal['mongodb'],
+            collection: Collection,
+            index: str,
+            embeddings_field: str = 'embeddings',
+            content_field: str = 'content',
+            embedding_function: Optional[callable] = None,
+            ranking_function: Optional[callable] = None
+        ):
+        '''
+        A client for performing hybrid RAG using both the Tavily API and a local database collection.
+        
+        Parameters:
+        api_key (str): The Tavily API key. If this is set to None, it will be loaded from the environment variable TAVILY_API_KEY.
+        db_provider (str): The database provider. Currently only 'mongodb' is supported.
+        collection (str): The name of the collection in the database that will be used for local search.
+        index (str): The name of the collection's vector search index.
+        embeddings_field (str): The name of the field in the collection that contains the embeddings.
+        content_field (str): The name of the field in the collection that contains the content.
+        embedding_function (callable): If provided, this function will be used to generate embeddings for the search query and documents.
+        ranking_function (callable): If provided, this function will be used to rerank the combined results.
+        '''
+        
         self.tavily = TavilyClient(api_key)
         
         if db_provider != 'mongodb':
@@ -79,8 +102,9 @@ class TavilyHybridClient():
         self.index = index
         self.embeddings_field = embeddings_field
         self.content_field = content_field
-        self.embedding_function = _cohere_embed
-        self.ranking_function = _cohere_rerank
+        
+        self.embedding_function = _cohere_embed if embedding_function is None else embedding_function
+        self.ranking_function = _cohere_rerank if ranking_function is None else ranking_function
         
         _validate_index(self)
 
@@ -124,7 +148,8 @@ class TavilyHybridClient():
                     "content": f"${self.content_field}",
                     "score": {
                         "$meta": "vectorSearchScore"
-                    }
+                    },
+                    "origin": "local"
                 }
             }
         ]))
@@ -139,7 +164,8 @@ class TavilyHybridClient():
         projected_foreign_results = [
             {
                 'content': result['content'],
-                'score': result['score']
+                'score': result['score'],
+                'origin': 'foreign'
             }
             for result in foreign_results
         ]

{tavily_python-0.3.6 → tavily_python-0.3.8/tavily_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tavily-python
-Version: 0.3.6
+Version: 0.3.8
 Summary: Python wrapper for the Tavily API
 Home-page: https://github.com/tavily-ai/tavily-python
 Author: Tavily AI
@@ -89,18 +89,18 @@ Once you do so, you're ready to search the Web in one line of code! All you need
 ### Methods
 * **`search`**(query, **kwargs)
   * Performs a Tavily Search query and returns the response as a well-structured `dict`.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `include_answer`, `include_raw_content`, `include_images`, `use_cache`. 
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `include_answer`, `include_raw_content`, `include_images`. 
   * **Returns** a `dict` with all related response fields. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `dict`. The details of the exact response format are given in the Search Responses section further down.
   
 * **`get_search_context`**(query, **kwargs)
   * Performs a Tavily Search query and returns a `str` of content and sources within the provided token limit. It's useful for getting only related content from retrieved websites without having to deal with context extraction and token management.
   * The **core parameter** for this function is `max_tokens`, an `int`. It defaults to `4000`. It is provided as a keyword argument.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`, `use_cache`.
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth`, `topic`, `max_results`, `include_domains`, `exclude_domains`.
   * **Returns** a `str` containing the content and sources of the results. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `str`.
 
 * **`qna_search`**(query, **kwargs)
   * Performs a search and returns a string containing an answer to the original query. This is optimal to be used as a tool for AI agents.
-  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth` (defaults to `"advanced"`), `topic`, `max_results`, `include_domains`, `exclude_domains`, `use_cache`, 
+  * **Additional parameters** can be provided as keyword arguments (detailed below). The keyword arguments supported by this method are: `search_depth` (defaults to `"advanced"`), `topic`, `max_results`, `include_domains`, `exclude_domains`. 
   * **Returns** a `str` containing a short answer to the search query. If you decide to use the asynchronous client, returns a `coroutine` resolving to that `str`.
 
 ### Keyword Arguments (optional)
@@ -121,8 +121,6 @@ Once you do so, you're ready to search the Web in one line of code! All you need
 
 * **`exclude_domains`: list[str]** -  A list of domains to specifically exclude from the search results. Default is `None`, which doesn't exclude any domains. Please note that this feature is only available when using the `"general"` search `topic`.
 
-* **`use_cache`: bool** -  Use the cached web search results. Default is `True`. If `False` is passed, a new web search will be done before generating your search results.
-
 ### Search Responses
 
 * **`answer`: str**- The answer to your search query. This will be `None` unless `include_answer` is set to `True`.

{tavily_python-0.3.6 → tavily_python-0.3.8}/tavily_python.egg-info/SOURCES.txt

@@ -8,8 +8,8 @@ tavily/config.py
 tavily/errors.py
 tavily/tavily.py
 tavily/utils.py
-tavily/hybrid_search/__init__.py
-tavily/hybrid_search/hybrid_search.py
+tavily/hybrid_rag/__init__.py
+tavily/hybrid_rag/hybrid_rag.py
 tavily_python.egg-info/PKG-INFO
 tavily_python.egg-info/SOURCES.txt
 tavily_python.egg-info/dependency_links.txt

tavily_python-0.3.6/tavily/hybrid_search/__init__.py

@@ -1 +0,0 @@
-from .hybrid_search import TavilyHybridClient