@agentscope-ai/agentscope 0.0.2

package/dist/model/index.d.ts

@@ -0,0 +1,377 @@
+import { C as ChatModelBase, c as ChatModelOptions, d as ChatModelRequestOptions, b as ChatResponse } from '../base-Cwi4bjze.js';
+export { a as ChatUsage } from '../base-Cwi4bjze.js';
+import { a as ToolChoice, T as ToolSchema } from '../index-CAxQAkiP.js';
+import { b as ToolCallBlock, T as TextBlock, a as ThinkingBlock } from '../block-VsnHrllL.js';
+import { Ollama, AbortableAsyncIterator, ChatResponse as ChatResponse$1 } from 'ollama';
+import { OpenAI } from 'openai';
+import { ChatCompletionMessageParam, ChatCompletionToolChoiceOption } from 'openai/resources/chat/completions';
+import 'zod';
+import '../base-BoIps2RL.js';
+import '../message-CzLeTlua.js';
+
+interface DashScopeThinkingConfig {
+    /**
+     * Whether to enable thinking or not.
+     */
+    enableThinking: boolean;
+    /**
+     * Maximum tokens for reasoning (optional).
+     */
+    thinkingBudget?: number;
+}
+interface DashScopeChatModelOptions extends ChatModelOptions {
+    /**
+     * The API key for authenticating with DashScope API.
+     */
+    apiKey: string;
+    /**
+     * Thinking configuration for DashScope models.
+     */
+    thinkingConfig?: DashScopeThinkingConfig;
+    /**
+     * (Deprecated) Use thinkingConfig instead.
+     * Whether to enable the "thinking" feature in the model.
+     */
+    enableThinking?: boolean;
+    /**
+     * Whether the model is multimodal or not, this will decide the default API endpoint.
+     */
+    multimodal?: boolean;
+    /**
+     * Preset generation parameters to include in each request.
+     * These parameters will be merged with the request-specific parameters.
+     */
+    presetGenParams?: Record<string, unknown>;
+    /**
+     * Preset headers that will be included in each request.
+     */
+    presetHeaders?: Record<string, unknown>;
+}
+/**
+ * The DashScope API chat model.
+ */
+declare class DashScopeChatModel extends ChatModelBase {
+    apiURL: string;
+    protected apiKey: string;
+    protected presetGenParams: Record<string, unknown> | undefined;
+    protected presetHeaders: Record<string, unknown> | undefined;
+    protected thinkingConfig?: DashScopeThinkingConfig;
+    /**
+     * Initializes a new instance of the DashScopeChatModel class.
+     *
+     * @param options - The DashScope chat model options.
+     * @param options.modelName - The name of the model to use.
+     * @param options.apiKey - The API key for authentication.
+     * @param options.stream - Whether to use streaming responses. Default is true.
+     * @param options.thinkingConfig - The thinking configuration for DashScope models, including whether to enable thinking and the thinking budget.
+     * @param options.maxRetries - The maximum number of retries for failed requests. Default is 3.
+     * @param options.fallbackModelName - The fallback model name to use if the primary model fails.
+     * @param options.presetGenParams - Preset generation parameters to include in each request.
+     * @param options.presetHeaders - Preset headers that will be included in each request.
+     * @param options.multimodal - Whether the model is multimodal or not, this will decide the default API endpoint. If not provided, it will be inferred from the model name.
+     * @param options.formatter - An optional custom formatter. If not provided, a default DashScopeChatFormatter will be used.
+     */
+    constructor({ modelName, apiKey, stream, thinkingConfig, maxRetries, fallbackModelName, presetGenParams, presetHeaders, multimodal, formatter, }: DashScopeChatModelOptions);
+    /**
+     * Calls the DashScope API with the given parameters.
+     *
+     * @param modelName - The name of the model to use.
+     * @param options - The chat model options.
+     * @returns A promise that resolves to either a ChatResponse or an AsyncGenerator of ChatResponses.
+     */
+    _callAPI(modelName: string, options: ChatModelRequestOptions<Record<string, unknown>>): Promise<ChatResponse | AsyncGenerator<ChatResponse, ChatResponse>>;
+    /**
+     * The method to format the tool choice parameter.
+     *
+     * @param toolChoice - The tool choice option.
+     * @returns The formatted tool choice.
+     */
+    _formatToolChoice(toolChoice?: ToolChoice): 'auto' | 'none' | Record<string, unknown>;
+    /**
+     * Parses a streamed response from DashScope API specifically for chat responses.
+     * An async generator that yields delta ChatResponse objects as they are received.
+     *
+     * @param response - The fetch response object.
+     * @param startTime - The start time of the request for usage calculation.
+     * @returns An async generator yielding delta ChatResponse objects, and returns the complete ChatResponse.
+     */
+    _parseDashScopeStreamedResponse(response: Response, startTime: number): AsyncGenerator<ChatResponse, ChatResponse>;
+    /**
+     * Convert data into blocks
+     *
+     * @param text - The text response from the llm API
+     * @param thinking - The thinking response
+     * @param toolCalls - The tool calls
+     * @returns An array of blocks
+     */
+    _dataToBlocks(text: string, thinking: string, toolCalls: Map<string, ToolCallBlock>): (TextBlock | ThinkingBlock | ToolCallBlock)[];
+    /**
+     * Format the tool schemas to the expected API format.
+     * @param tools
+     * @returns The formatted tool schemas.
+     */
+    _formatToolSchemas(tools: ToolSchema[] | undefined): ToolSchema[];
+}
+
+interface DeepSeekThinkingConfig {
+    /**
+     * Whether to enable thinking or not.
+     */
+    enableThinking: boolean;
+}
+interface DeepSeekChatModelOptions extends ChatModelOptions {
+    /**
+     * The API key for authenticating with DeepSeek API.
+     */
+    apiKey: string;
+    /**
+     * Thinking configuration for DeepSeek models.
+     */
+    thinkingConfig?: DeepSeekThinkingConfig;
+    /**
+     * Preset generation parameters to include in each request.
+     * These parameters will be merged with the request-specific parameters.
+     */
+    presetGenParams?: Record<string, unknown>;
+    /**
+     * Preset headers that will be included in each request.
+     */
+    presetHeaders?: Record<string, unknown>;
+}
+/**
+ * The DeepSeek API chat model.
+ */
+declare class DeepSeekChatModel extends ChatModelBase {
+    apiURL: string;
+    protected apiKey: string;
+    protected presetGenParams: Record<string, unknown> | undefined;
+    protected presetHeaders: Record<string, unknown> | undefined;
+    protected thinkingConfig: DeepSeekThinkingConfig;
+    /**
+     * Initializes a new instance of the DeepSeekChatModel class.
+     *
+     * @param options - The DeepSeek chat model options.
+     * @param options.modelName - The name of the model to use.
+     * @param options.apiKey - The API key for authentication.
+     * @param options.stream - Whether to use streaming responses. Default is true.
+     * @param options.thinkingConfig - Thinking configuration.
+     * @param options.maxRetries - The maximum number of retries for failed requests. Default is 0.
+     * @param options.fallbackModelName - The fallback model name to use if the primary model fails.
+     * @param options.presetGenParams - Preset generation parameters to include in each request.
+     * @param options.presetHeaders - Preset headers that will be included in each request.
+     * @param options.formatter
+     */
+    constructor({ modelName, apiKey, stream, thinkingConfig, maxRetries, fallbackModelName, presetGenParams, presetHeaders, formatter, }: DeepSeekChatModelOptions);
+    /**
+     * Calls the DeepSeek API with the given parameters.
+     *
+     * @param modelName - The name of the model to use.
+     * @param options - The chat model options.
+     * @returns A promise that resolves to either a ChatResponse or an AsyncGenerator of ChatResponses.
+     */
+    _callAPI(modelName: string, options: ChatModelRequestOptions<Record<string, unknown>>): Promise<ChatResponse | AsyncGenerator<ChatResponse, ChatResponse>>;
+    /**
+     * The method to format the tool choice parameter.
+     *
+     * @param toolChoice - The tool choice option.
+     * @returns The formatted tool choice.
+     */
+    _formatToolChoice(toolChoice?: ToolChoice): 'auto' | 'none' | 'required' | Record<string, unknown>;
+    /**
+     * Parses a streamed response from DeepSeek API specifically for chat responses.
+     * An async generator that yields delta ChatResponse objects as they are received.
+     *
+     * @param response - The fetch response object.
+     * @param startTime - The start time of the request for usage calculation.
+     * @returns An async generator yielding delta ChatResponse objects, and returns the complete ChatResponse.
+     */
+    _parseDeepSeekStreamedResponse(response: Response, startTime: number): AsyncGenerator<ChatResponse, ChatResponse>;
+    /**
+     * Convert data into blocks
+     *
+     * @param text - The text response from the llm API
+     * @param thinking - The thinking response
+     * @param toolCalls - The tool calls
+     * @returns An array of blocks
+     */
+    _accDataToBlocks(text: string, thinking: string, toolCalls: Map<string, ToolCallBlock>): (TextBlock | ThinkingBlock | ToolCallBlock)[];
+    /**
+     * Format the tool schemas to the expected API format for DeepSeek API.
+     * @param tools
+     * @returns The formatted tool schemas.
+     */
+    _formatToolSchemas(tools: ToolSchema[] | undefined): ToolSchema[];
+}
+
+interface OllamaThinkingConfig {
+    /**
+     * Whether to enable thinking or not.
+     */
+    enableThinking: boolean;
+    /**
+     * Thinking level for Ollama models (high, medium, low).
+     * Only applicable when enableThinking is true.
+     */
+    thinkingLevel?: 'high' | 'medium' | 'low';
+}
+interface OllamaChatModelOptions extends ChatModelOptions {
+    /**
+     * Additional parameters to pass to the Ollama API (e.g., temperature).
+     */
+    options?: Record<string, unknown>;
+    /**
+     * Duration to keep the model loaded in memory (e.g., "5m", "1h").
+     */
+    keepAlive?: string;
+    /**
+     * Thinking configuration for Ollama models.
+     */
+    thinkingConfig?: OllamaThinkingConfig;
+    /**
+     * The host address of the Ollama server.
+     */
+    host?: string;
+    /**
+     * Extra keyword arguments to initialize the Ollama client.
+     */
+    clientKwargs?: Record<string, unknown>;
+    /**
+     * Extra keyword arguments used in Ollama API generation.
+     */
+    generateKwargs?: Record<string, unknown>;
+}
+/**
+ * The Ollama chat model class in AgentScope.
+ */
+declare class OllamaChatModel extends ChatModelBase {
+    protected client: Ollama;
+    protected options?: Record<string, unknown>;
+    protected keepAlive: string;
+    protected thinkingConfig: OllamaThinkingConfig;
+    protected generateKwargs: Record<string, unknown>;
+    /**
+     * Initializes a new instance of the OllamaChatModel class.
+     * @param root0
+     * @param root0.modelName
+     * @param root0.stream
+     * @param root0.options
+     * @param root0.keepAlive
+     * @param root0.thinkingConfig
+     * @param root0.host
+     * @param root0.maxRetries
+     * @param root0.fallbackModelName
+     * @param root0.clientKwargs
+     * @param root0.generateKwargs
+     * @param root0.formatter
+     */
+    constructor({ modelName, stream, options, keepAlive, thinkingConfig, host, maxRetries, fallbackModelName, clientKwargs, generateKwargs, formatter, }: OllamaChatModelOptions);
+    /**
+     * Calls the Ollama API with the given parameters.
+     * @param modelName
+     * @param options
+     * @returns A promise that resolves to either a ChatResponse or an AsyncGenerator of ChatResponses.
+     */
+    _callAPI(modelName: string, options: ChatModelRequestOptions<Record<string, unknown>>): Promise<ChatResponse | AsyncGenerator<ChatResponse, ChatResponse>>;
+    /**
+     * Parse Ollama streaming response.
+     * @param stream
+     * @param startTime
+     * @returns An async generator that yields delta ChatResponse objects and returns the complete ChatResponse.
+     */
+    _parseOllamaStreamResponse(stream: AbortableAsyncIterator<ChatResponse$1>, startTime: number): AsyncGenerator<ChatResponse, ChatResponse>;
+    /**
+     * Parse Ollama non-streaming response.
+     * @param response
+     * @param startTime
+     * @returns A ChatResponse object containing the content blocks and usage.
+     */
+    _parseOllamaResponse(response: ChatResponse$1, startTime: number): ChatResponse;
+    /**
+     * Build content blocks from accumulated data.
+     * @param text
+     * @param thinking
+     * @param toolCalls
+     * @returns An array of content blocks.
+     */
+    _buildContentBlocks(text: string, thinking: string, toolCalls: Map<string, ToolCallBlock>): Array<TextBlock | ThinkingBlock | ToolCallBlock>;
+    /**
+     * Format tool choice parameter (not supported by Ollama).
+     * @param _toolChoice
+     * @returns undefined as Ollama does not support tool choice.
+     */
+    _formatToolChoice(_toolChoice?: ToolChoice): unknown;
+    /**
+     * Format tool schemas for Ollama API (no special formatting needed).
+     * @param tools
+     * @returns The same array of tool schemas, or an empty array if undefined.
+     */
+    _formatToolSchemas(tools: ToolSchema[] | undefined): ToolSchema[];
+}
+
+interface OpenAIChatModelOptions extends ChatModelOptions {
+    apiKey: string;
+    presetGenParams?: Record<string, unknown>;
+    baseURL?: string;
+}
+/**
+ * The OpenAI API chat model.
+ */
+declare class OpenAIChatModel extends ChatModelBase {
+    protected client: OpenAI;
+    protected presetGenParams: Record<string, unknown> | undefined;
+    /**
+     * Initializes a new instance of the OpenAIChatModel class.
+     * @param options
+     * @param options.modelName
+     * @param options.apiKey
+     * @param options.stream
+     * @param options.maxRetries
+     * @param options.fallbackModelName
+     * @param options.presetGenParams
+     * @param options.baseURL
+     * @param options.formatter
+     */
+    constructor({ modelName, apiKey, stream, maxRetries, fallbackModelName, presetGenParams, baseURL, formatter, }: OpenAIChatModelOptions);
+    /**
+     * Calls the OpenAI API with the given parameters.
+     *
+     * @param modelName - The name of the model to use.
+     * @param options - The chat model options.
+     * @returns A promise that resolves to either a ChatResponse or an AsyncGenerator of ChatResponses.
+     */
+    _callAPI(modelName: string, options: ChatModelRequestOptions<ChatCompletionMessageParam>): Promise<ChatResponse | AsyncGenerator<ChatResponse, ChatResponse>>;
+    /**
+     * Formats the tool choice for the API request.
+     *
+     * TODO: supports grouped tool choices.
+     *
+     * @param toolChoice - The tool choice option.
+     * @returns The formatted tool choice.
+     */
+    _formatToolChoice(toolChoice?: ToolChoice): ChatCompletionToolChoiceOption;
+    /**
+     * Parses a streamed response from OpenAI API.
+     * An async generator that yields delta ChatResponse objects as they are received.
+     *
+     * @param stream - The OpenAI stream object.
+     * @param startTime - The start time of the request for usage calculation.
+     * @returns An async generator yielding delta ChatResponse objects, and returns the complete ChatResponse.
+     */
+    _parseOpenAIStreamedResponse(stream: AsyncIterable<OpenAI.Chat.Completions.ChatCompletionChunk>, startTime: number): AsyncGenerator<ChatResponse, ChatResponse>;
+    /**
+     * Convert data into blocks
+     *
+     * @param text - The text response from the llm API
+     * @param toolCalls - The tool calls
+     * @returns An array of blocks
+     */
+    _accDataToBlocks(text: string, toolCalls: Map<string, ToolCallBlock>): (TextBlock | ToolCallBlock)[];
+    /**
+     * Format the tool schemas to the expected API format.
+     * @param tools
+     * @returns The formatted tool schemas.
+     */
+    _formatToolSchemas(tools: ToolSchema[] | undefined): ToolSchema[];
+}
+
+export { ChatModelBase, ChatResponse, DashScopeChatModel, DeepSeekChatModel, OllamaChatModel, OpenAIChatModel };