import type { ReferenceDocConfiguration } from "./reference-doc"; export const REFERENCE_DOCS: ReferenceDocConfiguration[] = [ /* Runtime */ { sourcePath: "packages/runtime/src/service-adapters/google/google-genai-adapter.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/classes/llm-adapters/GoogleGenerativeAIAdapter.mdx", className: "GoogleGenerativeAIAdapter", description: "Copilot Runtime adapter for Google Generative AI (e.g. Gemini).", }, { sourcePath: "packages/runtime/src/service-adapters/groq/groq-adapter.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/classes/llm-adapters/GroqAdapter.mdx", className: "GroqAdapter", description: "Copilot Runtime adapter for Groq.", }, { sourcePath: "packages/runtime/src/service-adapters/langchain/langchain-adapter.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/classes/llm-adapters/LangChainAdapter.mdx", className: "LangChainAdapter", description: "Copilot Runtime adapter for LangChain.", }, { sourcePath: "packages/runtime/src/service-adapters/openai/openai-adapter.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/classes/llm-adapters/OpenAIAdapter.mdx", className: "OpenAIAdapter", description: "Copilot Runtime adapter for OpenAI.", }, { sourcePath: "packages/runtime/src/service-adapters/openai/openai-assistant-adapter.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/classes/llm-adapters/OpenAIAssistantAdapter.mdx", className: "OpenAIAssistantAdapter", description: "Copilot Runtime adapter for OpenAI Assistant API.", }, { sourcePath: "packages/runtime/src/service-adapters/anthropic/anthropic-adapter.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/classes/llm-adapters/AnthropicAdapter.mdx", className: "AnthropicAdapter", description: "Copilot Runtime adapter for Anthropic.", }, /* Classes */ { sourcePath: "packages/react-core/src/lib/copilot-task.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/classes/CopilotTask.mdx", className: "CopilotTask", description: "CopilotTask is used to execute one-off tasks, for example on button click.", }, { sourcePath: "packages/runtime/src/lib/runtime/copilot-runtime.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/classes/CopilotRuntime.mdx", className: "CopilotRuntime", description: "Copilot Runtime is the back-end component of CopilotKit, enabling interaction with LLMs.", }, /* Components */ { sourcePath: "packages/react-ui/src/components/chat/Chat.tsx", destinationPath: "showcase/shell-docs/src/content/reference/v1/components/chat/CopilotChat.mdx", component: "CopilotChat", description: "The CopilotChat component, providing a chat interface for interacting with your copilot.", }, { sourcePath: "packages/react-core/src/components/copilot-provider/copilotkit.tsx", destinationPath: "showcase/shell-docs/src/content/reference/v1/components/CopilotKit.mdx", component: "CopilotKit", description: "The CopilotKit provider component, wrapping your application.", }, { sourcePath: "packages/react-ui/src/components/chat/Popup.tsx", destinationPath: "showcase/shell-docs/src/content/reference/v1/components/chat/CopilotPopup.mdx", component: "CopilotPopup", description: "The CopilotPopup component, providing a popup interface for interacting with your copilot.", }, { sourcePath: "packages/react-ui/src/components/chat/Sidebar.tsx", destinationPath: "showcase/shell-docs/src/content/reference/v1/components/chat/CopilotSidebar.mdx", component: "CopilotSidebar", description: "The CopilotSidebar component, providing a sidebar interface for interacting with your copilot.", }, { sourcePath: "packages/react-textarea/src/components/copilot-textarea/copilot-textarea.tsx", destinationPath: "showcase/shell-docs/src/content/reference/v1/components/CopilotTextarea.mdx", component: "CopilotTextarea", description: "An AI-powered textarea component for your application, which serves as a drop-in replacement for any textarea.", }, /* Hooks */ { sourcePath: "packages/react-core/src/hooks/use-copilot-chat.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/hooks/useCopilotChat.mdx", hook: "useCopilotChat", }, { sourcePath: "packages/react-core/src/hooks/use-copilot-chat-headless_c.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/hooks/useCopilotChatHeadless_c.mdx", hook: "useCopilotChatHeadless_c", }, { sourcePath: "packages/react-ui/src/hooks/use-copilot-chat-suggestions.tsx", destinationPath: "showcase/shell-docs/src/content/reference/v1/hooks/useCopilotChatSuggestions.mdx", hook: "useCopilotChatSuggestions", description: "The useCopilotChatSuggestions hook generates suggestions in the chat window based on real-time app state.", }, { sourcePath: "packages/react-core/src/hooks/use-copilot-readable.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/hooks/useCopilotReadable.mdx", hook: "useCopilotReadable", description: "The useCopilotReadable hook allows you to provide knowledge to your copilot (e.g. application state).", }, { sourcePath: "packages/react-core/src/hooks/use-coagent-state-render.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/hooks/useCoAgentStateRender.mdx", hook: "useCoAgentStateRender", description: "The useCoAgentStateRender hook allows you to render the state of the agent in the chat.", }, { sourcePath: "packages/react-core/src/hooks/use-coagent.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/hooks/useCoAgent.mdx", hook: "useCoAgent", description: "The useCoAgent hook allows you to share state bidirectionally between your application and the agent.", }, { sourcePath: "packages/react-core/src/hooks/use-copilot-additional-instructions.ts", destinationPath: "showcase/shell-docs/src/content/reference/v1/hooks/useCopilotAdditionalInstructions.mdx", hook: "useCopilotAdditionalInstructions", description: "The useCopilotAdditionalInstructions hook allows you to provide additional instructions to the agent.", }, /* SDKs */ { sourcePath: "sdk-python/copilotkit/langgraph.py", destinationPath: "showcase/shell-docs/src/content/reference/sdk/python/LangGraph.mdx", title: "LangGraph SDK", description: "The CopilotKit LangGraph SDK for Python allows you to build and run LangGraph workflows with CopilotKit.", pythonSymbols: [ "copilotkit_customize_config", "copilotkit_exit", "copilotkit_emit_state", "copilotkit_emit_message", "copilotkit_emit_tool_call", ], }, { sourcePath: "sdk-python/copilotkit/crewai/crewai_sdk.py", destinationPath: "showcase/shell-docs/src/content/reference/sdk/python/CrewAI.mdx", title: "CrewAI SDK", description: "The CopilotKit CrewAI SDK for Python allows you to build and run CrewAI agents with CopilotKit.", pythonSymbols: [ "copilotkit_emit_state", "copilotkit_predict_state", "copilotkit_exit", "copilotkit_emit_message", "copilotkit_emit_tool_call", ], }, /* Agents */ { sourcePath: "sdk-python/copilotkit/langgraph_agui_agent.py", destinationPath: "showcase/shell-docs/src/content/reference/sdk/python/LangGraphAGUIAgent.mdx", title: "LangGraphAGUIAgent", description: "LangGraphAGUIAgent lets you define your agent for use with CopilotKit.", pythonSymbols: ["LangGraphAGUIAgent", "CopilotKitConfig"], }, { sourcePath: "sdk-python/copilotkit/crewai/crewai_agent.py", destinationPath: "showcase/shell-docs/src/content/reference/sdk/python/CrewAIAgent.mdx", title: "CrewAIAgent", description: "CrewAIAgent lets you define your agent for use with CopilotKit.", pythonSymbols: ["CrewAIAgent", "CopilotKitConfig"], }, { sourcePath: "sdk-python/copilotkit/sdk.py", destinationPath: "showcase/shell-docs/src/content/reference/sdk/python/RemoteEndpoints.mdx", title: "Remote Endpoints", description: "CopilotKit Remote Endpoints allow you to connect actions and agents written in Python to your CopilotKit application.", pythonSymbols: ["CopilotKitRemoteEndpoint", "CopilotKitContext"], }, { sourcePath: "packages/sdk-js/src/langgraph/index.ts", destinationPath: "showcase/shell-docs/src/content/reference/sdk/js/LangGraph.mdx", title: "LangGraph SDK", description: "The CopilotKit LangGraph SDK for JavaScript allows you to build and run LangGraph workflows with CopilotKit.", typescriptSymbols: [ "copilotkitCustomizeConfig", "copilotkitExit", "copilotkitEmitState", "copilotkitEmitMessage", "copilotkitEmitToolCall", ], }, ];