From b9087e765d73900f1184a41900aa6820b1936f5b Mon Sep 17 00:00:00 2001 From: Brace Sproul Date: Wed, 6 Dec 2023 09:44:54 -0800 Subject: [PATCH] docs[patch]: Fix broken link 'tip' in docs (#14349) --- .../cookbook/prompt_size.ipynb | 10 ++++++-- .../how_to/message_history.ipynb | 10 ++++++-- .../agent_types/openai_assistants.ipynb | 5 +++- .../chains/foundational/llm_chain.ipynb | 6 ++++- .../foundational/sequential_chains.ipynb | 6 ++++- .../chains/foundational/transformation.ipynb | 6 ++++- .../data_connection/retrievers/index.ipynb | 2 ++ .../retrievers/self_query.ipynb | 2 ++ docs/docs/modules/model_io/chat/index.ipynb | 2 ++ docs/docs/modules/model_io/llms/index.ipynb | 2 ++ .../use_cases/question_answering/index.ipynb | 25 +++++++++++++++---- 11 files changed, 63 insertions(+), 13 deletions(-) diff --git a/docs/docs/expression_language/cookbook/prompt_size.ipynb b/docs/docs/expression_language/cookbook/prompt_size.ipynb index b03a5a93e5..2ee6945c88 100644 --- a/docs/docs/expression_language/cookbook/prompt_size.ipynb +++ b/docs/docs/expression_language/cookbook/prompt_size.ipynb @@ -209,7 +209,10 @@ "id": "637f994a-5134-402a-bcf0-4de3911eaf49", "metadata": {}, "source": [ - ":::tip [LangSmith trace](https://smith.langchain.com/public/60909eae-f4f1-43eb-9f96-354f5176f66f/r)\n", + ":::tip\n", + "\n", + "[LangSmith trace](https://smith.langchain.com/public/60909eae-f4f1-43eb-9f96-354f5176f66f/r)\n", + "\n", ":::" ] }, @@ -374,7 +377,10 @@ "id": "5a7e498b-dc68-4267-a35c-90ceffa91c46", "metadata": {}, "source": [ - ":::tip [LangSmith trace](https://smith.langchain.com/public/3b27d47f-e4df-4afb-81b1-0f88b80ca97e/r)\n", + ":::tip\n", + "\n", + "[LangSmith trace](https://smith.langchain.com/public/3b27d47f-e4df-4afb-81b1-0f88b80ca97e/r)\n", + "\n", ":::" ] } diff --git a/docs/docs/expression_language/how_to/message_history.ipynb b/docs/docs/expression_language/how_to/message_history.ipynb index 4a9218b328..77991cb66b 100644 --- a/docs/docs/expression_language/how_to/message_history.ipynb +++ b/docs/docs/expression_language/how_to/message_history.ipynb @@ -251,7 +251,10 @@ "id": "da3d1feb-b4bb-4624-961c-7db2e1180df7", "metadata": {}, "source": [ - ":::tip [Langsmith trace](https://smith.langchain.com/public/863a003b-7ca8-4b24-be9e-d63ec13c106e/r)\n", + ":::tip\n", + "\n", + "[Langsmith trace](https://smith.langchain.com/public/863a003b-7ca8-4b24-be9e-d63ec13c106e/r)\n", + "\n", ":::" ] }, @@ -334,7 +337,10 @@ "id": "b898d1b1-11e6-4d30-a8dd-cc5e45533611", "metadata": {}, "source": [ - ":::tip [LangSmith trace](https://smith.langchain.com/public/f6c3e1d1-a49d-4955-a9fa-c6519df74fa7/r)\n", + ":::tip\n", + "\n", + "[LangSmith trace](https://smith.langchain.com/public/f6c3e1d1-a49d-4955-a9fa-c6519df74fa7/r)\n", + "\n", ":::" ] }, diff --git a/docs/docs/modules/agents/agent_types/openai_assistants.ipynb b/docs/docs/modules/agents/agent_types/openai_assistants.ipynb index 152d41f90a..0fb83ff6b0 100644 --- a/docs/docs/modules/agents/agent_types/openai_assistants.ipynb +++ b/docs/docs/modules/agents/agent_types/openai_assistants.ipynb @@ -153,7 +153,10 @@ "id": "db6b9cbf-dd54-4346-be6c-842e08756ccc", "metadata": {}, "source": [ - ":::tip [LangSmith trace](https://smith.langchain.com/public/6750972b-0849-4beb-a8bb-353d424ffade/r)\n", + ":::tip\n", + "\n", + "[LangSmith trace](https://smith.langchain.com/public/6750972b-0849-4beb-a8bb-353d424ffade/r)\n", + "\n", ":::" ] }, diff --git a/docs/docs/modules/chains/foundational/llm_chain.ipynb b/docs/docs/modules/chains/foundational/llm_chain.ipynb index 94a335aa92..8eeddacff4 100644 --- a/docs/docs/modules/chains/foundational/llm_chain.ipynb +++ b/docs/docs/modules/chains/foundational/llm_chain.ipynb @@ -66,7 +66,11 @@ "source": [ "## [Legacy] LLMChain\n", "\n", - ":::note This is a legacy class, using LCEL as shown above is preffered.\n", + ":::note\n", + "\n", + "This is a legacy class, using LCEL as shown above is preferred.\n", + "\n", + ":::\n", "\n", "An `LLMChain` is a simple chain that adds some functionality around language models. It is used widely throughout LangChain, including in other chains and agents.\n", "\n", diff --git a/docs/docs/modules/chains/foundational/sequential_chains.ipynb b/docs/docs/modules/chains/foundational/sequential_chains.ipynb index 304f73c215..09ff795615 100644 --- a/docs/docs/modules/chains/foundational/sequential_chains.ipynb +++ b/docs/docs/modules/chains/foundational/sequential_chains.ipynb @@ -130,7 +130,11 @@ "source": [ "## [Legacy] SequentialChain\n", "\n", - ":::note This is a legacy class, using LCEL as shown above is preffered.\n", + ":::note\n", + "\n", + "This is a legacy class, using LCEL as shown above is preferred.\n", + "\n", + ":::\n", "\n", "Sequential chains allow you to connect multiple chains and compose them into pipelines that execute some specific scenario. There are two types of sequential chains:\n", "\n", diff --git a/docs/docs/modules/chains/foundational/transformation.ipynb b/docs/docs/modules/chains/foundational/transformation.ipynb index 5435cfb6ac..10d36a53d5 100644 --- a/docs/docs/modules/chains/foundational/transformation.ipynb +++ b/docs/docs/modules/chains/foundational/transformation.ipynb @@ -88,7 +88,11 @@ "source": [ "## [Legacy] TransformationChain\n", "\n", - ":::note This is a legacy class, using LCEL as shown above is preffered.\n", + ":::note\n", + "\n", + "This is a legacy class, using LCEL as shown above is preferred.\n", + "\n", + ":::\n", "\n", "This notebook showcases using a generic transformation chain." ] diff --git a/docs/docs/modules/data_connection/retrievers/index.ipynb b/docs/docs/modules/data_connection/retrievers/index.ipynb index 0d40ea7290..1f407fa9ce 100644 --- a/docs/docs/modules/data_connection/retrievers/index.ipynb +++ b/docs/docs/modules/data_connection/retrievers/index.ipynb @@ -17,7 +17,9 @@ "metadata": {}, "source": [ ":::info\n", + "\n", "Head to [Integrations](/docs/integrations/retrievers/) for documentation on built-in retriever integrations with 3rd-party tools.\n", + "\n", ":::\n", "\n", "A retriever is an interface that returns documents given an unstructured query. It is more general than a vector store.\n", diff --git a/docs/docs/modules/data_connection/retrievers/self_query.ipynb b/docs/docs/modules/data_connection/retrievers/self_query.ipynb index fcee4a9784..1b9828436b 100644 --- a/docs/docs/modules/data_connection/retrievers/self_query.ipynb +++ b/docs/docs/modules/data_connection/retrievers/self_query.ipynb @@ -8,7 +8,9 @@ "# Self-querying\n", "\n", ":::info\n", + "\n", "Head to [Integrations](/docs/integrations/retrievers/self_query) for documentation on vector stores with built-in support for self-querying.\n", + "\n", ":::\n", "\n", "A self-querying retriever is one that, as the name suggests, has the ability to query itself. Specifically, given any natural language query, the retriever uses a query-constructing LLM chain to write a structured query and then applies that structured query to its underlying VectorStore. This allows the retriever to not only use the user-input query for semantic similarity comparison with the contents of stored documents but to also extract filters from the user query on the metadata of stored documents and to execute those filters.\n", diff --git a/docs/docs/modules/model_io/chat/index.ipynb b/docs/docs/modules/model_io/chat/index.ipynb index 74e826ae91..2d0f1b617e 100644 --- a/docs/docs/modules/model_io/chat/index.ipynb +++ b/docs/docs/modules/model_io/chat/index.ipynb @@ -17,7 +17,9 @@ "metadata": {}, "source": [ ":::info\n", + "\n", "Head to [Integrations](/docs/integrations/chat/) for documentation on built-in integrations with chat model providers.\n", + "\n", ":::\n", "\n", "Chat models are a variation on language models.\n", diff --git a/docs/docs/modules/model_io/llms/index.ipynb b/docs/docs/modules/model_io/llms/index.ipynb index 64c9449e3e..3fcfb182e4 100644 --- a/docs/docs/modules/model_io/llms/index.ipynb +++ b/docs/docs/modules/model_io/llms/index.ipynb @@ -17,7 +17,9 @@ "metadata": {}, "source": [ ":::info\n", + "\n", "Head to [Integrations](/docs/integrations/llms/) for documentation on built-in integrations with LLM providers.\n", + "\n", ":::\n", "\n", "Large Language Models (LLMs) are a core component of LangChain.\n", diff --git a/docs/docs/use_cases/question_answering/index.ipynb b/docs/docs/use_cases/question_answering/index.ipynb index 8e5fbe2a2c..4bfc6b91c3 100644 --- a/docs/docs/use_cases/question_answering/index.ipynb +++ b/docs/docs/use_cases/question_answering/index.ipynb @@ -243,7 +243,10 @@ "id": "639dc31a-7f16-40f6-ba2a-20e7c2ecfe60", "metadata": {}, "source": [ - ":::tip Check out the [LangSmith trace](https://smith.langchain.com/public/1c6ca97e-445b-4d00-84b4-c7befcbc59fe/r) \n", + ":::tip\n", + "\n", + "Check out the [LangSmith trace](https://smith.langchain.com/public/1c6ca97e-445b-4d00-84b4-c7befcbc59fe/r) \n", + "\n", ":::" ] }, @@ -723,7 +726,10 @@ "id": "2c000e5f-2b7f-4eb9-8876-9f4b186b4a08", "metadata": {}, "source": [ - ":::tip Check out the [LangSmith trace](https://smith.langchain.com/public/1799e8db-8a6d-4eb2-84d5-46e8d7d5a99b/r) \n", + ":::tip\n", + "\n", + "Check out the [LangSmith trace](https://smith.langchain.com/public/1799e8db-8a6d-4eb2-84d5-46e8d7d5a99b/r) \n", + "\n", ":::" ] }, @@ -800,7 +806,10 @@ "id": "94b952e6-dc4b-415b-9cf3-1ad333e48366", "metadata": {}, "source": [ - ":::tip Check out the [LangSmith trace](https://smith.langchain.com/public/da23c4d8-3b33-47fd-84df-a3a582eedf84/r) \n", + ":::tip\n", + "\n", + "Check out the [LangSmith trace](https://smith.langchain.com/public/da23c4d8-3b33-47fd-84df-a3a582eedf84/r) \n", + "\n", ":::" ] }, @@ -872,7 +881,10 @@ "id": "b437da5d-ca09-4d15-9be2-c35e5a1ace77", "metadata": {}, "source": [ - ":::tip Check out the [LangSmith trace](https://smith.langchain.com/public/007d7e01-cb62-4a84-8b71-b24767f953ee/r)\n", + ":::tip\n", + "\n", + "Check out the [LangSmith trace](https://smith.langchain.com/public/007d7e01-cb62-4a84-8b71-b24767f953ee/r)\n", + "\n", ":::" ] }, @@ -1050,7 +1062,10 @@ "id": "53263a65-4de2-4dd8-9291-6a8169ab6f1d", "metadata": {}, "source": [ - ":::tip Check out the [LangSmith trace](https://smith.langchain.com/public/b3001782-bb30-476a-886b-12da17ec258f/r) \n", + ":::tip\n", + "\n", + "Check out the [LangSmith trace](https://smith.langchain.com/public/b3001782-bb30-476a-886b-12da17ec258f/r) \n", + "\n", ":::" ] },