AIDK API Reference / aidk-angular / EngineService

Class: EngineService

Defined in: packages/angular/src/engine.service.ts:27

Implements

• OnDestroy

Constructors

Constructor

new EngineService(ngZone: NgZone, config: EngineClientConfig): EngineService;

Defined in: packages/angular/src/engine.service.ts:39

Parameters

Parameter	Type
ngZone	NgZone
config	EngineClientConfig

Returns

EngineService

Properties

Property	Modifier	Type	Description	Defined in
sessionId	readonly	string	Current session ID	packages/angular/src/engine.service.ts:32

Accessors

userId

Get Signature

get userId(): string | undefined;

Defined in: packages/angular/src/engine.service.ts:35

Current user ID

Returns

string | undefined

Methods

execute()

execute(agentId: string, input: EngineInput): Observable<ExecutionResult>;

Defined in: packages/angular/src/engine.service.ts:78

Execute an agent (non-streaming)

Parameters

Parameter	Type
agentId	string
input	EngineInput

Returns

Observable<ExecutionResult>

---

getClient()

getClient(): EngineClient;

Defined in: packages/angular/src/engine.service.ts:71

Get the underlying client (for advanced use cases)

Returns

EngineClient

---

getExecution()

getExecution(executionId: string): Observable<unknown>;

Defined in: packages/angular/src/engine.service.ts:153

Get execution by ID

Parameters

Parameter	Type
executionId	string

Returns

Observable<unknown>

---

getExecutions()

getExecutions(params?: {
  limit?: number;
  offset?: number;
  tenantId?: string;
  threadId?: string;
  userId?: string;
}): Observable<unknown[]>;

Defined in: packages/angular/src/engine.service.ts:140

Get execution history

Parameters

Parameter	Type
params?	{ limit?: number; offset?: number; tenantId?: string; threadId?: string; userId?: string; }
params.limit?	number
params.offset?	number
params.tenantId?	string
params.threadId?	string
params.userId?	string

Returns

Observable<unknown[]>

---

ngOnDestroy()

ngOnDestroy(): void;

Defined in: packages/angular/src/engine.service.ts:55

A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns

void

Implementation of

OnDestroy.ngOnDestroy

---

publish()

publish<T>(
   channel: string, 
   type: string, 
   payload?: unknown): Observable<T>;

Defined in: packages/angular/src/engine.service.ts:131

Publish an event to a channel Returns Observable of server response (may include updated state)

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
channel	string
type	string
payload?	unknown

Returns

Observable<T>

---

stream()

stream(agentId: string, input: EngineInput): Observable<EngineStreamEvent>;

Defined in: packages/angular/src/engine.service.ts:85

Stream agent execution as Observable

Parameters

Parameter	Type
agentId	string
input	EngineInput

Returns

Observable<EngineStreamEvent>

---

subscribeToChannel()

subscribeToChannel(channels: string | string[]): Observable<ChannelEvent>;

Defined in: packages/angular/src/engine.service.ts:115

Subscribe to channel events

Parameters

Parameter	Type
channels	string | string[]

Returns

Observable<ChannelEvent>

---

updateConfig()

updateConfig(updates: Partial<EngineClientConfig>): void;

Defined in: packages/angular/src/engine.service.ts:64

Update client configuration (e.g., after user login)

Parameters

Parameter	Type
updates	Partial<EngineClientConfig>

Returns

void