From edca3e33dd1b0b711ce277d8de665db720ebb6ae Mon Sep 17 00:00:00 2001 From: Isaac Francisco <78627776+isahers1@users.noreply.github.com> Date: Wed, 5 Jun 2024 12:09:53 -0700 Subject: [PATCH] docs: deprecation of max_length parameter used in Exa search (#22567) --- docs/docs/integrations/tools/exa_search.ipynb | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/docs/integrations/tools/exa_search.ipynb b/docs/docs/integrations/tools/exa_search.ipynb index b1388a3f6fe..24a0e394957 100644 --- a/docs/docs/integrations/tools/exa_search.ipynb +++ b/docs/docs/integrations/tools/exa_search.ipynb @@ -65,6 +65,17 @@ "ExaSearchRetriever is a retriever that uses Exa Search to retrieve relevant documents." ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + ":::{.callout-note}\n", + "\n", + "The `max_characters` parameter for **TextContentsOptions** used to be called `max_length` which is now deprecated. Make sure to use `max_characters` instead.\n", + "\n", + ":::" + ] + }, { "cell_type": "code", "execution_count": 10, @@ -96,7 +107,7 @@ "\n", "# retrieve 5 documents, with content truncated at 1000 characters\n", "retriever = ExaSearchRetriever(\n", - " k=5, text_contents_options=TextContentsOptions(max_length=200)\n", + " k=5, text_contents_options=TextContentsOptions(max_characters=200)\n", ")\n", "\n", "prompt = PromptTemplate.from_template(\n",