diff --git a/docs/docs/integrations/platforms/google.mdx b/docs/docs/integrations/platforms/google.mdx index 03a8b4a10fb..350ff563bae 100644 --- a/docs/docs/integrations/platforms/google.mdx +++ b/docs/docs/integrations/platforms/google.mdx @@ -486,23 +486,6 @@ from langchain.agents.agent_toolkits import GmailToolkit ``` -### Google Drive - -This toolkit uses the `Google Drive API`. - -We need to install several python packages. - -```bash -pip install google-api-python-client google-auth-httplib2 google-auth-oauthlib -``` - -See a [usage example and authorization instructions](/docs/integrations/toolkits/google_drive). - -```python -from langchain_googledrive.utilities.google_drive import GoogleDriveAPIWrapper -from langchain_googledrive.tools.google_drive.tool import GoogleDriveSearchTool -``` - ## Chat Loaders ### GMail diff --git a/docs/docs/integrations/toolkits/google_drive.ipynb b/docs/docs/integrations/toolkits/google_drive.ipynb deleted file mode 100644 index 9832af659c3..00000000000 --- a/docs/docs/integrations/toolkits/google_drive.ipynb +++ /dev/null @@ -1,218 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# Google Drive tool\n", - "\n", - "This notebook walks through connecting a LangChain to the Google Drive API.\n", - "\n", - "## Prerequisites\n", - "\n", - "1. Create a Google Cloud project or use an existing project\n", - "1. Enable the [Google Drive API](https://console.cloud.google.com/flows/enableapi?apiid=drive.googleapis.com)\n", - "1. [Authorize credentials for desktop app](https://developers.google.com/drive/api/quickstart/python#authorize_credentials_for_a_desktop_application)\n", - "1. `pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib`\n", - "\n", - "## Instructions for retrieving your Google Docs data\n", - "By default, the `GoogleDriveTools` and `GoogleDriveWrapper` expects the `credentials.json` file to be `~/.credentials/credentials.json`, but this is configurable using the `GOOGLE_ACCOUNT_FILE` environment variable. \n", - "The location of `token.json` use the same directory (or use the parameter `token_path`). Note that `token.json` will be created automatically the first time you use the tool.\n", - "\n", - "`GoogleDriveSearchTool` can retrieve a selection of files with some requests. \n", - "\n", - "By default, If you use a `folder_id`, all the files inside this folder can be retrieved to `Document`, if the name match the query.\n" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "#!pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "You can obtain your folder and document id from the URL:\n", - "\n", - "* Folder: https://drive.google.com/drive/u/0/folders/1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5 -> folder id is `\"1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5\"`\n", - "* Document: https://docs.google.com/document/d/1bfaMQ18_i56204VaQDVeAFpqEijJTgvurupdEDiaUQw/edit -> document id is `\"1bfaMQ18_i56204VaQDVeAFpqEijJTgvurupdEDiaUQw\"`\n", - "\n", - "The special value `root` is for your personal home." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "folder_id = \"root\"\n", - "# folder_id='1yucgL9WGgWZdM1TOuKkeghlPizuzMYb5'" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "By default, all files with these mime-type can be converted to `Document`.\n", - "- text/text\n", - "- text/plain\n", - "- text/html\n", - "- text/csv\n", - "- text/markdown\n", - "- image/png\n", - "- image/jpeg\n", - "- application/epub+zip\n", - "- application/pdf\n", - "- application/rtf\n", - "- application/vnd.google-apps.document (GDoc)\n", - "- application/vnd.google-apps.presentation (GSlide)\n", - "- application/vnd.google-apps.spreadsheet (GSheet)\n", - "- application/vnd.google.colaboratory (Notebook colab)\n", - "- application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX)\n", - "- application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)\n", - "\n", - "It's possible to update or customize this. See the documentation of `GoogleDriveAPIWrapper`.\n", - "\n", - "But, the corresponding packages must installed." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "#!pip install unstructured" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": { - "tags": [] - }, - "outputs": [], - "source": [ - "from langchain_googledrive.tools.google_drive.tool import GoogleDriveSearchTool\n", - "from langchain_googledrive.utilities.google_drive import GoogleDriveAPIWrapper\n", - "\n", - "# By default, search only in the filename.\n", - "tool = GoogleDriveSearchTool(\n", - " api_wrapper=GoogleDriveAPIWrapper(\n", - " folder_id=folder_id,\n", - " num_results=2,\n", - " template=\"gdrive-query-in-folder\", # Search in the body of documents\n", - " )\n", - ")" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "import logging\n", - "\n", - "logging.basicConfig(level=logging.INFO)" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "tool.run(\"machine learning\")" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "tool.description" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "from langchain.agents import load_tools\n", - "\n", - "tools = load_tools(\n", - " [\"google-drive-search\"],\n", - " folder_id=folder_id,\n", - " template=\"gdrive-query-in-folder\",\n", - ")" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## Use within an Agent" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": { - "tags": [] - }, - "outputs": [], - "source": [ - "from langchain.agents import AgentType, initialize_agent\n", - "from langchain.llms import OpenAI\n", - "\n", - "llm = OpenAI(temperature=0)\n", - "agent = initialize_agent(\n", - " tools=tools,\n", - " llm=llm,\n", - " agent=AgentType.STRUCTURED_CHAT_ZERO_SHOT_REACT_DESCRIPTION,\n", - ")" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": { - "tags": [] - }, - "outputs": [], - "source": [ - "agent.run(\"Search in google drive, who is 'Yann LeCun' ?\")" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.10.9" - } - }, - "nbformat": 4, - "nbformat_minor": 4 -} diff --git a/docs/vercel.json b/docs/vercel.json index ee9f02ad1ad..a12ad16193f 100644 --- a/docs/vercel.json +++ b/docs/vercel.json @@ -1,5 +1,9 @@ { "redirects": [ + { + "source": "/docs/integrations/toolkits/google_drive", + "destination": "/docs/integrations/tools/google_drive" + }, { "source": "/docs/use_cases/question_answering/analyze_document", "destination": "/cookbook"