archastro.platform.types.chat

  1# Copyright (c) 2026 ArchAstro Inc. Licensed under the MIT License.
  2# This file is auto-generated by @archastro/sdk-generator. Do not edit.
  3# Content hash: 43c3317ab780
  4
  5from typing import Any, Literal
  6
  7from pydantic import BaseModel, Field
  8
  9from .common import Agent, Message
 10from .teams import Team
 11from .threads import Thread
 12from .users import User
 13
 14
 15class ChatMember(BaseModel):
 16    """
 17    A participant in a chat thread, which may be either a human user or an AI agent. Exactly one of `user` or `agent` is populated depending on `type`.
 18    """
 19
 20    agent: Agent | None = Field(
 21        default=None,
 22        description='Full agent object for this member. Populated when `type` is `"agent"`; `null` for user members.',
 23    )
 24    membership_type: str | None = Field(
 25        default=None,
 26        description='Role of this member within the thread. Common values are `"owner"` and `"member"`. `null` when the membership type is not applicable.',
 27    )
 28    type: str = Field(
 29        ...,
 30        description='Kind of participant. One of `"user"` (a human user) or `"agent"` (an AI agent).',
 31    )
 32    user: User | None = Field(
 33        default=None,
 34        description='Full user object for this member. Populated when `type` is `"user"`; `null` for agent members.',
 35    )
 36
 37
 38class ChatRoomModel(BaseModel):
 39    """
 40    A point-in-time snapshot of a chat room's state, including its loaded messages, member roster, and pagination cursors. Returned when loading or refreshing a thread's message list.
 41    """
 42
 43    after_cursor: str | None = Field(
 44        default=None,
 45        description="Opaque cursor to pass when fetching messages newer than those in this snapshot. `null` when this snapshot already reflects the latest messages.",
 46    )
 47    agent: Agent | None = Field(
 48        default=None,
 49        description="The agent associated with this chat room. `null` when no agent is attached.",
 50    )
 51    before_cursor: str | None = Field(
 52        default=None,
 53        description="Opaque cursor to pass when fetching messages older than those in this snapshot. `null` when the beginning of the thread history has been reached.",
 54    )
 55    is_transient: bool = Field(
 56        ...,
 57        description="Whether this thread is ephemeral. Transient threads are not retained in long-term storage and may be deleted when the session ends.",
 58    )
 59    members: list[ChatMember] = Field(
 60        ...,
 61        description="All active members of the chat room, including both human users and agents.",
 62    )
 63    messages: list[Message] = Field(
 64        ...,
 65        description="The page of messages currently loaded for the thread, ordered chronologically. Use `before_cursor` or `after_cursor` to page through additional history.",
 66    )
 67    messages_loaded_on_last_update: int | None = Field(
 68        default=None,
 69        description="Number of messages that were added to the snapshot in the most recent incremental update. `null` on the initial load.",
 70    )
 71    team: Team | None = Field(
 72        default=None,
 73        description="The team that owns this thread. `null` for threads scoped to an individual user rather than a team.",
 74    )
 75    thread: Thread = Field(
 76        ...,
 77        description="The parent thread whose message history and membership this snapshot represents.",
 78    )
 79
 80
 81class ChatForkThreadResponse(BaseModel):
 82    """
 83    Response returned after forking a chat thread. Contains the new thread, its initial chat-room snapshot, and the owning team when applicable.
 84    """
 85
 86    chat_model: ChatRoomModel | None = Field(
 87        default=None,
 88        description="Initial chat-room render snapshot for the forked thread, including members and loaded messages. `null` for transient threads whose room model is suppressed.",
 89    )
 90    team: Team | None = Field(
 91        default=None,
 92        description="Team that owns the forked thread. Present only when the original thread was team-scoped; `null` for personal threads.",
 93    )
 94    thread: Thread = Field(
 95        ..., description="The newly-created thread produced by the fork operation."
 96    )
 97
 98
 99class ChatLoadMoreMessagesResponse(BaseModel):
100    """
101    Response returned after loading an additional page of chat messages. Contains a refreshed chat-room snapshot with the newly-fetched messages merged in.
102    """
103
104    data: ChatRoomModel = Field(
105        ...,
106        description="Updated chat-room snapshot for the thread, incorporating the newly-loaded page of messages alongside any previously loaded messages.",
107    )
108
109
110class ChatLocalToolFunction(BaseModel):
111    """
112    A function implemented by the client connected to a personal thread.
113    """
114
115    description: str
116    name: str
117    parameters: dict[str, Any]
118
119
120class ChatLocalToolDefinition(BaseModel):
121    """
122    An OpenAI-compatible local function definition supplied while joining a personal thread.
123    """
124
125    function: ChatLocalToolFunction
126    type: Literal["function"]
127
128
129class ChatMarkThreadReadResponse(BaseModel):
130    """
131    Response returned after marking a chat thread as read. Confirms that the read marker was successfully recorded for the authenticated user.
132    """
133
134    success: bool = Field(
135        ...,
136        description="Indicates whether the read marker was successfully applied. Always `true` on success; errors are returned as channel error replies rather than a `false` value here.",
137    )
138
139
140class ChatMessageListResponse(BaseModel):
141    """
142    Response returned when listing the messages of a joined chat thread. Contains the set of messages currently loaded for the thread.
143    """
144
145    messages: list[Message] = Field(
146        ...,
147        description="Ordered array of message objects currently loaded for the thread, from oldest to newest. Use the `load_more_messages` channel message to fetch earlier pages.",
148    )
149
150
151class ChatPostMessageResponse(BaseModel):
152    """
153    Response returned after successfully posting a message to a chat thread. Contains the persisted message object echoed back to the sender.
154    """
155
156    message: Message = Field(
157        ...,
158        description="The message that was created and stored. Contains the full message object including its assigned ID, author, content, and timestamps.",
159    )