use Configure Suggestions
React hook for configuring chat suggestions
Overview
useConfigureSuggestions is a React hook that registers a suggestions configuration with the CopilotKit core. It supports two modes: static suggestions (a fixed list) and dynamic suggestions (generated by the agent based on instructions).
The configuration is automatically registered on mount and removed on unmount. When the configuration changes, suggestions are reloaded automatically.
To read the suggestions and render your own pills, see useSuggestions. For suggestions in a chat UI, see Prebuilt components.
Signature
import { useConfigureSuggestions } from "@copilotkit/react-core/v2";
function useConfigureSuggestions(
config: SuggestionsConfigInput | null | undefined,
deps?: ReadonlyArray<unknown>,
): void;Parameters
Prop
Type
Usage
Static Suggestions
function WelcomeSuggestions() {
useConfigureSuggestions({
suggestions: [
{ title: "Get started", message: "Help me get started with my project" },
{ title: "Show examples", message: "Show me some example use cases" },
{
title: "Documentation",
message: "Where can I find the documentation?",
},
],
available: "before-first-message",
});
return null;
}Dynamic Suggestions
function SmartSuggestions() {
useConfigureSuggestions({
instructions:
"Suggest follow-up questions based on the conversation so far. " +
"Focus on actionable next steps the user might want to take.",
maxSuggestions: 3,
minSuggestions: 1,
available: "after-first-message",
});
return null;
}Dynamic Suggestions with Dependencies
function ContextualSuggestions() {
const [topic, setTopic] = useState("general");
useConfigureSuggestions(
{
instructions: `Generate suggestions related to the topic: ${topic}`,
maxSuggestions: 3,
},
[topic],
);
return (
<select value={topic} onChange={(e) => setTopic(e.target.value)}>
<option value="general">General</option>
<option value="technical">Technical</option>
<option value="business">Business</option>
</select>
);
}Conditionally Disabling Suggestions
function ConditionalSuggestions({ enabled }: { enabled: boolean }) {
useConfigureSuggestions(
enabled
? {
suggestions: [{ title: "Help", message: "I need help" }],
}
: null,
);
return null;
}Targeting a Specific Agent
function AgentSpecificSuggestions() {
useConfigureSuggestions({
instructions: "Suggest data analysis tasks the user can perform.",
maxSuggestions: 4,
providerAgentId: "analyst",
consumerAgentId: "analyst",
available: "always",
});
return null;
}Behavior
- Automatic Registration: The configuration is registered with the core on mount and removed on unmount.
- Change Detection: The hook serializes the configuration to JSON for comparison. If the serialized value changes, the hook removes the old configuration and registers the new one. Then the suggestions reload.
- Dependency Tracking: When a
depsarray is provided, any change in its values triggers a suggestion reload, even if the serialized configuration itself has not changed. - Configuration Discrimination: The hook distinguishes between dynamic and static configurations by checking for the presence of the
instructionsproperty. Ifinstructionsis present, it is treated as a dynamic configuration. - Disabled State: Passing
null,undefined, or a configuration withavailable: "disabled"will remove any previously registered configuration and produce no suggestions. - isLoading Normalization: For static suggestions, the
isLoadingfield defaults tofalseif not explicitly provided.
How is this guide?