From 31c3082740f7dbf34f6c8e6908850bf6b9cf249c Mon Sep 17 00:00:00 2001 From: Lorenze Jay Date: Mon, 21 Oct 2024 14:29:11 -0700 Subject: [PATCH] fixed docs --- docs/concepts/memory.mdx | 66 +++++++++++++++++++++++++++++++++------- 1 file changed, 55 insertions(+), 11 deletions(-) diff --git a/docs/concepts/memory.mdx b/docs/concepts/memory.mdx index b07096442..8aa213dfd 100644 --- a/docs/concepts/memory.mdx +++ b/docs/concepts/memory.mdx @@ -105,9 +105,48 @@ my_crew = Crew( process=Process.sequential, memory=True, verbose=True, - embedder=embedding_functions.OpenAIEmbeddingFunction( - api_key=os.getenv("OPENAI_API_KEY"), model_name="text-embedding-3-small" - ) + embedder={ + "provider": "openai", + "config": { + "model": 'text-embedding-3-small' + } + } +) +``` +Alternatively, you can directly pass the OpenAIEmbeddingFunction to the embedder parameter. + +Example: +```python Code +from crewai import Crew, Agent, Task, Process +from chromadb.utils.embedding_functions.openai_embedding_function import OpenAIEmbeddingFunction + +my_crew = Crew( + agents=[...], + tasks=[...], + process=Process.sequential, + memory=True, + verbose=True, + embedder=OpenAIEmbeddingFunction(api_key=os.getenv("OPENAI_API_KEY"), model_name="text-embedding-3-small"), +) +``` + +### Using Ollama embeddings + +```python Code +from crewai import Crew, Agent, Task, Process + +my_crew = Crew( + agents=[...], + tasks=[...], + process=Process.sequential, + memory=True, + verbose=True, + embedder={ + "provider": "ollama", + "config": { + "model": "mxbai-embed-large" + } + } ) ``` @@ -122,10 +161,12 @@ my_crew = Crew( process=Process.sequential, memory=True, verbose=True, - embedder=embedding_functions.OpenAIEmbeddingFunction( - api_key=os.getenv("OPENAI_API_KEY"), - model_name="text-embedding-ada-002" - ) + embedder={ + "provider": "google", + "config": { + api_key="YOUR_API_KEY" + } + } ) ``` @@ -181,10 +222,13 @@ my_crew = Crew( process=Process.sequential, memory=True, verbose=True, - embedder=embedding_functions.CohereEmbeddingFunction( - api_key=YOUR_API_KEY, - model_name="" - ) + embedder={ + "provider": "cohere", + "config": { + "api_key": "YOUR_API_KEY", + "model_name": "" + } + } ) ```