Documentation
¶
Index ¶
- Constants
- type ActiveFeedState
- type ApprovalCallback
- type ApprovalCallbackPayload
- type ApprovalCallbackResult
- type ApprovalEditor
- type ApprovalForgeView
- type ApprovalMeta
- type ApprovalOption
- type AssistantMessageState
- type AssistantState
- type AsyncOperationState
- type ConversationPage
- type ConversationState
- type ConversationStateResponse
- type CreateConversationInput
- type DecideToolApprovalInput
- type DecideToolApprovalOutput
- type Direction
- type DownloadFileInput
- type DownloadFileOutput
- type EditQueuedTurnInput
- type ElicitationState
- type ElicitationStatus
- type ExecutionPageState
- type ExecutionState
- type ExportResourcesInput
- type ExportResourcesOutput
- type FeedActivation
- type FeedMatch
- type FeedSpec
- type FeedState
- type FileEntry
- type GetMessagesInput
- type GetResourceOutput
- type GetTemplateInput
- type GetTemplateOutput
- type GetTranscriptInput
- type ImportResourcesInput
- type ImportResourcesOutput
- type LinkedConversationEntry
- type LinkedConversationPage
- type LinkedConversationState
- type ListConversationsInput
- type ListFilesInput
- type ListFilesOutput
- type ListLinkedConversationsInput
- type ListPendingElicitationsInput
- type ListPendingToolApprovalsInput
- type ListResourcesInput
- type ListResourcesOutput
- type ListTemplatesInput
- type ListTemplatesOutput
- type MessagePage
- type ModelStepState
- type MoveQueuedTurnInput
- type PageInput
- type PendingElicitation
- type PendingToolApproval
- type PendingToolApprovalPage
- type PlanFeedPayload
- type PlanStep
- type QuerySelector
- type ResolveElicitationInput
- type Resource
- type ResourceRef
- type SaveResourceInput
- type StarterTask
- type SteerTurnInput
- type SteerTurnOutput
- type StreamEventsInput
- type TemplateListItem
- type ToolDefinitionInfo
- type ToolStepState
- type TurnState
- type TurnStatus
- type UpdateConversationInput
- type UploadFileInput
- type UploadFileOutput
- type UsageSummary
- type UserMessageState
- type WorkspaceAgentInfo
- type WorkspaceCapabilities
- type WorkspaceDefaults
- type WorkspaceMetadata
- type WorkspaceModelInfo
Constants ¶
View Source
const ( DirectionBefore = data.DirectionBefore DirectionAfter = data.DirectionAfter DirectionLatest = data.DirectionLatest )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActiveFeedState ¶
type ActiveFeedState struct {
FeedID string `json:"feedId"`
Title string `json:"title"`
ItemCount int `json:"itemCount"`
Data json.RawMessage `json:"data,omitempty"`
}
type ApprovalCallback ¶
type ApprovalCallbackPayload ¶
type ApprovalCallbackPayload struct {
Approval *ApprovalMeta `json:"approval,omitempty"`
EditedFields map[string]interface{} `json:"editedFields,omitempty"`
OriginalArgs map[string]interface{} `json:"originalArgs,omitempty"`
}
type ApprovalCallbackResult ¶
type ApprovalEditor ¶
type ApprovalForgeView ¶
type ApprovalForgeView struct {
WindowRef string `json:"windowRef,omitempty"`
ContainerRef string `json:"containerRef,omitempty"`
DataSource string `json:"dataSource,omitempty"`
Callbacks []*ApprovalCallback `json:"callbacks,omitempty"`
}
type ApprovalMeta ¶
type ApprovalMeta struct {
Type string `json:"type,omitempty"`
ToolName string `json:"toolName,omitempty"`
Title string `json:"title,omitempty"`
Message string `json:"message,omitempty"`
AcceptLabel string `json:"acceptLabel,omitempty"`
RejectLabel string `json:"rejectLabel,omitempty"`
CancelLabel string `json:"cancelLabel,omitempty"`
Editors []*ApprovalEditor `json:"editors,omitempty"`
Forge *ApprovalForgeView `json:"forge,omitempty"`
}
type ApprovalOption ¶
type AssistantMessageState ¶
type AssistantState ¶
type AssistantState struct {
Preamble *AssistantMessageState `json:"preamble,omitempty"`
Final *AssistantMessageState `json:"final,omitempty"`
}
type AsyncOperationState ¶
type ConversationPage ¶
type ConversationPage = data.ConversationPage
type ConversationState ¶
type ConversationState struct {
ConversationID string `json:"conversationId"`
Turns []*TurnState `json:"turns"`
Feeds []*ActiveFeedState `json:"feeds,omitempty"`
}
type ConversationStateResponse ¶
type ConversationStateResponse struct {
SchemaVersion string `json:"schemaVersion"`
Conversation *ConversationState `json:"conversation"`
Feeds []*ActiveFeedState `json:"feeds,omitempty"`
Usage *UsageSummary `json:"usage,omitempty"`
EventCursor string `json:"eventCursor,omitempty"`
}
type CreateConversationInput ¶
type DecideToolApprovalInput ¶
type DecideToolApprovalInput struct {
ID string `json:"id,omitempty"`
Action string `json:"action,omitempty"`
UserID string `json:"userId,omitempty"`
Reason string `json:"reason,omitempty"`
Note string `json:"note,omitempty"`
Decision string `json:"decision,omitempty"`
EditedFields map[string]interface{} `json:"editedFields,omitempty"`
CallbackState map[string]interface{} `json:"callbackState,omitempty"`
Payload map[string]interface{} `json:"payload,omitempty"`
}
type DownloadFileInput ¶
type DownloadFileOutput ¶
type EditQueuedTurnInput ¶
type ElicitationState ¶
type ElicitationState struct {
ElicitationID string `json:"elicitationId"`
Status ElicitationStatus `json:"status"`
Message string `json:"message,omitempty"`
RequestedSchema json.RawMessage `json:"requestedSchema,omitempty"`
CallbackURL string `json:"callbackUrl,omitempty"`
ResponsePayload json.RawMessage `json:"responsePayload,omitempty"`
}
type ElicitationStatus ¶
type ElicitationStatus string
const ( ElicitationStatusPending ElicitationStatus = "pending" ElicitationStatusAccepted ElicitationStatus = "accepted" ElicitationStatusDeclined ElicitationStatus = "declined" ElicitationStatusCanceled ElicitationStatus = "canceled" )
type ExecutionPageState ¶
type ExecutionPageState struct {
PageID string `json:"pageId"`
AssistantMessageID string `json:"assistantMessageId"`
ParentMessageID string `json:"parentMessageId"`
TurnID string `json:"turnId"`
Iteration int `json:"iteration"`
Mode string `json:"mode,omitempty"`
Status string `json:"status,omitempty"`
ModelSteps []*ModelStepState `json:"modelSteps,omitempty"`
ToolSteps []*ToolStepState `json:"toolSteps,omitempty"`
PreambleMessageID string `json:"preambleMessageId,omitempty"`
FinalAssistantMessageID string `json:"finalAssistantMessageId,omitempty"`
Preamble string `json:"preamble,omitempty"`
Content string `json:"content,omitempty"`
FinalResponse bool `json:"finalResponse"`
}
type ExecutionState ¶
type ExecutionState struct {
Pages []*ExecutionPageState `json:"pages"`
ActivePageIdx int `json:"activePageIndex"`
TotalElapsedMs int64 `json:"totalElapsedMs"`
}
type ExportResourcesInput ¶
type ExportResourcesInput struct {
Kinds []string `json:"kinds,omitempty"`
}
type ExportResourcesOutput ¶
type FeedActivation ¶
type FeedActivation struct {
Kind string `yaml:"kind,omitempty" json:"kind,omitempty"`
Scope string `yaml:"scope,omitempty" json:"scope,omitempty"`
Service string `yaml:"service,omitempty" json:"service,omitempty"`
Method string `yaml:"method,omitempty" json:"method,omitempty"`
}
FeedActivation controls how feed data is gathered.
type FeedMatch ¶
type FeedMatch struct {
Service string `yaml:"service" json:"service"`
Method string `yaml:"method" json:"method"`
}
FeedMatch defines which tool calls trigger this feed.
type FeedSpec ¶
type FeedSpec struct {
ID string `yaml:"id" json:"id"`
Title string `yaml:"title,omitempty" json:"title,omitempty"`
Match FeedMatch `yaml:"match" json:"match"`
Activation FeedActivation `yaml:"activation,omitempty" json:"activation,omitempty"`
DataSource map[string]interface{} `yaml:"dataSource,omitempty" json:"dataSource,omitempty"`
UI interface{} `yaml:"ui,omitempty" json:"ui,omitempty"`
}
FeedSpec describes a tool feed loaded from workspace YAML.
type FeedState ¶
type FeedState struct {
FeedID string `json:"feedId"`
Title string `json:"title"`
ItemCount int `json:"itemCount"`
ToolName string `json:"toolName,omitempty"`
}
FeedState tracks active feeds for a conversation.
type GetMessagesInput ¶
type GetResourceOutput ¶
type GetTemplateInput ¶
type GetTemplateOutput ¶
type GetTemplateOutput struct {
Name string `json:"name,omitempty"`
Format string `json:"format,omitempty"`
Description string `json:"description,omitempty"`
Instructions string `json:"instructions,omitempty"`
Fences []map[string]interface{} `json:"fences,omitempty"`
Schema map[string]interface{} `json:"schema,omitempty"`
Examples []map[string]interface{} `json:"examples,omitempty"`
IncludedDocument bool `json:"includedDocument,omitempty"`
}
type GetTranscriptInput ¶
type ImportResourcesInput ¶
type ImportResourcesOutput ¶
type LinkedConversationEntry ¶
type LinkedConversationEntry struct {
ConversationID string `json:"conversationId"`
ParentConversationID string `json:"parentConversationId,omitempty"`
ParentTurnID string `json:"parentTurnId,omitempty"`
AgentID string `json:"agentId,omitempty"`
Title string `json:"title,omitempty"`
Status string `json:"status,omitempty"`
Response string `json:"response,omitempty"`
CreatedAt time.Time `json:"createdAt"`
UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}
type LinkedConversationPage ¶
type LinkedConversationPage struct {
Rows []*LinkedConversationEntry `json:"rows"`
NextCursor string `json:"nextCursor,omitempty"`
PrevCursor string `json:"prevCursor,omitempty"`
HasMore bool `json:"hasMore"`
}
type LinkedConversationState ¶
type LinkedConversationState struct {
ConversationID string `json:"conversationId"`
ParentConversationID string `json:"parentConversationId,omitempty"`
ParentTurnID string `json:"parentTurnId,omitempty"`
ToolCallID string `json:"toolCallId,omitempty"`
AgentID string `json:"agentId,omitempty"`
Title string `json:"title,omitempty"`
Status string `json:"status,omitempty"`
Response string `json:"response,omitempty"`
CreatedAt time.Time `json:"createdAt,omitempty"`
UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}
type ListConversationsInput ¶
type ListFilesInput ¶
type ListFilesOutput ¶
type ListPendingElicitationsInput ¶
type ListPendingElicitationsInput struct {
ConversationID string
}
type ListResourcesInput ¶
type ListResourcesInput struct {
Kind string
}
type ListResourcesOutput ¶
type ListResourcesOutput struct {
Names []string `json:"names,omitempty"`
Resources []*ResourceRef `json:"resources"`
}
type ListTemplatesInput ¶
type ListTemplatesInput struct{}
type ListTemplatesOutput ¶
type ListTemplatesOutput struct {
Items []TemplateListItem `json:"items"`
}
type MessagePage ¶
type MessagePage = data.MessagePage
type ModelStepState ¶
type ModelStepState struct {
ModelCallID string `json:"modelCallId"`
AssistantMessageID string `json:"assistantMessageId"`
Provider string `json:"provider,omitempty"`
Model string `json:"model,omitempty"`
Status string `json:"status,omitempty"`
RequestPayloadID string `json:"requestPayloadId,omitempty"`
ResponsePayloadID string `json:"responsePayloadId,omitempty"`
ProviderRequestPayloadID string `json:"providerRequestPayloadId,omitempty"`
ProviderResponsePayloadID string `json:"providerResponsePayloadId,omitempty"`
StreamPayloadID string `json:"streamPayloadId,omitempty"`
RequestPayload json.RawMessage `json:"requestPayload,omitempty"`
ResponsePayload json.RawMessage `json:"responsePayload,omitempty"`
ProviderRequestPayload json.RawMessage `json:"providerRequestPayload,omitempty"`
ProviderResponsePayload json.RawMessage `json:"providerResponsePayload,omitempty"`
StreamPayload json.RawMessage `json:"streamPayload,omitempty"`
StartedAt *time.Time `json:"startedAt,omitempty"`
CompletedAt *time.Time `json:"completedAt,omitempty"`
}
type MoveQueuedTurnInput ¶
type PendingElicitation ¶
type PendingElicitation struct {
ConversationID string `json:"conversationId"`
ElicitationID string `json:"elicitationId"`
MessageID string `json:"messageId"`
Status string `json:"status"`
Role string `json:"role"`
Type string `json:"type"`
CreatedAt time.Time `json:"createdAt"`
Content string `json:"content,omitempty"`
Elicitation map[string]interface{} `json:"elicitation,omitempty"`
}
type PendingToolApproval ¶
type PendingToolApproval struct {
ID string `json:"id"`
UserID string `json:"userId"`
ConversationID string `json:"conversationId,omitempty"`
TurnID string `json:"turnId,omitempty"`
MessageID string `json:"messageId,omitempty"`
ToolName string `json:"toolName"`
Title string `json:"title,omitempty"`
Arguments map[string]interface{} `json:"arguments,omitempty"`
Metadata map[string]interface{} `json:"metadata,omitempty"`
Status string `json:"status"`
Decision string `json:"decision,omitempty"`
CreatedAt time.Time `json:"createdAt"`
UpdatedAt *time.Time `json:"updatedAt,omitempty"`
ErrorMessage string `json:"errorMessage,omitempty"`
}
type PendingToolApprovalPage ¶
type PendingToolApprovalPage struct {
Rows []*PendingToolApproval `json:"rows"`
Total int `json:"total"`
Limit int `json:"limit"`
Offset int `json:"offset,omitempty"`
HasMore bool `json:"hasMore,omitempty"`
}
type PlanFeedPayload ¶
type QuerySelector ¶
type ResolveElicitationInput ¶
type ResourceRef ¶
type SaveResourceInput ¶
type StarterTask ¶
type SteerTurnInput ¶
type SteerTurnOutput ¶
type StreamEventsInput ¶
type TemplateListItem ¶
type ToolDefinitionInfo ¶
type ToolDefinitionInfo struct {
Name string `json:"name"`
Description string `json:"description,omitempty"`
Parameters map[string]interface{} `json:"parameters,omitempty"`
Required []string `json:"required,omitempty"`
OutputSchema map[string]interface{} `json:"output_schema,omitempty"`
Cacheable bool `json:"cacheable,omitempty"`
}
type ToolStepState ¶
type ToolStepState struct {
ToolCallID string `json:"toolCallId"`
ToolMessageID string `json:"toolMessageId"`
ToolName string `json:"toolName"`
OperationID string `json:"operationId,omitempty"`
Status string `json:"status,omitempty"`
RequestPayloadID string `json:"requestPayloadId,omitempty"`
ResponsePayloadID string `json:"responsePayloadId,omitempty"`
RequestPayload json.RawMessage `json:"requestPayload,omitempty"`
ResponsePayload json.RawMessage `json:"responsePayload,omitempty"`
LinkedConversationID string `json:"linkedConversationId,omitempty"`
LinkedConversationAgentID string `json:"linkedConversationAgentId,omitempty"`
LinkedConversationTitle string `json:"linkedConversationTitle,omitempty"`
StartedAt *time.Time `json:"startedAt,omitempty"`
CompletedAt *time.Time `json:"completedAt,omitempty"`
AsyncOperation *AsyncOperationState `json:"asyncOperation,omitempty"`
}
type TurnState ¶
type TurnState struct {
TurnID string `json:"turnId"`
Status TurnStatus `json:"status"`
User *UserMessageState `json:"user,omitempty"`
Execution *ExecutionState `json:"execution,omitempty"`
Assistant *AssistantState `json:"assistant,omitempty"`
Elicitation *ElicitationState `json:"elicitation,omitempty"`
LinkedConversations []*LinkedConversationState `json:"linkedConversations,omitempty"`
CreatedAt time.Time `json:"createdAt,omitempty"`
QueueSeq int `json:"queueSeq,omitempty"`
StartedByMessageID string `json:"startedByMessageId,omitempty"`
}
type TurnStatus ¶
type TurnStatus string
const ( TurnStatusQueued TurnStatus = "queued" TurnStatusRunning TurnStatus = "running" TurnStatusWaitingForUser TurnStatus = "waiting_for_user" TurnStatusCompleted TurnStatus = "completed" TurnStatusFailed TurnStatus = "failed" TurnStatusCanceled TurnStatus = "canceled" )
type UpdateConversationInput ¶
type UploadFileInput ¶
type UploadFileOutput ¶
type UsageSummary ¶
type UserMessageState ¶
type WorkspaceAgentInfo ¶
type WorkspaceAgentInfo struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
ModelRef string `json:"modelRef,omitempty"`
StarterTasks []StarterTask `json:"starterTasks,omitempty"`
}
type WorkspaceCapabilities ¶
type WorkspaceCapabilities struct {
AgentAutoSelection bool `json:"agentAutoSelection,omitempty"`
ModelAutoSelection bool `json:"modelAutoSelection,omitempty"`
ToolAutoSelection bool `json:"toolAutoSelection,omitempty"`
CompactConversation bool `json:"compactConversation,omitempty"`
PruneConversation bool `json:"pruneConversation,omitempty"`
AnonymousSession bool `json:"anonymousSession,omitempty"`
MessageCursor bool `json:"messageCursor,omitempty"`
StructuredElicitation bool `json:"structuredElicitation,omitempty"`
TurnStartedEvent bool `json:"turnStartedEvent,omitempty"`
}
type WorkspaceDefaults ¶
type WorkspaceMetadata ¶
type WorkspaceMetadata struct {
WorkspaceRoot string `json:"workspaceRoot,omitempty"`
DefaultAgent string `json:"defaultAgent,omitempty"`
DefaultModel string `json:"defaultModel,omitempty"`
DefaultEmbedder string `json:"defaultEmbedder,omitempty"`
Defaults *WorkspaceDefaults `json:"defaults,omitempty"`
Capabilities WorkspaceCapabilities `json:"capabilities,omitempty"`
Agents []string `json:"agents,omitempty"`
Models []string `json:"models,omitempty"`
AgentInfos []WorkspaceAgentInfo `json:"agentInfos,omitempty"`
ModelInfos []WorkspaceModelInfo `json:"modelInfos,omitempty"`
Version string `json:"version,omitempty"`
}
type WorkspaceModelInfo ¶
Click to show internal directories.
Click to hide internal directories.