From beec7259c86593efe01d22f3680c043dc687c57a Mon Sep 17 00:00:00 2001 From: Eugene Yurtsev Date: Mon, 15 Jan 2024 14:14:11 -0500 Subject: [PATCH] docs: Add info admonitions to a few agents (#15899) Add admonitions directly in the agent page to explain constraints and include a link to agent types. --- .../modules/agents/agent_types/structured_chat.ipynb | 4 ++-- docs/docs/modules/agents/agent_types/xml_agent.ipynb | 11 +++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/docs/modules/agents/agent_types/structured_chat.ipynb b/docs/docs/modules/agents/agent_types/structured_chat.ipynb index 2ed2a9586eb..d2da33a6ba9 100644 --- a/docs/docs/modules/agents/agent_types/structured_chat.ipynb +++ b/docs/docs/modules/agents/agent_types/structured_chat.ipynb @@ -17,7 +17,7 @@ "source": [ "# Structured chat\n", "\n", - "The structured chat agent is capable of using multi-input tools.\n" + "The structured chat agent is capable of using multi-input tools." ] }, { @@ -237,7 +237,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.1" + "version": "3.11.4" } }, "nbformat": 4, diff --git a/docs/docs/modules/agents/agent_types/xml_agent.ipynb b/docs/docs/modules/agents/agent_types/xml_agent.ipynb index 1a8d09bd3e6..5ba476a2990 100644 --- a/docs/docs/modules/agents/agent_types/xml_agent.ipynb +++ b/docs/docs/modules/agents/agent_types/xml_agent.ipynb @@ -17,7 +17,14 @@ "source": [ "# XML Agent\n", "\n", - "Some language models (like Anthropic's Claude) are particularly good at reasoning/writing XML. This goes over how to use an agent that uses XML when prompting. " + "Some language models (like Anthropic's Claude) are particularly good at reasoning/writing XML. This goes over how to use an agent that uses XML when prompting. \n", + "\n", + ":::tip\n", + "\n", + "* Use with regular LLMs, not with chat models.\n", + "* Use only with unstructured tools; i.e., tools that accept a single string input.\n", + "* See [AgentTypes](../index) documentation for more agent types.\n", + ":::" ] }, { @@ -217,7 +224,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.1" + "version": "3.11.4" } }, "nbformat": 4,