Merge branch 'main' into add-header-run-endpoint

docs/docs/core-components/agents.mdx

@@ -0,0 +1,52 @@
+---
+title: Agents powered by Langflow
+slug: /agents
+---
+
+import Icon from "@site/src/components/icon/icon";
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+OpenRAG leverages Langflow's Agent component to power the OpenRAG Open Search Agent flow.
+
+This flow intelligently chats with your knowledge by embedding your query, comparing it the vector database embeddings, and generating a response with the LLM.
+
+The Agent component shines here in its ability to make decisions on not only what query should be sent, but when a query is necessary to solve the problem at hand. 
+
+<details closed>
+<summary>How do agents work?</summary>
+
+Agents extend Large Language Models (LLMs) by integrating tools, which are functions that provide additional context and enable autonomous task execution. These integrations make agents more specialized and powerful than standalone LLMs.
+
+Whereas an LLM might generate acceptable, inert responses to general queries and tasks, an agent can leverage the integrated context and tools to provide more relevant responses and even take action. For example, you might create an agent that can access your company's documentation, repositories, and other resources to help your team with tasks that require knowledge of your specific products, customers, and code.
+
+Agents use LLMs as a reasoning engine to process input, determine which actions to take to address the query, and then generate a response. The response could be a typical text-based LLM response, or it could involve an action, like editing a file, running a script, or calling an external API.
+
+In an agentic context, tools are functions that the agent can run to perform tasks or access external resources. A function is wrapped as a Tool object with a common interface that the agent understands. Agents become aware of tools through tool registration, which is when the agent is provided a list of available tools typically at agent initialization. The Tool object's description tells the agent what the tool can do so that it can decide whether the tool is appropriate for a given request.
+
+</details>
+
+## Use the OpenRAG Open Search Agent flow
+
+If you've chatted with your knowledge in OpenRAG, you've already experienced the OpenRAG Open Search Agent chat flow.
+To view the flow, click <Icon name="Settings" aria-hidden="true"/> **Settings**, and then click **Edit in Langflow**.
+This flow contains seven components:
+
+* The Agent component orchestrates the entire flow by deciding when to search the knowledge base, how to formulate search queries, and how to combine retrieved information with the user's question to generate a comprehensive response.
+The Agent behaves according to the prompt in the **Agent Instructions** field.
+* The Chat Input component is connected to the Agent component's Input port. This allows to flow to be triggered by an incoming prompt from a user or application.
+* The OpenSearch component is connected to the Agent component's Tools port. The agent may not use this database for every request; the agent only uses this connection if it decides the knowledge can help respond to the prompt.
+* The Language Model component is connected to the Agent component's Language Model port. The agent uses the connected LLM to reason through the request sent through Chat Input.
+* The Embedding Model component is connected to the Open Search component's Embedding port. This component converts text queries into vector representations that are compared with document embeddings stored in OpenSearch for semantic similarity matching. This gives your Agent's queries context.
+* The Text Input component is populated with the global variable `OPENRAG-QUERY-FILTER`. 
+This filter is the Knowledge filter, and filters which knowledge sources to search through.
+* The Agent component's Output port is connected to the Chat Output component, which returns the final response to the user or application.
+
+All flows included with OpenRAG are designed to be modular, performant, and provider-agnostic.
+To modify a flow, click <Icon name="Settings" aria-hidden="true"/> **Settings**, and click **Edit in Langflow**.
+Flows are edited in the same way as in the [Langflow visual editor](https://docs.langflow.org/concepts-overview).
+
+For an example of changing out the agent's LLM in OpenRAG, see the [Quickstart](/quickstart#change-components).
+
+To restore the flow to its initial state, in OpenRAG, click <Icon name="Settings" aria-hidden="true"/> **Settings**, and then click **Restore Flow**.
+OpenRAG warns you that this discards all custom settings. Click **Restore** to restore the flow.

docs/docs/get-started/quickstart.mdx

@@ -16,6 +16,8 @@ Get started with OpenRAG by loading your knowledge, swapping out your language m
 ## Find your way around 
 
 1. In OpenRAG, click <Icon name="MessageSquare" aria-hidden="true"/> **Chat**.
+   The chat is powered by the OpenRAG Open Search Agent.
+   For more information, see [Langflow Agents](/agents).
 2. Ask `What documents are available to you?`
    The agent responds with a message summarizing the documents that OpenRAG loads by default, which are PDFs about evaluating data quality when using LLMs in health care.
 3. To confirm the agent is correct, click <Icon name="Library" aria-hidden="true"/> **Knowledge**.
@@ -33,7 +35,7 @@ Get started with OpenRAG by loading your knowledge, swapping out your language m
 These events log the agent's request to the tool and the tool's response, so you have direct visibility into your agent's functionality.
 If you aren't getting the results you need, you can further tune the knowledge ingestion and agent behavior in the next section.
 
-## Swap out the language model to modify agent behavior
+## Swap out the language model to modify agent behavior {#change-components}
 
 To modify the knowledge ingestion or Agent behavior, click <Icon name="Settings" aria-hidden="true"/> **Settings**.
 

docs/sidebars.js

@@ -47,6 +47,17 @@ const sidebars = {
         },
       ],
     },
+    {
+      type: "category",
+      label: "Core components",
+      items: [
+        {
+          type: "doc",
+          id: "core-components/agents",
+          label: "Langflow Agents"
+        },
+      ],
+    },
     {
       type: "category",
       label: "Configuration",