@celljs/ai-openai 3.4.4

package/lib/common/api/openai-api.spec.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const http_1 = require("@celljs/http");
+const test_container_1 = require("../test/test-container");
+const api_protocol_1 = require("./api-protocol");
+const chat_request_1 = require("./chat-request");
+const embeddings_request_1 = require("./embeddings-request");
+const message_1 = require("./message");
+require("../index");
+describe('OpenAIAPI', () => {
+    const container = (0, test_container_1.createContainer)();
+    let openaiAPI;
+    // Mock response data
+    const mockResponses = {
+        chat: {
+            id: 'chatcmpl-123',
+            object: 'chat.completion',
+            created: 1677652288,
+            model: 'gpt-3.5-turbo',
+            choices: [{
+                    index: 0,
+                    message: {
+                        role: 'assistant',
+                        content: 'Hello! How can I help you today?'
+                    },
+                    finish_reason: 'stop'
+                }],
+            usage: {
+                prompt_tokens: 9,
+                completion_tokens: 12,
+                total_tokens: 21
+            }
+        },
+        stream: {
+            id: 'chatcmpl-123',
+            object: 'chat.completion.chunk',
+            created: 1677652288,
+            model: 'gpt-3.5-turbo',
+            choices: [{
+                    index: 0,
+                    delta: {
+                        role: 'assistant',
+                        content: 'Hello'
+                    }
+                }]
+        },
+        embeddings: {
+            object: 'list',
+            data: [{ object: 'embedding', embedding: [0.1, 0.2, 0.3], index: 0 }],
+            model: 'text-embedding-3-small',
+            usage: { prompt_tokens: 8, total_tokens: 8 }
+        }
+    };
+    beforeEach(() => {
+        // Configure mock REST operations
+        container.rebind(http_1.RestOperations).toConstantValue({
+            post: async (url, data) => {
+                if (url === '/v1/embeddings') {
+                    return { data: mockResponses.embeddings };
+                }
+                if (data.stream) {
+                    const stream = new ReadableStream({
+                        start(controller) {
+                            controller.enqueue(`data: ${JSON.stringify(mockResponses.stream)}\n\n`);
+                            controller.enqueue('data: [DONE]\n\n');
+                            controller.close();
+                        }
+                    });
+                    return { data: stream };
+                }
+                return { data: mockResponses.chat };
+            }
+        });
+        openaiAPI = container.get(api_protocol_1.OpenAIAPI);
+    });
+    describe('chat', () => {
+        it('should return correct response for non-streaming request', async () => {
+            const request = new chat_request_1.ChatCompletionRequest();
+            request.model = 'gpt-3.5-turbo';
+            request.messages = [{ role: message_1.Role.USER, content: 'Hello' }];
+            const response = await openaiAPI.chat(request);
+            (0, chai_1.expect)(response.body.id).to.equal('chatcmpl-123');
+            (0, chai_1.expect)(response.body.choices[0].message.content).to.equal('Hello! How can I help you today?');
+            (0, chai_1.expect)(response.body.usage.totalTokens).to.equal(21);
+        });
+        it('should throw error when stream is enabled', async () => {
+            const request = new chat_request_1.ChatCompletionRequest();
+            request.model = 'gpt-3.5-turbo';
+            request.messages = [{ role: message_1.Role.USER, content: 'Hello' }];
+            request.stream = true;
+            try {
+                await openaiAPI.chat(request);
+            }
+            catch (e) {
+                (0, chai_1.expect)(e).to.be.instanceOf(Error);
+                (0, chai_1.expect)(e.message).to.include('Request must set the stream property to false.');
+            }
+        });
+    });
+    describe('chat', () => {
+        it('should throw error when stream is disabled', async () => {
+            const request = new chat_request_1.ChatCompletionRequest();
+            request.model = 'gpt-3.5-turbo';
+            request.messages = [{ role: message_1.Role.USER, content: 'Hello' }];
+            request.stream = false;
+            try {
+                await openaiAPI.chat(request);
+            }
+            catch (e) {
+                (0, chai_1.expect)(e).to.be.instanceOf(Error);
+                (0, chai_1.expect)(e.message).to.include('Request must set the stream property to true.');
+            }
+        });
+    });
+    describe('streamingChat', () => {
+        it('should handle streaming response correctly', done => {
+            const request = new chat_request_1.ChatCompletionRequest();
+            request.model = 'gpt-3.5-turbo';
+            request.messages = [{ role: message_1.Role.USER, content: 'Hello' }];
+            request.stream = true;
+            openaiAPI.streamingChat(request).then(response$ => {
+                response$.subscribe({
+                    next: chunk => {
+                        (0, chai_1.expect)(chunk.body.id).to.equal('chatcmpl-123');
+                        (0, chai_1.expect)(chunk.body.choices[0].delta.content).to.equal('Hello');
+                        done();
+                    }
+                });
+            });
+        });
+        it('should throw error when stream is disabled', async () => {
+            const request = new chat_request_1.ChatCompletionRequest();
+            request.model = 'gpt-3.5-turbo';
+            request.messages = [{ role: message_1.Role.USER, content: 'Hello' }];
+            request.stream = false;
+            try {
+                await openaiAPI.streamingChat(request);
+            }
+            catch (e) {
+                (0, chai_1.expect)(e).to.be.instanceOf(Error);
+                (0, chai_1.expect)(e.message).to.include('Request must set the stream property to true.');
+            }
+        });
+    });
+    describe('embed', () => {
+        it('should return correct embedding vectors', async () => {
+            const request = embeddings_request_1.EmbeddingRequest.fromInput('Hello world');
+            const response = await openaiAPI.embed(request);
+            (0, chai_1.expect)(response.body.object).to.equal('list');
+            (0, chai_1.expect)(response.body.data[0].embedding).to.deep.equal([0.1, 0.2, 0.3]);
+            (0, chai_1.expect)(response.body.model).to.equal('text-embedding-3-small');
+        });
+        it('should support batch inputs', async () => {
+            const request = embeddings_request_1.EmbeddingRequest.fromInputAndModel(['Hello', 'World'], 'text-embedding-3-small');
+            const response = await openaiAPI.embed(request);
+            (0, chai_1.expect)(response.body.data[0].embedding).to.deep.equal([0.1, 0.2, 0.3]);
+            (0, chai_1.expect)(response.body.usage.totalTokens).to.equal(8);
+        });
+    });
+});
+//# sourceMappingURL=openai-api.spec.js.map

package/lib/common/api/openai-api.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-api.spec.js","sourceRoot":"","sources":["../../../src/common/api/openai-api.spec.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,uCAA8C;AAC9C,2DAAyD;AACzD,iDAA2C;AAC3C,iDAAuD;AACvD,6DAAwD;AACxD,uCAAiC;AACjC,oBAAkB;AAElB,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACvB,MAAM,SAAS,GAAG,IAAA,gCAAe,GAAE,CAAC;IACpC,IAAI,SAAoB,CAAC;IAEzB,qBAAqB;IACrB,MAAM,aAAa,GAAG;QAClB,IAAI,EAAE;YACF,EAAE,EAAE,cAAc;YAClB,MAAM,EAAE,iBAAiB;YACzB,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,eAAe;YACtB,OAAO,EAAE,CAAC;oBACN,KAAK,EAAE,CAAC;oBACR,OAAO,EAAE;wBACL,IAAI,EAAE,WAAW;wBACjB,OAAO,EAAE,kCAAkC;qBAC9C;oBACD,aAAa,EAAE,MAAM;iBACxB,CAAC;YACF,KAAK,EAAE;gBACH,aAAa,EAAE,CAAC;gBAChB,iBAAiB,EAAE,EAAE;gBACrB,YAAY,EAAE,EAAE;aACnB;SACJ;QACD,MAAM,EAAE;YACJ,EAAE,EAAE,cAAc;YAClB,MAAM,EAAE,uBAAuB;YAC/B,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,eAAe;YACtB,OAAO,EAAE,CAAC;oBACN,KAAK,EAAE,CAAC;oBACR,KAAK,EAAE;wBACH,IAAI,EAAE,WAAW;wBACjB,OAAO,EAAE,OAAO;qBACnB;iBACJ,CAAC;SACL;QACD,UAAU,EAAE;YACR,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;YACrE,KAAK,EAAE,wBAAwB;YAC/B,KAAK,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE;SAC/C;KACJ,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACZ,iCAAiC;QACjC,SAAS,CAAC,MAAM,CAAC,qBAAc,CAAC,CAAC,eAAe,CAAC;YAC7C,IAAI,EAAE,KAAK,EAAE,GAAW,EAAE,IAAS,EAAE,EAAE;gBACnC,IAAI,GAAG,KAAK,gBAAgB,EAAE;oBAC1B,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;iBAC7C;gBACD,IAAI,IAAI,CAAC,MAAM,EAAE;oBACb,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC;wBAC9B,KAAK,CAAC,UAAU;4BACZ,UAAU,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;4BACxE,UAAU,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;4BACvC,UAAU,CAAC,KAAK,EAAE,CAAC;wBACvB,CAAC;qBACJ,CAAC,CAAC;oBACH,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;iBAC3B;gBACD,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,EAAE,CAAC;YACxC,CAAC;SACJ,CAAC,CAAC;QACH,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,wBAAS,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;QAClB,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACtE,MAAM,OAAO,GAAG,IAAI,oCAAqB,EAAE,CAAC;YAC5C,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;YAChC,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAE3D,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/C,IAAA,aAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAClD,IAAA,aAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;YAC9F,IAAA,aAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,OAAO,GAAG,IAAI,oCAAqB,EAAE,CAAC;YAC5C,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;YAChC,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAC3D,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;YACtB,IAAI;gBACA,MAAM,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACjC;YAAC,OAAO,CAAC,EAAE;gBACR,IAAA,aAAM,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAA,aAAM,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,gDAAgD,CAAC,CAAC;aAClF;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;QAClB,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,OAAO,GAAG,IAAI,oCAAqB,EAAE,CAAC;YAC5C,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;YAChC,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAC3D,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC;YACvB,IAAI;gBACA,MAAM,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACjC;YAAC,OAAO,CAAC,EAAE;gBACR,IAAA,aAAM,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAA,aAAM,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,+CAA+C,CAAC,CAAC;aACjF;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,4CAA4C,EAAE,IAAI,CAAC,EAAE;YACpD,MAAM,OAAO,GAAG,IAAI,oCAAqB,EAAE,CAAC;YAC5C,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;YAChC,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAC3D,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;YAEtB,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBAC9C,SAAS,CAAC,SAAS,CAAC;oBAChB,IAAI,EAAE,KAAK,CAAC,EAAE;wBACV,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;wBAC/C,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;wBAC9D,IAAI,EAAE,CAAC;oBACX,CAAC;iBACJ,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,OAAO,GAAG,IAAI,oCAAqB,EAAE,CAAC;YAC5C,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;YAChC,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAC3D,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC;YAEvB,IAAI;gBACA,MAAM,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;aAC1C;YAAC,OAAO,CAAC,EAAE;gBACR,IAAA,aAAM,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAA,aAAM,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,+CAA+C,CAAC,CAAC;aACjF;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;QACnB,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,OAAO,GAAG,qCAAgB,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAEhD,IAAA,aAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC9C,IAAA,aAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YACvE,IAAA,aAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YACzC,MAAM,OAAO,GAAG,qCAAgB,CAAC,iBAAiB,CAC9C,CAAC,OAAO,EAAE,OAAO,CAAC,EAClB,wBAAwB,CAC3B,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChD,IAAA,aAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YACvE,IAAA,aAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/common/api/openai-model.d.ts

@@ -0,0 +1,117 @@
+/**
+ * OpenAI Chat Completion Models:
+ *
+ * - [GPT-4o](https://platform.openai.com/docs/models/gpt-4o)
+ * - [GPT-4o mini](https://platform.openai.com/docs/models/gpt-4o-mini)
+ * - [GPT-4 and GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo)
+ * - [GPT-3.5 Turbo](https://platform.openai.com/docs/models/gpt-3-5-turbo)
+ * - [DALL·E](https://platform.openai.com/docs/models/dall-e)
+ */
+export declare enum OpenAIModel {
+    /**
+     * Points to the most recent snapshot of the o1 model: o1-preview-2024-09-12
+     */
+    O1_PREVIEW = "o1-preview",
+    /**
+     * Latest o1 model snapshot
+     */
+    O1_PREVIEW_2024_09_12 = "o1-preview-2024-09-12",
+    /**
+     * Points to the most recent o1-mini snapshot: o1-mini-2024-09-12
+     */
+    O1_MINI = "o1-mini",
+    /**
+     * Latest o1-mini model snapshot
+     */
+    O1_MINI_2024_09_12 = "o1-mini-2024-09-12",
+    /**
+     * Multimodal flagship model that’s cheaper and faster than GPT-4 Turbo. Currently
+     * points to gpt-4o-2024-05-13.
+     */
+    GPT_4_O = "gpt-4o",
+    /**
+     * Preview release for audio inputs in chat completions.
+     */
+    GPT_4_O_AUDIO_PREVIEW = "gpt-4o-audio-preview",
+    /**
+     * Affordable and intelligent small model for fast, lightweight tasks. GPT-4o mini
+     * is cheaper and more capable than GPT-3.5 Turbo. Currently points to
+     * gpt-4o-mini-2024-07-18.
+     */
+    GPT_4_O_MINI = "gpt-4o-mini",
+    /**
+     * GPT-4 Turbo with Vision The latest GPT-4 Turbo model with vision capabilities.
+     * Vision requests can now use JSON mode and function calling. Currently points to
+     * gpt-4-turbo-2024-04-09.
+     */
+    GPT_4_TURBO = "gpt-4-turbo",
+    /**
+     * GPT-4 Turbo with Vision model. Vision requests can now use JSON mode and
+     * function calling.
+     */
+    GPT_4_TURBO_2024_04_09 = "gpt-4-turbo-2024-04-09",
+    /**
+     * (New) GPT-4 Turbo - latest GPT-4 model intended to reduce cases of “laziness”
+     * where the model doesn’t complete a task. Returns a maximum of 4,096 output
+     * tokens. Context window: 128k tokens
+     * Currently points to gpt-4-0125-preview
+     */
+    GPT_4_0125_PREVIEW = "gpt-4-0125-preview",
+    /**
+     * Currently points to gpt-4-0125-preview - model featuring improved instruction
+     * following, JSON mode, reproducible outputs, parallel function calling, and
+     * more. Returns a maximum of 4,096 output tokens Context window: 128k tokens
+     */
+    GPT_4_TURBO_PREVIEW = "gpt-4-turbo-preview",
+    /**
+     * Currently points to gpt-4-0613. Snapshot of gpt-4 from June 13th 2023 with
+     * improved function calling support. Context window: 8k tokens
+     * Returns a maximum of 4,096 output tokens Context window: 8k tokens
+     */
+    GPT_4 = "gpt-4",
+    /**
+     * Currently points to gpt-3.5-turbo-0125. model with higher accuracy at
+     * responding in requested formats and a fix for a bug which caused a text
+     * encoding issue for non-English language function calls. Returns a maximum of
+     * 4,096 Context window: 16k tokens
+     */
+    GPT_3_5_TURBO = "gpt-3.5-turbo",
+    /**
+     * Currently points to gpt-3.5-turbo-0125. model with higher accuracy at
+     * responding in requested formats and a fix for a bug which caused a text
+     * encoding issue for non-English language function calls. Returns a maximum of
+     * 4,096 Context window: 16k tokens
+     */
+    GPT_3_5_TURBO_0125 = "gpt-3.5-turbo-0125",
+    /**
+     * GPT-3.5 Turbo model with improved instruction following, JSON mode,
+     * reproducible outputs, parallel function calling, and more. Returns a maximum of
+     * 4,096 output tokens. Context window: 16k tokens.
+     */
+    GPT_3_5_TURBO_1106 = "gpt-3.5-turbo-1106",
+    /**
+     * Most capable embedding model for both English and non-English tasks. DIMENSION:
+     * 3072
+     */
+    TEXT_EMBEDDING_3_LARGE = "text-embedding-3-large",
+    /**
+     * Increased performance over 2nd generation ada embedding model. DIMENSION: 1536
+     */
+    TEXT_EMBEDDING_3_SMALL = "text-embedding-3-small",
+    /**
+     * Most capable 2nd generation embedding model, replacing 16 first generation
+     * models. DIMENSION: 1536
+     */
+    TEXT_EMBEDDING_ADA_002 = "text-embedding-ada-002",
+    /**
+     * The latest DALL·E model released in Nov 2023.
+     */
+    DALL_E_3 = "dall-e-3",
+    /**
+     * The previous DALL·E model released in Nov 2022. The 2nd iteration of DALL·E
+     * with more realistic, accurate, and 4x greater resolution images than the
+     * original model.
+     */
+    DALL_E_2 = "dall-e-2"
+}
+//# sourceMappingURL=openai-model.d.ts.map

package/lib/common/api/openai-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-model.d.ts","sourceRoot":"","sources":["../../../src/common/api/openai-model.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AACH,oBAAY,WAAW;IAEnB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,qBAAqB,0BAA0B;IAE/C;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,kBAAkB,uBAAuB;IAEzC;;;OAGG;IACH,OAAO,WAAW;IAElB;;OAEG;IACH,qBAAqB,yBAAyB;IAE9C;;;;OAIG;IACH,YAAY,gBAAgB;IAE5B;;;;OAIG;IACH,WAAW,gBAAgB;IAE3B;;;OAGG;IACH,sBAAsB,2BAA2B;IAEjD;;;;;OAKG;IACH,kBAAkB,uBAAuB;IAEzC;;;;OAIG;IACH,mBAAmB,wBAAwB;IAE3C;;;;OAIG;IACH,KAAK,UAAU;IAEf;;;;;OAKG;IACH,aAAa,kBAAkB;IAE/B;;;;;OAKG;IACH,kBAAkB,uBAAuB;IAEzC;;;;OAIG;IACH,kBAAkB,uBAAuB;IAEzC;;;OAGG;IACH,sBAAsB,2BAA2B;IAEjD;;OAEG;IACH,sBAAsB,2BAA2B;IAEjD;;;OAGG;IACH,sBAAsB,2BAA2B;IAEjD;;OAEG;IACH,QAAQ,aAAa;IAErB;;;;OAIG;IACH,QAAQ,aAAa;CACxB"}

package/lib/common/api/openai-model.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAIModel = void 0;
+/**
+ * OpenAI Chat Completion Models:
+ *
+ * - [GPT-4o](https://platform.openai.com/docs/models/gpt-4o)
+ * - [GPT-4o mini](https://platform.openai.com/docs/models/gpt-4o-mini)
+ * - [GPT-4 and GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo)
+ * - [GPT-3.5 Turbo](https://platform.openai.com/docs/models/gpt-3-5-turbo)
+ * - [DALL·E](https://platform.openai.com/docs/models/dall-e)
+ */
+var OpenAIModel;
+(function (OpenAIModel) {
+    /**
+     * Points to the most recent snapshot of the o1 model: o1-preview-2024-09-12
+     */
+    OpenAIModel["O1_PREVIEW"] = "o1-preview";
+    /**
+     * Latest o1 model snapshot
+     */
+    OpenAIModel["O1_PREVIEW_2024_09_12"] = "o1-preview-2024-09-12";
+    /**
+     * Points to the most recent o1-mini snapshot: o1-mini-2024-09-12
+     */
+    OpenAIModel["O1_MINI"] = "o1-mini";
+    /**
+     * Latest o1-mini model snapshot
+     */
+    OpenAIModel["O1_MINI_2024_09_12"] = "o1-mini-2024-09-12";
+    /**
+     * Multimodal flagship model that’s cheaper and faster than GPT-4 Turbo. Currently
+     * points to gpt-4o-2024-05-13.
+     */
+    OpenAIModel["GPT_4_O"] = "gpt-4o";
+    /**
+     * Preview release for audio inputs in chat completions.
+     */
+    OpenAIModel["GPT_4_O_AUDIO_PREVIEW"] = "gpt-4o-audio-preview";
+    /**
+     * Affordable and intelligent small model for fast, lightweight tasks. GPT-4o mini
+     * is cheaper and more capable than GPT-3.5 Turbo. Currently points to
+     * gpt-4o-mini-2024-07-18.
+     */
+    OpenAIModel["GPT_4_O_MINI"] = "gpt-4o-mini";
+    /**
+     * GPT-4 Turbo with Vision The latest GPT-4 Turbo model with vision capabilities.
+     * Vision requests can now use JSON mode and function calling. Currently points to
+     * gpt-4-turbo-2024-04-09.
+     */
+    OpenAIModel["GPT_4_TURBO"] = "gpt-4-turbo";
+    /**
+     * GPT-4 Turbo with Vision model. Vision requests can now use JSON mode and
+     * function calling.
+     */
+    OpenAIModel["GPT_4_TURBO_2024_04_09"] = "gpt-4-turbo-2024-04-09";
+    /**
+     * (New) GPT-4 Turbo - latest GPT-4 model intended to reduce cases of “laziness”
+     * where the model doesn’t complete a task. Returns a maximum of 4,096 output
+     * tokens. Context window: 128k tokens
+     * Currently points to gpt-4-0125-preview
+     */
+    OpenAIModel["GPT_4_0125_PREVIEW"] = "gpt-4-0125-preview";
+    /**
+     * Currently points to gpt-4-0125-preview - model featuring improved instruction
+     * following, JSON mode, reproducible outputs, parallel function calling, and
+     * more. Returns a maximum of 4,096 output tokens Context window: 128k tokens
+     */
+    OpenAIModel["GPT_4_TURBO_PREVIEW"] = "gpt-4-turbo-preview";
+    /**
+     * Currently points to gpt-4-0613. Snapshot of gpt-4 from June 13th 2023 with
+     * improved function calling support. Context window: 8k tokens
+     * Returns a maximum of 4,096 output tokens Context window: 8k tokens
+     */
+    OpenAIModel["GPT_4"] = "gpt-4";
+    /**
+     * Currently points to gpt-3.5-turbo-0125. model with higher accuracy at
+     * responding in requested formats and a fix for a bug which caused a text
+     * encoding issue for non-English language function calls. Returns a maximum of
+     * 4,096 Context window: 16k tokens
+     */
+    OpenAIModel["GPT_3_5_TURBO"] = "gpt-3.5-turbo";
+    /**
+     * Currently points to gpt-3.5-turbo-0125. model with higher accuracy at
+     * responding in requested formats and a fix for a bug which caused a text
+     * encoding issue for non-English language function calls. Returns a maximum of
+     * 4,096 Context window: 16k tokens
+     */
+    OpenAIModel["GPT_3_5_TURBO_0125"] = "gpt-3.5-turbo-0125";
+    /**
+     * GPT-3.5 Turbo model with improved instruction following, JSON mode,
+     * reproducible outputs, parallel function calling, and more. Returns a maximum of
+     * 4,096 output tokens. Context window: 16k tokens.
+     */
+    OpenAIModel["GPT_3_5_TURBO_1106"] = "gpt-3.5-turbo-1106";
+    /**
+     * Most capable embedding model for both English and non-English tasks. DIMENSION:
+     * 3072
+     */
+    OpenAIModel["TEXT_EMBEDDING_3_LARGE"] = "text-embedding-3-large";
+    /**
+     * Increased performance over 2nd generation ada embedding model. DIMENSION: 1536
+     */
+    OpenAIModel["TEXT_EMBEDDING_3_SMALL"] = "text-embedding-3-small";
+    /**
+     * Most capable 2nd generation embedding model, replacing 16 first generation
+     * models. DIMENSION: 1536
+     */
+    OpenAIModel["TEXT_EMBEDDING_ADA_002"] = "text-embedding-ada-002";
+    /**
+     * The latest DALL·E model released in Nov 2023.
+     */
+    OpenAIModel["DALL_E_3"] = "dall-e-3";
+    /**
+     * The previous DALL·E model released in Nov 2022. The 2nd iteration of DALL·E
+     * with more realistic, accurate, and 4x greater resolution images than the
+     * original model.
+     */
+    OpenAIModel["DALL_E_2"] = "dall-e-2";
+})(OpenAIModel = exports.OpenAIModel || (exports.OpenAIModel = {}));
+//# sourceMappingURL=openai-model.js.map

package/lib/common/api/openai-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-model.js","sourceRoot":"","sources":["../../../src/common/api/openai-model.ts"],"names":[],"mappings":";;;AACA;;;;;;;;GAQG;AACH,IAAY,WA8HX;AA9HD,WAAY,WAAW;IAEnB;;OAEG;IACH,wCAAyB,CAAA;IAEzB;;OAEG;IACH,8DAA+C,CAAA;IAE/C;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,wDAAyC,CAAA;IAEzC;;;OAGG;IACH,iCAAkB,CAAA;IAElB;;OAEG;IACH,6DAA8C,CAAA;IAE9C;;;;OAIG;IACH,2CAA4B,CAAA;IAE5B;;;;OAIG;IACH,0CAA2B,CAAA;IAE3B;;;OAGG;IACH,gEAAiD,CAAA;IAEjD;;;;;OAKG;IACH,wDAAyC,CAAA;IAEzC;;;;OAIG;IACH,0DAA2C,CAAA;IAE3C;;;;OAIG;IACH,8BAAe,CAAA;IAEf;;;;;OAKG;IACH,8CAA+B,CAAA;IAE/B;;;;;OAKG;IACH,wDAAyC,CAAA;IAEzC;;;;OAIG;IACH,wDAAyC,CAAA;IAEzC;;;OAGG;IACH,gEAAiD,CAAA;IAEjD;;OAEG;IACH,gEAAiD,CAAA;IAEjD;;;OAGG;IACH,gEAAiD,CAAA;IAEjD;;OAEG;IACH,oCAAqB,CAAA;IAErB;;;;OAIG;IACH,oCAAqB,CAAA;AACzB,CAAC,EA9HW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA8HtB"}

package/lib/common/api/response-format.d.ts

@@ -0,0 +1,60 @@
+export declare enum ResponseFormatType {
+    TEXT = "text",
+    JSON_OBJECT = "json_object",
+    JSON_SCHEMA = "json_schema"
+}
+export declare class JsonSchema {
+    name: string;
+    schema: Map<string, any>;
+    strict: boolean;
+    constructor(name: string, schema: Map<string, any>, strict: boolean);
+    static builder(): JsonSchemaBuilder;
+}
+export declare class JsonSchemaBuilder {
+    private name;
+    private schema;
+    private strict;
+    withName(name: string): this;
+    withSchema(schema: Map<string, any>): this;
+    withStrict(strict: boolean): this;
+    build(): JsonSchema;
+}
+/**
+ * An object specifying the format that the model must output.
+ *
+ * Setting the type to JSON_SCHEMA, enables Structured Outputs which ensures the model
+ * will match your supplied JSON schema. Learn more in the
+ * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+ *
+ * References: [OpenAi API - ResponseFormat](https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format),
+ * [JSON Mode](https://platform.openai.com/docs/guides/structured-outputs#json-mode),
+ * [Structured Outputs vs JSON mode](https://platform.openai.com/docs/guides/structured-outputs#structured-outputs-vs-json-mode)
+ */
+export declare class ResponseFormat {
+    /**
+     * Type Must be one of 'text', 'json_object' or 'json_schema'.
+     */
+    type: ResponseFormatType;
+    /**
+     * JSON schema object that describes the format of the JSON object. Only applicable
+     * when type is 'json_schema'.
+     */
+    schema?: JsonSchema;
+    /**
+     * Whether the model must strictly adhere to the schema. Only applicable when type is
+     * 'json_schema'.
+     */
+    strict?: boolean;
+    constructor(type: ResponseFormatType, schema?: JsonSchema, strict?: boolean);
+    static builder(): ResponseFormatBuilder;
+}
+export declare class ResponseFormatBuilder {
+    private type;
+    private schema?;
+    private strict?;
+    withType(type: ResponseFormatType): this;
+    withSchema(schema: JsonSchema): this;
+    withStrict(strict: boolean): this;
+    build(): ResponseFormat;
+}
+//# sourceMappingURL=response-format.d.ts.map

package/lib/common/api/response-format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-format.d.ts","sourceRoot":"","sources":["../../../src/common/api/response-format.ts"],"names":[],"mappings":"AAAA,oBAAY,kBAAkB;IAC1B,IAAI,SAAS;IACb,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;CAC9B;AAED,qBAAa,UAAU;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;gBACJ,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO;IAMnE,MAAM,CAAC,OAAO;CAGjB;AAED,qBAAa,iBAAiB;IAC1B,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,MAAM,CAAU;IAExB,QAAQ,CAAC,IAAI,EAAE,MAAM;IAKrB,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC;IAKnC,UAAU,CAAC,MAAM,EAAE,OAAO;IAK1B,KAAK;CAGR;AAED;;;;;;;;;;GAUG;AACH,qBAAa,cAAc;IACvB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;gBAEL,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,OAAO;IAM3E,MAAM,CAAC,OAAO;CAGjB;AAED,qBAAa,qBAAqB;IAC9B,OAAO,CAAC,IAAI,CAAqB;IACjC,OAAO,CAAC,MAAM,CAAC,CAAa;IAC5B,OAAO,CAAC,MAAM,CAAC,CAAU;IAEzB,QAAQ,CAAC,IAAI,EAAE,kBAAkB;IAKjC,UAAU,CAAC,MAAM,EAAE,UAAU;IAK7B,UAAU,CAAC,MAAM,EAAE,OAAO;IAI1B,KAAK;CAGR"}

package/lib/common/api/response-format.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseFormatBuilder = exports.ResponseFormat = exports.JsonSchemaBuilder = exports.JsonSchema = exports.ResponseFormatType = void 0;
+var ResponseFormatType;
+(function (ResponseFormatType) {
+    ResponseFormatType["TEXT"] = "text";
+    ResponseFormatType["JSON_OBJECT"] = "json_object";
+    ResponseFormatType["JSON_SCHEMA"] = "json_schema";
+})(ResponseFormatType = exports.ResponseFormatType || (exports.ResponseFormatType = {}));
+class JsonSchema {
+    constructor(name, schema, strict) {
+        this.name = name;
+        this.schema = schema;
+        this.strict = strict;
+    }
+    static builder() {
+        return new JsonSchemaBuilder();
+    }
+}
+exports.JsonSchema = JsonSchema;
+class JsonSchemaBuilder {
+    withName(name) {
+        this.name = name;
+        return this;
+    }
+    withSchema(schema) {
+        this.schema = schema;
+        return this;
+    }
+    withStrict(strict) {
+        this.strict = strict;
+        return this;
+    }
+    build() {
+        return new JsonSchema(this.name, this.schema, this.strict);
+    }
+}
+exports.JsonSchemaBuilder = JsonSchemaBuilder;
+/**
+ * An object specifying the format that the model must output.
+ *
+ * Setting the type to JSON_SCHEMA, enables Structured Outputs which ensures the model
+ * will match your supplied JSON schema. Learn more in the
+ * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+ *
+ * References: [OpenAi API - ResponseFormat](https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format),
+ * [JSON Mode](https://platform.openai.com/docs/guides/structured-outputs#json-mode),
+ * [Structured Outputs vs JSON mode](https://platform.openai.com/docs/guides/structured-outputs#structured-outputs-vs-json-mode)
+ */
+class ResponseFormat {
+    constructor(type, schema, strict) {
+        this.type = type;
+        this.schema = schema;
+        this.strict = strict;
+    }
+    static builder() {
+        return new ResponseFormatBuilder();
+    }
+}
+exports.ResponseFormat = ResponseFormat;
+class ResponseFormatBuilder {
+    withType(type) {
+        this.type = type;
+        return this;
+    }
+    withSchema(schema) {
+        this.schema = schema;
+        return this;
+    }
+    withStrict(strict) {
+        this.strict = strict;
+        return this;
+    }
+    build() {
+        return new ResponseFormat(this.type, this.schema, this.strict);
+    }
+}
+exports.ResponseFormatBuilder = ResponseFormatBuilder;
+//# sourceMappingURL=response-format.js.map

package/lib/common/api/response-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-format.js","sourceRoot":"","sources":["../../../src/common/api/response-format.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,iDAA2B,CAAA;IAC3B,iDAA2B,CAAA;AAC/B,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,MAAa,UAAU;IAInB,YAAY,IAAY,EAAE,MAAwB,EAAE,MAAe;QAC/D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,OAAO;QACV,OAAO,IAAI,iBAAiB,EAAE,CAAC;IACnC,CAAC;CACJ;AAbD,gCAaC;AAED,MAAa,iBAAiB;IAK1B,QAAQ,CAAC,IAAY;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,UAAU,CAAC,MAAwB;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,UAAU,CAAC,MAAe;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK;QACD,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;CACJ;AAvBD,8CAuBC;AAED;;;;;;;;;;GAUG;AACH,MAAa,cAAc;IAkBvB,YAAY,IAAwB,EAAE,MAAmB,EAAE,MAAgB;QACvE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,OAAO;QACV,OAAO,IAAI,qBAAqB,EAAE,CAAC;IACvC,CAAC;CACJ;AA3BD,wCA2BC;AAED,MAAa,qBAAqB;IAK9B,QAAQ,CAAC,IAAwB;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,UAAU,CAAC,MAAkB;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,UAAU,CAAC,MAAe;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,KAAK;QACD,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACnE,CAAC;CACJ;AAtBD,sDAsBC"}

package/lib/common/api/usage.d.ts

@@ -0,0 +1,79 @@
+import { Usage as IUsage } from '@celljs/ai-core';
+/**
+ * Breakdown of tokens used in the prompt.
+ */
+export declare class PromptTokensDetails {
+    /**
+     * Audio input tokens present in the prompt.
+     */
+    audioTokens?: number;
+    /**
+     * Cached tokens present in the prompt.
+     */
+    cachedTokens?: number;
+    constructor(audioTokens?: number, cachedTokens?: number);
+}
+/**
+ * Breakdown of tokens used in a completion.
+ */
+export declare class CompletionTokenDetails {
+    /**
+     * Number of tokens generated by the model for reasoning.
+     */
+    reasoningTokens?: number;
+    /**
+     * Number of tokens generated by the model for accepted predictions.
+     */
+    acceptedPredictionTokens?: number;
+    /**
+     * Number of tokens generated by the model for audio.
+     */
+    audioTokens?: number;
+    /**
+     * Number of tokens generated by the model for rejected predictions.
+     */
+    rejectedPredictionTokens?: number;
+    constructor(reasoningTokens?: number, acceptedPredictionTokens?: number, audioTokens?: number, rejectedPredictionTokens?: number);
+}
+/**
+ * The response object returned from the /embedding endpoint.
+ */
+export declare class EmbeddingsResponse {
+    /**
+     * The model used for generating the embeddings.
+     */
+    model: string;
+    /**
+     * The list of embeddings generated from the model.
+     * Each embedding (list of doubles) corresponds to a single input text.
+     */
+    embeddings: number[][];
+    constructor(model: string, embeddings: number[][]);
+}
+/**
+ * Usage statistics for the completion request.
+ */
+export declare class Usage implements IUsage {
+    /**
+     * Number of tokens in the generated completion. Only applicable for completion requests.
+     */
+    completionTokens?: number;
+    /**
+     * Number of tokens in the prompt.
+     */
+    promptTokens?: number;
+    /**
+     * Total number of tokens used in the request (prompt + completion).
+     */
+    totalTokens?: number;
+    /**
+     * Breakdown of tokens used in the prompt.
+     */
+    promptTokensDetails?: PromptTokensDetails;
+    /**
+     * Breakdown of tokens used in a completion.
+     */
+    completionTokenDetails?: CompletionTokenDetails;
+    constructor(completionTokens?: number, promptTokens?: number, totalTokens?: number, promptTokensDetails?: PromptTokensDetails, completionTokenDetails?: CompletionTokenDetails);
+}
+//# sourceMappingURL=usage.d.ts.map

package/lib/common/api/usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../../src/common/api/usage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAGlD;;GAEG;AACH,qBAAa,mBAAmB;IAC5B;;OAEG;IAEH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IAEH,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEV,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;CAI1D;AAED;;GAEG;AACH,qBAAa,sBAAsB;IAC/B;;OAEG;IAEH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IAEH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IAEH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IAEH,wBAAwB,CAAC,EAAE,MAAM,CAAC;gBAG9B,eAAe,CAAC,EAAE,MAAM,EACxB,wBAAwB,CAAC,EAAE,MAAM,EACjC,WAAW,CAAC,EAAE,MAAM,EACpB,wBAAwB,CAAC,EAAE,MAAM;CAOxC;AAED;;GAEG;AACH,qBAAa,kBAAkB;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC;gBAEX,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE;CAIpD;AAED;;GAEG;AACH,qBAAa,KAAM,YAAW,MAAM;IAChC;;OAEG;IAEH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IAEH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IAEH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IAEH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C;;OAEG;IAEH,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;gBAG5C,gBAAgB,CAAC,EAAE,MAAM,EACzB,YAAY,CAAC,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,MAAM,EACpB,mBAAmB,CAAC,EAAE,mBAAmB,EACzC,sBAAsB,CAAC,EAAE,sBAAsB;CAQtD"}