The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
docs: fixed nimble's provider page and retriever (#29695)
Yoav Levyaf3f75907352
diff --git a/docs/docs/integrations/providers/nimble.ipynb b/docs/docs/integrations/providers/nimble.ipynbindex e19dce9340..a140fb1e98 100644--- a/docs/docs/integrations/providers/nimble.ipynb+++ b/docs/docs/integrations/providers/nimble.ipynb@@ -27,18 +27,12 @@"If you'd like to learn more about Nimble, visit us at [nimbleway.com](https://www.nimbleway.com/).\n","\n","\n",- "## Currently we expose the following components\n",- "\n",- "* **Retriever** - Allow us to query the internet and get parsed textual results utilizing several search engines.\n",- "\n",- "\n"+ "## Retrievers:"]},{"cell_type": "markdown",- "source": [- "## Usage"- ],+ "source": "### NimbleSearchRetriever","metadata": {"id": "AuMFgVFrKbNH"},@@ -47,7 +41,9 @@{"cell_type": "markdown","source": [- "In order to use our provider you have to provide an API key like so"+ "Enables developers to build RAG applications and AI Agents that can search, access, and retrieve online information from anywhere on the web.\n",+ "\n",+ "We need to install the `langchain-nimble` python package."],"metadata": {"id": "sFlPjZX9KdK6"@@ -55,25 +51,32 @@"id": "sFlPjZX9KdK6"},{+ "metadata": {},"cell_type": "code",- "source": [- "import getpass\n",- "import os\n",- "\n",- "os.environ[\"NIMBLE_API_KEY\"] = getpass.getpass()"- ],- "metadata": {- "id": "eAqSHZ-Z8R3F"- },- "id": "eAqSHZ-Z8R3F",+ "outputs": [],"execution_count": null,- "outputs": []+ "source": "%pip install -U langchain-nimble",+ "id": "65f237c852aa3885"+ },+ {+ "metadata": {},+ "cell_type": "markdown",+ "source": "See a [usage example](/docs/integrations/retrievers/nimble/).",+ "id": "77bd7b9a6a8e381b"},{+ "metadata": {},"cell_type": "markdown","source": [- "For more information about the Authentication process, see [Nimble APIs Authentication Documentation](https://docs.nimbleway.com/nimble-sdk/web-api/nimble-web-api-quick-start-guide/nimble-apis-authentication)."+ "```python\n",+ "from langchain_nimble import NimbeSearchRetriever\n",+ "```"],+ "id": "511f9d569c21a5d2"+ },+ {+ "cell_type": "markdown",+ "source": "Note that authentication is required, please refer to the [Setup section in the documentation](/docs/integrations/retrievers/nimble/#setup).","metadata": {"id": "WfwnI_RS8PO5"},diff --git a/docs/docs/integrations/retrievers/nimble.ipynb b/docs/docs/integrations/retrievers/nimble.ipynbindex fda1cbb119..af3203b721 100644--- a/docs/docs/integrations/retrievers/nimble.ipynb+++ b/docs/docs/integrations/retrievers/nimble.ipynb@@ -27,7 +27,7 @@" It has two modes:\n","\n","* **Search & Retrieve**: Execute a search query, get the top result URLs, and retrieve the text from those URLs.\n",- "* **Retrieve**: Provide a list of URLs, and retrieve the text/data from those URLs\n",+ "* **Retrieve**: Provide a list of URLs, and retrieve the text/data from those URLs.\n","\n","\n","If you'd like to learn more about the underlying Nimble APIs, visit the [documentation here](https://docs.nimbleway.com/nimble-sdk/web-api/web-api-overview).\n",@@ -39,17 +39,11 @@"\n","For more information about available plans, see our [Pricing page.](https://www.nimbleway.com/pricing)\n","\n",- "Once you have registered, you'll receive your API credentials, which you can use to generate the authentication credential string by Base64 encoding them in the following fashion:\n",+ "Once you have registered, you will need to enter the \"Nimble API\" pipeline in the [\"Pipelines\" page](https://app.nimbleway.com/pipelines) which will provide you with your API credentials (as a base64 token) that you will use to authenticate your retriever:\n","\n",- "```\n",- "base64(username:password)\n",- "```\n",+ "\n","\n",- "You can set your credential string as an environment variable so `NimbleSearchRetriever` will capture it automatically without having to pass it each time inline.\n",- "\n",- "`NimbleSearchRetriever`.\n",- "\n",- "\n"+ "Now, you can set your credential string as an environment variable so `NimbleSearchRetriever` will capture it automatically without having to pass it each time inline.\n"]},{@@ -105,7 +99,7 @@"source": ["### Installation\n","\n",- "This retriever lives in the `langchain-community` package."+ "The retriever is part of langchain providers which is included in the langchain-nimble package available on pypi."]},{@@ -118,7 +112,7 @@},"outputId": "d4d68bd0-6b7d-450b-9861-8d92172ca727"},- "source": "%pip install -U langchain-nimble langchain_openai",+ "source": "%pip install -U langchain-nimble langchain-openai","outputs": [],"execution_count": null},@@ -172,7 +166,6 @@"* `api_key` (optional) string - Nimble's API key, can be sent directly when instantiating the retriever or with the environment variable (`NIMBLE_API_KEY`)\n","* `search_engine` (optional) string - The search engine your query will be executed through, you can choose from\n"," * `google_search` (default value) - Google's search engine\n",- " * `google_sge` - Google’s search generative experience (read more [here](https://www.nimbleway.com/blog/google-sge))\n"," * `bing_search` - Bing's search engine\n"," * `yandex_search` - Yandex search engine\n","* `render` (optional) boolean - Enables or disables Javascript rendering on the target page (if enabled the results might return more slowly)\n",@@ -194,9 +187,7 @@},{"cell_type": "markdown",- "source": [- "### Example of Search & Retrieve Mode with a search query string\n"- ],+ "source": "### Example of search & retrieve mode with a search query string\n","metadata": {"id": "e7FHmVL-rprU"},