Modules§
- assistant_
content_ part - Nested message and enum types in
AssistantContentPart. - knowledge_
base_ service_ client - Generated client implementations.
- model_
message - Nested message and enum types in
ModelMessage. - stream_
chat_ response - Nested message and enum types in
StreamChatResponse. - user_
content_ part - Nested message and enum types in
UserContentPart. - workbook_
agent_ service_ client - Generated client implementations.
- workbook_
mutation - Nested message and enum types in
WorkbookMutation.
Structs§
- AddOr
Replace Variable Mutation - AddOrReplaceVariableMutation is a mutation to add or replace a variable in the workbook
- AddOr
Update Panel Mutation - this is the “result” of the mutation
- AddTab
Mutation - Add a new tab to the workbook
- Assistant
Content Part - Content part for assistant messages: can be text, reasoning, or mutation.
- Assistant
Model Message - An assistant message containing text
- Create
OrUpdate Knowledge Base Request - CreateOrUpdateKnowledgeBaseRequest is a request to create a knowledge from an attachment in the attachment’s workspace. Subsequent calls for the same attachment will overwrite the existing knowledge base.
- Create
OrUpdate Knowledge Base Response - CreateOrUpdateKnowledgeBaseResponse is the response to creating/updating a knowledge base
- Delete
Request - Delete
Response - Delete
Variables Mutation - DeleteVariablesMutation is a mutation to delete variables from the workbook
- Error
- An error that occurred during the chat session
- Finish
- Indicates the end of a chat session
- Generate
Summary Description Request - generate summary description is intentionally going to return the generated description to the frontend rather than storing it in the knowledge base directly because the description needs to be accepted by the user
- Generate
Summary Description Response - GetBatch
Request - GetBatch
Response - Image
Part - User-supplied image part.
- Knowledge
Base - KnowledgeBase represents a knowledge base entry
- List
Request - List
Response - Model
Message - ModelMessage is a discriminated union of system, user, assistant, and tool messages. Each message type has its own structure and content.
- Reasoning
Delta - A delta (continuation) of a reasoning message from the agent
- Reasoning
End - Indicates the end of a reasoning message from the agent
- Reasoning
Part - Reasoning part for assistant messages.
- Reasoning
Start - Indicates the start of a reasoning message from the agent
- Remove
Panels Mutation - Stream
Chat Request - StreamChatRequest is a request to stream chat messages for workbook AI agent
- Stream
Chat Response - StreamChatResponse is a discriminated union response to a StreamChatRequest
- Text
Delta - A delta (continuation) of a text message from the agent
- TextEnd
- Indicates the end of a text message from the agent
- Text
Part - Text part for user or assistant messages.
- Text
Start - Indicates the start of a text message from the agent
- Time
Range - Timestamp
- Tool
Action - this is a concise descirption of a tool call that the agent is making internally
without revealing too much detail about the tool call, it informs the user what the agent is doing
at a high level. the format is:
{tool_action_verb} {tool_target}for example: “Search channels for My Datasource” - User
Content Part - User
Model Message - A user message containing text
- Workbook
Mutation - WorkbookMutation is a mutation to the workbook
Enums§
- Knowledge
Base Type - KnowledgeBaseType defines the types of knowledge base