From f27f9748c45a179f2d2eba47f270cacee72f3ca7 Mon Sep 17 00:00:00 2001 From: Brandon McConnell Date: Thu, 6 Nov 2025 11:46:51 -0500 Subject: [PATCH] =?UTF-8?q?fix:=20fix=20improper=20CopilotKit=20casing=20"?= =?UTF-8?q?Copilotkit"=20=E2=86=92=20"CopilotKit"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- SECURITY.md | 4 +-- community/content/README.md | 2 +- .../demos_2024/Copilotkit-weather-bot.md | 6 ++--- community/demos_2024/EventTimer.md | 2 +- community/demos_2024/cal-buddy.md | 2 +- .../demos_2024/copilotkit-task-manager.md | 2 +- community/demos_2024/movie-bot.md | 2 +- community/demos_2024/priority-todolist.md | 2 +- .../(root)/custom-look-and-feel/index.mdx | 2 +- .../docs/adk/custom-look-and-feel/index.mdx | 2 +- docs/content/docs/ag2/concepts/ag2.mdx | 2 +- .../docs/ag2/custom-look-and-feel/index.mdx | 2 +- .../docs/agno/concepts/agentic-copilots.mdx | 2 +- .../docs/agno/concepts/copilotkit-stream.mdx | 2 +- .../docs/agno/concepts/your-framework.mdx | 6 ++--- .../docs/agno/custom-look-and-feel/index.mdx | 2 +- .../concepts/agentic-copilots.mdx | 2 +- .../concepts/copilotkit-stream.mdx | 2 +- .../docs/crewai-crews/concepts/crewai.mdx | 6 ++--- .../custom-look-and-feel/index.mdx | 2 +- .../concepts/agentic-copilots.mdx | 2 +- .../concepts/copilotkit-stream.mdx | 2 +- .../docs/crewai-flows/concepts/crewai.mdx | 6 ++--- .../custom-look-and-feel/index.mdx | 2 +- .../langgraph-platform-endpoint.mdx | 4 +-- .../remote-backend-endpoint.mdx | 2 +- .../guides/custom-look-and-feel/index.mdx | 2 +- .../langgraph/concepts/agentic-copilots.mdx | 2 +- .../langgraph/concepts/copilotkit-config.mdx | 12 ++++----- .../docs/langgraph/concepts/langgraph.mdx | 8 +++--- .../langgraph/human-in-the-loop/index.mdx | 2 +- .../llamaindex/custom-look-and-feel/index.mdx | 2 +- .../docs/mastra/concepts/agentic-copilots.mdx | 2 +- docs/content/docs/mastra/concepts/mastra.mdx | 6 ++--- .../mastra/custom-look-and-feel/index.mdx | 2 +- .../pydantic-ai/concepts/agentic-copilots.mdx | 2 +- .../docs/pydantic-ai/concepts/pydantic-ai.mdx | 6 ++--- .../custom-look-and-feel/index.mdx | 2 +- docs/public/llms-full.txt | 26 +++++++++---------- docs/public/llms.txt | 2 +- ...osting-copilot-runtime-create-endpoint.mdx | 2 +- ...ing-copilot-runtime-langgraph-endpoint.mdx | 2 +- .../self-hosting-copilot-runtime-starter.mdx | 2 +- .../coagents-travel/ui/lib/hooks/README.md | 4 +-- 44 files changed, 79 insertions(+), 79 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index 6427ab5a48..97389e562e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,6 +1,6 @@ # Security Policy -At **Copilotkit**, we are continuously working to improve not only the product but also the open-source repository. To achieve this, we encourage you to take some time to responsibly disclose any issues you may encounter. +At **CopilotKit**, we are continuously working to improve not only the product but also the open-source repository. To achieve this, we encourage you to take some time to responsibly disclose any issues you may encounter. ## Reporting a Vulnerability @@ -26,7 +26,7 @@ We hope this product meets your expectations. However, if you notice anything th - **Resolution**: We aim to release a fix or mitigation within 30 days of confirming the vulnerability. ### Note -**If you do not receive an acknowledgment of your email within 48 hours, and you haven’t heard from our security team after 5 days, please directly message someone from the Copilotkit team in our [Discord community](https://discord.gg/6dffbvGU3D).** +**If you do not receive an acknowledgment of your email within 48 hours, and you haven’t heard from our security team after 5 days, please directly message someone from the CopilotKit team in our [Discord community](https://discord.gg/6dffbvGU3D).** ## Security Best Practices diff --git a/community/content/README.md b/community/content/README.md index 9a257c99df..9bd1a8be25 100644 --- a/community/content/README.md +++ b/community/content/README.md @@ -18,7 +18,7 @@ Please show your support and give a ⭐ to the [CopilotKit repository](https://g 1. **Project Setup and Guidelines**: Check out the [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed setup instructions and contribution guidelines. 2. **Choose a Topic**: Browse our [Issues section](https://github.com/CopilotKit/CopilotKit/issues) tagged with `hacktoberfest`. CopilotKit allows multi-assignment! 3. **Submit Your Demo**: Build and submit your project following the steps in the `CONTRIBUTING.md`. -4. **Share Your Project**: Post your project on Twitter/X tagging `@Copilotkit` and adding the hashtag `#CopilotKitHacktoberfest` at the bottom of the post. The projects with the **most likes** will be crowned winners! +4. **Share Your Project**: Post your project on Twitter/X tagging `@CopilotKit` and adding the hashtag `#CopilotKitHacktoberfest` at the bottom of the post. The projects with the **most likes** will be crowned winners! --- diff --git a/community/demos_2024/Copilotkit-weather-bot.md b/community/demos_2024/Copilotkit-weather-bot.md index 4131f88d52..e50ee3b4c8 100644 --- a/community/demos_2024/Copilotkit-weather-bot.md +++ b/community/demos_2024/Copilotkit-weather-bot.md @@ -1,5 +1,5 @@ -# 1. Copilotkit-weather-Bot +# 1. CopilotKit-weather-Bot This Next.js application is a weather forecasting tool that utilizes CopilotKit for AI-powered interactions and Shadcn-UI for styling. It allows users to input a location and receive real-time weather information, including temperature, description, humidity, and wind speed. @@ -28,13 +28,13 @@ List the technologies and frameworks you used (e.g., CopilotKit, Next.js) ## 4. GitHub Project Link ### GitHub Repo Link: -[JanumalaAkhilendra/Copilotkit-weather-bot](https://github.com/JanumalaAkhilendra/Copilotkit-weather-bot) +[JanumalaAkhilendra/CopilotKit-weather-bot](https://github.com/JanumalaAkhilendra/CopilotKit-weather-bot) ### 5 bonus points - If your app is live, include the link here: - [Live app](https://copilotkit-weather-bot.vercel.app/) -- A youtube video demo of Copilotkit-weather-bot is available [here](https://youtu.be/F2wiIcNrwOg) +- A youtube video demo of CopilotKit-weather-bot is available [here](https://youtu.be/F2wiIcNrwOg) ## 6. Screenshot diff --git a/community/demos_2024/EventTimer.md b/community/demos_2024/EventTimer.md index f875fa98e1..dd4bbde46c 100644 --- a/community/demos_2024/EventTimer.md +++ b/community/demos_2024/EventTimer.md @@ -20,7 +20,7 @@ List the technologies and frameworks you used (e.g., CopilotKit, Next.js) ## 4. GitHub Project Link ### GitHub Repo Link: -[https://github.com/prathamesh424/EventCounter--Copilotkit](https://github.com/prathamesh424/EventCounter--Copilotkit) +[https://github.com/prathamesh424/EventCounter--CopilotKit](https://github.com/prathamesh424/EventCounter--CopilotKit) ### 5 bonus points diff --git a/community/demos_2024/cal-buddy.md b/community/demos_2024/cal-buddy.md index d3aedce02b..b3e6335699 100644 --- a/community/demos_2024/cal-buddy.md +++ b/community/demos_2024/cal-buddy.md @@ -23,7 +23,7 @@ Event Planner ( Hacktoberfest Demo ) ## Content -- [Dev.to - Copilotkit: Your AI Wingman for Coding Adventures](https://dev.to/chiragagg5k/copilotkit-your-ai-wingman-for-coding-adventures-28gl) +- [Dev.to - CopilotKit: Your AI Wingman for Coding Adventures](https://dev.to/chiragagg5k/copilotkit-your-ai-wingman-for-coding-adventures-28gl) - [Quira - Quest 20 Submission](https://quira.sh/repo/ChiragAgg5k-cal-buddy-863122206) - [Twitter - Sharing Progress](https://x.com/ChiragAgg5k/status/1839259454216323135) diff --git a/community/demos_2024/copilotkit-task-manager.md b/community/demos_2024/copilotkit-task-manager.md index 183982fec0..79d0fc4206 100644 --- a/community/demos_2024/copilotkit-task-manager.md +++ b/community/demos_2024/copilotkit-task-manager.md @@ -5,7 +5,7 @@ In this project, I developed a Task Manager using React for the frontend, Tailwi ### Method 1 - Using Form - User can add Task using form with its detail description, date & time and also needs to add priority of task. - User also show task completed as well as delete the task. -### Method 2 - Using Copilotkit +### Method 2 - Using CopilotKit - User need to write task name,task details also update and delete the task. ## 2. Name of Issue/Topic diff --git a/community/demos_2024/movie-bot.md b/community/demos_2024/movie-bot.md index 986711f1d5..281afad82b 100644 --- a/community/demos_2024/movie-bot.md +++ b/community/demos_2024/movie-bot.md @@ -1,6 +1,6 @@ ## 🚀 **Movie-BOT** -[Movie-Copilotkit-Bot](https://moviebot-sigma.vercel.app/) - An AI powered Movie Bot app that suggests you movies based on the genre , mood and your previous watch history. +[Movie-CopilotKit-Bot](https://moviebot-sigma.vercel.app/) - An AI powered Movie Bot app that suggests you movies based on the genre , mood and your previous watch history. ### 📝 **Name of Issue/Topic** diff --git a/community/demos_2024/priority-todolist.md b/community/demos_2024/priority-todolist.md index 22f0249cb1..f5043897a7 100644 --- a/community/demos_2024/priority-todolist.md +++ b/community/demos_2024/priority-todolist.md @@ -3,7 +3,7 @@ In this project, I developed a TO-DO List with Prioritization using React for th ### Method 1 - Using Form - User can add Task using form with its detail description, date & time and also needs to add priority of task. - User also show task completed as well as delete the task. -### Method 2 - Using Copilotkit +### Method 2 - Using CopilotKit - User need to write task name,task details, due date and time as well as priority of task. ## 2. Name of Issue/Topic diff --git a/docs/content/docs/(root)/custom-look-and-feel/index.mdx b/docs/content/docs/(root)/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/(root)/custom-look-and-feel/index.mdx +++ b/docs/content/docs/(root)/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/adk/custom-look-and-feel/index.mdx b/docs/content/docs/adk/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/adk/custom-look-and-feel/index.mdx +++ b/docs/content/docs/adk/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/ag2/concepts/ag2.mdx b/docs/content/docs/ag2/concepts/ag2.mdx index b3cac57e0a..e866e4d36e 100644 --- a/docs/content/docs/ag2/concepts/ag2.mdx +++ b/docs/content/docs/ag2/concepts/ag2.mdx @@ -1,6 +1,6 @@ --- title: AG2 -description: An agentic framework for building LLM applications that can be used with Copilotkit. +description: An agentic framework for building LLM applications that can be used with CopilotKit. icon: custom/ag2 --- diff --git a/docs/content/docs/ag2/custom-look-and-feel/index.mdx b/docs/content/docs/ag2/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/ag2/custom-look-and-feel/index.mdx +++ b/docs/content/docs/ag2/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/agno/concepts/agentic-copilots.mdx b/docs/content/docs/agno/concepts/agentic-copilots.mdx index 0aa9972161..d3f4878420 100644 --- a/docs/content/docs/agno/concepts/agentic-copilots.mdx +++ b/docs/content/docs/agno/concepts/agentic-copilots.mdx @@ -105,7 +105,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo } > diff --git a/docs/content/docs/agno/concepts/copilotkit-stream.mdx b/docs/content/docs/agno/concepts/copilotkit-stream.mdx index 730dff6424..57de5f638a 100644 --- a/docs/content/docs/agno/concepts/copilotkit-stream.mdx +++ b/docs/content/docs/agno/concepts/copilotkit-stream.mdx @@ -3,7 +3,7 @@ title: Streaming and Tool Calls description: CoAgents support streaming your messages and tool calls to the frontend. --- -If you'd like to stream messages from your Agno agents you can utilize our Copilotkit SDK which provides a collection +If you'd like to stream messages from your Agno agents you can utilize our CopilotKit SDK which provides a collection of functions and utilities for interacting with the agent's state or behavior. This allows you to choose how messages and tool calls are emitted and streamed to the frontend. diff --git a/docs/content/docs/agno/concepts/your-framework.mdx b/docs/content/docs/agno/concepts/your-framework.mdx index f1f998a35e..c582928f5d 100644 --- a/docs/content/docs/agno/concepts/your-framework.mdx +++ b/docs/content/docs/agno/concepts/your-framework.mdx @@ -1,6 +1,6 @@ --- title: Agno -description: An agentic framework for building LLM applications that can be used with Copilotkit. +description: An agentic framework for building LLM applications that can be used with CopilotKit. icon: custom/agno --- @@ -12,7 +12,7 @@ icon: custom/agno /> -Agno is an agentic framework for building LLM applications that can be used with Copilotkit. Agno Agents allow developers +Agno is an agentic framework for building LLM applications that can be used with CopilotKit. Agno Agents allow developers to combine and coordinate coding tasks efficiently, providing a robust framework for building sophisticated AI automations. ## CoAgents and Agno @@ -26,7 +26,7 @@ Let's break down some key terms and understand how they relate to and are implem - ** manage state**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember information from previous messages and the UI to update the agent with new information. Read more about how state sharing works [here](/agno/shared-state). -- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth" +- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth" when transitioning between agents. Read more about how multi-actor workflows work [here](/agno/multi-agent-flows) and how messages are managed [here](/agno/concepts/message-management). - **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to diff --git a/docs/content/docs/agno/custom-look-and-feel/index.mdx b/docs/content/docs/agno/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/agno/custom-look-and-feel/index.mdx +++ b/docs/content/docs/agno/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/crewai-crews/concepts/agentic-copilots.mdx b/docs/content/docs/crewai-crews/concepts/agentic-copilots.mdx index 9c4f46a325..572bd823c8 100644 --- a/docs/content/docs/crewai-crews/concepts/agentic-copilots.mdx +++ b/docs/content/docs/crewai-crews/concepts/agentic-copilots.mdx @@ -105,7 +105,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo } > diff --git a/docs/content/docs/crewai-crews/concepts/copilotkit-stream.mdx b/docs/content/docs/crewai-crews/concepts/copilotkit-stream.mdx index e6b17118f6..06755b81ea 100644 --- a/docs/content/docs/crewai-crews/concepts/copilotkit-stream.mdx +++ b/docs/content/docs/crewai-crews/concepts/copilotkit-stream.mdx @@ -3,7 +3,7 @@ title: Streaming and Tool Calls description: CoAgents support streaming your messages and tool calls to the frontend. --- -If you'd like to stream messages from your CrewAI agents you can utilize our Copilotkit SDK which provides a collection +If you'd like to stream messages from your CrewAI agents you can utilize our CopilotKit SDK which provides a collection of functions and utilities for interacting with the agent's state or behavior. This allows you to choose how messages and tool calls are emitted and streamed to the frontend. diff --git a/docs/content/docs/crewai-crews/concepts/crewai.mdx b/docs/content/docs/crewai-crews/concepts/crewai.mdx index 01282df7f4..f64c7d6b0e 100644 --- a/docs/content/docs/crewai-crews/concepts/crewai.mdx +++ b/docs/content/docs/crewai-crews/concepts/crewai.mdx @@ -1,6 +1,6 @@ --- title: CrewAI -description: An agentic framework for building LLM applications that can be used with Copilotkit. +description: An agentic framework for building LLM applications that can be used with CopilotKit. icon: custom/crewai --- @@ -12,7 +12,7 @@ icon: custom/crewai /> -CrewAI is an agentic framework for building LLM applications that can be used with Copilotkit. CrewAi Flows allow developers +CrewAI is an agentic framework for building LLM applications that can be used with CopilotKit. CrewAi Flows allow developers to combine and coordinate coding tasks and Crews efficiently, providing a robust framework for building sophisticated AI automations. ## CoAgents and CrewAI @@ -26,7 +26,7 @@ Let's break down some key terms and understand how they relate to and are implem - **Manage state**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember information from previous messages and the UI to update the agent with new information. Read more about how state sharing works [here](/crewai-crews/shared-state). -- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth" +- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth" when transitioning between agents. Read more about how multi-actor workflows work [here](/crewai-crews/multi-agent-flows) and how messages are managed [here](/crewai-crews/concepts/message-management). - **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to diff --git a/docs/content/docs/crewai-crews/custom-look-and-feel/index.mdx b/docs/content/docs/crewai-crews/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/crewai-crews/custom-look-and-feel/index.mdx +++ b/docs/content/docs/crewai-crews/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/crewai-flows/concepts/agentic-copilots.mdx b/docs/content/docs/crewai-flows/concepts/agentic-copilots.mdx index c6ec510d5f..3620e8666e 100644 --- a/docs/content/docs/crewai-flows/concepts/agentic-copilots.mdx +++ b/docs/content/docs/crewai-flows/concepts/agentic-copilots.mdx @@ -105,7 +105,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo } > diff --git a/docs/content/docs/crewai-flows/concepts/copilotkit-stream.mdx b/docs/content/docs/crewai-flows/concepts/copilotkit-stream.mdx index 91e0dc4fc0..9acc35c067 100644 --- a/docs/content/docs/crewai-flows/concepts/copilotkit-stream.mdx +++ b/docs/content/docs/crewai-flows/concepts/copilotkit-stream.mdx @@ -3,7 +3,7 @@ title: Streaming and Tool Calls description: CoAgents support streaming your messages and tool calls to the frontend. --- -If you'd like to stream messages from your CrewAI agents you can utilize our Copilotkit SDK which provides a collection +If you'd like to stream messages from your CrewAI agents you can utilize our CopilotKit SDK which provides a collection of functions and utilities for interacting with the agent's state or behavior. This allows you to choose how messages and tool calls are emitted and streamed to the frontend. diff --git a/docs/content/docs/crewai-flows/concepts/crewai.mdx b/docs/content/docs/crewai-flows/concepts/crewai.mdx index 5684e03565..7a86b1a522 100644 --- a/docs/content/docs/crewai-flows/concepts/crewai.mdx +++ b/docs/content/docs/crewai-flows/concepts/crewai.mdx @@ -1,6 +1,6 @@ --- title: CrewAI -description: An agentic framework for building LLM applications that can be used with Copilotkit. +description: An agentic framework for building LLM applications that can be used with CopilotKit. icon: custom/crewai --- @@ -12,7 +12,7 @@ icon: custom/crewai /> -CrewAI is an agentic framework for building LLM applications that can be used with Copilotkit. CrewAi Flows allow developers +CrewAI is an agentic framework for building LLM applications that can be used with CopilotKit. CrewAi Flows allow developers to combine and coordinate coding tasks and Crews efficiently, providing a robust framework for building sophisticated AI automations. ## CoAgents and CrewAI @@ -26,7 +26,7 @@ Let's break down some key terms and understand how they relate to and are implem - ** manage state**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember information from previous messages and the UI to update the agent with new information. Read more about how state sharing works [here](/crewai-flows/shared-state). -- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth" +- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth" when transitioning between agents. Read more about how multi-actor workflows work [here](/crewai-flows/multi-agent-flows) and how messages are managed [here](/crewai-flows/concepts/message-management). - **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to diff --git a/docs/content/docs/crewai-flows/custom-look-and-feel/index.mdx b/docs/content/docs/crewai-flows/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/crewai-flows/custom-look-and-feel/index.mdx +++ b/docs/content/docs/crewai-flows/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/direct-to-llm/guides/backend-actions/langgraph-platform-endpoint.mdx b/docs/content/docs/direct-to-llm/guides/backend-actions/langgraph-platform-endpoint.mdx index a204452b03..05f7e47a33 100644 --- a/docs/content/docs/direct-to-llm/guides/backend-actions/langgraph-platform-endpoint.mdx +++ b/docs/content/docs/direct-to-llm/guides/backend-actions/langgraph-platform-endpoint.mdx @@ -11,7 +11,7 @@ import { TailoredContentOption, } from "@/components/react/tailored-content.tsx"; import CopilotCloudConfigureRemoteEndpointLangGraphSnippet from "@/snippets/copilot-cloud-configure-remote-endpoint-langgraph.mdx"; -import CopilotCloudConfigureCopilotkitProviderSnippet from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx"; +import CopilotCloudConfigureCopilotKitProviderSnippet from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx"; import LangGraphPlatformDeploymentTabs from "@/snippets/langgraph-platform-deployment-tabs.mdx"; import { FaCloud, FaServer } from "react-icons/fa"; @@ -49,7 +49,7 @@ import { FaCloud, FaServer } from "react-icons/fa"; Copilot Cloud hooks into your CopilotKit provider, so you'll need to set it up first if you haven't already. - + diff --git a/docs/content/docs/direct-to-llm/guides/backend-actions/remote-backend-endpoint.mdx b/docs/content/docs/direct-to-llm/guides/backend-actions/remote-backend-endpoint.mdx index 38c00b45d9..3b87e17462 100644 --- a/docs/content/docs/direct-to-llm/guides/backend-actions/remote-backend-endpoint.mdx +++ b/docs/content/docs/direct-to-llm/guides/backend-actions/remote-backend-endpoint.mdx @@ -5,7 +5,7 @@ icon: "custom/python" --- import FindCopilotRuntimeSnippet from "@/snippets/find-your-copilot-runtime.mdx"; import CopilotCloudConfigureRemoteEndpointSnippet from "@/snippets/copilot-cloud-configure-remote-endpoint.mdx"; -import CopilotCloudConfigureCopilotkitProviderSnippet from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx"; +import CopilotCloudConfigureCopilotKitProviderSnippet from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx"; import { TailoredContent, TailoredContentOption } from "@/components/react/tailored-content"; import { Accordions, Accordion } from "fumadocs-ui/components/accordion"; import { FaCloud, FaServer } from "react-icons/fa"; diff --git a/docs/content/docs/direct-to-llm/guides/custom-look-and-feel/index.mdx b/docs/content/docs/direct-to-llm/guides/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/direct-to-llm/guides/custom-look-and-feel/index.mdx +++ b/docs/content/docs/direct-to-llm/guides/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/langgraph/concepts/agentic-copilots.mdx b/docs/content/docs/langgraph/concepts/agentic-copilots.mdx index dfd8ec77c0..a259f50186 100644 --- a/docs/content/docs/langgraph/concepts/agentic-copilots.mdx +++ b/docs/content/docs/langgraph/concepts/agentic-copilots.mdx @@ -100,7 +100,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo } > diff --git a/docs/content/docs/langgraph/concepts/copilotkit-config.mdx b/docs/content/docs/langgraph/concepts/copilotkit-config.mdx index b7aa010c4c..e03af1e3f2 100644 --- a/docs/content/docs/langgraph/concepts/copilotkit-config.mdx +++ b/docs/content/docs/langgraph/concepts/copilotkit-config.mdx @@ -4,15 +4,15 @@ icon: "lucide/Zap" description: CoAgents support streaming your messages and tool calls to the frontend. --- -If you'd like to change how LangGraph agents behave as CoAgents you can utilize our Copilotkit SDK which provides a collection -of functions and utilities for interacting with the agent's state or behavior. One example of this is the Copilotkit config +If you'd like to change how LangGraph agents behave as CoAgents you can utilize our CopilotKit SDK which provides a collection +of functions and utilities for interacting with the agent's state or behavior. One example of this is the CopilotKit config which is a wrapper of the LangGraph `config` object. This allows you to extend the configuration of your LangGraph nodes to -change how LangGraph and Copilotkit interact with each other. This allows you to change how messages and tool calls are emitted and +change how LangGraph and CopilotKit interact with each other. This allows you to change how messages and tool calls are emitted and streamed to the frontend. ## Message Streaming If you did not change anything in your LangGraph node, message streaming will be on by default. This allows for a message to be -streamed to Copilotkit as it is being generated, allowing for a more responsive experience. However, you can disable this if you +streamed to CopilotKit as it is being generated, allowing for a more responsive experience. However, you can disable this if you want to have the message only be sent after the agent has finished generating it. ```python @@ -24,8 +24,8 @@ config = copilotkit_customize_config( ``` ## Emitting Tool Calls -Emission of tool calls are off by default. This means that tool calls will not be sent to Copilotkit for processing and rendering. -However, within a node you can extend the LangGraph `config` object to emit tool calls to Copilotkit. This is useful in situations +Emission of tool calls are off by default. This means that tool calls will not be sent to CopilotKit for processing and rendering. +However, within a node you can extend the LangGraph `config` object to emit tool calls to CopilotKit. This is useful in situations where you may to emit what a potential tool call will look like prior to being executed. ```python diff --git a/docs/content/docs/langgraph/concepts/langgraph.mdx b/docs/content/docs/langgraph/concepts/langgraph.mdx index 31a79dc3fd..b549f269fb 100644 --- a/docs/content/docs/langgraph/concepts/langgraph.mdx +++ b/docs/content/docs/langgraph/concepts/langgraph.mdx @@ -1,6 +1,6 @@ --- title: LangGraph -description: An agentic framework for building LLM applications that can be used with Copilotkit. +description: An agentic framework for building LLM applications that can be used with CopilotKit. icon: custom/langchain --- @@ -8,7 +8,7 @@ icon: custom/langchain CoAgents High Level Overview -LangGraph is an agentic framework for building LLM applications that can be used with Copilotkit. It is built on top of LangChain's +LangGraph is an agentic framework for building LLM applications that can be used with CopilotKit. It is built on top of LangChain's [LangGraph](https://langchain-ai.github.io/langgraph/) library and extends it with additional functionality for building agentic applications. @@ -23,7 +23,7 @@ There are some key terms here so let's break them down and understand how they r - **Stateful**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember information from previous messages and the UI to update the agent with new information. Read more about how state sharing works [here](/coagents/shared-state). -- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth" +- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth" when transitioning between agents. Read more about how multi-actor workflows work [here](/coagents/multi-agent-flows) and how messages are managed [here](/coagents/concepts/message-management). - **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to @@ -47,7 +47,7 @@ For a quick refresher on each, check out the [Python](https://langchain-ai.githu ## LangGraph Platform LangGraph Platform is a platform for building and deploying LangGraph applications. It is built on top of the LangGraph library and -allows you to build, manage, and deploy graphs that Copilotkit can interface with. For more information checkout the official +allows you to build, manage, and deploy graphs that CopilotKit can interface with. For more information checkout the official [LangGraph Platform](https://langchain-ai.github.io/langgraph/concepts/langgraph_platform) documentation. If you want to take the next step to deploy your LangGraph application as an CoAgent, check out our [quickstart guide](/coagents/quickstart/langgraph). diff --git a/docs/content/docs/langgraph/human-in-the-loop/index.mdx b/docs/content/docs/langgraph/human-in-the-loop/index.mdx index d3a14418b7..9fc8b425e8 100644 --- a/docs/content/docs/langgraph/human-in-the-loop/index.mdx +++ b/docs/content/docs/langgraph/human-in-the-loop/index.mdx @@ -34,7 +34,7 @@ HITL combines the efficiency of AI with human judgment, creating a system that's ## How can I use this? -Copilotkit provides two main approaches for HITL LangGraph workflows - interrupt and node-based. +CopilotKit provides two main approaches for HITL LangGraph workflows - interrupt and node-based. Unsure which approach to use? We recommend starting with the [Interrupt](/coagents/human-in-the-loop/interrupt-flow) flow. diff --git a/docs/content/docs/llamaindex/custom-look-and-feel/index.mdx b/docs/content/docs/llamaindex/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/llamaindex/custom-look-and-feel/index.mdx +++ b/docs/content/docs/llamaindex/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/mastra/concepts/agentic-copilots.mdx b/docs/content/docs/mastra/concepts/agentic-copilots.mdx index 13c3ed9fde..1674a4a549 100644 --- a/docs/content/docs/mastra/concepts/agentic-copilots.mdx +++ b/docs/content/docs/mastra/concepts/agentic-copilots.mdx @@ -100,7 +100,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo } > diff --git a/docs/content/docs/mastra/concepts/mastra.mdx b/docs/content/docs/mastra/concepts/mastra.mdx index d8ed3375ab..bd011b6946 100644 --- a/docs/content/docs/mastra/concepts/mastra.mdx +++ b/docs/content/docs/mastra/concepts/mastra.mdx @@ -1,10 +1,10 @@ --- title: Mastra -description: An agentic framework for building LLM applications that can be used with Copilotkit. +description: An agentic framework for building LLM applications that can be used with CopilotKit. icon: custom/mastra --- -Mastra is an agentic framework for building LLM applications that can be used with Copilotkit. Mastra Agents allow developers +Mastra is an agentic framework for building LLM applications that can be used with CopilotKit. Mastra Agents allow developers to combine and coordinate tasks efficiently, providing a robust framework for building sophisticated AI automations. ## CoAgents and Mastra @@ -12,7 +12,7 @@ to combine and coordinate tasks efficiently, providing a robust framework for bu How do CoAgents extend Mastra? -- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth" +- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth" when transitioning between agents. Read more about how multi-actor workflows work [here](/mastra/multi-agent-flows) and how messages are managed [here](/mastra/concepts/message-management). - **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to diff --git a/docs/content/docs/mastra/custom-look-and-feel/index.mdx b/docs/content/docs/mastra/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/mastra/custom-look-and-feel/index.mdx +++ b/docs/content/docs/mastra/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/content/docs/pydantic-ai/concepts/agentic-copilots.mdx b/docs/content/docs/pydantic-ai/concepts/agentic-copilots.mdx index 770f311077..86b2091f01 100644 --- a/docs/content/docs/pydantic-ai/concepts/agentic-copilots.mdx +++ b/docs/content/docs/pydantic-ai/concepts/agentic-copilots.mdx @@ -105,7 +105,7 @@ Pydantic AI is a framework that gives you precise control over AI agents. Pydant } > diff --git a/docs/content/docs/pydantic-ai/concepts/pydantic-ai.mdx b/docs/content/docs/pydantic-ai/concepts/pydantic-ai.mdx index a28c76701b..23b0d8800f 100644 --- a/docs/content/docs/pydantic-ai/concepts/pydantic-ai.mdx +++ b/docs/content/docs/pydantic-ai/concepts/pydantic-ai.mdx @@ -1,6 +1,6 @@ --- title: Pydantic AI -description: An agentic framework for building LLM applications that can be used with Copilotkit. +description: An agentic framework for building LLM applications that can be used with CopilotKit. icon: custom/pydantic --- @@ -12,7 +12,7 @@ icon: custom/pydantic /> -Pydantic AI is an agentic framework for building LLM applications that can be used with Copilotkit. Pydantic AI Agents allow developers +Pydantic AI is an agentic framework for building LLM applications that can be used with CopilotKit. Pydantic AI Agents allow developers to combine and coordinate coding tasks efficiently, providing a robust framework for building sophisticated AI automations. ## CoAgents and Pydantic AI @@ -26,7 +26,7 @@ Let's break down some key terms and understand how they relate to and are implem - ** manage state**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember information from previous messages and the UI to update the agent with new information. Read more about how state sharing works [here](/pydantic-ai/shared-state). -- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth" +- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth" when transitioning between agents. Read more about how multi-actor workflows work [here](/pydantic-ai/multi-agent-flows). - **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to generate natural language responses. diff --git a/docs/content/docs/pydantic-ai/custom-look-and-feel/index.mdx b/docs/content/docs/pydantic-ai/custom-look-and-feel/index.mdx index f20b0a19c9..7c059b39d0 100644 --- a/docs/content/docs/pydantic-ai/custom-look-and-feel/index.mdx +++ b/docs/content/docs/pydantic-ai/custom-look-and-feel/index.mdx @@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless Markdown Rendering} - description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." + description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps." href="./custom-look-and-feel/markdown-rendering" /> \ No newline at end of file diff --git a/docs/public/llms-full.txt b/docs/public/llms-full.txt index b79faa017e..3d800fd0dd 100644 --- a/docs/public/llms-full.txt +++ b/docs/public/llms-full.txt @@ -3653,11 +3653,11 @@ On this pageCoAgents and LangGraph # LangGraph -An agentic framework for building LLM applications that can be used with Copilotkit. +An agentic framework for building LLM applications that can be used with CopilotKit. ![CoAgents High Level Overview](https://docs.copilotkit.aihttps://cdn.copilotkit.ai/docs/copilotkit/images/coagents/coagents-highlevel-overview.png) -LangGraph is an agentic framework for building LLM applications that can be used with Copilotkit. It is built on top of LangChain's +LangGraph is an agentic framework for building LLM applications that can be used with CopilotKit. It is built on top of LangChain's [LangGraph](https://langchain-ai.github.io/langgraph/) library and extends it with additional functionality for building agentic applications. @@ -3672,7 +3672,7 @@ There are some key terms here so let's break them down and understand how they r - **Stateful**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember information from previous messages and the UI to update the agent with new information. Read more about how state sharing works [here](https://docs.copilotkit.ai/coagents/shared-state). -- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth" +- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth" when transitioning between agents. Read more about how multi-actor workflows work [here](https://docs.copilotkit.ai/coagents/multi-agent-flows) and how messages are managed [here](https://docs.copilotkit.ai/coagents/concepts/message-management). - **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to @@ -3697,7 +3697,7 @@ For a quick refresher on each, check out the [Python](https://langchain-ai.githu ## [LangGraph Platform](https://docs.copilotkit.ai/coagents/concepts/langgraph\#langgraph-platform) LangGraph Platform is a platform for building and deploying LangGraph applications. It is built on top of the LangGraph library and -allows you to build, manage, and deploy graphs that Copilotkit can interface with. For more information checkout the official +allows you to build, manage, and deploy graphs that CopilotKit can interface with. For more information checkout the official [LangGraph Platform](https://langchain-ai.github.io/langgraph/concepts/langgraph_platform) documentation. If you want to take the next step to deploy your LangGraph application as an CoAgent, check out our [quickstart guide](https://docs.copilotkit.ai/coagents/quickstart/langgraph). @@ -4520,7 +4520,7 @@ Help me understand what agentic copilots are, where LangGraph fits in, and how t I'm already using LangGraph -Help me understand what agentic copilots are, what Copilotkit does to integrate with LangGraph, and how to get started. +Help me understand what agentic copilots are, what CopilotKit does to integrate with LangGraph, and how to get started. ![CoAgents Shared State](https://docs.copilotkit.aihttps://cdn.copilotkit.ai/docs/copilotkit/images/coagents/SharedStateCoAgents.gif) @@ -6063,7 +6063,7 @@ Chat with an Agent](https://docs.copilotkit.ai/crewai-flows/agentic-chat-ui) ![](https://static.scarf.sh/a.png?x-pxid=ffc9f65d-0186-4575-b065-61d62ea9d7d3) -## Copilotkit Configuration Guide +## CopilotKit Configuration Guide CrewAI CrewAI support is here! Checkout the [Crew](https://docs.copilotkit.ai/crewai-crews) and [Flow](https://docs.copilotkit.ai/crewai-flows) documentation. Search docs @@ -6076,16 +6076,16 @@ On this pageMessage Streaming CoAgents support streaming your messages and tool calls to the frontend. -If you'd like to change how LangGraph agents behave as CoAgents you can utilize our Copilotkit SDK which provides a collection -of functions and utilities for interacting with the agent's state or behavior. One example of this is the Copilotkit config +If you'd like to change how LangGraph agents behave as CoAgents you can utilize our CopilotKit SDK which provides a collection +of functions and utilities for interacting with the agent's state or behavior. One example of this is the CopilotKit config which is a wrapper of the LangGraph `config` object. This allows you to extend the configuration of your LangGraph nodes to -change how LangGraph and Copilotkit interact with each other. This allows you to change how messages and tool calls are emitted and +change how LangGraph and CopilotKit interact with each other. This allows you to change how messages and tool calls are emitted and streamed to the frontend. ## [Message Streaming](https://docs.copilotkit.ai/coagents/concepts/copilotkit-config\#message-streaming) If you did not change anything in your LangGraph node, message streaming will be on by default. This allows for a message to be -streamed to Copilotkit as it is being generated, allowing for a more responsive experience. However, you can disable this if you +streamed to CopilotKit as it is being generated, allowing for a more responsive experience. However, you can disable this if you want to have the message only be sent after the agent has finished generating it. ``` @@ -6098,8 +6098,8 @@ config = copilotkit_customize_config( ## [Emitting Tool Calls](https://docs.copilotkit.ai/coagents/concepts/copilotkit-config\#emitting-tool-calls) -Emission of tool calls are off by default. This means that tool calls will not be sent to Copilotkit for processing and rendering. -However, within a node you can extend the LangGraph `config` object to emit tool calls to Copilotkit. This is useful in situations +Emission of tool calls are off by default. This means that tool calls will not be sent to CopilotKit for processing and rendering. +However, within a node you can extend the LangGraph `config` object to emit tool calls to CopilotKit. This is useful in situations where you may to emit what a potential tool call will look like prior to being executed. ``` @@ -7212,7 +7212,7 @@ HITL combines the efficiency of AI with human judgment, creating a system that's ## [How can I use this?](https://docs.copilotkit.ai/coagents/human-in-the-loop\#how-can-i-use-this) -Copilotkit provides two main approaches for HITL LangGraph workflows - interrupt and node-based. +CopilotKit provides two main approaches for HITL LangGraph workflows - interrupt and node-based. Unsure which approach to use? We recommend starting with the [Interrupt](https://docs.copilotkit.ai/coagents/human-in-the-loop/interrupt-flow) flow. diff --git a/docs/public/llms.txt b/docs/public/llms.txt index 12c41dd11c..044a5d15b0 100644 --- a/docs/public/llms.txt +++ b/docs/public/llms.txt @@ -48,7 +48,7 @@ - [Multi-Agent Flows](https://docs.copilotkit.ai/coagents/multi-agent-flows): Learn to orchestrate complex flows with multiple agents. - [Copilot Sidebar Component](https://docs.copilotkit.ai/reference/components/chat/CopilotSidebar): Customizable sidebar component for chatbot interactions in CopilotKit. - [CrewAI Quickstart Guide](https://docs.copilotkit.ai/crewai-flows/quickstart/crewai): Quickly set up CrewAI Flows with CopilotKit integration. -- [Copilotkit Configuration Guide](https://docs.copilotkit.ai/coagents/concepts/copilotkit-config): Learn to configure message streaming and tool calls in Copilotkit. +- [CopilotKit Configuration Guide](https://docs.copilotkit.ai/coagents/concepts/copilotkit-config): Learn to configure message streaming and tool calls in CopilotKit. - [Agentic Chat UI](https://docs.copilotkit.ai/coagents/agentic-chat-ui): Explore CopilotKit's agentic chat UI components for user interaction. - [CrewAIAgent Overview](https://docs.copilotkit.ai/reference/sdk/python/CrewAIAgent): Define and serve agents using CrewAIAgent in Python. - [CrewAI Quickstart Guide](https://docs.copilotkit.ai/crewai-crews/quickstart/crewai): Quickly set up CrewAI Crews with CopilotKit integration. diff --git a/docs/snippets/self-hosting-copilot-runtime-create-endpoint.mdx b/docs/snippets/self-hosting-copilot-runtime-create-endpoint.mdx index 04b75b5ea2..7adf1f3ad1 100644 --- a/docs/snippets/self-hosting-copilot-runtime-create-endpoint.mdx +++ b/docs/snippets/self-hosting-copilot-runtime-create-endpoint.mdx @@ -254,7 +254,7 @@ If you are not sure yet, simply ignore this note. import { Request, Response } from 'express'; @Controller() - export class CopilotkitController { + export class CopilotKitController { @All('/copilotkit') copilotkit(@Req() req: Request, @Res() res: Response) { {{adapterSetup}} diff --git a/docs/snippets/self-hosting-copilot-runtime-langgraph-endpoint.mdx b/docs/snippets/self-hosting-copilot-runtime-langgraph-endpoint.mdx index 22a07379ff..30d5c562d6 100644 --- a/docs/snippets/self-hosting-copilot-runtime-langgraph-endpoint.mdx +++ b/docs/snippets/self-hosting-copilot-runtime-langgraph-endpoint.mdx @@ -212,7 +212,7 @@ import { RiNextjsLine } from "react-icons/ri"; import OpenAI from "openai"; @Controller() - export class CopilotkitController { + export class CopilotKitController { @All('/copilotkit') copilotkit(@Req() req: Request, @Res() res: Response) { const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY }); diff --git a/docs/snippets/self-hosting-copilot-runtime-starter.mdx b/docs/snippets/self-hosting-copilot-runtime-starter.mdx index 02f65691af..7448644f35 100644 --- a/docs/snippets/self-hosting-copilot-runtime-starter.mdx +++ b/docs/snippets/self-hosting-copilot-runtime-starter.mdx @@ -180,7 +180,7 @@ import { RiNextjsLine } from "react-icons/ri"; @Controller() - export class CopilotkitController { + export class CopilotKitController { @All('/copilotkit') copilotkit(@Req() req: Request, @Res() res: Response) { const serviceAdapter = new ExperimentalEmptyAdapter(); diff --git a/examples/coagents-travel/ui/lib/hooks/README.md b/examples/coagents-travel/ui/lib/hooks/README.md index c89d888234..2a95785dbb 100644 --- a/examples/coagents-travel/ui/lib/hooks/README.md +++ b/examples/coagents-travel/ui/lib/hooks/README.md @@ -1,6 +1,6 @@ # use-trips.tsx -This hook is where most of the magic happens for Copilotkit (if you're looking for the rest, check out [app/page.tsx](../../app/page.tsx) and [api/copilotkit/route.ts](../../app/api/copilotkit/route.ts)). It handles interacting with the CoAgent's state and provides helper functions for the UI to interact with and update the CoAgent's state. It also provides intermediate streaming for human-in-the-loop components as well as progress tracking. +This hook is where most of the magic happens for CopilotKit (if you're looking for the rest, check out [app/page.tsx](../../app/page.tsx) and [api/copilotkit/route.ts](../../app/api/copilotkit/route.ts)). It handles interacting with the CoAgent's state and provides helper functions for the UI to interact with and update the CoAgent's state. It also provides intermediate streaming for human-in-the-loop components as well as progress tracking. ## Key Concepts @@ -43,7 +43,7 @@ This hook is used to add front-end functions as tool calls to an agent or LLM. T For our needs, we can keep it simple and think of it as a way to force the LLM for user approval before performing some action. This is accomplished two ways. 1. Setting a "breakpoint" in the agent code via the `interrupt_after` option when compiling an agent. -2. Emitting tool calls via the Copilotkit SDK. +2. Emitting tool calls via the CopilotKit SDK. 3. Sending approval/rejection response back to the agent via our `useCopilotAction` hook. This is gone into in more detail in our documentation on implementing [human in the loop](https://docs.copilotkit.ai/coagents/human-in-the-loop/node-flow).