ACPex.Schema.Session.UpdateNotification (ACPex v0.1.0)

View Source

Streaming update notification from the agent.

Sent by the agent during prompt processing to provide real-time updates about its progress. These are notifications (no response expected).

Required Fields

  • session_id - The session identifier (string)
  • update - The update content (map)

Optional Fields

  • meta - Additional metadata (map)

Update Types

The update map can contain various types of information:

  • message - A message chunk from the agent
  • thought - Agent's reasoning or explanation
  • toolCall - Information about a tool being called
  • plan - A step-by-step plan for the task

Example

%ACPex.Schema.Session.UpdateNotification{
  session_id: "session-123",
  update: %{
    "type" => "thought",
    "content" => "Analyzing the code structure..."
  }
}

JSON Representation

{
  "sessionId": "session-123",
  "update": {
    "type": "thought",
    "content": "Analyzing the code structure..."
  }
}

Summary

Functions

Creates a changeset for validation.

Types

t()

@type t() :: %ACPex.Schema.Session.UpdateNotification{
  meta: map() | nil,
  session_id: String.t(),
  update: map()
}

Functions

changeset(struct \\ %__MODULE__{}, params)

@spec changeset(t(), map()) :: Ecto.Changeset.t()

Creates a changeset for validation.

Required Fields

  • session_id - Must be present
  • update - Must be present