A programming framework for agentic AI
Improve docstring of query_texts and search_string (#795)
Li Jiang3c2a38ec0608
diff --git a/autogen/agentchat/contrib/qdrant_retrieve_user_proxy_agent.py b/autogen/agentchat/contrib/qdrant_retrieve_user_proxy_agent.pyindex 619befdef..88a2d318a 100644--- a/autogen/agentchat/contrib/qdrant_retrieve_user_proxy_agent.py+++ b/autogen/agentchat/contrib/qdrant_retrieve_user_proxy_agent.py@@ -100,8 +100,8 @@ class QdrantRetrieveUserProxyAgent(RetrieveUserProxyAgent):"""Args:problem (str): the problem to be solved.- n_results (int): the number of results to be retrieved.- search_string (str): only docs containing this string will be retrieved.+ n_results (int): the number of results to be retrieved. Default is 20.+ search_string (str): only docs that contain an exact match of this string will be retrieved. Default is ""."""if not self._collection:print("Trying to create collection.")diff --git a/autogen/agentchat/contrib/retrieve_user_proxy_agent.py b/autogen/agentchat/contrib/retrieve_user_proxy_agent.pyindex 5edc13f24..777ac1f87 100644--- a/autogen/agentchat/contrib/retrieve_user_proxy_agent.py+++ b/autogen/agentchat/contrib/retrieve_user_proxy_agent.py@@ -367,8 +367,8 @@ class RetrieveUserProxyAgent(UserProxyAgent):Args:problem (str): the problem to be solved.- n_results (int): the number of results to be retrieved.- search_string (str): only docs containing this string will be retrieved.+ n_results (int): the number of results to be retrieved. Default is 20.+ search_string (str): only docs that contain an exact match of this string will be retrieved. Default is ""."""if not self._collection or not self._get_or_create:print("Trying to create collection.")diff --git a/autogen/retrieve_utils.py b/autogen/retrieve_utils.pyindex ba856e3b2..6f423b307 100644--- a/autogen/retrieve_utils.py+++ b/autogen/retrieve_utils.py@@ -335,12 +335,12 @@ def query_vector_db(and query function.Args:- query_texts (List[str]): the query texts.+ query_texts (List[str]): the list of strings which will be used to query the vector db.n_results (Optional, int): the number of results to return. Default is 10.client (Optional, API): the chromadb compatible client. Default is None, a chromadb client will be used.db_path (Optional, str): the path to the vector db. Default is "/tmp/chromadb.db".collection_name (Optional, str): the name of the collection. Default is "all-my-documents".- search_string (Optional, str): the search string. Default is "".+ search_string (Optional, str): the search string. Only docs that contain an exact match of this string will be retrieved. Default is "".embedding_model (Optional, str): the embedding model to use. Default is "all-MiniLM-L6-v2". Will be ignored ifembedding_function is not None.embedding_function (Optional, Callable): the embedding function to use. Default is None, SentenceTransformer with