From 9e1ed17bfbfd6d1074d907268b684486bbeef8ed Mon Sep 17 00:00:00 2001 From: mogith-pn <143642606+mogith-pn@users.noreply.github.com> Date: Thu, 11 Jan 2024 09:03:10 +0530 Subject: [PATCH] Community : Modified doc strings and example notebook for Clarifai (#15816) Community : Modified doc strings and example notebook for Clarifai Description: 1. Modified doc strings inside clarifai vectorstore class and embeddings. 2. Modified notebook examples. --------- Co-authored-by: Eugene Yurtsev --- docs/docs/integrations/llms/clarifai.ipynb | 6 ++---- docs/docs/integrations/text_embedding/clarifai.ipynb | 12 ++---------- .../langchain_community/embeddings/clarifai.py | 3 ++- .../langchain_community/vectorstores/clarifai.py | 8 +++++--- 4 files changed, 11 insertions(+), 18 deletions(-) diff --git a/docs/docs/integrations/llms/clarifai.ipynb b/docs/docs/integrations/llms/clarifai.ipynb index 307e01f43b3..023bd3ac501 100644 --- a/docs/docs/integrations/llms/clarifai.ipynb +++ b/docs/docs/integrations/llms/clarifai.ipynb @@ -127,10 +127,8 @@ "Setup the user id and app id where the model resides. You can find a list of public models on https://clarifai.com/explore/models\n", "\n", "You will have to also initialize the model id and if needed, the model version id. Some models have many versions, you can choose the one appropriate for your task.\n", - "\n", - " or\n", - " \n", - "You can use the model_url (for ex: \"https://clarifai.com/anthropic/completion/models/claude-v2\") for intialization." + " \n", + "Alternatively, You can use the model_url (for ex: \"https://clarifai.com/anthropic/completion/models/claude-v2\") for intialization." ] }, { diff --git a/docs/docs/integrations/text_embedding/clarifai.ipynb b/docs/docs/integrations/text_embedding/clarifai.ipynb index fdf4e1bcdfa..ab006c48b35 100644 --- a/docs/docs/integrations/text_embedding/clarifai.ipynb +++ b/docs/docs/integrations/text_embedding/clarifai.ipynb @@ -50,20 +50,12 @@ }, { "cell_type": "code", - "execution_count": 2, + "execution_count": null, "id": "3f5dc9d7-65e3-4b5b-9086-3327d016cfe0", "metadata": { "tags": [] }, - "outputs": [ - { - "name": "stdout", - "output_type": "stream", - "text": [ - " ········\n" - ] - } - ], + "outputs": [], "source": [ "# Please login and get your API key from https://clarifai.com/settings/security\n", "from getpass import getpass\n", diff --git a/libs/community/langchain_community/embeddings/clarifai.py b/libs/community/langchain_community/embeddings/clarifai.py index 66f8116321c..f3dd4022e01 100644 --- a/libs/community/langchain_community/embeddings/clarifai.py +++ b/libs/community/langchain_community/embeddings/clarifai.py @@ -23,7 +23,8 @@ class ClarifaiEmbeddings(BaseModel, Embeddings): app_id=APP_ID, model_id=MODEL_ID) (or) - clarifai_llm = Clarifai(model_url=EXAMPLE_URL) + Example_URL = "https://clarifai.com/clarifai/main/models/BAAI-bge-base-en-v15" + clarifai = ClarifaiEmbeddings(model_url=EXAMPLE_URL) """ model_url: Optional[str] = None diff --git a/libs/community/langchain_community/vectorstores/clarifai.py b/libs/community/langchain_community/vectorstores/clarifai.py index d5c63232b78..5d8ae8c86b0 100644 --- a/libs/community/langchain_community/vectorstores/clarifai.py +++ b/libs/community/langchain_community/vectorstores/clarifai.py @@ -24,10 +24,12 @@ class Clarifai(VectorStore): .. code-block:: python from langchain_community.vectorstores import Clarifai - from langchain_community.embeddings.openai import OpenAIEmbeddings - embeddings = OpenAIEmbeddings() - vectorstore = Clarifai("langchain_store", embeddings.embed_query) + clarifai_vector_db = Clarifai( + user_id=USER_ID, + app_id=APP_ID, + number_of_docs=NUMBER_OF_DOCS, + ) """ def __init__(