Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docstring of query_texts and search_string #795

Merged
merged 4 commits into from
Nov 29, 2023
Merged

Improve docstring of query_texts and search_string #795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
32fb87d
Improve docstring of query_texts and search_string
thinkall Nov 28, 2023
fba21f4
Merge branch 'main' into fix_728
thinkall Nov 29, 2023
40d65b8
Update docstring
thinkall Nov 29, 2023
4390623
Update docstring
thinkall Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions autogen/agentchat/contrib/qdrant_retrieve_user_proxy_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ def retrieve_docs(self, problem: str, n_results: int = 20, search_string: str =
"""
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.")
Expand Down
4 changes: 2 additions & 2 deletions autogen/agentchat/contrib/retrieve_user_proxy_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,8 +367,8 @@ def retrieve_docs(self, problem: str, n_results: int = 20, search_string: str =

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.")
Expand Down
4 changes: 2 additions & 2 deletions autogen/retrieve_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 if
embedding_function is not None.
embedding_function (Optional, Callable): the embedding function to use. Default is None, SentenceTransformer with
Expand Down
Loading