Appearance
AI Assistant Deprecated
AI Assistant is a chat-based AI that generates and corrects SQL, creates charts, and answers questions about how to use Codatum, based on natural language instructions. Its successor is AI agent.
In workspaces where the AI agent feature is available, the AI agent is shown in the same place instead, and you can't select AI Assistant separately. See Availability for details.
WARNING
This feature is deprecated and will be removed in a future release.
Key features
- Sending data to the LLM: How data is handled for training purposes, and what information might be sent to the LLM.
- Availability: Usable only where the AI agent feature isn't provided.
- Enabling it: Enable it under AI feature settings in workspace settings.
- Opening it: Open it from global nav, a shortcut, or a notebook.
- Roles: AI Analyst / AI Support.
- Display modes: Dock sidebar / float / fullscreen.
- Sessions: Starting a new session, history, and language/connection settings.
- Notebook integration: Applying SQL/charts, fixing errors, and more.
Sending data to the LLM
Only external LLM services that contractually guarantee your input data won't be used for training are used. If you want to use your own API key, you can configure this under Custom in AI profile.
AI Assistant might send SQL, the schema of referenced tables, and the messages you enter to the LLM service. Check your organization's AI usage policy before using this feature.
Availability
AI Assistant can be used in workspaces where the AI agent feature isn't provided. Where the AI agent feature is available, AI agent is shown in the same place instead.
Using it requires the following.
- Write permission on the notebook.
- AI features overall and AI Assistant enabled under AI feature settings in workspace settings.
Enabling it
Enabling AI features requires Workspace Owner permission.
- Open global nav > Workspace settings > AI feature settings.
- Turn on AI features overall using the switch at the top of the screen.
- Turn on AI Assistant under Available AI features.
You can also individually enable the following features on the same screen.
| Feature | Description |
|---|---|
| AI Assistant | A chat-based AI that creates SQL and charts and also answers questions |
| AI code completion | Provides inline SQL completion within a SQL block |
| AI name suggestion | Automatically suggests names for SQL and charts |
Where the AI agent feature is available, the same switch is labeled AI Agent instead. For setup steps, see Enabling the AI agent.
Opening it
You can open it in any of the following ways.
- Open AI Assistant at the bottom of global nav. If it isn't enabled, go to the enablement screen from Enable AI Assistant.
- Use the AI Assistant shortcut (⌘+L / Ctrl+L by default; see Keyboard shortcuts).
- On a doc page, type
/and select AI Analyst. - From the menu at the top right of a SQL block, select Open with this SQL, or Performance optimization / SQL refactoring.
- Select Fix with AI on a SQL block that has an error.
- Start a how-to session from AI support in the help menu.
- Select Summarize, Revise and Refine, or Translate to from the menu shown when you select text.
Roles
You can switch between the following roles in the chat screen.
| Role | Description |
|---|---|
| AI Analyst | Assists with generating and correcting SQL and charts |
| AI Support | Answers questions about how to use Codatum and provides guidance on its features |
Display modes
You can switch the display from the header.
| Display | Description |
|---|---|
| Dock sidebar | Pins it to the edge of the screen |
| Float | Displays it floating on screen, and you can move it |
| Fullscreen | Shows the chat in a larger view |
Sessions
You can perform the following actions from the header.
| Action | Description |
|---|---|
| Start new session | Starts a new session |
| Session history | Lists recent sessions and lets you switch between them |
In the chat input field, you can configure the following.
| Item | Description |
|---|---|
| Response language | The Assistant's response language |
| Connection | In AI Analyst mode, the connection the response assumes (this determines the SQL syntax assumed) |
Sending a message uses Request. From the input field, you can pass context with Add notebook SQL / Add table metadata.
Notebook integration
While you have a notebook's doc page open, you can apply SQL or charts generated by AI Assistant to the notebook.
- Drag the generated SQL, or select Apply, to reflect it in the original SQL block.
- For charts too, you can Apply to the source chart or drag it onto a notebook page.
- From a SQL block, you can start a session that includes the target SQL using Open with this SQL, Fix with AI on an error, and similar.
AI Assistant presents suggestions in the chat, and you apply them to the notebook yourself using Apply and similar. For autonomous notebook editing, see Agent mode in AI agent.
Relationship with the AI agent
| Item | AI Assistant | AI agent |
|---|---|---|
| Availability | When the AI agent feature isn't available | When the AI agent feature is available |
| How work proceeds | Suggests in chat; you apply the changes | Proceeds autonomously with analysis, notebook editing, and more |
| Context | Adding SQL/tables to a message, and similar | @ mentions, agent context, AI profile, and more |
| Model and permission settings | Workspace AI feature settings | AI profile |
For details on the successor feature, see AI agent.