Theia API Documentation v1.76.0
    Preparing search index...

    Provides chat session information and session actions for the external API.

    Implemented by each frontend and registered with the backend over RPC. The backend queries the registered providers on demand when external clients call the HTTP API.

    interface ExternalChatSessionProvider {
        createSession(
            request: ExternalChatSessionCreateRequest,
        ): Promise<ExternalChatSessionCreateResult>;
        getSession(
            sessionId: string,
        ): Promise<undefined | ExternalChatSessionDetail>;
        getSessions(): Promise<ExternalChatSessionSummary[]>;
        getSessionSummary(
            sessionId: string,
        ): Promise<undefined | ExternalChatSessionSummary>;
        getWorkspace(): Promise<undefined | string>;
        openSession(sessionId: string): Promise<boolean>;
        restoreSession(
            sessionId: string,
        ): Promise<undefined | ExternalChatSessionDetail>;
        sendPrompt(
            sessionId: string,
            prompt: ExternalChatPrompt,
        ): Promise<undefined | ExternalChatPromptResult>;
    }

    Implemented by

    Index

    Methods

    • Restores the given session if necessary and shows it in this frontend's chat view. Returns false if the session is unknown to this frontend.

      Parameters

      • sessionId: string

      Returns Promise<boolean>