Module v1

Module v1 

Source

Modules§

ai_agent_service_client
Generated client implementations.
ai_features_service_client
Generated client implementations.
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.
model_message_with_id
Nested message and enum types in ModelMessageWithId.
stream_chat_request
Nested message and enum types in StreamChatRequest.
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§

AddOrReplaceVariableMutation
AddOrReplaceVariableMutation is a mutation to add or replace a variable in the workbook
AddOrUpdatePanelMutation
this is the “result” of the mutation
AddTabMutation
Add a new tab to the workbook
AppendMessage
This will append a message to an existing conversation A non existent conversation id will raise an error
AssistantContentPart
Content part for assistant messages: can be text, reasoning, or mutation.
AssistantModelMessage
An assistant message containing text
ConversationMetadata
CreateConversationRequest
CreateConversation request will create a new conversation thread if old conversation id is not set, a brand new, clear chat is created If old conversation id is set without a previous message id, the full conversation thread will be copied if previous message id is set with a previous message id, the conversation thread up until that message will be copied the above case is useful for branching a conversation into a new thread
CreateConversationResponse
CreateConversationResponse will return the conversation id for the new conversation
CreateOrUpdateKnowledgeBaseRequest
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.
CreateOrUpdateKnowledgeBaseResponse
CreateOrUpdateKnowledgeBaseResponse is the response to creating/updating a knowledge base
DeleteConversationRequest
DeleteConversationResponse
DeleteRequest
DeleteResponse
DeleteVariablesMutation
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
GenerateSummaryDescriptionRequest
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
GenerateSummaryDescriptionResponse
GetBatchRequest
GetBatchResponse
GetConversationRequest
a GetConversationRequest allows you to retrieve a subset of messages from a conversation thread represented by provided rid. To start from a particular message - you can also provide a message id.
GetConversationResponse
GlobalContext
DefaultContext (no context)
ImagePart
User-supplied image part.
IsAiEnabledForUserRequest
IsAiEnabledForUserResponse
KnowledgeBase
KnowledgeBase represents a knowledge base entry
ListConversationsRequest
Will generate all conversation threads that this user has in this workspace
ListConversationsResponse
ListConversationsResponse is a list of conversations that can be used in a call to GetConversationRequest to get a full conversation from storage. These are ordered by creation time.
ListRequest
ListResponse
ModelMessage
ModelMessage is a discriminated union of system, user, assistant, and tool messages. Each message type has its own structure and content.
ModelMessageWithId
Model message with id allows you to identify the message ID of a given message
ReasoningDelta
A delta (continuation) of a reasoning message from the agent
ReasoningEnd
Indicates the end of a reasoning message from the agent
ReasoningPart
Reasoning part for assistant messages.
ReasoningStart
Indicates the start of a reasoning message from the agent
RemovePanelsMutation
StreamChatRequest
StreamChatRequest is a request to stream chat messages for AI agent
StreamChatResponse
StreamChatResponse is a discriminated union response to a StreamChatRequest
TextDelta
A delta (continuation) of a text message from the agent
TextEnd
Indicates the end of a text message from the agent
TextPart
Text part for user or assistant messages.
TextStart
Indicates the start of a text message from the agent
TimeRange
Timestamp
ToolAction
this is a concise description 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”
UpdateConversationMetadataRequest
UpdateConversationMetadataResponse
UserContentPart
UserModelMessage
A user message containing text
WorkbookAgentServiceStreamChatRequest
StreamChatRequest is a request to stream chat messages for workbook AI agent
WorkbookContext
WorkbookContext contains workbook-specific context fields
WorkbookMutation
WorkbookMutation is a mutation to the workbook
WorkbookUserPresence
WorkbookUserPresence contains the user’s presence in the workbook which is used to describe what the user is viewing at the time of the message.

Enums§

KnowledgeBaseType
KnowledgeBaseType defines the types of knowledge base