x

Module: vibex/x

XAgent - The space’s conversational representative

X is the interface between users and their spaces. Each space has an X agent that acts as its representative. When you need to interact with a space, you talk to X. XAgent merges TaskExecutor and Orchestrator functionality into a single, user-friendly interface.

Classes

XAgent

Properties:

Name	Type	Description
`spaceId`	`string`
`singleAgentId`	`string`

Methods:

executeWorkflow

Execute a complex task using the Workflow Engine


function executeWorkflow(goal: string): Promise<string>

Parameters:

Name	Type	Description
`goal`	`string`

getSpace

Getter for space (needed for external access)


function getSpace(): Space

getSystemPrompt

Override getSystemPrompt to include plan and artifacts context


function getSystemPrompt(context?: AgentContext): string

Parameters:

Name	Type	Description
`context`	`AgentContext` (optional)

generateText

Generate text - uses new AI SDK-style signature


function generateText(options: {
    messages: XMessage[];
    system?: string;
    [key: string]: unknown;
  }): Promise<AgentResponse>

Parameters:

Name	Type	Description
`options`	`\{ messages: XMessage[]; system?: string; [key: string]: unknown; \}`

streamText

XAgent streamText - Orchestration Layer Responsibilities: History management, agent delegation, persistence


function streamText(options: {
    messages: XMessage[];
    system?: string;
    spaceId?: string;
    metadata?: Record<string, unknown>;
    [key: string]: unknown;
  }): Promise<StreamTextResultType>

Parameters:

Name	Type	Description
`options`	`object`

stop

Stop current operation


function stop(): void

addMessage

Add message to queue (soft interrupt)


function addMessage(message: string, metadata?: Record<string, unknown>): string

Parameters:

Name	Type	Description
`message`	`string`
`metadata`	`Record<string, unknown>` (optional)

createPlan

Create or update the space plan


function createPlan(goal?: string): Promise<Plan>

Parameters:

Name	Type	Description
`goal`	`string` (optional)

adaptPlan

Adapt the plan based on new information or user feedback


function adaptPlan(feedback: string): Promise<Plan>

Parameters:

Name	Type	Description
`feedback`	`string`

getSummary

Get XAgent summary


function getSummary(): Record<string, unknown>

start

Static factory to start a new space


function start(goal: string, options: XOptions = {}): Promise<XAgent>

Parameters:

Name	Type	Description
`goal`	`string`
`options`	`XOptions`	(default: `{}`)

resume

Static factory to resume an existing space


function resume(spaceId: string, options: XOptions = {}): Promise<XAgent>

Parameters:

Name	Type	Description
`spaceId`	`string`
`options`	`XOptions`	(default: `{}`)

Interfaces

XOptions

Properties:

Name	Type	Description
`model`	`string`	(optional)
`storageRoot`	`string`	(optional)
`defaultGoal`	`string`	(optional)
`spaceId`	`string`	(optional)
`singleAgentId`	`string`	(optional)

XStreamOptions

Properties:

Name	Type	Description
`messages`	`XMessage[]`	(optional)
`tools`	`Record<string, unknown>`	(optional)
`artifactId`	`string`	(optional)

XAgentResponse

Properties:

Name	Type	Description
`plan`	`Plan`	(optional)
`taskResults`	`unknown[]`	(optional)
`artifacts`	`unknown[]`	(optional)
`preservedSteps`	`string[]`	(optional)
`regeneratedSteps`	`string[]`	(optional)
`planChanges`	`Record<string, unknown>`	(optional)