Skip to content

Commit bd735d0

Browse files
authored
Fix docstring (microsoft#3172)
1 parent 0cdbc34 commit bd735d0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

autogen/agentchat/contrib/retrieve_user_proxy_agent.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ def __init__(
136136
- `client` (Optional, chromadb.Client) - the chromadb client. If key not provided, a
137137
default client `chromadb.Client()` will be used. If you want to use other
138138
vector db, extend this class and override the `retrieve_docs` function.
139-
**Deprecated**: use `vector_db` instead.
139+
*[Deprecated]* use `vector_db` instead.
140140
- `docs_path` (Optional, Union[str, List[str]]) - the path to the docs directory. It
141141
can also be the path to a single file, the url to a single file or a list
142142
of directories, files and urls. Default is None, which works only if the
@@ -150,7 +150,7 @@ def __init__(
150150
By default, "extra_docs" is set to false, starting document IDs from zero.
151151
This poses a risk as new documents might overwrite existing ones, potentially
152152
causing unintended loss or alteration of data in the collection.
153-
**Deprecated**: use `new_docs` when use `vector_db` instead of `client`.
153+
*[Deprecated]* use `new_docs` when use `vector_db` instead of `client`.
154154
- `new_docs` (Optional, bool) - when True, only adds new documents to the collection;
155155
when False, updates existing documents and adds new ones. Default is True.
156156
Document id is used to determine if a document is new or existing. By default, the
@@ -173,7 +173,7 @@ def __init__(
173173
models can be found at `https://www.sbert.net/docs/pretrained_models.html`.
174174
The default model is a fast model. If you want to use a high performance model,
175175
`all-mpnet-base-v2` is recommended.
176-
**Deprecated**: no need when use `vector_db` instead of `client`.
176+
*[Deprecated]* no need when use `vector_db` instead of `client`.
177177
- `embedding_function` (Optional, Callable) - the embedding function for creating the
178178
vector db. Default is None, SentenceTransformer with the given `embedding_model`
179179
will be used. If you want to use OpenAI, Cohere, HuggingFace or other embedding
@@ -220,7 +220,7 @@ def __init__(
220220
221221
Example of overriding retrieve_docs - If you have set up a customized vector db, and it's
222222
not compatible with chromadb, you can easily plug in it with below code.
223-
**Deprecated**: Use `vector_db` instead. You can extend VectorDB and pass it to the agent.
223+
*[Deprecated]* use `vector_db` instead. You can extend VectorDB and pass it to the agent.
224224
```python
225225
class MyRetrieveUserProxyAgent(RetrieveUserProxyAgent):
226226
def query_vector_db(

0 commit comments

Comments
 (0)