@celljs/ai-openai 3.6.2 → 3.6.4

package/src/common/api/chat-request.ts

@@ -5,16 +5,18 @@ import { ResponseFormat } from './response-format';
 export class StreamOptions {
     static INCLUDE_USAGE = new StreamOptions(true);
 
-    constructor(
-        /**
-         * includeUsage If set, an additional chunk will be streamed
-         * before the data: [DONE] message. The usage field on this chunk
-         * shows the token usage statistics for the entire request, and
-         * the choices field will always be an empty array. All other chunks
-         * will also include a usage field, but with a null value.
-         */
-        public includeUsage: boolean
-    ) {
+    /**
+     * includeUsage If set, an additional chunk will be streamed
+     * before the data: [DONE] message. The usage field on this chunk
+     * shows the token usage statistics for the entire request, and
+     * the choices field will always be an empty array. All other chunks
+     * will also include a usage field, but with a null value.
+     */
+    @Expose({ name: 'include_usage' })
+    includeUsage: boolean;
+
+    constructor(includeUsage: boolean) {
+        this.includeUsage = includeUsage;
     }
 }
 
@@ -22,9 +24,13 @@ export class StreamOptions {
  * Function definition.
  */
 export class Function {
+    @Expose()
     description: string;
+    @Expose()
     name: string;
+    @Expose()
     parameters: Record<string, any>;
+    @Expose()
     strict?: boolean;
 
     static create(description: string, name: string, parameters: Record<string, any>, strict?: boolean): Function {
@@ -48,11 +54,14 @@ export class FunctionTool {
     /**
      * The type of the tool. Currently, only 'function' is supported.
      */
+    @Expose()
     type: ToolType;
 
     /**
      * The function definition.
      */
+    @Type(() => Function)
+    @Expose()
     function: Function;
 
     static create(func: Function): FunctionTool {
@@ -92,10 +101,12 @@ export class AudioParameters {
     /**
      * Specifies the voice type.
      */
+    @Expose()
     voice?: Voice;
     /**
      * Specifies the output audio format.
      */
+    @Expose({ name: 'response_format' })
     format?: AudioResponseFormat;
 }
 
@@ -106,20 +117,25 @@ export class ChatCompletionRequest {
     /**
      * A list of messages comprising the conversation so far.
      */
+    @Type(() => ChatCompletionMessage)
+    @Expose()
     messages: ChatCompletionMessage[];
 
     /**
      * ID of the model to use.
      */
+    @Expose()
     model: string;
     /**
      * Whether to store the output of this chat completion request for use in OpenAI's model distillation or evals products.
      */
+    @Expose()
     store?: boolean;
 
     /**
      * Developer-defined tags and values used for filtering completions in the OpenAI's dashboard.
      */
+    @Expose()
     metadata?: Record<string, any>;
 
     /**
@@ -139,6 +155,7 @@ export class ChatCompletionRequest {
     /**
      * Whether to return log probabilities of the output tokens or not.
      */
+    @Expose()
     logprobs?: boolean;
 
     /**
@@ -150,6 +167,7 @@ export class ChatCompletionRequest {
     /**
      * @deprecated The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API.
      */
+    @Expose({ name: 'max_tokens' })
     maxTokens?: number;
 
     /**
@@ -161,6 +179,7 @@ export class ChatCompletionRequest {
     /**
      * How many chat completion choices to generate for each input message.
      */
+    @Expose()
     n?: number;
 
     /**
@@ -194,6 +213,7 @@ export class ChatCompletionRequest {
      * If specified, our system will make a best effort to sample deterministically,
      * such that repeated requests with the same seed and parameters should return the same result.
      */
+    @Expose()
     seed?: number;
 
     /**
@@ -205,11 +225,13 @@ export class ChatCompletionRequest {
     /**
      * Up to 4 sequences where the API will stop generating further tokens.
      */
+    @Expose()
     stop?: string[];
 
     /**
      * Options for streaming response.
      */
+    @Expose()
     stream?: boolean;
 
     /**
@@ -223,6 +245,7 @@ export class ChatCompletionRequest {
      * What sampling temperature to use, between 0 and 1. Higher values like 0.8 will make the output more random,
      * while lower values like 0.2 will make it more focused and deterministic.
      */
+    @Expose()
     temperature?: number;
 
     /**
@@ -254,6 +277,7 @@ export class ChatCompletionRequest {
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
      */
+    @Expose()
     user?: string;
 
     /**

package/src/common/api/chat-response.ts

@@ -9,10 +9,12 @@ export class TopLogProbs {
     /**
      * The token.
      */
+    @Expose()
     token: string;
     /**
      * The log probability of the token.
      */
+    @Expose()
     logprob: number;
     /**
      * A list of integers representing the UTF-8 bytes
@@ -32,10 +34,12 @@ export class Content {
     /**
      * The token.
      */
+    @Expose()
     token: string;
     /**
      * The log probability of the token.
      */
+    @Expose()
     logprob: number;
     /**
      * A list of integers representing the UTF-8 bytes representation
@@ -63,11 +67,13 @@ export class LogProbs {
      * Message content tokens with log probability information.
      */
     @Type(() => Content)
+    @Expose()
     content: Content[];
     /**
      * Message refusal tokens with log probability information.
      */
     @Type(() => Content)
+    @Expose()
     refusal: Content[];
 }
 
@@ -83,6 +89,7 @@ export class Choice {
     /**
      * The index of the choice in the list of choices.
      */
+    @Expose()
     index: number;
     /**
      * A chat completion message generated by the model.
@@ -92,6 +99,8 @@ export class Choice {
     /**
      * Log probability information for the choice.
      */
+    @Type(() => LogProbs)
+    @Expose()
     logprobs: LogProbs;
 }
 
@@ -103,21 +112,25 @@ export class ChatCompletion {
     /**
      * A unique identifier for the chat completion.
      */
+    @Expose()
     id: string;
     /**
      * A list of chat completion choices. Can be more than one if n is
      * greater than 1.
      */
     @Type(() => Choice)
+    @Expose()
     choices: Choice[];
     /**
      * The Unix timestamp (in seconds) of when the chat completion was
      * created.
      */
+    @Expose()
     created: number;
     /**
      * The model used for the chat completion.
      */
+    @Expose()
     model: string;
     /**
      * The service tier used for processing the request. This field is
@@ -135,11 +148,13 @@ export class ChatCompletion {
     /**
      * The object type, which is always chat.completion.
      */
+    @Expose()
     object: string;
     /**
      * Usage statistics for the completion request.
      */
     @Type(() => Usage)
+    @Expose()
     usage: Usage;
 }
 
@@ -155,16 +170,19 @@ export class ChunkChoice {
     /**
      * The index of the choice in the list of choices.
      */
+    @Expose()
     index: number;
     /**
      * A chat completion delta generated by streamed model responses.
      */
     @Type(() => ChatCompletionMessage)
+    @Expose()
     delta: ChatCompletionMessage;
     /**
      * Log probability information for the choice.
      */
     @Type(() => LogProbs)
+    @Expose()
     logprobs: LogProbs;
 }
 
@@ -176,21 +194,25 @@ export class ChatCompletionChunk {
     /**
      * A unique identifier for the chat completion. Each chunk has the same ID.
      */
+    @Expose()
     id: string;
     /**
      * A list of chat completion choices. Can be more than one if n is
      * greater than 1.
      */
     @Type(() => ChunkChoice)
+    @Expose()
     choices: ChunkChoice[];
     /**
      * The Unix timestamp (in seconds) of when the chat completion was
      * created. Each chunk has the same timestamp.
      */
+    @Expose()
     created: number;
     /**
      * The model used for the chat completion.
      */
+    @Expose()
     model: string;
     /**
      * The service tier used for processing the request. This field is
@@ -208,11 +230,13 @@ export class ChatCompletionChunk {
     /**
      * The object type, which is always 'chat.completion.chunk'.
      */
+    @Expose()
     object: string;
     /**
      * Usage statistics for the completion request. Present in the last chunk
      * only if the StreamOptions.includeUsage is set to true.
      */
     @Type(() => Usage)
+    @Expose()
     usage: Usage;
 }

package/src/common/api/embeddings-request.ts

@@ -7,16 +7,19 @@ export class Embedding {
     /**
      * The index of the embedding in the list of embeddings.
      */
+    @Expose()
     index: number;
 
     /**
      * The embedding vector, which is a list of floats. The length of vector depends on the model.
      */
+    @Expose()
     embedding: number[];
 
     /**
      * The object type, which is always 'embedding'.
      */
+    @Expose()
     object: string;
 
     constructor(index: number, embedding: number[], object = 'embedding') {
@@ -36,11 +39,13 @@ export class EmbeddingRequest<T> {
      * The input must not exceed the max input tokens for the model (8192 tokens for text-embedding-ada-002),
      * cannot be an empty string, and any array must be 2048 dimensions or less.
      */
+    @Expose()
     input: T;
 
     /**
      * ID of the model to use.
      */
+    @Expose()
     model: string;
 
     /**
@@ -52,11 +57,13 @@ export class EmbeddingRequest<T> {
     /**
      * The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
      */
+    @Expose()
     dimensions?: number;
 
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
      */
+    @Expose()
     user?: string;
 
     /**

package/src/common/api/embeddings-response.ts

@@ -1,4 +1,4 @@
-import { Type } from 'class-transformer';
+import { Type, Expose } from 'class-transformer';
 import { Embedding } from './embeddings-request';
 import { Usage } from './usage';
 
@@ -11,23 +11,27 @@ export class EmbeddingResponse {
     /**
      * Must have value "list".
      */
+    @Expose()
     object: string;
 
     /**
      * List of entities.
      */
     @Type(() => Embedding)
+    @Expose()
     data: Embedding[];
 
     /**
      * ID of the model to use.
      */
+    @Expose()
     model: string;
 
     /**
      * Usage statistics for the completion request.
      */
     @Type(() => Usage)
+    @Expose()
     usage: Usage;
 
     constructor(

package/src/common/api/message.ts

@@ -52,10 +52,12 @@ export class ChatCompletionFunction {
     /**
      * The name of the function.
      */
+    @Expose()
     name: string;
     /**
      * The arguments that the model expects you to pass to the function.
      */
+    @Expose()
     arguments: string;
 }
 
@@ -67,20 +69,25 @@ export class ToolCall {
      * The index of the tool call in the list of tool calls. Required in
      * case of streaming.
      */
+    @Expose()
     index?: number;
     /**
      * The ID of the tool call. This ID must be referenced when you submit
      * the tool outputs in using the Submit tool outputs to run endpoint.
      */
+    @Expose()
     id: string;
     /**
      * The type of tool call the output is required for. For now, this is
      * always function.
      */
+    @Expose()
     type: string;
     /**
      * The function definition.
      */
+    @Type(() => ChatCompletionFunction)
+    @Expose()
     function: ChatCompletionFunction;
 }
 
@@ -91,10 +98,12 @@ export class AudioOutput {
     /**
      * Unique identifier for the audio response from the model.
      */
+    @Expose()
     id?: string;
     /**
      * Audio output from the model.
      */
+    @Expose()
     data?: string;
     /**
      * When the audio content will no longer be available on the server.
@@ -104,6 +113,7 @@ export class AudioOutput {
     /**
      * Transcript of the audio output from the model.
      */
+    @Expose()
     transcript?: string;
 
     static create(id?: string, data?: string, expiresAt?: number, transcript?: string): AudioOutput {
@@ -137,10 +147,12 @@ export class InputAudio {
     /**
      * Base64 encoded audio data.
      */
+    @Expose()
     data: string;
     /**
      * The format of the encoded audio data. Currently supports "wav" and "mp3".
      */
+    @Expose()
     format: Format;
 }
 
@@ -153,10 +165,12 @@ export class ImageUrl {
      * base64 encoded image data must have a special prefix in the following
      * format: "data:{mimetype};base64,{base64-encoded-image-data}".
      */
+    @Expose()
     url: string;
     /**
      * Specifies the detail level of the image.
      */
+    @Expose()
     detail?: string;
 }
 
@@ -168,10 +182,12 @@ export class MediaContent {
     /**
      * Content type, each can be of type text or image_url.
      */
+    @Expose()
     type: string;
     /**
      * The text content of the message.
      */
+    @Expose()
     text: string;
     /**
      * The image content of the message. You can pass multiple images
@@ -225,12 +241,14 @@ export class ChatCompletionMessage {
      * The role of the messages author. Could be one of the {@link Role}
      * types.
      */
+    @Expose()
     role: Role;
     /**
      * An optional name for the participant. Provides the model information to
      * differentiate between participants of the same role. In case of Function calling,
      * the name is the function name that the message is responding to.
      */
+    @Expose()
     name?: string;
     /**
      * Tool call that this message is responding to. Only applicable for
@@ -248,6 +266,7 @@ export class ChatCompletionMessage {
      * The refusal message by the assistant. Applicable only for
      * {@link Role#ASSISTANT} role and null otherwise.
      */
+    @Expose()
     refusal?: string;
     /**
      * Audio response from the model.

package/src/common/api/openai-api.ts

@@ -49,7 +49,7 @@ export class OpenAIAPIImpl implements OpenAIAPI {
         const { data, status, headers } = await this.restOperations
             .post(
                 this.finalApiOptions.completionsPath,
-                instanceToPlain(chatRequest),
+                instanceToPlain(chatRequest, { excludeExtraneousValues: true }),
                 {
                     baseURL: this.finalApiOptions.baseUrl,
                     headers: {
@@ -72,7 +72,7 @@ export class OpenAIAPIImpl implements OpenAIAPI {
         const { data, status, headers } = await this.restOperations
         .post<ReadableStream>(
             this.finalApiOptions.completionsPath,
-            instanceToPlain(chatRequest),
+            instanceToPlain(chatRequest, { excludeExtraneousValues: true }),
             {
                 baseURL: this.finalApiOptions.baseUrl,
                 headers: {
@@ -116,7 +116,7 @@ export class OpenAIAPIImpl implements OpenAIAPI {
         const { data, status, headers } = await this.restOperations
             .post<EmbeddingResponse>(
                 this.finalApiOptions.embeddingsPath,
-                instanceToPlain(embeddingRequest),
+                instanceToPlain(embeddingRequest, { excludeExtraneousValues: true }),
                 { baseURL: this.finalApiOptions.baseUrl, signal: embeddingRequest.signal });
         return {
             status,

package/src/common/api/response-format.ts

@@ -1,3 +1,5 @@
+import { Expose, Type } from 'class-transformer';
+
 export enum ResponseFormatType {
     TEXT = 'text',
     JSON_OBJECT = 'json_object',
@@ -5,8 +7,11 @@ export enum ResponseFormatType {
 }
 
 export class JsonSchema {
+    @Expose()
     name: string;
+    @Expose()
     schema: Map<string, any>;
+    @Expose()
     strict: boolean;
     constructor(name: string, schema: Map<string, any>, strict: boolean) {
         this.name = name;
@@ -59,18 +64,22 @@ export class ResponseFormat {
     /**
      * Type Must be one of 'text', 'json_object' or 'json_schema'.
      */
+    @Expose()
     type: ResponseFormatType;
 
     /**
      * JSON schema object that describes the format of the JSON object. Only applicable
      * when type is 'json_schema'.
      */
+    @Type(() => JsonSchema)
+    @Expose()
     schema?: JsonSchema;
 
     /**
      * Whether the model must strictly adhere to the schema. Only applicable when type is
      * 'json_schema'.
      */
+    @Expose()
     strict?: boolean;
 
     constructor(type: ResponseFormatType, schema?: JsonSchema, strict?: boolean) {

package/src/common/api/usage.ts

@@ -1,5 +1,5 @@
 import { Usage as IUsage } from '@celljs/ai-core';
-import { Expose } from 'class-transformer';
+import { Expose, Type } from 'class-transformer';
 
 /**
  * Breakdown of tokens used in the prompt.
@@ -71,12 +71,14 @@ export class EmbeddingsResponse {
     /**
      * The model used for generating the embeddings.
      */
+    @Expose()
     model: string;
 
     /**
      * The list of embeddings generated from the model.
      * Each embedding (list of doubles) corresponds to a single input text.
      */
+    @Expose()
     embeddings: number[][];
 
     constructor(model: string, embeddings: number[][]) {
@@ -110,12 +112,14 @@ export class Usage implements IUsage {
     /**
      * Breakdown of tokens used in the prompt.
      */
+    @Type(() => PromptTokensDetails)
     @Expose({ name: 'prompt_tokens_details' })
     promptTokensDetails?: PromptTokensDetails;
 
     /**
      * Breakdown of tokens used in a completion.
      */
+    @Type(() => CompletionTokenDetails)
     @Expose({ name: 'completion_tokens_details' })
     completionTokenDetails?: CompletionTokenDetails;
 

package/src/common/model/openai-chat-model.ts

@@ -153,7 +153,7 @@ export class OpenAIChatModel implements ChatModel {
                         throw new IllegalArgumentError('ToolResponseMessage must have an id');
                     }
                 });
-                return  message.responses.map(tr => {
+                return message.responses.map(tr => {
                     const chatCompletionMessage = ChatCompletionMessage.create(tr.responseData, Role.TOOL);
                     chatCompletionMessage.name = tr.name;
                     chatCompletionMessage.toolCallId = tr.id;

package/src/common/model/openai-chat-options.ts

@@ -1,5 +1,5 @@
 import { FunctionCallback, FunctionCallingOptions } from '@celljs/ai-core';
-import { Expose, Exclude } from 'class-transformer';
+import { Expose, Exclude, Type } from 'class-transformer';
 import { OpenAIModel } from '../api/openai-model';
 import { Constant } from '@celljs/core';
 import { AudioParameters, FunctionTool, ResponseFormat, StreamOptions } from '../api';
@@ -96,12 +96,14 @@ export class OpenAIChatOptions implements FunctionCallingOptions {
      * An object specifying the format that the model must output. Setting to { "type":
      * "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.
      */
+    @Type(() => ResponseFormat)
     @Expose({ name: 'response_format' })
     responseFormat?: ResponseFormat;
 
     /**
      * Options for streaming response. Included in the API only if streaming-mode completion is requested.
      */
+    @Type(() => StreamOptions)
     @Expose({ name: 'stream_options' })
     streamOptions?: StreamOptions;
 
@@ -109,17 +111,21 @@ export class OpenAIChatOptions implements FunctionCallingOptions {
      * This feature is in Beta. If specified, our system will make a best effort to sample
      * deterministically, such that repeated requests with the same seed and parameters should return the same result.
      */
+    @Expose()
     seed?: number;
 
     /**
      * Up to 4 sequences where the API will stop generating further tokens.
      */
+    @Expose()
     stop?: string[];
 
     /**
      * A list of tools the model may call. Currently, only functions are supported as a tool. Use this to
      * provide a list of functions the model may generate JSON inputs for.
      */
+    @Type(() => FunctionTool)
+    @Expose()
     tools?: FunctionTool[];
 
     /**
@@ -131,6 +137,7 @@ export class OpenAIChatOptions implements FunctionCallingOptions {
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
      */
+    @Expose()
     user?: string;
 
     /**

package/src/common/model/openai-embedding-options.ts

@@ -10,6 +10,7 @@ export class OpenAIEmbeddingOptions implements EmbeddingOptions {
     /**
      * ID of the model to use.
      */
+    @Expose()
     model?: string;
 
     /**
@@ -22,11 +23,13 @@ export class OpenAIEmbeddingOptions implements EmbeddingOptions {
      * The number of dimensions the resulting output embeddings should have.
      * Only supported in text-embedding-3 and later models.
      */
+    @Expose()
     dimensions?: number;
 
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
      */
+    @Expose()
     user?: string;
 
     copy(): OpenAIEmbeddingOptions {