Struct AssistantMessageData

go/rpc/zsession_events.go:206–245

Assistant response containing text content, optional tool requests, and interaction metadata

// Assistant response containing text content, optional tool requests, and interaction metadata
type AssistantMessageData struct {
	// Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances.
	APICallID *string `json:"apiCallId,omitempty"`
	// Provider-agnostic citations linking spans of this message's content to the sources that support them. Experimental; only populated when citation emission is enabled.
	// Experimental: Citations is part of an experimental API and may change or be removed.
	Citations *Citations `json:"citations,omitempty"`
	// The assistant's text response content
	Content string `json:"content"`
	// Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume.
	EncryptedContent *string `json:"encryptedContent,omitempty"`
	// CAPI interaction ID for correlating this message with upstream telemetry
	InteractionID *string `json:"interactionId,omitempty"`
	// Unique identifier for this assistant message
	MessageID string `json:"messageId"`
	// Model that produced this assistant message, if known
	Model *string `json:"model,omitempty"`
	// Actual output token count from the API response (completion_tokens), used for accurate token accounting
	OutputTokens *int64 `json:"outputTokens,omitempty"`
	// Tool call ID of the parent tool invocation when this event originates from a sub-agent
	// Deprecated: ParentToolCallID is deprecated.
	ParentToolCallID *string `json:"parentToolCallId,omitempty"`
	// Generation phase for phased-output models (e.g., thinking vs. response phases)
	Phase *string `json:"phase,omitempty"`
	// Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume.
	ReasoningOpaque *string `json:"reasoningOpaque,omitempty"`
	// Readable reasoning text from the model's extended thinking
	ReasoningText *string `json:"reasoningText,omitempty"`
	// OpenAI-compatible wire field the provider used for reasoning (e.g. reasoning_content/reasoning). Populated only when non-canonical, so the dialect round-trips across turns.
	ReasoningWireField *string `json:"reasoningWireField,omitempty"`
	// GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs
	RequestID *string `json:"requestId,omitempty"`
	// Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping
	ServerTools *AssistantMessageServerTools `json:"serverTools,omitempty"`
	// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation
	ServiceRequestID *string `json:"serviceRequestId,omitempty"`
	// Tool invocations requested by the assistant in this message
	ToolRequests []AssistantMessageToolRequest `json:"toolRequests,omitzero"`
	// Identifier for the agent loop turn that produced this message, matching the corresponding assistant.turn_start event
	TurnID *string `json:"turnId,omitempty"`
}

func (*AssistantMessageData) sessionEventData()      {}
func (*AssistantMessageData) Type() SessionEventType { return SessionEventTypeAssistantMessage }