Chats

albert.resources.chats

ChatComponentType

Bases: str, Enum

Component type of a chat message.

Attributes:

Name	Type	Description
TEXT
IMAGE
REASONING_BLOCK
NOTEBOOK_CITATION
PRODUCT_CARD
INGREDIENT_CARD

TEXT

TEXT = 'text'

IMAGE

IMAGE = 'image'

REASONING_BLOCK

REASONING_BLOCK = 'reasoning_block'

NOTEBOOK_CITATION

NOTEBOOK_CITATION = 'notebook_citation'

PRODUCT_CARD

PRODUCT_CARD = 'product_card'

INGREDIENT_CARD

INGREDIENT_CARD = 'ingredient_card'

ChatUserType

Bases: str, Enum

Origin of a chat message (user-submitted vs system-generated).

Attributes:

Name	Type	Description
USER
SYSTEM

USER

USER = 'user'

SYSTEM

SYSTEM = 'system'

ChatRole

Bases: str, Enum

Chat role for a message, as used by the LLM conversation model.

Attributes:

Name	Type	Description
USER
ASSISTANT

USER

USER = 'user'

ASSISTANT

ASSISTANT = 'assistant'

ChatFolderType

Bases: str, Enum

Hierarchy level of a chat folder.

Attributes:

Name	Type	Description
ROOT
CHILD

ROOT

ROOT = 'root'

CHILD

CHILD = 'child'

ChatSession

Bases: BaseResource

A persistent chat session.

Attributes:

Name	Type	Description
id	str | None	The session ID assigned by the server.
name	str	The display name of the session.
parent_id	str | None	Optional folder ID that contains this session.
source_session_id	str | None	Optional external session identifier for linking to a source system.

id

id: str | None = Field(default=None)

name

name: str

parent_id

parent_id: str | None = Field(
    default=None, alias="parentId"
)

source_session_id

source_session_id: str | None = Field(
    default=None, alias="sourceSessionId"
)

ChatMessage

Bases: BaseResource

A single message component within a chat session.

Attributes:

Name	Type	Description
id	str | None	The message ID assigned by the server.
source_request_id	str | None	Client-generated request trace identifier. Auto-generated on create if not set.
sequence	str | None	Zero-padded position of this message in the session (e.g. "000", "001").
component_type	ChatComponentType	The type of message component (e.g. text, image, reasoning_block).
user_type	ChatUserType	Whether the message originates from a user or the system.
role	ChatRole	The LLM conversation role (user or assistant).
content	str | dict[str, Any]	Component-type-specific payload; a string or free-form object.
parent_id	str | None	The session ID this message belongs to. Present in GET responses; derived from the URL path on create.
component_id	str | None	Component instance identifier.
parent_request_id	str | None	Parent request ID for branched messages.
branch_index	int | None	Branch index for branched messages.
span_id	str | None	Span/trace identifier.
is_visible	bool | None	Whether the component is visible in the UI.
display_feedback	bool | None	Whether to show the feedback UI for this message.

id

id: str | None = Field(default=None)

source_request_id

source_request_id: str | None = Field(
    default=None, alias="sourceRequestId"
)

sequence

sequence: str | None = Field(default=None)

component_type

component_type: ChatComponentType = Field(
    alias="componentType"
)

user_type

user_type: ChatUserType = Field(alias='userType')

role

role: ChatRole = Field(alias='role')

content

content: str | dict[str, Any] = Field(alias='Content')

parent_id

parent_id: str | None = Field(
    default=None, alias="parentId"
)

component_id

component_id: str | None = Field(
    default=None, alias="componentId"
)

parent_request_id

parent_request_id: str | None = Field(
    default=None, alias="parentRequestId"
)

branch_index

branch_index: int | None = Field(
    default=None, alias="branchIndex"
)

span_id

span_id: str | None = Field(default=None, alias='spanId')

is_visible

is_visible: bool | None = Field(
    default=None, alias="isVisible"
)

display_feedback

display_feedback: bool | None = Field(
    default=None, alias="displayFeedback"
)

ChatFolder

Bases: BaseResource

A folder used to organise chat sessions.

Attributes:

Name	Type	Description
id	str | None	The folder ID assigned by the server.
name	str	The display name of the folder.
folder_type	ChatFolderType | None	Whether this is a root or child folder.
parent_id	str | None	Optional parent folder ID for nested folders.

id

id: str | None = Field(default=None)

name

name: str

folder_type

folder_type: ChatFolderType | None = Field(
    default=None, alias="type"
)

parent_id

parent_id: str | None = Field(
    default=None, alias="parentId"
)