From 57c668cd9630be7b8a10fddd2e9956bb24846d95 Mon Sep 17 00:00:00 2001 From: Erick Friis Date: Wed, 30 Oct 2024 20:27:01 -0700 Subject: [PATCH 1/3] docs: throw on broken anchors --- docs/docusaurus.config.js | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 305b14df135ac..fc00559683ac9 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -26,6 +26,7 @@ const config = { trailingSlash: true, onBrokenLinks: "throw", onBrokenMarkdownLinks: "throw", + onBrokenAnchors: "throw", themes: ["@docusaurus/theme-mermaid"], markdown: { From 896b0aba87f0625af4465887b5502fcbbe468490 Mon Sep 17 00:00:00 2001 From: Eugene Yurtsev Date: Wed, 13 Nov 2024 13:21:05 -0500 Subject: [PATCH 2/3] updates --- docs/docs/concepts/runnables.mdx | 1 + docs/docs/how_to/structured_output.ipynb | 6 +++--- docs/docs/integrations/chat/cloudflare_workersai.ipynb | 2 +- .../document_loaders/google_cloud_sql_mssql.ipynb | 6 +++--- .../document_loaders/google_cloud_sql_mysql.ipynb | 4 ++-- docs/docs/integrations/providers/astradb.mdx | 4 ++-- 6 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/docs/concepts/runnables.mdx b/docs/docs/concepts/runnables.mdx index 961942c67d92f..683e08a47a456 100644 --- a/docs/docs/concepts/runnables.mdx +++ b/docs/docs/concepts/runnables.mdx @@ -315,6 +315,7 @@ the `RunnableConfig` manually to sub-calls in some cases. Please see the [Propagating RunnableConfig](#propagation-of-runnableconfig) section for more information. ::: + ## Creating a runnable from a function You may need to create a custom Runnable that runs arbitrary logic. This is especially diff --git a/docs/docs/how_to/structured_output.ipynb b/docs/docs/how_to/structured_output.ipynb index e1d6f2b68e82e..4e8880f61166a 100644 --- a/docs/docs/how_to/structured_output.ipynb +++ b/docs/docs/how_to/structured_output.ipynb @@ -913,9 +913,9 @@ ], "metadata": { "kernelspec": { - "display_name": "poetry-venv-2", + "display_name": "Python 3 (ipykernel)", "language": "python", - "name": "poetry-venv-2" + "name": "python3" }, "language_info": { "codemirror_mode": { @@ -927,7 +927,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.11.9" + "version": "3.11.4" } }, "nbformat": 4, diff --git a/docs/docs/integrations/chat/cloudflare_workersai.ipynb b/docs/docs/integrations/chat/cloudflare_workersai.ipynb index df7c2a1cb667b..571cf32282fb8 100644 --- a/docs/docs/integrations/chat/cloudflare_workersai.ipynb +++ b/docs/docs/integrations/chat/cloudflare_workersai.ipynb @@ -17,7 +17,7 @@ "source": [ "# ChatCloudflareWorkersAI\n", "\n", - "This will help you getting started with CloudflareWorkersAI [chat models](/docs/concepts/#chat-models). For detailed documentation of all available Cloudflare WorkersAI models head to the [API reference](https://developers.cloudflare.com/workers-ai/).\n", + "This will help you getting started with CloudflareWorkersAI [chat models](/docs/concepts/chat_models). For detailed documentation of all available Cloudflare WorkersAI models head to the [API reference](https://developers.cloudflare.com/workers-ai/).\n", "\n", "\n", "## Overview\n", diff --git a/docs/docs/integrations/document_loaders/google_cloud_sql_mssql.ipynb b/docs/docs/integrations/document_loaders/google_cloud_sql_mssql.ipynb index 1dd568c85c7ea..42ac2892cb6d4 100644 --- a/docs/docs/integrations/document_loaders/google_cloud_sql_mssql.ipynb +++ b/docs/docs/integrations/document_loaders/google_cloud_sql_mssql.ipynb @@ -34,7 +34,7 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 1, "metadata": {}, "outputs": [], "source": [ @@ -328,7 +328,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "The view generated from SQL query can have different schema than default table. In such cases, the behavior of MSSQLLoader is the same as loading from table with non-default schema. Please refer to section [Load documents with customized document page content & metadata](#Load-documents-with-customized-document-page-content-&-metadata)." + "The view generated from SQL query can have different schema than default table. In such cases, the behavior of MSSQLLoader is the same as loading from table with non-default schema. Please refer to section [Load documents with customized document page content & metadata](#load-documents-with-customized-document-page-content--metadata)." ] }, { @@ -633,7 +633,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.11.6" + "version": "3.11.4" } }, "nbformat": 4, diff --git a/docs/docs/integrations/document_loaders/google_cloud_sql_mysql.ipynb b/docs/docs/integrations/document_loaders/google_cloud_sql_mysql.ipynb index d656b8642f47e..5743fdedc543a 100644 --- a/docs/docs/integrations/document_loaders/google_cloud_sql_mysql.ipynb +++ b/docs/docs/integrations/document_loaders/google_cloud_sql_mysql.ipynb @@ -317,7 +317,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "The view generated from SQL query can have different schema than default table. In such cases, the behavior of MySQLLoader is the same as loading from table with non-default schema. Please refer to section [Load documents with customized document page content & metadata](#Load-documents-with-customized-document-page-content-&-metadata)." + "The view generated from SQL query can have different schema than default table. In such cases, the behavior of MySQLLoader is the same as loading from table with non-default schema. Please refer to section [Load documents with customized document page content & metadata](#load-documents-with-customized-document-page-content--metadata)." ] }, { @@ -619,7 +619,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.11.6" + "version": "3.11.4" } }, "nbformat": 4, diff --git a/docs/docs/integrations/providers/astradb.mdx b/docs/docs/integrations/providers/astradb.mdx index d545d1ea02625..853eafcc8ff5d 100644 --- a/docs/docs/integrations/providers/astradb.mdx +++ b/docs/docs/integrations/providers/astradb.mdx @@ -133,7 +133,7 @@ store = AstraDBStore( ) ``` -Learn more in the [example notebook](/docs/integrations/stores/astradb#astradbstore). +See the API Reference for the [AstraDBStore](https://python.langchain.com/api_reference/astradb/storage/langchain_astradb.storage.AstraDBStore.html). ## Byte Store @@ -147,4 +147,4 @@ store = AstraDBByteStore( ) ``` -Learn more in the [example notebook](/docs/integrations/stores/astradb#astradbbytestore). +See the API reference for the [AstraDBByteStore](https://python.langchain.com/api_reference/astradb/storage/langchain_astradb.storage.AstraDBByteStore.html). From 8b73ac272dcf7d4685a1726abe50393d432e6883 Mon Sep 17 00:00:00 2001 From: Eugene Yurtsev Date: Wed, 13 Nov 2024 14:15:31 -0500 Subject: [PATCH 3/3] x --- docs/docs/concepts/runnables.mdx | 3 +- docs/docs/integrations/providers/nvidia.mdx | 2 +- .../integrations/providers/unstructured.mdx | 2 +- .../integrations/tools/google_books.ipynb | 4 +-- docs/docs/integrations/tools/zapier.ipynb | 34 +++++++++---------- 5 files changed, 22 insertions(+), 23 deletions(-) diff --git a/docs/docs/concepts/runnables.mdx b/docs/docs/concepts/runnables.mdx index 683e08a47a456..f586adcebbe1d 100644 --- a/docs/docs/concepts/runnables.mdx +++ b/docs/docs/concepts/runnables.mdx @@ -315,8 +315,7 @@ the `RunnableConfig` manually to sub-calls in some cases. Please see the [Propagating RunnableConfig](#propagation-of-runnableconfig) section for more information. ::: - -## Creating a runnable from a function +## Creating a runnable from a function {#custom-runnables} You may need to create a custom Runnable that runs arbitrary logic. This is especially useful if using [LangChain Expression Language (LCEL)](/docs/concepts/lcel) to compose diff --git a/docs/docs/integrations/providers/nvidia.mdx b/docs/docs/integrations/providers/nvidia.mdx index 0f02b3522367e..2dc6bf2f43837 100644 --- a/docs/docs/integrations/providers/nvidia.mdx +++ b/docs/docs/integrations/providers/nvidia.mdx @@ -51,7 +51,7 @@ result = llm.invoke("Write a ballad about LangChain.") print(result.content) ``` -Using the API, you can query live endpoints available on the NVIDIA API Catalog to get quick results from a DGX-hosted cloud compute environment. All models are source-accessible and can be deployed on your own compute cluster using NVIDIA NIM which is part of NVIDIA AI Enterprise, shown in the next section [Working with NVIDIA NIMs](##working-with-nvidia-nims). +Using the API, you can query live endpoints available on the NVIDIA API Catalog to get quick results from a DGX-hosted cloud compute environment. All models are source-accessible and can be deployed on your own compute cluster using NVIDIA NIM which is part of NVIDIA AI Enterprise, shown in the next section [Working with NVIDIA NIMs](#working-with-nvidia-nims). ## Working with NVIDIA NIMs When ready to deploy, you can self-host models with NVIDIA NIM—which is included with the NVIDIA AI Enterprise software license—and run them anywhere, giving you ownership of your customizations and full control of your intellectual property (IP) and AI applications. diff --git a/docs/docs/integrations/providers/unstructured.mdx b/docs/docs/integrations/providers/unstructured.mdx index 33510cf5e4803..312a28d6f6815 100644 --- a/docs/docs/integrations/providers/unstructured.mdx +++ b/docs/docs/integrations/providers/unstructured.mdx @@ -164,7 +164,7 @@ from langchain_community.document_loaders import UnstructuredOrgModeLoader ### UnstructuredPDFLoader -See a [usage example](/docs/how_to/document_loader_pdf#using-unstructured). +See a [usage example](/docs/how_to/document_loader_pdf/#layout-analysis-and-extraction-of-text-from-images). ```python from langchain_community.document_loaders import UnstructuredPDFLoader diff --git a/docs/docs/integrations/tools/google_books.ipynb b/docs/docs/integrations/tools/google_books.ipynb index 57446c435f638..0954a1f15067c 100644 --- a/docs/docs/integrations/tools/google_books.ipynb +++ b/docs/docs/integrations/tools/google_books.ipynb @@ -139,7 +139,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### [Invoke directly with args](/docs/concepts/#invoke-with-just-the-arguments)\n", + "### [Invoke directly with args](/docs/concepts/tools)\n", "\n", "See below for an direct invocation example." ] @@ -165,7 +165,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### [Invoke with ToolCall](/docs/concepts/#invoke-with-toolcall)\n", + "### [Invoke with ToolCall](/docs/concepts/tools)\n", "\n", "See below for a tool call example." ] diff --git a/docs/docs/integrations/tools/zapier.ipynb b/docs/docs/integrations/tools/zapier.ipynb index a6deab263082e..3c73d1f15ac11 100644 --- a/docs/docs/integrations/tools/zapier.ipynb +++ b/docs/docs/integrations/tools/zapier.ipynb @@ -110,19 +110,19 @@ "text": [ "\n", "\n", - "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n", - "\u001b[32;1m\u001b[1;3m I need to find the email and summarize it.\n", + "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n", + "\u001B[32;1m\u001B[1;3m I need to find the email and summarize it.\n", "Action: Gmail: Find Email\n", - "Action Input: Find the latest email from Silicon Valley Bank\u001b[0m\n", - "Observation: \u001b[31;1m\u001b[1;3m{\"from__name\": \"Silicon Valley Bridge Bank, N.A.\", \"from__email\": \"sreply@svb.com\", \"body_plain\": \"Dear Clients, After chaotic, tumultuous & stressful days, we have clarity on path for SVB, FDIC is fully insuring all deposits & have an ask for clients & partners as we rebuild. Tim Mayopoulos Finished chain.\u001b[0m\n" + "\u001B[1m> Finished chain.\u001B[0m\n" ] }, { @@ -286,18 +286,18 @@ "text": [ "\n", "\n", - "\u001b[1m> Entering new SimpleSequentialChain chain...\u001b[0m\n", - "\u001b[36;1m\u001b[1;3m{\"from__name\": \"Silicon Valley Bridge Bank, N.A.\", \"from__email\": \"sreply@svb.com\", \"body_plain\": \"Dear Clients, After chaotic, tumultuous & stressful days, we have clarity on path for SVB, FDIC is fully insuring all deposits & have an ask for clients & partners as we rebuild. Tim Mayopoulos Entering new SimpleSequentialChain chain...\u001B[0m\n", + "\u001B[36;1m\u001B[1;3m{\"from__name\": \"Silicon Valley Bridge Bank, N.A.\", \"from__email\": \"sreply@svb.com\", \"body_plain\": \"Dear Clients, After chaotic, tumultuous & stressful days, we have clarity on path for SVB, FDIC is fully insuring all deposits & have an ask for clients & partners as we rebuild. Tim Mayopoulos Finished chain.\u001b[0m\n" + "\u001B[1m> Finished chain.\u001B[0m\n" ] }, { @@ -325,7 +325,7 @@ "id": "09ff954e-45f2-4595-92ea-91627abde4a0", "metadata": {}, "source": [ - "## Example Using OAuth Access Token\n", + "## Example Using OAuth Access Token{#oauth}\n", "The below snippet shows how to initialize the wrapper with a procured OAuth access token. Note the argument being passed in as opposed to setting an environment variable. Review the [authentication docs](https://nla.zapier.com/docs/authentication/#oauth-credentials) for full user-facing oauth developer support.\n", "\n", "The developer is tasked with handling the OAuth handshaking to procure and refresh the access token."