@inference-gateway/sdk 0.6.0 → 0.6.1

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.6.1](https://github.com/inference-gateway/typescript-sdk/compare/v0.6.0...v0.6.1) (2025-04-28)
+
+### ♻️ Improvements
+
+*  Remove redundant request option ([#11](https://github.com/inference-gateway/typescript-sdk/issues/11)) ([82e34e2](https://github.com/inference-gateway/typescript-sdk/commit/82e34e2ee9782fd224945bff1bd4daf2859a4f79))
+
 ## [0.6.0](https://github.com/inference-gateway/typescript-sdk/compare/v0.5.1...v0.6.0) (2025-04-28)
 
 ### ✨ Features

package/dist/src/client.d.ts

@@ -40,11 +40,16 @@ export declare class InferenceGatewayClient {
     /**
      * Creates a chat completion.
      */
-    createChatCompletion(request: SchemaCreateChatCompletionRequest, provider?: Provider): Promise<SchemaCreateChatCompletionResponse>;
+    createChatCompletion(request: Omit<SchemaCreateChatCompletionRequest, 'stream'>, provider?: Provider): Promise<SchemaCreateChatCompletionResponse>;
     /**
      * Creates a streaming chat completion.
+     * This method always sets stream=true internally, so there's no need to specify it in the request.
+     *
+     * @param request - Chat completion request (must include at least model and messages)
+     * @param callbacks - Callbacks for handling streaming events
+     * @param provider - Optional provider to use for this request
      */
-    streamChatCompletion(request: SchemaCreateChatCompletionRequest, callbacks: ChatCompletionStreamCallbacks, provider?: Provider): Promise<void>;
+    streamChatCompletion(request: Omit<SchemaCreateChatCompletionRequest, 'stream' | 'stream_options'>, callbacks: ChatCompletionStreamCallbacks, provider?: Provider): Promise<void>;
     /**
      * Proxy a request to a specific provider.
      */

package/dist/src/client.js

@@ -87,11 +87,16 @@ class InferenceGatewayClient {
         }
         return this.request('/chat/completions', {
             method: 'POST',
-            body: JSON.stringify(request),
+            body: JSON.stringify({ ...request, stream: false }),
         }, query);
     }
     /**
      * Creates a streaming chat completion.
+     * This method always sets stream=true internally, so there's no need to specify it in the request.
+     *
+     * @param request - Chat completion request (must include at least model and messages)
+     * @param callbacks - Callbacks for handling streaming events
+     * @param provider - Optional provider to use for this request
      */
     async streamChatCompletion(request, callbacks, provider) {
         const query = {};
@@ -120,6 +125,9 @@ class InferenceGatewayClient {
                 body: JSON.stringify({
                     ...request,
                     stream: true,
+                    stream_options: {
+                        include_usage: true,
+                    },
                 }),
                 signal: controller.signal,
             });

package/dist/tests/client.test.js

@@ -89,7 +89,6 @@ describe('InferenceGatewayClient', () => {
                     { role: generated_1.MessageRole.system, content: 'You are a helpful assistant' },
                     { role: generated_1.MessageRole.user, content: 'Hello' },
                 ],
-                stream: false,
             };
             const mockResponse = {
                 id: 'chatcmpl-123',
@@ -120,14 +119,13 @@ describe('InferenceGatewayClient', () => {
             expect(result).toEqual(mockResponse);
             expect(mockFetch).toHaveBeenCalledWith('http://localhost:8080/v1/chat/completions', expect.objectContaining({
                 method: 'POST',
-                body: JSON.stringify(mockRequest),
+                body: JSON.stringify({ ...mockRequest, stream: false }),
             }));
         });
         it('should create a chat completion with a specific provider', async () => {
             const mockRequest = {
                 model: 'claude-3-opus-20240229',
                 messages: [{ role: generated_1.MessageRole.user, content: 'Hello' }],
-                stream: false,
             };
             const mockResponse = {
                 id: 'chatcmpl-456',
@@ -158,7 +156,7 @@ describe('InferenceGatewayClient', () => {
             expect(result).toEqual(mockResponse);
             expect(mockFetch).toHaveBeenCalledWith('http://localhost:8080/v1/chat/completions?provider=anthropic', expect.objectContaining({
                 method: 'POST',
-                body: JSON.stringify(mockRequest),
+                body: JSON.stringify({ ...mockRequest, stream: false }),
             }));
         });
     });
@@ -167,7 +165,6 @@ describe('InferenceGatewayClient', () => {
             const mockRequest = {
                 model: 'gpt-4o',
                 messages: [{ role: generated_1.MessageRole.user, content: 'Hello' }],
-                stream: true,
             };
             const mockStream = new web_1.TransformStream();
             const writer = mockStream.writable.getWriter();
@@ -201,6 +198,9 @@ describe('InferenceGatewayClient', () => {
                 body: JSON.stringify({
                     ...mockRequest,
                     stream: true,
+                    stream_options: {
+                        include_usage: true,
+                    },
                 }),
             }));
         });
@@ -208,7 +208,6 @@ describe('InferenceGatewayClient', () => {
             const mockRequest = {
                 model: 'gpt-4o',
                 messages: [{ role: generated_1.MessageRole.user, content: 'Hello' }],
-                stream: true,
             };
             const mockStream = new web_1.TransformStream();
             const writer = mockStream.writable.getWriter();
@@ -253,6 +252,9 @@ describe('InferenceGatewayClient', () => {
                 body: JSON.stringify({
                     ...mockRequest,
                     stream: true,
+                    stream_options: {
+                        include_usage: true,
+                    },
                 }),
             }));
         });
@@ -274,7 +276,6 @@ describe('InferenceGatewayClient', () => {
                         },
                     },
                 ],
-                stream: true,
             };
             const mockStream = new web_1.TransformStream();
             const writer = mockStream.writable.getWriter();
@@ -312,12 +313,21 @@ describe('InferenceGatewayClient', () => {
                 },
             });
             expect(callbacks.onFinish).toHaveBeenCalledTimes(1);
+            expect(mockFetch).toHaveBeenCalledWith('http://localhost:8080/v1/chat/completions', expect.objectContaining({
+                method: 'POST',
+                body: JSON.stringify({
+                    ...mockRequest,
+                    stream: true,
+                    stream_options: {
+                        include_usage: true,
+                    },
+                }),
+            }));
         });
         it('should handle errors in streaming chat completions', async () => {
             const mockRequest = {
                 model: 'gpt-4o',
                 messages: [{ role: generated_1.MessageRole.user, content: 'Hello' }],
-                stream: true,
             };
             mockFetch.mockResolvedValueOnce({
                 ok: false,
@@ -334,10 +344,6 @@ describe('InferenceGatewayClient', () => {
             const mockRequest = {
                 model: 'gpt-4o',
                 messages: [{ role: generated_1.MessageRole.user, content: 'Hello' }],
-                stream: true,
-                stream_options: {
-                    include_usage: true,
-                },
             };
             const mockStream = new web_1.TransformStream();
             const writer = mockStream.writable.getWriter();
@@ -379,6 +385,9 @@ describe('InferenceGatewayClient', () => {
                 body: JSON.stringify({
                     ...mockRequest,
                     stream: true,
+                    stream_options: {
+                        include_usage: true,
+                    },
                 }),
             }));
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inference-gateway/sdk",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "An SDK written in Typescript for the [Inference Gateway](https://github.com/inference-gateway/inference-gateway).",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",