@leikeduntech/leiai-js 4.0.3 → 4.1.0

package/build/index.d.ts

@@ -169,7 +169,6 @@ declare namespace openai {
                 delta: {
                     role: Role;
                     content?: string;
-                    reasoning_content?: string;
                 };
                 index: number;
                 finish_reason: string | null;
@@ -203,17 +202,29 @@ declare namespace openai {
          */
         role?: ChatCompletionRequestMessageRoleEnum;
         /**
-         * The contents of the message
-         * @type {string}
+         * The contents of the message. Can be a string or an array of content parts (text, images, etc.)
+         * @type {string | Array<any>}
          * @memberof ChatCompletionRequestMessage
          */
-        content?: string;
+        content?: string | Array<any>;
         /**
          * The name of the user in a multi-user chat
          * @type {string}
          * @memberof ChatCompletionRequestMessage
          */
         name?: string;
+        /**
+         * Tool call ID for tool role messages
+         * @type {string}
+         * @memberof ChatCompletionRequestMessage
+         */
+        tool_call_id?: string;
+        /**
+         * Tool calls made by the assistant
+         * @type {Array<any>}
+         * @memberof ChatCompletionRequestMessage
+         */
+        tool_calls?: Array<any>;
         /**
          * 阿里云的参数 input = {prompt: '哪个公园距离我更近', history: [
          *
@@ -236,7 +247,6 @@ declare namespace openai {
          * ]}
          */
         input?: object;
-        tool_call_id?: string;
     }
     const ChatCompletionRequestMessageRoleEnum: {
         readonly System: 'system';
@@ -262,7 +272,31 @@ declare namespace openai {
          * @type {string}
          * @memberof ChatCompletionResponseMessage
          */
-        content: string;
+        content: string | null;
+        /**
+         * Tool calls made by the assistant
+         * @type {Array<any>}
+         * @memberof ChatCompletionResponseMessage
+         */
+        tool_calls?: Array<any> | null;
+        /**
+         * Deprecated: Use tool_calls instead
+         * @type {object}
+         * @memberof ChatCompletionResponseMessage
+         */
+        function_call?: object | null;
+        /**
+         * Refusal information
+         * @type {string | null}
+         * @memberof ChatCompletionResponseMessage
+         */
+        refusal?: string | null;
+        /**
+         * Annotations
+         * @type {Array<any>}
+         * @memberof ChatCompletionResponseMessage
+         */
+        annotations?: Array<any> | null;
     }
     const ChatCompletionResponseMessageRoleEnum: {
         readonly System: 'system';
@@ -277,7 +311,7 @@ declare namespace openai {
      */
     interface CreateChatCompletionRequest {
         /**
-         * ID of the model to use. Currently, only `gpt-3.5-turbo` and `gpt-3.5-turbo-0301` are supported.
+         * ID of the model to use.
          * @type {string}
          * @memberof CreateChatCompletionRequest
          */
@@ -313,17 +347,29 @@ declare namespace openai {
          */
         stream?: boolean | null;
         /**
-         *
+         * Options for streaming response. Only set this when you set `stream: true`.
+         * @type {object}
+         * @memberof CreateChatCompletionRequest
+         */
+        stream_options?: object | null;
+        /**
+         * Up to 4 sequences where the API will stop generating further tokens.
          * @type {CreateChatCompletionRequestStop}
          * @memberof CreateChatCompletionRequest
          */
         stop?: CreateChatCompletionRequestStop;
         /**
-         * The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens).
+         * The maximum number of tokens allowed for the generated answer. Deprecated in favor of `max_completion_tokens`.
          * @type {number}
          * @memberof CreateChatCompletionRequest
          */
-        max_tokens?: number;
+        max_tokens?: number | null;
+        /**
+         * An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
+         * @type {number}
+         * @memberof CreateChatCompletionRequest
+         */
+        max_completion_tokens?: number | null;
         /**
          * 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.  [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)
          * @type {number}
@@ -343,13 +389,148 @@ declare namespace openai {
          */
         logit_bias?: object | null;
         /**
-         * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
+         * Whether to return log probabilities of the output tokens or not.
+         * @type {boolean}
+         * @memberof CreateChatCompletionRequest
+         */
+        logprobs?: boolean | null;
+        /**
+         * An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.
+         * @type {number}
+         * @memberof CreateChatCompletionRequest
+         */
+        top_logprobs?: number | null;
+        /**
+         * A list of tools the model may call. You can provide either custom tools or function tools.
+         * @type {Array<any>}
+         * @memberof CreateChatCompletionRequest
+         */
+        tools?: Array<any> | null;
+        /**
+         * Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools.
+         * @type {string | object}
+         * @memberof CreateChatCompletionRequest
+         */
+        tool_choice?: string | object | null;
+        /**
+         * Whether to enable parallel function calling during tool use.
+         * @type {boolean}
+         * @memberof CreateChatCompletionRequest
+         */
+        parallel_tool_calls?: boolean | null;
+        /**
+         * Parameters for audio output. Required when audio output is requested with `modalities: ["audio"]`.
+         * @type {object}
+         * @memberof CreateChatCompletionRequest
+         */
+        audio?: object | null;
+        /**
+         * Output types that you would like the model to generate. Most models are capable of generating text, which is the default: `["text"]`. The `gpt-4o-audio-preview` model can also be used to generate audio.
+         * @type {Array<string>}
+         * @memberof CreateChatCompletionRequest
+         */
+        modalities?: Array<string> | null;
+        /**
+         * An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs.
+         * @type {object}
+         * @memberof CreateChatCompletionRequest
+         */
+        response_format?: object | null;
+        /**
+         * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format.
+         * @type {object}
+         * @memberof CreateChatCompletionRequest
+         */
+        metadata?: object | null;
+        /**
+         * A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.
+         * @type {string}
+         * @memberof CreateChatCompletionRequest
+         */
+        safety_identifier?: string | null;
+        /**
+         * Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field.
+         * @type {string}
+         * @memberof CreateChatCompletionRequest
+         */
+        prompt_cache_key?: string | null;
+        /**
+         * The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching.
+         * @type {string}
+         * @memberof CreateChatCompletionRequest
+         */
+        prompt_cache_retention?: string | null;
+        /**
+         * Constrains effort on reasoning for reasoning models. Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`.
          * @type {string}
          * @memberof CreateChatCompletionRequest
          */
-        user?: string;
-        pluginList?: string | object;
+        reasoning_effort?: string | null;
+        /**
+         * Specifies the processing type used for serving the request. Options: 'auto', 'default', 'flex', 'priority'.
+         * @type {string}
+         * @memberof CreateChatCompletionRequest
+         */
+        service_tier?: string | null;
+        /**
+         * Whether or not to store the output of this chat completion request for use in model distillation or evals products.
+         * @type {boolean}
+         * @memberof CreateChatCompletionRequest
+         */
+        store?: boolean | null;
+        /**
+         * Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`.
+         * @type {string}
+         * @memberof CreateChatCompletionRequest
+         */
+        verbosity?: string | null;
+        /**
+         * Configuration for a Predicted Output, which can greatly improve response times when large parts of the model response are known ahead of time.
+         * @type {object}
+         * @memberof CreateChatCompletionRequest
+         */
+        prediction?: object | null;
+        /**
+         * This tool searches the web for relevant results to use in a response.
+         * @type {object}
+         * @memberof CreateChatCompletionRequest
+         */
+        web_search_options?: object | null;
+        /**
+         * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Deprecated in favor of `safety_identifier` and `prompt_cache_key`.
+         * @type {string}
+         * @memberof CreateChatCompletionRequest
+         */
+        user?: string | null;
+        /**
+         * Deprecated: Use `tools` instead. A list of functions the model may generate JSON inputs for.
+         * @type {Array<any>}
+         * @memberof CreateChatCompletionRequest
+         */
+        functions?: Array<any> | null;
+        /**
+         * Deprecated: Use `tool_choice` instead. Controls which (if any) function is called by the model.
+         * @type {string | object}
+         * @memberof CreateChatCompletionRequest
+         */
+        function_call?: string | object | null;
+        /**
+         * Deprecated: Use `seed` instead. This feature is in Beta.
+         * @type {number}
+         * @memberof CreateChatCompletionRequest
+         */
+        seed?: number | null;
+        /**
+         * Custom file list (non-standard parameter)
+         * @type {Array<any>}
+         * @memberof CreateChatCompletionRequest
+         */
         fileList?: Array<any>;
+        /**
+         * Custom extended parameters (non-standard parameter)
+         * @type {any}
+         * @memberof CreateChatCompletionRequest
+         */
         extParams?: any;
     }
     /**
@@ -365,45 +546,100 @@ declare namespace openai {
      */
     interface CreateChatCompletionResponse {
         /**
-         *
+         * A unique identifier for the chat completion.
          * @type {string}
          * @memberof CreateChatCompletionResponse
          */
         id?: string;
         /**
-         *
+         * The object type, which is always `chat.completion`.
          * @type {string}
          * @memberof CreateChatCompletionResponse
          */
         object?: string;
         /**
-         *
+         * The Unix timestamp (in seconds) of when the chat completion was created.
          * @type {number}
          * @memberof CreateChatCompletionResponse
          */
         created?: number;
         /**
-         *
+         * The model used for the chat completion.
          * @type {string}
          * @memberof CreateChatCompletionResponse
          */
         model?: string;
         /**
-         *
+         * A list of chat completion choices.
          * @type {Array<CreateChatCompletionResponseChoicesInner>}
          * @memberof CreateChatCompletionResponse
          */
         choices?: Array<CreateChatCompletionResponseChoicesInner>;
         /**
-         *
+         * Usage statistics for the completion request.
          * @type {CreateCompletionResponseUsage}
          * @memberof CreateChatCompletionResponse
          */
         usage?: CreateCompletionResponseUsage;
+        /**
+         * Specifies the processing type used for serving the request.
+         * @type {string}
+         * @memberof CreateChatCompletionResponse
+         */
+        service_tier?: string | null;
+        /**
+         * System fingerprint representing the backend configuration.
+         * @type {string}
+         * @memberof CreateChatCompletionResponse
+         */
+        system_fingerprint?: string | null;
+        /**
+         * The tools used in this completion.
+         * @type {Array<any>}
+         * @memberof CreateChatCompletionResponse
+         */
+        tools?: Array<any> | null;
+        /**
+         * The tool choice used in this completion.
+         * @type {string | object}
+         * @memberof CreateChatCompletionResponse
+         */
+        tool_choice?: string | object | null;
+        /**
+         * Metadata attached to the completion.
+         * @type {object}
+         * @memberof CreateChatCompletionResponse
+         */
+        metadata?: object | null;
+        /**
+         * Custom result field (non-standard)
+         * @type {string}
+         * @memberof CreateChatCompletionResponse
+         */
         result?: string;
+        /**
+         * Custom is_truncated field (non-standard)
+         * @type {boolean}
+         * @memberof CreateChatCompletionResponse
+         */
         is_truncated?: boolean;
+        /**
+         * Custom need_clear_history field (non-standard)
+         * @type {boolean}
+         * @memberof CreateChatCompletionResponse
+         */
         need_clear_history?: boolean;
+        /**
+         * Custom output field (non-standard)
+         * @type {any}
+         * @memberof CreateChatCompletionResponse
+         */
         output?: any;
+        /**
+         * Custom request_id field (non-standard)
+         * @type {string}
+         * @memberof CreateChatCompletionResponse
+         */
         request_id?: string;
     }
     /**
@@ -413,23 +649,29 @@ declare namespace openai {
      */
     interface CreateChatCompletionResponseChoicesInner {
         /**
-         *
+         * The index of the choice in the choices array.
          * @type {number}
          * @memberof CreateChatCompletionResponseChoicesInner
          */
         index?: number;
         /**
-         *
+         * The message generated by the model.
          * @type {ChatCompletionResponseMessage}
          * @memberof CreateChatCompletionResponseChoicesInner
          */
         message?: ChatCompletionResponseMessage;
         /**
-         *
+         * The reason the model stopped generating tokens.
          * @type {string}
          * @memberof CreateChatCompletionResponseChoicesInner
          */
-        finish_reason?: string;
+        finish_reason?: string | null;
+        /**
+         * Log probability information for the choice.
+         * @type {object}
+         * @memberof CreateChatCompletionResponseChoicesInner
+         */
+        logprobs?: object | null;
     }
     /**
      *
@@ -438,23 +680,49 @@ declare namespace openai {
      */
     interface CreateCompletionResponseUsage {
         /**
-         *
+         * Number of tokens in the prompt.
          * @type {number}
          * @memberof CreateCompletionResponseUsage
          */
         prompt_tokens: number;
         /**
-         *
+         * Number of tokens in the completion.
          * @type {number}
          * @memberof CreateCompletionResponseUsage
          */
         completion_tokens: number;
         /**
-         *
+         * Total number of tokens used.
          * @type {number}
          * @memberof CreateCompletionResponseUsage
          */
         total_tokens: number;
+        /**
+         * Details about prompt tokens (cached tokens, audio tokens, etc.)
+         * @type {object}
+         * @memberof CreateCompletionResponseUsage
+         */
+        prompt_tokens_details?: {
+            cached_tokens?: number;
+            audio_tokens?: number;
+        };
+        /**
+         * Details about completion tokens (reasoning tokens, audio tokens, etc.)
+         * @type {object}
+         * @memberof CreateCompletionResponseUsage
+         */
+        completion_tokens_details?: {
+            reasoning_tokens?: number;
+            audio_tokens?: number;
+            accepted_prediction_tokens?: number;
+            rejected_prediction_tokens?: number;
+        };
+        /**
+         * Whether the usage is estimated.
+         * @type {boolean}
+         * @memberof CreateCompletionResponseUsage
+         */
+        estimated?: boolean;
     }
 }
 
@@ -488,7 +756,6 @@ declare class ChatGPTAPI {
      * @param fetch - Optional override for the `fetch` implementation to use. Defaults to the global `fetch` function.
      */
     constructor(opts: ChatGPTAPIOptions);
-    pluginListMap(pluginList: any): any;
     /**
      * Sends a message to the OpenAI chat completions endpoint, waits for the response
      * to resolve, and returns the response.
@@ -586,4 +853,4 @@ declare class ChatGPTUnofficialProxyAPI {
     sendMessage(text: string, opts?: SendMessageBrowserOptions): Promise<ChatMessage>;
 }
 
-export { ChatGPTAPI, ChatGPTAPIOptions, ChatGPTError, ChatGPTUnofficialProxyAPI, ChatMessage, ContentType, ConversationJSONBody, ConversationResponseEvent, CreateChatCompletionStreamResponse, CreateCompletionStreamResponseUsage, FetchFn, GetMessageByIdFunction, Message, MessageActionType, MessageContent, MessageMetadata, PluginParams, Prompt, PromptContent, Role, SendMessageBrowserOptions, SendMessageOptions, UpsertMessageFunction, openai };
+export { ChatGPTAPI, type ChatGPTAPIOptions, ChatGPTError, ChatGPTUnofficialProxyAPI, type ChatMessage, type ContentType, type ConversationJSONBody, type ConversationResponseEvent, type CreateChatCompletionStreamResponse, type CreateCompletionStreamResponseUsage, type FetchFn, type GetMessageByIdFunction, type Message, type MessageActionType, type MessageContent, type MessageMetadata, type PluginParams, type Prompt, type PromptContent, type Role, type SendMessageBrowserOptions, type SendMessageOptions, type UpsertMessageFunction, openai };