diff --git a/docs/core_docs/docs/how_to/example_selectors.ipynb b/docs/core_docs/docs/how_to/example_selectors.ipynb index 3c2a88841b7a..67b63d131a27 100644 --- a/docs/core_docs/docs/how_to/example_selectors.ipynb +++ b/docs/core_docs/docs/how_to/example_selectors.ipynb @@ -17,16 +17,14 @@ "source": [ "# How to use example selectors\n", "\n", - "```{=mdx}\n", - "import PrerequisiteLinks from \"@theme/PrerequisiteLinks\";\n", + ":::info Prerequisites\n", + "\n", + "This guide assumes familiarity with the following concepts:\n", "\n", - "\n", - "```\n", + "\n", + ":::\n", "\n", "If you have a large number of examples, you may need to select which ones to include in the prompt. The Example Selector is the class responsible for doing so.\n", "\n", diff --git a/docs/core_docs/docs/how_to/example_selectors_length_based.mdx b/docs/core_docs/docs/how_to/example_selectors_length_based.mdx index f7dbac989018..b1b7323f661a 100644 --- a/docs/core_docs/docs/how_to/example_selectors_length_based.mdx +++ b/docs/core_docs/docs/how_to/example_selectors_length_based.mdx @@ -1,15 +1,13 @@ # How to select examples by length -```{=mdx} -import PrerequisiteLinks from "@theme/PrerequisiteLinks"; +:::info Prerequisites + +This guide assumes familiarity with the following concepts: - -``` + +::: This example selector selects which examples to use based on length. This is useful when you are worried about constructing a prompt that will go over the length of the context window. diff --git a/docs/core_docs/docs/how_to/example_selectors_similarity.mdx b/docs/core_docs/docs/how_to/example_selectors_similarity.mdx index 1dc2c090614c..06eeb65f9c0b 100644 --- a/docs/core_docs/docs/how_to/example_selectors_similarity.mdx +++ b/docs/core_docs/docs/how_to/example_selectors_similarity.mdx @@ -1,16 +1,14 @@ # How to select examples by similarity -```{=mdx} -import PrerequisiteLinks from "@theme/PrerequisiteLinks"; +:::info Prerequisites + +This guide assumes familiarity with the following concepts: - -``` + +::: This object selects examples based on similarity to the inputs. It does this by finding the examples with the embeddings that have the greatest cosine similarity with the inputs. diff --git a/docs/core_docs/docs/how_to/few_shot_examples.ipynb b/docs/core_docs/docs/how_to/few_shot_examples.ipynb index 73caf674410b..5e7814f1de10 100644 --- a/docs/core_docs/docs/how_to/few_shot_examples.ipynb +++ b/docs/core_docs/docs/how_to/few_shot_examples.ipynb @@ -23,16 +23,16 @@ "\n", "This guide will cover few-shotting with string prompt templates. For a guide on few-shotting with chat messages for chat models, see [here](/docs/how_to/few_shot_examples_chat/).\n", "\n", - "```{=mdx}\n", - "import PrerequisiteLinks from \"@theme/PrerequisiteLinks\";\n", + ":::info Prerequisites\n", + "\n", + "This guide assumes familiarity with the following concepts:\n", "\n", - "\n", - "```\n", + "\n", + ":::\n", "\n", "## Create a formatter for the few-shot examples\n", "\n", diff --git a/docs/core_docs/docs/how_to/few_shot_examples_chat.ipynb b/docs/core_docs/docs/how_to/few_shot_examples_chat.ipynb index 4a71f3a6aa27..fffb3d7eb4c1 100644 --- a/docs/core_docs/docs/how_to/few_shot_examples_chat.ipynb +++ b/docs/core_docs/docs/how_to/few_shot_examples_chat.ipynb @@ -25,16 +25,16 @@ "\n", "**Note:** The following code examples are for chat models only, since `FewShotChatMessagePromptTemplates` are designed to output formatted [chat messages](/docs/concepts/#message-types) rather than pure strings. For similar few-shot prompt examples for pure string templates compatible with completion models (LLMs), see the [few-shot prompt templates](/docs/how_to/few_shot_examples/) guide.\n", "\n", - "```{=mdx}\n", - "import PrerequisiteLinks from \"@theme/PrerequisiteLinks\";\n", + ":::info Prerequisites\n", + "\n", + "This guide assumes familiarity with the following concepts:\n", "\n", - "\n", - "```" + "\n", + ":::" ] }, { diff --git a/docs/core_docs/docs/how_to/output_parser_json.ipynb b/docs/core_docs/docs/how_to/output_parser_json.ipynb index 9e85b3d85d6b..778a682a212d 100644 --- a/docs/core_docs/docs/how_to/output_parser_json.ipynb +++ b/docs/core_docs/docs/how_to/output_parser_json.ipynb @@ -13,17 +13,17 @@ "Keep in mind that large language models are leaky abstractions! You'll have to use an LLM with sufficient capacity to generate well-formed JSON.\n", ":::\n", "\n", - "```{=mdx}\n", - "import PrerequisiteLinks from \"@theme/PrerequisiteLinks\";\n", + ":::info Prerequisites\n", + "\n", + "This guide assumes familiarity with the following concepts:\n", "\n", - "\n", - "```" + "\n", + ":::" ] }, { diff --git a/docs/core_docs/docs/how_to/prompts_composition.ipynb b/docs/core_docs/docs/how_to/prompts_composition.ipynb index 95cccaebf0f2..3866fd93ba10 100644 --- a/docs/core_docs/docs/how_to/prompts_composition.ipynb +++ b/docs/core_docs/docs/how_to/prompts_composition.ipynb @@ -17,11 +17,13 @@ "source": [ "# How to compose prompts together\n", "\n", - "```{=mdx}\n", - "import PrerequisiteLinks from \"@theme/PrerequisiteLinks\";\n", + ":::info Prerequisites\n", "\n", - "\n", - "```\n", + "This guide assumes familiarity with the following concepts:\n", + "\n", + "- [Prompt templates](/docs/concepts/#prompt-templates)\n", + "\n", + ":::\n", "\n", "LangChain provides a user friendly interface for composing different parts of prompts together. You can do this with either string prompts or chat prompts. Constructing prompts this way allows for easy reuse of components." ] diff --git a/docs/core_docs/docs/how_to/prompts_partial.mdx b/docs/core_docs/docs/how_to/prompts_partial.mdx index b85318ea3d6b..de93000f9c48 100644 --- a/docs/core_docs/docs/how_to/prompts_partial.mdx +++ b/docs/core_docs/docs/how_to/prompts_partial.mdx @@ -1,12 +1,12 @@ # How to partially format prompt templates -import PrerequisiteLinks from "@theme/PrerequisiteLinks"; +:::info Prerequisites + +This guide assumes familiarity with the following concepts: - + +::: Like partially binding arguments to a function, it can make sense to "partial" a prompt template - e.g. pass in a subset of the required values, as to create a new prompt template which expects only the remaining subset of values. diff --git a/docs/core_docs/docs/how_to/sequence.ipynb b/docs/core_docs/docs/how_to/sequence.ipynb index 748148f35802..5a6c7a246930 100644 --- a/docs/core_docs/docs/how_to/sequence.ipynb +++ b/docs/core_docs/docs/how_to/sequence.ipynb @@ -19,16 +19,16 @@ "\n", "The resulting [`RunnableSequence`](https://api.js.langchain.com/classes/langchain_core_runnables.RunnableSequence.html) is itself a runnable, which means it can be invoked, streamed, or further chained just like any other runnable. Advantages of chaining runnables in this way are efficient streaming (the sequence will stream output as soon as it is available), and debugging and tracing with tools like [LangSmith](/docs/how_to/debugging).\n", "\n", - "```{=mdx}\n", - "import PrerequisiteLinks from \"@theme/PrerequisiteLinks\";\n", + ":::info Prerequisites\n", + "\n", + "This guide assumes familiarity with the following concepts:\n", "\n", - "\n", - "```\n", + "\n", + ":::\n", "\n", "## The pipe method\n", "\n", diff --git a/docs/core_docs/docs/how_to/streaming.ipynb b/docs/core_docs/docs/how_to/streaming.ipynb index 626a0d07b10d..5f82c2bcb34a 100644 --- a/docs/core_docs/docs/how_to/streaming.ipynb +++ b/docs/core_docs/docs/how_to/streaming.ipynb @@ -6,13 +6,13 @@ "source": [ "# How to stream\n", "\n", - "```{=mdx}\n", - "import PrerequisiteLinks from \"@theme/PrerequisiteLinks\";\n", + ":::info Prerequisites\n", + "\n", + "This guide assumes familiarity with the following concepts:\n", "\n", - "\n", - "```\n", + "\n", + ":::\n", "\n", "Streaming is critical in making applications based on LLMs feel responsive to end-users.\n", "\n", diff --git a/docs/core_docs/docs/how_to/tool_calling.ipynb b/docs/core_docs/docs/how_to/tool_calling.ipynb index e1f9ec1d84b5..4ee29a44b0fe 100644 --- a/docs/core_docs/docs/how_to/tool_calling.ipynb +++ b/docs/core_docs/docs/how_to/tool_calling.ipynb @@ -40,14 +40,16 @@ "LangChain implements standard interfaces for defining tools, passing them to LLMs, \n", "and representing tool calls. This guide will show you how to use them.\n", "\n", - "```{=mdx}\n", - "import PrerequisiteLinks from \"@theme/PrerequisiteLinks\";\n", + ":::info Prerequisites\n", + "\n", + "This guide assumes familiarity with the following concepts:\n", "\n", - "\n", - "```\n", + "\n", + ":::\n", + "\n", + "\n", "\n", "## Passing tools to LLMs\n", "\n", diff --git a/docs/core_docs/src/theme/PrerequisiteLinks.js b/docs/core_docs/src/theme/PrerequisiteLinks.js deleted file mode 100644 index 14206a24b8aa..000000000000 --- a/docs/core_docs/src/theme/PrerequisiteLinks.js +++ /dev/null @@ -1,20 +0,0 @@ -import React from "react"; -import { marked } from "marked"; -import DOMPurify from "isomorphic-dompurify"; -import Admonition from "@theme/Admonition"; - -export default function PrerequisiteLinks({ content }) { - return ( - -
- This guide will assume familiarity with the following concepts: -
-
- - ); -}