@celljs/ai-openai 3.7.8 → 3.9.0

package/esm/common/api/api-protocol.d.ts

@@ -0,0 +1,46 @@
+import { Observable } from 'rxjs';
+import { ChatCompletionRequest } from './chat-request.js';
+import { ChatCompletion, ChatCompletionChunk } from './chat-response.js';
+import { EmbeddingResponse } from './embeddings-response.js';
+import { EmbeddingRequest } from './embeddings-request.js';
+import { ResponseEntity } from '@celljs/http';
+export declare const OpenAIAPIOptions: unique symbol;
+export declare const OpenAIAPI: unique symbol;
+export interface OpenAIAPIOptions {
+    baseUrl?: string;
+    apiKey?: string;
+    completionsPath?: string;
+    embeddingsPath?: string;
+}
+/**
+ * Interface representing the OpenAI API.
+ */
+export interface OpenAIAPI {
+    /**
+     * Creates a model response for the given chat conversation.
+     * @param chatRequest - The chat completion request.
+     * @param additionalHttpHeader - Optional, additional HTTP headers to be added to the request.
+     * @returns A promise that resolves to the chat completion response.
+     */
+    chat(chatRequest: ChatCompletionRequest, additionalHttpHeader?: Record<string, string>): Promise<ResponseEntity<ChatCompletion>>;
+    /**
+     * Creates a streaming chat response for the given chat conversation.
+     * @param chatRequest - The chat completion request. Must have the stream property set to true.
+     * @param additionalHttpHeader - Optional, additional HTTP headers to be added to the request.
+     * @returns A promise that resolves to an observable of chat completion chunks.
+     */
+    streamingChat(chatRequest: ChatCompletionRequest, additionalHttpHeader?: Record<string, string>): Promise<Observable<ResponseEntity<ChatCompletionChunk>>>;
+    /**
+     * Creates an embedding vector representing the input text or token array.
+     * @param embeddingsRequest - The embedding request.
+     * @typeParam T - Type of the entity in the data list. Can be a string or list of tokens (e.g., integers).
+     * For embedding multiple inputs in a single request, you can pass a list of strings or a list of lists of tokens.
+     * @example
+     * ```typescript
+     * embed(List.of("text1", "text2", "text3"));
+     * embed(List.of(List.of(1, 2, 3), List.of(3, 4, 5)));
+     * ```
+     * @returns A promise that resolves to an embedding response containing a list of embeddings.
+     */
+    embed<T>(embeddingsRequest: EmbeddingRequest<T>): Promise<ResponseEntity<EmbeddingResponse>>;
+}

package/esm/common/api/api-protocol.js

@@ -0,0 +1,3 @@
+export const OpenAIAPIOptions = Symbol('OpenAIAPIOptions');
+export const OpenAIAPI = Symbol('OpenAIAPI');
+//# sourceMappingURL=api-protocol.js.map

package/esm/common/api/api-protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-protocol.js","sourceRoot":"","sources":["../../../src/common/api/api-protocol.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAC3D,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC"}

package/esm/common/api/chat-request.d.ts

@@ -0,0 +1,203 @@
+import { ChatCompletionMessage } from './message.js';
+import { ResponseFormat } from './response-format.js';
+import { Prediction } from '@celljs/ai-core';
+export declare class StreamOptions {
+    static INCLUDE_USAGE: StreamOptions;
+    /**
+     * 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.
+     */
+    includeUsage: boolean;
+    constructor(includeUsage: boolean);
+}
+/**
+ * Function definition.
+ */
+export declare class Function {
+    description: string;
+    name: string;
+    parameters: Record<string, any>;
+    strict?: boolean;
+    static create(description: string, name: string, parameters: Record<string, any>, strict?: boolean): Function;
+}
+export declare enum ToolType {
+    /**
+     * Function tool type.
+     */
+    FUNCTION = "function"
+}
+export declare class FunctionTool {
+    /**
+     * The type of the tool. Currently, only 'function' is supported.
+     */
+    type: ToolType;
+    /**
+     * The function definition.
+     */
+    function: Function;
+    static create(func: Function): FunctionTool;
+}
+/**
+ * The type of modality for the model completion.
+ */
+export declare enum OutputModality {
+    AUDIO = "audio",
+    TEXT = "text"
+}
+export declare enum Voice {
+    ALLOY = "alloy",
+    ECHO = "echo",
+    FABLE = "fable",
+    ONYX = "onyx",
+    NOVA = "nova",
+    SHIMMER = "shimmer"
+}
+export declare enum AudioResponseFormat {
+    MP3 = "mp3",
+    FLAC = "flac",
+    OPUS = "opus",
+    PCM16 = "pcm16",
+    WAV = "wav"
+}
+export declare class AudioParameters {
+    /**
+     * Specifies the voice type.
+     */
+    voice?: Voice;
+    /**
+     * Specifies the output audio format.
+     */
+    format?: AudioResponseFormat;
+}
+/**
+ * Creates a model response for the given chat conversation.
+ */
+export declare class ChatCompletionRequest {
+    /**
+     * A list of messages comprising the conversation so far.
+     */
+    messages: ChatCompletionMessage[];
+    /**
+     * ID of the model to use.
+     */
+    model: string;
+    /**
+     * Whether to store the output of this chat completion request for use in OpenAI's model distillation or evals products.
+     */
+    store?: boolean;
+    /**
+     * Developer-defined tags and values used for filtering completions in the OpenAI's dashboard.
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far,
+     * decreasing the model's likelihood to repeat the same line verbatim.
+     */
+    frequencyPenalty?: number;
+    /**
+     * Modify the likelihood of specified tokens appearing in the completion.
+     * Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100.
+     */
+    logitBias?: Record<string, number>;
+    /**
+     * Whether to return log probabilities of the output tokens or not.
+     */
+    logprobs?: boolean;
+    /**
+     * An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability.
+     */
+    topLogprobs?: number;
+    /**
+     * @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.
+     */
+    maxTokens?: number;
+    /**
+     * An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
+     */
+    maxCompletionTokens?: number;
+    /**
+     * How many chat completion choices to generate for each input message.
+     */
+    n?: number;
+    /**
+     * Output types that you would like the model to generate for this request.
+     */
+    outputModalities?: OutputModality[];
+    /**
+     * Parameters for audio output. Required when audio output is requested with outputModalities: ["audio"].
+     */
+    audioParameters?: AudioParameters;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far,
+     * increasing the model's likelihood to talk about new topics.
+     */
+    presencePenalty?: number;
+    /**
+     * An object specifying the format that the model must output.
+     */
+    responseFormat?: ResponseFormat;
+    /**
+     * 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.
+     */
+    seed?: number;
+    /**
+     * Specifies the latency tier to use for processing the request.
+     */
+    serviceTier?: string;
+    /**
+     * Up to 4 sequences where the API will stop generating further tokens.
+     */
+    stop?: string[];
+    /**
+     * Options for streaming response.
+     */
+    stream?: boolean;
+    /**
+     * The format to return the response in. Currently, the only accepted value is "json".
+     */
+    streamOptions?: StreamOptions;
+    /**
+     * 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.
+     */
+    temperature?: number;
+    /**
+     * An alternative to sampling with temperature, called nucleus sampling,
+     * where the model considers the results of the tokens with top_p probability mass.
+     */
+    topP?: number;
+    /**
+     * A list of tools the model may call. Currently, only functions are supported as a tool.
+     */
+    tools?: FunctionTool[];
+    /**
+     * Controls which (if any) function is called by the model.
+     */
+    toolChoice?: Record<string, any>;
+    /**
+     * If set to true, the model will call all functions in the tools list in parallel. Otherwise,
+     * the model will call the functions in the tools list in the order they are provided.
+     */
+    parallelToolCalls?: boolean;
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
+     */
+    user?: string;
+    /**
+     * Static predicted output content, such as the content of a text file that is
+     * being regenerated.
+     */
+    prediction?: Prediction | null;
+    /**
+     * Extra parameters to be added to the request.
+     */
+    extra?: Record<string, unknown>;
+    /**
+     * An optional signal to abort the request.
+     */
+    signal?: AbortSignal;
+}

package/esm/common/api/chat-request.js

@@ -0,0 +1,236 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Exclude, Expose, Type } from 'class-transformer';
+import { ChatCompletionMessage } from './message.js';
+import { ResponseFormat } from './response-format.js';
+export class StreamOptions {
+    constructor(includeUsage) {
+        this.includeUsage = includeUsage;
+    }
+}
+StreamOptions.INCLUDE_USAGE = new StreamOptions(true);
+__decorate([
+    Expose({ name: 'include_usage' }),
+    __metadata("design:type", Boolean)
+], StreamOptions.prototype, "includeUsage", void 0);
+/**
+ * Function definition.
+ */
+export class Function {
+    static create(description, name, parameters, strict) {
+        const func = new Function();
+        func.description = description;
+        func.name = name;
+        func.parameters = parameters;
+        func.strict = strict;
+        return func;
+    }
+}
+__decorate([
+    Expose(),
+    __metadata("design:type", String)
+], Function.prototype, "description", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", String)
+], Function.prototype, "name", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Object)
+], Function.prototype, "parameters", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Boolean)
+], Function.prototype, "strict", void 0);
+export var ToolType;
+(function (ToolType) {
+    /**
+     * Function tool type.
+     */
+    ToolType["FUNCTION"] = "function";
+})(ToolType || (ToolType = {}));
+export class FunctionTool {
+    static create(func) {
+        const tool = new FunctionTool();
+        tool.type = ToolType.FUNCTION;
+        tool.function = func;
+        return tool;
+    }
+}
+__decorate([
+    Expose(),
+    __metadata("design:type", String)
+], FunctionTool.prototype, "type", void 0);
+__decorate([
+    Type(() => Function),
+    Expose(),
+    __metadata("design:type", Function)
+], FunctionTool.prototype, "function", void 0);
+/**
+ * The type of modality for the model completion.
+ */
+export var OutputModality;
+(function (OutputModality) {
+    OutputModality["AUDIO"] = "audio";
+    OutputModality["TEXT"] = "text";
+})(OutputModality || (OutputModality = {}));
+export var Voice;
+(function (Voice) {
+    Voice["ALLOY"] = "alloy";
+    Voice["ECHO"] = "echo";
+    Voice["FABLE"] = "fable";
+    Voice["ONYX"] = "onyx";
+    Voice["NOVA"] = "nova";
+    Voice["SHIMMER"] = "shimmer";
+})(Voice || (Voice = {}));
+export var AudioResponseFormat;
+(function (AudioResponseFormat) {
+    AudioResponseFormat["MP3"] = "mp3";
+    AudioResponseFormat["FLAC"] = "flac";
+    AudioResponseFormat["OPUS"] = "opus";
+    AudioResponseFormat["PCM16"] = "pcm16";
+    AudioResponseFormat["WAV"] = "wav";
+})(AudioResponseFormat || (AudioResponseFormat = {}));
+export class AudioParameters {
+}
+__decorate([
+    Expose(),
+    __metadata("design:type", String)
+], AudioParameters.prototype, "voice", void 0);
+__decorate([
+    Expose({ name: 'response_format' }),
+    __metadata("design:type", String)
+], AudioParameters.prototype, "format", void 0);
+/**
+ * Creates a model response for the given chat conversation.
+ */
+export class ChatCompletionRequest {
+}
+__decorate([
+    Type(() => ChatCompletionMessage),
+    Expose(),
+    __metadata("design:type", Array)
+], ChatCompletionRequest.prototype, "messages", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", String)
+], ChatCompletionRequest.prototype, "model", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Boolean)
+], ChatCompletionRequest.prototype, "store", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Object)
+], ChatCompletionRequest.prototype, "metadata", void 0);
+__decorate([
+    Expose({ name: 'frequency_penalty' }),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "frequencyPenalty", void 0);
+__decorate([
+    Expose({ name: 'logit_bias' }),
+    __metadata("design:type", Object)
+], ChatCompletionRequest.prototype, "logitBias", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Boolean)
+], ChatCompletionRequest.prototype, "logprobs", void 0);
+__decorate([
+    Expose({ name: 'top_logprobs' }),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "topLogprobs", void 0);
+__decorate([
+    Expose({ name: 'max_tokens' }),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "maxTokens", void 0);
+__decorate([
+    Expose({ name: 'max_completion_tokens' }),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "maxCompletionTokens", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "n", void 0);
+__decorate([
+    Expose({ name: 'output_modalities' }),
+    __metadata("design:type", Array)
+], ChatCompletionRequest.prototype, "outputModalities", void 0);
+__decorate([
+    Expose({ name: 'audio_parameters' }),
+    Type(() => AudioParameters),
+    __metadata("design:type", AudioParameters)
+], ChatCompletionRequest.prototype, "audioParameters", void 0);
+__decorate([
+    Expose({ name: 'presence_penalty' }),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "presencePenalty", void 0);
+__decorate([
+    Expose({ name: 'response_format' }),
+    Type(() => ResponseFormat),
+    __metadata("design:type", ResponseFormat)
+], ChatCompletionRequest.prototype, "responseFormat", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "seed", void 0);
+__decorate([
+    Expose({ name: 'service_tier' }),
+    __metadata("design:type", String)
+], ChatCompletionRequest.prototype, "serviceTier", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Array)
+], ChatCompletionRequest.prototype, "stop", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Boolean)
+], ChatCompletionRequest.prototype, "stream", void 0);
+__decorate([
+    Expose({ name: 'stream_options' }),
+    Type(() => StreamOptions),
+    __metadata("design:type", StreamOptions)
+], ChatCompletionRequest.prototype, "streamOptions", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "temperature", void 0);
+__decorate([
+    Expose({ name: 'top_p' }),
+    __metadata("design:type", Number)
+], ChatCompletionRequest.prototype, "topP", void 0);
+__decorate([
+    Type(() => FunctionTool),
+    __metadata("design:type", Array)
+], ChatCompletionRequest.prototype, "tools", void 0);
+__decorate([
+    Expose({ name: 'tool_choice' }),
+    __metadata("design:type", Object)
+], ChatCompletionRequest.prototype, "toolChoice", void 0);
+__decorate([
+    Expose({ name: 'parallel_tool_calls' }),
+    __metadata("design:type", Boolean)
+], ChatCompletionRequest.prototype, "parallelToolCalls", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", String)
+], ChatCompletionRequest.prototype, "user", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Object)
+], ChatCompletionRequest.prototype, "prediction", void 0);
+__decorate([
+    Expose(),
+    __metadata("design:type", Object)
+], ChatCompletionRequest.prototype, "extra", void 0);
+__decorate([
+    Exclude(),
+    __metadata("design:type", AbortSignal)
+], ChatCompletionRequest.prototype, "signal", void 0);
+//# sourceMappingURL=chat-request.js.map

package/esm/common/api/chat-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-request.js","sourceRoot":"","sources":["../../../src/common/api/chat-request.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGnD,MAAM,OAAO,aAAa;IAatB,YAAY,YAAqB;QAC7B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,CAAC;CACJ;AAfU,2BAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;AAU/C;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;;mDACZ;AAO1B;;GAEG;AACH,MAAM,OAAO,QAAQ;IAUjB,MAAM,CAAC,MAAM,CAAC,WAAmB,EAAE,IAAY,EAAE,UAA+B,EAAE,MAAgB;QAC9F,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAhBG;IADC,MAAM,EAAE;;6CACW;AAEpB;IADC,MAAM,EAAE;;sCACI;AAEb;IADC,MAAM,EAAE;;4CACuB;AAEhC;IADC,MAAM,EAAE;;wCACQ;AAYrB,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAChB;;OAEG;IACH,iCAAqB,CAAA;AACzB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAED,MAAM,OAAO,YAAY;IAcrB,MAAM,CAAC,MAAM,CAAC,IAAc;QACxB,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAfG;IADC,MAAM,EAAE;;0CACM;AAOf;IAFC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;IACpB,MAAM,EAAE;8BACC,QAAQ;8CAAC;AAUvB;;GAEG;AACH,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACtB,iCAAe,CAAA;IACf,+BAAa,CAAA;AACjB,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AAED,MAAM,CAAN,IAAY,KAOX;AAPD,WAAY,KAAK;IACb,wBAAe,CAAA;IACf,sBAAa,CAAA;IACb,wBAAe,CAAA;IACf,sBAAa,CAAA;IACb,sBAAa,CAAA;IACb,4BAAmB,CAAA;AACvB,CAAC,EAPW,KAAK,KAAL,KAAK,QAOhB;AAED,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC3B,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,oCAAa,CAAA;IACb,sCAAe,CAAA;IACf,kCAAW,CAAA;AACf,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAED,MAAM,OAAO,eAAe;CAW3B;AANG;IADC,MAAM,EAAE;;8CACK;AAKd;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;;+CACP;AAGjC;;GAEG;AACH,MAAM,OAAO,qBAAqB;CAyLjC;AAnLG;IAFC,IAAI,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC;IACjC,MAAM,EAAE;;uDACyB;AAMlC;IADC,MAAM,EAAE;;oDACK;AAKd;IADC,MAAM,EAAE;;oDACO;AAMhB;IADC,MAAM,EAAE;;uDACsB;AAO/B;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;;+DACZ;AAO1B;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;;wDACI;AAMnC;IADC,MAAM,EAAE;;uDACU;AAMnB;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;;0DACZ;AAMrB;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;;wDACZ;AAMnB;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;;kEACb;AAM7B;IADC,MAAM,EAAE;;gDACE;AAMX;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;;+DACF;AAOpC;IAFC,MAAM,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;IACpC,IAAI,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC;8BACV,eAAe;8DAAC;AAOlC;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC;;8DACZ;AAOzB;IAFC,MAAM,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;IACnC,IAAI,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC;8BACV,cAAc;6DAAC;AAOhC;IADC,MAAM,EAAE;;mDACK;AAMd;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;;0DACZ;AAMrB;IADC,MAAM,EAAE;;mDACO;AAMhB;IADC,MAAM,EAAE;;qDACQ;AAOjB;IAFC,MAAM,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAClC,IAAI,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC;8BACV,aAAa;4DAAC;AAO9B;IADC,MAAM,EAAE;;0DACY;AAOrB;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;mDACZ;AAMd;IADC,IAAI,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;;oDACF;AAMvB;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;;yDACC;AAOjC;IADC,MAAM,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;;gEACZ;AAM5B;IADC,MAAM,EAAE;;mDACK;AAOd;IADC,MAAM,EAAE;;yDACsB;AAM/B;IADC,MAAM,EAAE;;oDACuB;AAMhC;IADC,OAAO,EAAE;8BACD,WAAW;qDAAC"}

package/esm/common/api/chat-response.d.ts

@@ -0,0 +1,192 @@
+import { ChatCompletionFinishReason, ChatCompletionMessage } from './message.js';
+import { Usage } from './usage.js';
+/**
+ * The most likely tokens and their log probability, at this token position.
+ */
+export declare class TopLogProbs {
+    /**
+     * The token.
+     */
+    token: string;
+    /**
+     * The log probability of the token.
+     */
+    logprob: number;
+    /**
+     * A list of integers representing the UTF-8 bytes
+     * representation of the token. Useful in instances where characters are represented by multiple
+     * tokens and their byte representations must be combined to generate the correct
+     * text representation. Can be null if there is no bytes representation for the
+     * token.
+     */
+    probBytes: number[];
+}
+/**
+ * Message content tokens with log probability information.
+ */
+export declare class Content {
+    /**
+     * The token.
+     */
+    token: string;
+    /**
+     * The log probability of the token.
+     */
+    logprob: number;
+    /**
+     * A list of integers representing the UTF-8 bytes representation
+     * of the token. Useful in instances where characters are represented by multiple
+     * tokens and their byte representations must be combined to generate the correct
+     * text representation. Can be null if there is no bytes representation for the
+     * token.
+     */
+    probBytes: number[];
+    /**
+     * List of the most likely tokens and their log probability, at
+     * this token position. In rare cases, there may be fewer than the number of
+     * requested top_logprobs returned.
+     */
+    topLogprobs: TopLogProbs[];
+}
+/**
+ * Log probability information for the choice.
+ */
+export declare class LogProbs {
+    /**
+     * Message content tokens with log probability information.
+     */
+    content: Content[];
+    /**
+     * Message refusal tokens with log probability information.
+     */
+    refusal: Content[];
+}
+/**
+ * Chat completion choice.
+ */
+export declare class Choice {
+    /**
+     * The reason the model stopped generating tokens.
+     */
+    finishReason: ChatCompletionFinishReason;
+    /**
+     * The index of the choice in the list of choices.
+     */
+    index: number;
+    /**
+     * A chat completion message generated by the model.
+     */
+    message: ChatCompletionMessage;
+    /**
+     * Log probability information for the choice.
+     */
+    logprobs: LogProbs;
+}
+/**
+ * Represents a chat completion response returned by model, based on the provided
+ * input.
+ */
+export declare class ChatCompletion {
+    /**
+     * A unique identifier for the chat completion.
+     */
+    id: string;
+    /**
+     * A list of chat completion choices. Can be more than one if n is
+     * greater than 1.
+     */
+    choices: Choice[];
+    /**
+     * The Unix timestamp (in seconds) of when the chat completion was
+     * created.
+     */
+    created: number;
+    /**
+     * The model used for the chat completion.
+     */
+    model: string;
+    /**
+     * The service tier used for processing the request. This field is
+     * only included if the service_tier parameter is specified in the request.
+     */
+    serviceTier: string;
+    /**
+     * This fingerprint represents the backend configuration that
+     * the model runs with. Can be used in conjunction with the seed request parameter to
+     * understand when backend changes have been made that might impact determinism.
+     */
+    systemFingerprint: string;
+    /**
+     * The object type, which is always chat.completion.
+     */
+    object: string;
+    /**
+     * Usage statistics for the completion request.
+     */
+    usage: Usage;
+}
+/**
+ * Chat completion choice.
+ */
+export declare class ChunkChoice {
+    /**
+     * The reason the model stopped generating tokens.
+     */
+    finishReason: ChatCompletionFinishReason;
+    /**
+     * The index of the choice in the list of choices.
+     */
+    index: number;
+    /**
+     * A chat completion delta generated by streamed model responses.
+     */
+    delta: ChatCompletionMessage;
+    /**
+     * Log probability information for the choice.
+     */
+    logprobs: LogProbs;
+}
+/**
+ * Represents a streamed chunk of a chat completion response returned by model, based
+ * on the provided input.
+ */
+export declare class ChatCompletionChunk {
+    /**
+     * A unique identifier for the chat completion. Each chunk has the same ID.
+     */
+    id: string;
+    /**
+     * A list of chat completion choices. Can be more than one if n is
+     * greater than 1.
+     */
+    choices: ChunkChoice[];
+    /**
+     * The Unix timestamp (in seconds) of when the chat completion was
+     * created. Each chunk has the same timestamp.
+     */
+    created: number;
+    /**
+     * The model used for the chat completion.
+     */
+    model: string;
+    /**
+     * The service tier used for processing the request. This field is
+     * only included if the service_tier parameter is specified in the request.
+     */
+    serviceTier: string;
+    /**
+     * This fingerprint represents the backend configuration that
+     * the model runs with. Can be used in conjunction with the seed request parameter to
+     * understand when backend changes have been made that might impact determinism.
+     */
+    systemFingerprint: string;
+    /**
+     * The object type, which is always 'chat.completion.chunk'.
+     */
+    object: string;
+    /**
+     * Usage statistics for the completion request. Present in the last chunk
+     * only if the StreamOptions.includeUsage is set to true.
+     */
+    usage: Usage;
+}