@compassdigital/sdk.typescript 4.400.0 → 4.402.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.400.0",
+	"version": "4.402.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -1306,6 +1306,8 @@ import {
 	PostAiImageGenerateResponse,
 	PostAiTranslateBody,
 	PostAiTranslateResponse,
+	PostOpenaiChatBody,
+	PostOpenaiChatResponse,
 } from './interface/ai';
 
 import {
@@ -14274,6 +14276,19 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('ai', '/ai/translate', 'POST', `/ai/translate`, body, options);
 	}
 
+	/**
+	 * POST /ai/openai/chat - Chat with OpenAI
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_openai_chat(
+		body: PostOpenaiChatBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostOpenaiChatResponse> {
+		return this.request('ai', '/ai/openai/chat', 'POST', `/ai/openai/chat`, body, options);
+	}
+
 	/**
 	 * POST /centricos/ai/item/description - Generate item description
 	 *

package/src/interface/ai.ts

@@ -78,6 +78,56 @@ export interface TranslateResponse {
 	translations: Record<string, string>;
 }
 
+export interface OpenAiChatMessage {
+	// The role of the message
+	role: 'developer' | 'system' | 'user' | 'assistant' | 'tool' | 'function';
+	// The content of the message
+	content: string;
+	// The name of the message
+	name: string;
+	// The tool calls of the message
+	toolCalls: string[];
+	// The tool call ID (for tool role messages)
+	toolCallId: string;
+}
+
+export interface OpenAiChatBody {
+	// The model to use for the chat completion
+	model: string;
+	// The messages to send to the chat completion
+	messages: OpenAiChatMessage[];
+	// The tools to use for the chat completion
+	tools: string[];
+	// The tool choices to use for the chat completion
+	tool_choice: Record<string, any>;
+	// The temperature to use for the chat completion
+	temperature: number;
+	// The max tokens to use for the chat completion
+	max_tokens: number;
+}
+
+export interface OpenAiChatChoice {
+	// The index of the choice
+	index: number;
+	// The message of the choice
+	message: OpenAiChatMessage;
+	// The finish reason of the choice
+	finishReason: string;
+}
+
+export interface OpenAiChatResponse {
+	// The id of the chat completion
+	id: string;
+	// The object of the chat completion
+	object: string;
+	// The created at of the chat completion
+	created: number;
+	// The model of the chat completion
+	model: string;
+	// The choices of the chat completion
+	choices: OpenAiChatChoice[];
+}
+
 // POST /ai/language/generate - Generate text from a given prompt
 
 export type PostAiLanguageGenerateBody = GenerateTextRequest;
@@ -95,3 +145,9 @@ export type PostAiImageGenerateResponse = GenerateImageResponse;
 export type PostAiTranslateBody = TranslateRequest;
 
 export type PostAiTranslateResponse = TranslateResponse;
+
+// POST /ai/openai/chat - Chat with OpenAI
+
+export type PostOpenaiChatBody = OpenAiChatBody;
+
+export type PostOpenaiChatResponse = OpenAiChatResponse;