mirror of
https://github.com/onyx-dot-app/onyx.git
synced 2026-10-22 19:32:55 -05:00
a51f0d7cb2
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
113 lines
3.9 KiB
Go
113 lines
3.9 KiB
Go
// Package models defines API request/response types for the Onyx CLI.
|
|
package models
|
|
|
|
import "time"
|
|
|
|
// AgentSummary represents an agent from the API.
|
|
type AgentSummary struct {
|
|
ID int `json:"id"`
|
|
Name string `json:"name"`
|
|
Description string `json:"description"`
|
|
IsDefaultPersona bool `json:"is_default_persona"`
|
|
IsVisible bool `json:"is_visible"`
|
|
}
|
|
|
|
// ChatSessionSummary is a brief session listing.
|
|
type ChatSessionSummary struct {
|
|
ID string `json:"id"`
|
|
Name *string `json:"name"`
|
|
AgentID *int `json:"persona_id"`
|
|
Created time.Time `json:"time_created"`
|
|
}
|
|
|
|
// ChatSessionDetails is a session with timestamps as strings.
|
|
type ChatSessionDetails struct {
|
|
ID string `json:"id"`
|
|
Name *string `json:"name"`
|
|
AgentID *int `json:"persona_id"`
|
|
Created string `json:"time_created"`
|
|
Updated string `json:"time_updated"`
|
|
}
|
|
|
|
// ChatMessageDetail is a single message in a session.
|
|
type ChatMessageDetail struct {
|
|
MessageID int `json:"message_id"`
|
|
ParentMessage *int `json:"parent_message"`
|
|
LatestChildMessage *int `json:"latest_child_message"`
|
|
Message string `json:"message"`
|
|
MessageType string `json:"message_type"`
|
|
TimeSent string `json:"time_sent"`
|
|
Error *string `json:"error"`
|
|
}
|
|
|
|
// ChatSessionDetailResponse is the full session detail from the API.
|
|
type ChatSessionDetailResponse struct {
|
|
ChatSessionID string `json:"chat_session_id"`
|
|
Description *string `json:"description"`
|
|
AgentID *int `json:"persona_id"`
|
|
AgentName *string `json:"persona_name"`
|
|
Messages []ChatMessageDetail `json:"messages"`
|
|
}
|
|
|
|
// ChatFileType represents a file type for uploads.
|
|
type ChatFileType string
|
|
|
|
const (
|
|
ChatFileImage ChatFileType = "image"
|
|
ChatFileDoc ChatFileType = "document"
|
|
ChatFilePlainText ChatFileType = "plain_text"
|
|
ChatFileCSV ChatFileType = "csv"
|
|
)
|
|
|
|
// FileDescriptorPayload is a file descriptor for send-message requests.
|
|
type FileDescriptorPayload struct {
|
|
ID string `json:"id"`
|
|
Type ChatFileType `json:"type"`
|
|
Name string `json:"name,omitempty"`
|
|
}
|
|
|
|
// UserFileSnapshot represents an uploaded file.
|
|
type UserFileSnapshot struct {
|
|
ID string `json:"id"`
|
|
Name string `json:"name"`
|
|
FileID string `json:"file_id"`
|
|
ChatFileType ChatFileType `json:"chat_file_type"`
|
|
}
|
|
|
|
// CategorizedFilesSnapshot is the response from file upload.
|
|
type CategorizedFilesSnapshot struct {
|
|
UserFiles []UserFileSnapshot `json:"user_files"`
|
|
}
|
|
|
|
// ChatSessionCreationInfo is included when creating a new session inline.
|
|
type ChatSessionCreationInfo struct {
|
|
AgentID int `json:"persona_id"`
|
|
}
|
|
|
|
// SendMessagePayload is the request body for POST /api/chat/send-chat-message.
|
|
type SendMessagePayload struct {
|
|
Message string `json:"message"`
|
|
ChatSessionID *string `json:"chat_session_id,omitempty"`
|
|
ChatSessionInfo *ChatSessionCreationInfo `json:"chat_session_info,omitempty"`
|
|
ParentMessageID *int `json:"parent_message_id"`
|
|
FileDescriptors []FileDescriptorPayload `json:"file_descriptors"`
|
|
Origin string `json:"origin"`
|
|
IncludeCitations bool `json:"include_citations"`
|
|
Stream bool `json:"stream"`
|
|
}
|
|
|
|
// SearchDoc represents a document found during search.
|
|
type SearchDoc struct {
|
|
DocumentID string `json:"document_id"`
|
|
SemanticIdentifier string `json:"semantic_identifier"`
|
|
Link *string `json:"link"`
|
|
SourceType string `json:"source_type"`
|
|
}
|
|
|
|
// Placement indicates where a stream event belongs in the conversation.
|
|
type Placement struct {
|
|
TurnIndex int `json:"turn_index"`
|
|
TabIndex int `json:"tab_index"`
|
|
SubTurnIndex *int `json:"sub_turn_index"`
|
|
}
|