@theia/ai-openai 1.58.3 → 1.59.0-next.72

package/lib/node/openai-streaming-iterator.js

@@ -0,0 +1,126 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2025 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamingAsyncIterator = void 0;
+const core_1 = require("@theia/core");
+const promise_util_1 = require("@theia/core/lib/common/promise-util");
+class StreamingAsyncIterator {
+    constructor(stream, cancellationToken) {
+        this.stream = stream;
+        this.requestQueue = new Array();
+        this.messageCache = new Array();
+        this.done = false;
+        this.terminalError = undefined;
+        this.toDispose = new core_1.DisposableCollection();
+        this.registerStreamListener('error', error => {
+            console.error('Error in OpenAI chat completion stream:', error);
+            this.terminalError = error;
+            this.dispose();
+        });
+        this.registerStreamListener('abort', () => {
+            this.terminalError = new core_1.CancellationError();
+            this.dispose();
+        }, true);
+        this.registerStreamListener('message', message => {
+            if (message.role === 'tool') {
+                this.handleIncoming({
+                    tool_calls: [{
+                            id: message.tool_call_id,
+                            finished: true,
+                            result: Array.isArray(message.content) ? message.content.join('') : message.content
+                        }]
+                });
+            }
+            console.debug('Received Open AI message', JSON.stringify(message));
+        });
+        this.registerStreamListener('end', () => {
+            this.dispose();
+        }, true);
+        this.registerStreamListener('chunk', chunk => {
+            var _a;
+            this.handleIncoming({ ...(_a = chunk.choices[0]) === null || _a === void 0 ? void 0 : _a.delta });
+        });
+        if (cancellationToken) {
+            this.toDispose.push(cancellationToken.onCancellationRequested(() => stream.abort()));
+        }
+    }
+    [Symbol.asyncIterator]() { return this; }
+    next() {
+        if (this.messageCache.length && this.requestQueue.length) {
+            throw new Error('Assertion error: cache and queue should not both be populated.');
+        }
+        // Deliver all the messages we got, even if we've since terminated.
+        if (this.messageCache.length) {
+            return Promise.resolve({
+                done: false,
+                value: this.messageCache.shift()
+            });
+        }
+        else if (this.terminalError) {
+            return Promise.reject(this.terminalError);
+        }
+        else if (this.done) {
+            return Promise.resolve({
+                done: true,
+                value: undefined
+            });
+        }
+        else {
+            const toQueue = new promise_util_1.Deferred();
+            this.requestQueue.push(toQueue);
+            return toQueue.promise;
+        }
+    }
+    handleIncoming(message) {
+        if (this.messageCache.length && this.requestQueue.length) {
+            throw new Error('Assertion error: cache and queue should not both be populated.');
+        }
+        if (this.requestQueue.length) {
+            this.requestQueue.shift().resolve({
+                done: false,
+                value: message
+            });
+        }
+        else {
+            this.messageCache.push(message);
+        }
+    }
+    registerStreamListener(eventType, handler, once) {
+        if (once) {
+            this.stream.once(eventType, handler);
+        }
+        else {
+            this.stream.on(eventType, handler);
+        }
+        this.toDispose.push({ dispose: () => this.stream.off(eventType, handler) });
+    }
+    dispose() {
+        this.done = true;
+        this.toDispose.dispose();
+        // We will be receiving no more messages. Any outstanding requests have to be handled.
+        if (this.terminalError) {
+            this.requestQueue.forEach(request => request.reject(this.terminalError));
+        }
+        else {
+            this.requestQueue.forEach(request => request.resolve({ done: true, value: undefined }));
+        }
+        // Leave the message cache alone - if it was populated, then the request queue was empty, but we'll still try to deliver the messages if asked.
+        this.requestQueue.length = 0;
+    }
+}
+exports.StreamingAsyncIterator = StreamingAsyncIterator;
+//# sourceMappingURL=openai-streaming-iterator.js.map

package/lib/node/openai-streaming-iterator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-streaming-iterator.js","sourceRoot":"","sources":["../../src/node/openai-streaming-iterator.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;AAGhF,sCAAqG;AACrG,sEAA+D;AAK/D,MAAa,sBAAsB;IAM/B,YAA+B,MAA4B,EAAE,iBAAqC;QAAnE,WAAM,GAAN,MAAM,CAAsB;QALxC,iBAAY,GAAG,IAAI,KAAK,EAAwB,CAAC;QACjD,iBAAY,GAAG,IAAI,KAAK,EAAmC,CAAC;QACrE,SAAI,GAAG,KAAK,CAAC;QACb,kBAAa,GAAsB,SAAS,CAAC;QACpC,cAAS,GAAG,IAAI,2BAAoB,EAAE,CAAC;QAEtD,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;YACzC,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;YAChE,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC3B,IAAI,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,GAAG,EAAE;YACtC,IAAI,CAAC,aAAa,GAAG,IAAI,wBAAiB,EAAE,CAAC;YAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,EAAE,IAAI,CAAC,CAAC;QACT,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE;YAC7C,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAC1B,IAAI,CAAC,cAAc,CAAC;oBAChB,UAAU,EAAE,CAAC;4BACT,EAAE,EAAE,OAAO,CAAC,YAAY;4BACxB,QAAQ,EAAE,IAAI;4BACd,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO;yBACtF,CAAC;iBACL,CAAC,CAAC;YACP,CAAC;YACD,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,GAAG,EAAE;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,EAAE,IAAI,CAAC,CAAC;QACT,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;;YACzC,IAAI,CAAC,cAAc,CAAC,EAAE,GAAG,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,KAAK,EAAE,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QACH,IAAI,iBAAiB,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzF,CAAC;IACL,CAAC;IAED,CAAC,MAAM,CAAC,aAAa,CAAC,KAA6D,OAAO,IAAI,CAAC,CAAC,CAAC;IAEjG,IAAI;QACA,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACtF,CAAC;QACD,mEAAmE;QACnE,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,OAAO,CAAC;gBACnB,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAG;aACpC,CAAC,CAAC;QACP,CAAC;aAAM,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9C,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,OAAO,OAAO,CAAC,OAAO,CAAC;gBACnB,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,SAAS;aACnB,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,MAAM,OAAO,GAAG,IAAI,uBAAQ,EAAc,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAChC,OAAO,OAAO,CAAC,OAAO,CAAC;QAC3B,CAAC;IACL,CAAC;IAES,cAAc,CAAC,OAAwC;QAC7D,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACtF,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAG,CAAC,OAAO,CAAC;gBAC/B,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,OAAO;aACjB,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC;IACL,CAAC;IAES,sBAAsB,CAAiD,SAAgB,EAAE,OAA0C,EAAE,IAAc;QACzJ,IAAI,IAAI,EAAE,CAAC;YACP,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,OAAO;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,sFAAsF;QACtF,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QAC7E,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;QAC5F,CAAC;QACD,+IAA+I;QAC/I,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;IACjC,CAAC;CACJ;AApGD,wDAoGC"}

package/lib/node/openai-streaming-iterator.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=openai-streaming-iterator.spec.d.ts.map

package/lib/node/openai-streaming-iterator.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-streaming-iterator.spec.d.ts","sourceRoot":"","sources":["../../src/node/openai-streaming-iterator.spec.ts"],"names":[],"mappings":""}

package/lib/node/openai-streaming-iterator.spec.js

@@ -0,0 +1,208 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2025 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const sinon = require("sinon");
+const openai_streaming_iterator_1 = require("./openai-streaming-iterator");
+const core_1 = require("@theia/core");
+const events_1 = require("events");
+describe('StreamingAsyncIterator', () => {
+    let mockStream;
+    let iterator;
+    let cts;
+    const consoleError = console.error;
+    beforeEach(() => {
+        mockStream = new events_1.EventEmitter();
+        mockStream.abort = sinon.stub();
+        cts = new core_1.CancellationTokenSource();
+    });
+    afterEach(() => {
+        if (iterator) {
+            iterator.dispose();
+        }
+        cts.dispose();
+        console.error = consoleError;
+    });
+    function createIterator(withCancellationToken = false) {
+        return new openai_streaming_iterator_1.StreamingAsyncIterator(mockStream, withCancellationToken ? cts.token : undefined);
+    }
+    it('should yield messages in the correct order when consumed immediately', async () => {
+        iterator = createIterator();
+        setTimeout(() => {
+            mockStream.emit('chunk', { choices: [{ delta: { content: 'Hello' } }] });
+            mockStream.emit('chunk', { choices: [{ delta: { content: ' ' } }] });
+            mockStream.emit('chunk', { choices: [{ delta: { content: 'World' } }] });
+            mockStream.emit('end');
+        }, 10);
+        const results = [];
+        while (true) {
+            const { value, done } = await iterator.next();
+            if (done) {
+                break;
+            }
+            results.push(value);
+        }
+        (0, chai_1.expect)(results).to.deep.equal([
+            { content: 'Hello' },
+            { content: ' ' },
+            { content: 'World' }
+        ]);
+    });
+    it('should buffer messages if consumer is slower (messages arrive before .next() is called)', async () => {
+        var _a;
+        iterator = createIterator();
+        mockStream.emit('chunk', { choices: [{ delta: { content: 'A' } }] });
+        mockStream.emit('chunk', { choices: [{ delta: { content: 'B' } }] });
+        mockStream.emit('chunk', { choices: [{ delta: { content: 'C' } }] });
+        mockStream.emit('end');
+        const results = [];
+        while (true) {
+            const { value, done } = await iterator.next();
+            if (done) {
+                break;
+            }
+            results.push((_a = value.content) !== null && _a !== void 0 ? _a : '');
+        }
+        (0, chai_1.expect)(results).to.deep.equal(['A', 'B', 'C']);
+    });
+    it('should resolve queued next() call when a message arrives (consumer is waiting first)', async () => {
+        iterator = createIterator();
+        const nextPromise = iterator.next();
+        setTimeout(() => {
+            mockStream.emit('chunk', { choices: [{ delta: { content: 'Hello from queue' } }] });
+            mockStream.emit('end');
+        }, 10);
+        const first = await nextPromise;
+        (0, chai_1.expect)(first.done).to.be.false;
+        (0, chai_1.expect)(first.value.content).to.equal('Hello from queue');
+        const second = await iterator.next();
+        (0, chai_1.expect)(second.done).to.be.true;
+        (0, chai_1.expect)(second.value).to.be.undefined;
+    });
+    it('should handle the end event correctly', async () => {
+        var _a;
+        iterator = createIterator();
+        mockStream.emit('chunk', { choices: [{ delta: { content: 'EndTest1' } }] });
+        mockStream.emit('chunk', { choices: [{ delta: { content: 'EndTest2' } }] });
+        mockStream.emit('end');
+        const results = [];
+        while (true) {
+            const { value, done } = await iterator.next();
+            if (done) {
+                break;
+            }
+            results.push((_a = value.content) !== null && _a !== void 0 ? _a : '');
+        }
+        (0, chai_1.expect)(results).to.deep.equal(['EndTest1', 'EndTest2']);
+    });
+    it('should reject pending .next() call with an error if error event occurs', async () => {
+        iterator = createIterator();
+        const pendingNext = iterator.next();
+        // Suppress console.error output
+        console.error = () => { };
+        const error = new Error('Stream error occurred');
+        mockStream.emit('error', error);
+        try {
+            await pendingNext;
+            chai_1.expect.fail('The promise should have been rejected with an error.');
+        }
+        catch (err) {
+            (0, chai_1.expect)(err).to.equal(error);
+        }
+    });
+    it('should reject pending .next() call with a CancellationError if "abort" event occurs', async () => {
+        iterator = createIterator();
+        const pendingNext = iterator.next();
+        // Suppress console.error output
+        console.error = () => { };
+        mockStream.emit('abort');
+        try {
+            await pendingNext;
+            chai_1.expect.fail('The promise should have been rejected with a CancellationError.');
+        }
+        catch (err) {
+            (0, chai_1.expect)(err).to.be.instanceOf(core_1.CancellationError);
+        }
+    });
+    it('should call stream.abort() when cancellation token is triggered', async () => {
+        iterator = createIterator(true);
+        cts.cancel();
+        sinon.assert.calledOnce(mockStream.abort);
+    });
+    it('should not lose unconsumed messages after disposal, but no new ones arrive', async () => {
+        iterator = createIterator();
+        mockStream.emit('chunk', { choices: [{ delta: { content: 'Msg1' } }] });
+        mockStream.emit('chunk', { choices: [{ delta: { content: 'Msg2' } }] });
+        iterator.dispose();
+        let result = await iterator.next();
+        (0, chai_1.expect)(result.done).to.be.false;
+        (0, chai_1.expect)(result.value.content).to.equal('Msg1');
+        result = await iterator.next();
+        (0, chai_1.expect)(result.done).to.be.false;
+        (0, chai_1.expect)(result.value.content).to.equal('Msg2');
+        result = await iterator.next();
+        (0, chai_1.expect)(result.done).to.be.true;
+        (0, chai_1.expect)(result.value).to.be.undefined;
+    });
+    it('should reject all pending requests with an error if disposal occurs after stream error', async () => {
+        iterator = createIterator();
+        const pendingNext1 = iterator.next();
+        const pendingNext2 = iterator.next();
+        // Suppress console.error output
+        console.error = () => { };
+        const error = new Error('Critical error');
+        mockStream.emit('error', error);
+        try {
+            await pendingNext1;
+            chai_1.expect.fail('expected to be rejected');
+        }
+        catch (err) {
+            (0, chai_1.expect)(err).to.equal(error);
+        }
+        try {
+            await pendingNext2;
+            chai_1.expect.fail('expected to be rejected');
+        }
+        catch (err) {
+            (0, chai_1.expect)(err).to.equal(error);
+        }
+    });
+    it('should handle receiving a "message" event with role="tool"', async () => {
+        iterator = createIterator();
+        setTimeout(() => {
+            mockStream.emit('message', {
+                role: 'tool',
+                tool_call_id: 'tool-123',
+                content: ['Part1', 'Part2']
+            });
+            mockStream.emit('end');
+        }, 10);
+        const results = [];
+        for await (const part of iterator) {
+            results.push(part);
+        }
+        (0, chai_1.expect)(results).to.have.lengthOf(1);
+        (0, chai_1.expect)(results[0].tool_calls).to.deep.equal([
+            {
+                id: 'tool-123',
+                finished: true,
+                result: 'Part1Part2'
+            }
+        ]);
+    });
+});
+//# sourceMappingURL=openai-streaming-iterator.spec.js.map

package/lib/node/openai-streaming-iterator.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-streaming-iterator.spec.js","sourceRoot":"","sources":["../../src/node/openai-streaming-iterator.spec.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;AAEhF,+BAA8B;AAC9B,+BAA+B;AAC/B,2EAAqE;AAErE,sCAAyE;AAEzE,mCAAsC;AAEtC,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACpC,IAAI,UAA+C,CAAC;IACpD,IAAI,QAAgC,CAAC;IACrC,IAAI,GAA4B,CAAC;IACjC,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACZ,UAAU,GAAG,IAAI,qBAAY,EAAyC,CAAC;QACvE,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAEhC,GAAG,GAAG,IAAI,8BAAuB,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,QAAQ,EAAE,CAAC;YACX,QAAQ,CAAC,OAAO,EAAE,CAAC;QACvB,CAAC;QACD,GAAG,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,GAAG,YAAY,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,SAAS,cAAc,CAAC,qBAAqB,GAAG,KAAK;QACjD,OAAO,IAAI,kDAAsB,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACjG,CAAC;IAED,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QAClF,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,UAAU,CAAC,GAAG,EAAE;YACZ,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;YACzE,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;YACrE,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;YACzE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,OAAO,GAAsC,EAAE,CAAC;QAEtD,OAAO,IAAI,EAAE,CAAC;YACV,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC9C,IAAI,IAAI,EAAE,CAAC;gBACP,MAAM;YACV,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;QAED,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B,EAAE,OAAO,EAAE,OAAO,EAAE;YACpB,EAAE,OAAO,EAAE,GAAG,EAAE;YAChB,EAAE,OAAO,EAAE,OAAO,EAAE;SACvB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yFAAyF,EAAE,KAAK,IAAI,EAAE;;QACrG,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACrE,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACrE,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACrE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEvB,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,OAAO,IAAI,EAAE,CAAC;YACV,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC9C,IAAI,IAAI,EAAE,CAAC;gBACP,MAAM;YACV,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,MAAA,KAAK,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC;QACtC,CAAC;QAED,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,KAAK,IAAI,EAAE;QAClG,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEpC,UAAU,CAAC,GAAG,EAAE;YACZ,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;YACpF,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC;QAChC,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC/B,IAAA,aAAM,EAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAEzD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC/B,IAAA,aAAM,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;;QACnD,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QAC5E,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QAC5E,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEvB,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,OAAO,IAAI,EAAE,CAAC;YACV,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC9C,IAAI,IAAI,EAAE,CAAC;gBACP,MAAM;YACV,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,MAAA,KAAK,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC;QACtC,CAAC;QAED,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,KAAK,IAAI,EAAE;QACpF,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEpC,gCAAgC;QAChC,OAAO,CAAC,KAAK,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QAE1B,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACjD,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAEhC,IAAI,CAAC;YACD,MAAM,WAAW,CAAC;YAClB,aAAM,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;QACxE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qFAAqF,EAAE,KAAK,IAAI,EAAE;QACjG,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEpC,gCAAgC;QAChC,OAAO,CAAC,KAAK,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QAE1B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEzB,IAAI,CAAC;YACD,MAAM,WAAW,CAAC;YAClB,aAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAC;QACnF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,wBAAiB,CAAC,CAAC;QACpD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC7E,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QAEhC,GAAG,CAAC,MAAM,EAAE,CAAC;QAEb,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,KAAuB,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,KAAK,IAAI,EAAE;QACxF,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACxE,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QAExE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAEnB,IAAI,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAChC,IAAA,aAAM,EAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAE9C,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAChC,IAAA,aAAM,EAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAE9C,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC/B,IAAA,aAAM,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wFAAwF,EAAE,KAAK,IAAI,EAAE;QACpG,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAErC,gCAAgC;QAChC,OAAO,CAAC,KAAK,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QAE1B,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC1C,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAEhC,IAAI,CAAC;YACD,MAAM,YAAY,CAAC;YACnB,aAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,CAAC;YACD,MAAM,YAAY,CAAC;YACnB,aAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QACxE,QAAQ,GAAG,cAAc,EAAE,CAAC;QAE5B,UAAU,CAAC,GAAG,EAAE;YACZ,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE;gBACvB,IAAI,EAAE,MAAM;gBACZ,YAAY,EAAE,UAAU;gBACxB,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;aAC9B,CAAC,CAAC;YACH,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,OAAO,GAAsC,EAAE,CAAC;QACtD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QAED,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACpC,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACxC;gBACI,EAAE,EAAE,UAAU;gBACd,QAAQ,EAAE,IAAI;gBACd,MAAM,EAAE,YAAY;aACvB;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@theia/ai-openai",
-  "version": "1.58.3",
+  "version": "1.59.0-next.72+f41d8efcd",
   "description": "Theia - OpenAI Integration",
   "dependencies": {
-    "@theia/ai-core": "1.58.3",
-    "@theia/core": "1.58.3",
-    "@theia/filesystem": "1.58.3",
-    "@theia/workspace": "1.58.3",
+    "@theia/ai-core": "1.59.0-next.72+f41d8efcd",
+    "@theia/core": "1.59.0-next.72+f41d8efcd",
+    "@theia/filesystem": "1.59.0-next.72+f41d8efcd",
+    "@theia/workspace": "1.59.0-next.72+f41d8efcd",
     "minimatch": "^5.1.0",
     "openai": "^4.77.0",
     "tslib": "^2.6.2"
@@ -45,10 +45,10 @@
     "watch": "theiaext watch"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.58.3"
+    "@theia/ext-scripts": "1.58.0"
   },
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "ca70c15332f91e0f61b12cd147b5ff8326e2e6d2"
+  "gitHead": "f41d8efcd4abb79167b74bf476eafc7857e97306"
 }

package/src/browser/openai-frontend-application-contribution.ts

@@ -92,7 +92,8 @@ export class OpenAiFrontendApplicationContribution implements FrontendApplicatio
                 model.url === newModel.url &&
                 model.apiKey === newModel.apiKey &&
                 model.apiVersion === newModel.apiVersion &&
-                model.supportsDeveloperMessage === newModel.supportsDeveloperMessage &&
+                model.developerMessageSettings === newModel.developerMessageSettings &&
+                model.supportsStructuredOutput === newModel.supportsStructuredOutput &&
                 model.enableStreaming === newModel.enableStreaming));
 
         this.manager.removeLanguageModels(...modelsToRemove.map(model => model.id));
@@ -116,8 +117,9 @@ export class OpenAiFrontendApplicationContribution implements FrontendApplicatio
             model: modelId,
             apiKey: true,
             apiVersion: true,
-            supportsDeveloperMessage: !openAIModelsSupportingDeveloperMessages.includes(modelId),
+            developerMessageSettings: openAIModelsNotSupportingDeveloperMessages.includes(modelId) ? 'user' : 'developer',
             enableStreaming: !openAIModelsWithDisabledStreaming.includes(modelId),
+            supportsStructuredOutput: !openAIModelsWithoutStructuredOutput.includes(modelId),
             defaultRequestSettings: modelRequestSetting?.requestSettings
         };
     }
@@ -141,7 +143,8 @@ export class OpenAiFrontendApplicationContribution implements FrontendApplicatio
                     url: pref.url,
                     apiKey: typeof pref.apiKey === 'string' || pref.apiKey === true ? pref.apiKey : undefined,
                     apiVersion: typeof pref.apiVersion === 'string' || pref.apiVersion === true ? pref.apiVersion : undefined,
-                    supportsDeveloperMessage: pref.supportsDeveloperMessage ?? true,
+                    developerMessageSettings: pref.developerMessageSettings ?? 'developer',
+                    supportsStructuredOutput: pref.supportsStructuredOutput ?? true,
                     enableStreaming: pref.enableStreaming ?? true,
                     defaultRequestSettings: modelRequestSetting?.requestSettings
                 }
@@ -165,5 +168,6 @@ export class OpenAiFrontendApplicationContribution implements FrontendApplicatio
     }
 }
 
-const openAIModelsWithDisabledStreaming = ['o1-preview', 'o1-mini'];
-const openAIModelsSupportingDeveloperMessages = ['o1-preview', 'o1-mini'];
+const openAIModelsWithDisabledStreaming: string[] = [];
+const openAIModelsNotSupportingDeveloperMessages = ['o1-preview', 'o1-mini'];
+const openAIModelsWithoutStructuredOutput = ['o1-preview', 'gpt-4-turbo', 'gpt-4', 'gpt-3.5-turbo', 'o1-mini', 'gpt-4o-2024-05-13'];

package/src/browser/openai-preferences.ts

@@ -16,6 +16,7 @@
 
 import { PreferenceSchema } from '@theia/core/lib/browser/preferences/preference-contribution';
 import { AI_CORE_PREFERENCES_TITLE } from '@theia/ai-core/lib/browser/ai-core-preferences';
+import { nls } from '@theia/core';
 
 export const API_KEY_PREF = 'ai-features.openAiOfficial.openAiApiKey';
 export const MODELS_PREF = 'ai-features.openAiOfficial.officialOpenAiModels';
@@ -26,15 +27,16 @@ export const OpenAiPreferencesSchema: PreferenceSchema = {
     properties: {
         [API_KEY_PREF]: {
             type: 'string',
-            markdownDescription: 'Enter an API Key of your official OpenAI Account. **Please note:** By using this preference the Open AI API key will be stored in clear text\
-            on the machine running Theia. Use the environment variable `OPENAI_API_KEY` to set the key securely.',
+            markdownDescription: nls.localize('theia/ai/openai/apiKey/mdDescription',
+                'Enter an API Key of your official OpenAI Account. **Please note:** By using this preference the Open AI API key will be stored in clear text \
+on the machine running Theia. Use the environment variable `OPENAI_API_KEY` to set the key securely.'),
             title: AI_CORE_PREFERENCES_TITLE,
         },
         [MODELS_PREF]: {
             type: 'array',
-            description: 'Official OpenAI models to use',
+            description: nls.localize('theia/ai/openai/models/description', 'Official OpenAI models to use'),
             title: AI_CORE_PREFERENCES_TITLE,
-            default: ['gpt-4o', 'gpt-4o-2024-08-06', 'gpt-4o-2024-05-13', 'gpt-4o-mini', 'gpt-4-turbo', 'gpt-4', 'gpt-3.5-turbo', 'o1-preview', 'o1-mini'],
+            default: ['gpt-4o', 'gpt-4o-2024-11-20', 'gpt-4o-2024-08-06', 'gpt-4o-mini', 'o1', 'o1-mini', 'o3-mini'],
             items: {
                 type: 'string'
             }
@@ -42,7 +44,8 @@ export const OpenAiPreferencesSchema: PreferenceSchema = {
         [CUSTOM_ENDPOINTS_PREF]: {
             type: 'array',
             title: AI_CORE_PREFERENCES_TITLE,
-            markdownDescription: 'Integrate custom models compatible with the OpenAI API, for example via `vllm`. The required attributes are `model` and `url`.\
+            markdownDescription: nls.localize('theia/ai/openai/customEndpoints/mdDescription',
+                'Integrate custom models compatible with the OpenAI API, for example via `vllm`. The required attributes are `model` and `url`.\
             \n\
             Optionally, you can\
             \n\
@@ -52,42 +55,60 @@ export const OpenAiPreferencesSchema: PreferenceSchema = {
             \n\
             - provide an `apiVersion` to access the API served at the given url in Azure. Use `true` to indicate the use of the global OpenAI API version.\
             \n\
-            - specify `supportsDeveloperMessage: false` to indicate that the developer role shall not be used.\
+            - set `developerMessageSettings` to one of `user`, `system`, `developer`, `mergeWithFollowingUserMessage`, or `skip` to control how the developer message is\
+            included (where `user`, `system`, and `developer` will be used as a role, `mergeWithFollowingUserMessage` will prefix the following user message with the system\
+            message or convert the system message to user message if the next message is not a user message. `skip` will just remove the system message).\
+            Defaulting to `developer`.\
+            \n\
+            - specify `supportsStructuredOutput: false` to indicate that structured output shall not be used.\
             \n\
             - specify `enableStreaming: false` to indicate that streaming shall not be used.\
             \n\
-            Refer to [our documentation](https://theia-ide.org/docs/user_ai/#openai-compatible-models-eg-via-vllm) for more information.',
+            Refer to [our documentation](https://theia-ide.org/docs/user_ai/#openai-compatible-models-eg-via-vllm) for more information.'),
             default: [],
             items: {
                 type: 'object',
                 properties: {
                     model: {
                         type: 'string',
-                        title: 'Model ID'
+                        title: nls.localize('theia/ai/openai/customEndpoints/modelId/title', 'Model ID')
                     },
                     url: {
                         type: 'string',
-                        title: 'The Open AI API compatible endpoint where the model is hosted'
+                        title: nls.localize('theia/ai/openai/customEndpoints/url/title', 'The Open AI API compatible endpoint where the model is hosted')
                     },
                     id: {
                         type: 'string',
-                        title: 'A unique identifier which is used in the UI to identify the custom model',
+                        title: nls.localize('theia/ai/openai/customEndpoints/id/title', 'A unique identifier which is used in the UI to identify the custom model'),
                     },
                     apiKey: {
                         type: ['string', 'boolean'],
-                        title: 'Either the key to access the API served at the given url or `true` to use the global OpenAI API key',
+                        title: nls.localize('theia/ai/openai/customEndpoints/apiKey/title',
+                            'Either the key to access the API served at the given url or `true` to use the global OpenAI API key'),
                     },
                     apiVersion: {
                         type: ['string', 'boolean'],
-                        title: 'Either the version to access the API served at the given url in Azure or `true` to use the global OpenAI API version',
+                        title: nls.localize('theia/ai/openai/customEndpoints/apiVersion/title',
+                            'Either the version to access the API served at the given url in Azure or `true` to use the global OpenAI API version'),
+                    },
+                    developerMessageSettings: {
+                        type: 'string',
+                        enum: ['user', 'system', 'developer', 'mergeWithFollowingUserMessage', 'skip'],
+                        default: 'developer',
+                        title: nls.localize('theia/ai/openai/customEndpoints/developerMessageSettings/title',
+                            'Controls the handling of system messages: `user`, `system`, and `developer` will be used as a role, `mergeWithFollowingUserMessage` will prefix\
+                         the following user message with the system message or convert the system message to user message if the next message is not a user message.\
+                         `skip` will just remove the system message), defaulting to `developer`.')
                     },
-                    supportsDeveloperMessage: {
+                    supportsStructuredOutput: {
                         type: 'boolean',
-                        title: 'Indicates whether the model supports the `developer` role. `true` by default.',
+                        title: nls.localize('theia/ai/openai/customEndpoints/supportsStructuredOutput/title',
+                            'Indicates whether the model supports structured output. `true` by default.'),
                     },
                     enableStreaming: {
                         type: 'boolean',
-                        title: 'Indicates whether the streaming API shall be used. `true` by default.',
+                        title: nls.localize('theia/ai/openai/customEndpoints/enableStreaming/title',
+                            'Indicates whether the streaming API shall be used. `true` by default.'),
                     }
                 }
             }

package/src/common/openai-language-models-manager.ts

@@ -15,6 +15,7 @@
 // *****************************************************************************
 export const OPENAI_LANGUAGE_MODELS_MANAGER_PATH = '/services/open-ai/language-model-manager';
 export const OpenAiLanguageModelsManager = Symbol('OpenAiLanguageModelsManager');
+
 export interface OpenAiModelDescription {
     /**
      * The identifier of the model which will be shown in the UI.
@@ -41,9 +42,16 @@ export interface OpenAiModelDescription {
      */
     enableStreaming: boolean;
     /**
-     * Flag to configure whether the OpenAPI model supports the `developer` role. Default is `true`.
+     * Property to configure the developer message of the model. Setting this property to 'user', 'system', or 'developer' will use that string as the role for the system message.
+     * Setting it to 'mergeWithFollowingUserMessage' will prefix the following user message with the system message or convert the system message to user if the following message
+     * is not a user message. 'skip' will remove the system message altogether.
+     * Defaults to 'developer'.
      */
-    supportsDeveloperMessage: boolean;
+    developerMessageSettings?: 'user' | 'system' | 'developer' | 'mergeWithFollowingUserMessage' | 'skip';
+    /**
+     * Flag to configure whether the OpenAPI model supports structured output. Default is `true`.
+     */
+    supportsStructuredOutput: boolean;
     /**
      * Default request settings for the OpenAI model.
      */

package/src/node/openai-backend-module.ts

@@ -19,6 +19,7 @@ import { OPENAI_LANGUAGE_MODELS_MANAGER_PATH, OpenAiLanguageModelsManager } from
 import { ConnectionHandler, RpcConnectionHandler } from '@theia/core';
 import { OpenAiLanguageModelsManagerImpl } from './openai-language-models-manager-impl';
 import { ConnectionContainerModule } from '@theia/core/lib/node/messaging/connection-container-module';
+import { OpenAiModelUtils } from './openai-language-model';
 
 export const OpenAiModelFactory = Symbol('OpenAiModelFactory');
 
@@ -32,5 +33,6 @@ const openAiConnectionModule = ConnectionContainerModule.create(({ bind, bindBac
 });
 
 export default new ContainerModule(bind => {
+    bind(OpenAiModelUtils).toSelf().inSingletonScope();
     bind(ConnectionContainerModule).toConstantValue(openAiConnectionModule);
 });