Skip to content

Data Models

Overview

The data models package provides the core data structures used throughout the application. These models define the shape of data for chat completions, streaming operations, tools/functions, and agent configurations. Each model is designed to be immutable and serializable, ensuring type safety and consistent data handling across the application.

Core Components

Agent Models

The agent models (StreamState, StreamResult, StreamContext, Config) handle the state and configuration of chat agents:

graph TD
    A[StreamContext] --> B[StreamState]
    A --> C[StreamResult]
    A --> D[Config]

Chat Completion Models

These models represent the structure of chat messages and conversations:

graph TD
    A[MessageBase] --> B[UserMessage]
    A --> C[AssistantMessage]
    A --> D[SystemMessage]
    A --> E[ToolMessage]
    B --> F[UserTextContent]
    B --> G[UserImageURLContent]

Tool Models

The tool models (Tool, Function, ToolsList) define the structure for function calling and tool execution:

graph TD
    A[Tool] --> B[Function]
    B --> C[FunctionParameters]
    D[ToolsList] --> A

Streaming Models

Models for handling streaming operations and pattern matching:

  • PatternMatchResult: Represents pattern matching results during streaming
  • StreamConfig: Configuration for streaming operations

WX Assistant Models

Models specific to Watson Assistant integration:

  • WxAssistantMessage: Message format for Watson Assistant
  • WxAssistantConversationInput: Input structure for Watson Assistant conversations

Module Structure

data_models/
├── agent.py          # Agent-related models
├── chat_completions.py  # Chat completion models
├── streaming.py      # Streaming operation models
├── tools.py          # Tool and function models
└── wx_assistant.py   # Watson Assistant models

Common Patterns

Message Chain Building

messages = [
    SystemMessage(content="You are a helpful assistant"),
    UserMessage(content=UserTextContent(text="Hello")),
    AssistantMessage(content="Hi! How can I help you today?")
]

See Also