Interface CopilotClient

The runtime as seen by this integration, upstream a class with the full session and status API.

interface CopilotClient {
    createSession(config: SessionConfig): Promise<CopilotSession>;
    deleteSession(sessionId: string): Promise<void>;
    listModels(): Promise<ModelInfo[]>;
    start(): Promise<void>;
    stop(): Promise<Error[]>;
}

Index

Methods

createSession deleteSession listModels start stop

Methods

createSession

createSession(config: SessionConfig): Promise<CopilotSession>
Parameters
- config: SessionConfig
Returns Promise<CopilotSession>
- Defined in packages/ai-copilot/src/node/copilot-sdk-types.ts:285

deleteSession

deleteSession(sessionId: string): Promise<void>
Removes a session and what it persisted in the Copilot home.
Parameters
- sessionId: string
Returns Promise<void>
- Defined in packages/ai-copilot/src/node/copilot-sdk-types.ts:287

listModels

listModels(): Promise<ModelInfo[]>
Returns Promise<ModelInfo[]>
- Defined in packages/ai-copilot/src/node/copilot-sdk-types.ts:284

start

start(): Promise<void>
Starts the runtime and connects to it.

Returns Promise<void>
- Defined in packages/ai-copilot/src/node/copilot-sdk-types.ts:281

stop

stop(): Promise<Error[]>
Stops the runtime and resolves with the errors its cleanup ran into, if any.

Returns Promise<Error[]>
- Defined in packages/ai-copilot/src/node/copilot-sdk-types.ts:283