useCopilotChatSuggestions
useCopilotChatSuggestions is experimental. The interface is not final and can change without notice.
useCopilotReadable
is a React hook that provides app-state and other information
to the Copilot. Optionally, the hook can also handle hierarchical state within your
application, passing these parent-child relationships to the Copilot.
Usage
Install Dependencies
This component is part of the @copilotkit/react-ui package.
npm install @copilotkit/react-core @copilotkit/react-ui
Simple Usage
import { useCopilotChatSuggestions } from "@copilotkit/react-ui";
export function MyComponent() {
const [employees, setEmployees] = useState([]);
useCopilotChatSuggestions({
instructions: `The following employees are on duty: ${JSON.stringify(employees)}`,
});
}
Dependency Management
import { useCopilotChatSuggestions } from "@copilotkit/react-ui";
export function MyComponent() {
useCopilotChatSuggestions(
{
instructions: "Suggest the most relevant next actions.",
},
[appState],
);
}
In the example above, the suggestions are generated based on the given instructions.
The hook monitors appState
, and updates suggestions accordingly whenever it changes.
Behavior and Lifecycle
The hook registers the configuration with the chat context upon component mount and removes it on unmount, ensuring a clean and efficient lifecycle management.
Parameters
A prompt or instructions for the GPT to generate suggestions.
The minimum number of suggestions to generate. Defaults to 1
.
The maximum number of suggestions to generate. Defaults to 3
.
An optional class name to apply to the suggestions.