@astack-tech/integrations 0.1.1-beta.5 → 0.2.0-beta.7

package/dist/model-provider/index.d.ts

@@ -1,195 +1,196 @@
-import { Component } from '@astack-tech/core';
+import { Component, Port } from '@astack-tech/core';
 
 /**
- * Deepseek 模型提供者配置
+ * Options for the DeepSeek model provider.
  */
 interface DeepseekConfig {
-    /**
-     * API 密钥
-     */
+    /** DeepSeek API key. */
     apiKey: string;
-    /**
-     * 使用的模型名称
-     * 默认为 'deepseek-chat'
-     */
-    model?: string;
-    /**
-     * 自定义 API 基础 URL
-     * 默认为 Deepseek 官方 API 地址
-     */
-    baseURL?: string;
-    /**
-     * 温度参数，控制输出的随机性
-     */
-    temperature?: number;
-    /**
-     * 最大生成的 token 数
-     */
-    maxTokens?: number;
-    /**
-     * 采样概率
-     */
-    topP?: number;
-    /**
-     * 系统提示消息
-     */
-    systemPrompt?: string;
-    /**
-     * 工具实例数组，直接传递工具实例
-     * 每个工具应具有 name、description 和 parameters 属性
-     */
-    rawTools?: Array<{
-        name: string;
-        description: string;
-        parameters?: Record<string, unknown>;
-    }>;
-    /**
-     * API 格式的工具定义数组，与 rawTools 二选一
-     * 使用 OpenAI 兼容的工具定义格式
-     */
-    tools?: unknown[];
-    /**
-     * dangerouslyAllowBrowser
-     * 是否允许在浏览器等非安全环境内运行
-     */
-    dangerouslyAllowBrowser?: boolean;
+    /** Model name. Defaults to `deepseek-chat`. */
+    model?: string | undefined;
+    /** API base URL. Defaults to `https://api.deepseek.com/v1`. */
+    baseURL?: string | undefined;
+    /** Sampling temperature. Defaults to `0.7`. */
+    temperature?: number | undefined;
+    /** Maximum number of generated tokens. */
+    maxTokens?: number | undefined;
+    /** Nucleus sampling probability. */
+    topP?: number | undefined;
+    /** System prompt added before every request. */
+    systemPrompt?: string | undefined;
+    /**
+     * Tools given as `{ name, description, parameters }` objects.
+     * When this list is not empty, it takes precedence over `tools`.
+     */
+    rawTools?: RawTool[] | undefined;
+    /** Tools in the OpenAI-compatible `{ type: 'function', function }` format. */
+    tools?: unknown[] | undefined;
+    /** Allows the OpenAI client to run in a browser. Defaults to `false`. */
+    dangerouslyAllowBrowser?: boolean | undefined;
+    /** Logs API errors to the console. Defaults to `false`. */
+    verbose?: boolean | undefined;
+}
+/**
+ * Tool description accepted by `rawTools` and `temporaryTools`.
+ */
+interface RawTool {
+    name: string;
+    description: string;
+    parameters?: Record<string, unknown> | undefined;
 }
 /**
- * 消息角色类型
+ * Role of a chat message.
  */
 type MessageRole = 'system' | 'user' | 'assistant' | 'tool';
 /**
- * 工具调用
+ * Tool call in the internal format.
  */
 interface ToolCall {
-    /**
-     * 工具调用 ID
-     */
-    id?: string;
-    /**
-     * 工具名称
-     */
+    /** Identifier assigned by the API. */
+    id?: string | undefined;
+    /** Name of the tool. */
     tool_name: string;
-    /**
-     * 工具调用参数
-     */
+    /** Parsed arguments. */
     arguments: Record<string, unknown>;
 }
 /**
- * Token 使用统计
+ * Tool call returned by `chatCompletion`. It carries both the OpenAI shape
+ * (`type`, `function`) and the internal shape (`tool_name`, `arguments`).
+ */
+interface ResponseToolCall {
+    id: string;
+    type: 'function';
+    function: {
+        name: string;
+        arguments: string;
+    };
+    tool_name: string;
+    arguments: Record<string, unknown>;
+}
+/**
+ * Partial tool call emitted while streaming. `arguments` holds the raw JSON fragment.
+ */
+interface StreamToolCall {
+    id: string;
+    type: 'function';
+    function: {
+        name: string;
+        arguments: string;
+    };
+    tool_name: string;
+    arguments: string;
+}
+/**
+ * Token usage reported by the API.
  */
 interface TokenUsage {
-    /**
-     * 完成部分的 token 数量
-     */
     completion_tokens: number;
-    /**
-     * 提示部分的 token 数量
-     */
     prompt_tokens: number;
-    /**
-     * 提示缓存命中的 token 数量（可选）
-     */
-    prompt_cache_hit_tokens?: number;
-    /**
-     * 提示缓存未命中的 token 数量（可选）
-     */
-    prompt_cache_miss_tokens?: number;
-    /**
-     * 总 token 数量
-     */
+    prompt_cache_hit_tokens?: number | undefined;
+    prompt_cache_miss_tokens?: number | undefined;
     total_tokens: number;
 }
 /**
- * 对话消息类型
+ * Chat message accepted as input. It matches the agent message contract in
+ * `@astack-tech/components`, so agent histories can be passed directly.
  */
 interface Message {
-    /**
-     * 消息角色
-     */
-    role: MessageRole;
-    /**
-     * 消息内容
-     */
-    content?: string;
-    /**
-     * 工具调用
-     */
-    tool_calls?: ToolCall[];
-    /**
-     * 工具调用 ID，用于工具响应消息
-     */
-    tool_call_id?: string;
-    /**
-     * Token 使用统计（可选）
-     */
-    usage?: TokenUsage;
+    /** One of `system`, `user`, `assistant` or `tool` (see `MessageRole`). */
+    role: string;
+    content?: string | undefined;
+    /** Accepted for compatibility. Assistant tool calls are not forwarded to the API. */
+    tool_calls?: readonly unknown[] | undefined;
+    /** Identifier of the call that a `tool` message answers. */
+    tool_call_id?: string | undefined;
+    usage?: TokenUsage | undefined;
 }
 /**
- * Deepseek 组件
- *
- * 使用 OpenAI 兼容接口调用 Deepseek 模型
- *
- * 输入:
- *   - prompt: 文本提示
- *   - messages: 对话消息数组
+ * Assistant message returned by `chatCompletion`.
+ */
+interface AssistantMessage {
+    role: 'assistant';
+    content: string;
+    tool_calls?: ResponseToolCall[] | undefined;
+    usage?: TokenUsage | undefined;
+}
+/**
+ * Chunk yielded by `streamChatCompletion`.
+ */
+interface StreamChunk {
+    role: 'assistant';
+    content: string;
+    tool_calls?: StreamToolCall[] | undefined;
+    usage?: TokenUsage | undefined;
+}
+/**
+ * Per-call options.
+ */
+interface ChatCompletionOptions {
+    /** Tools for this call only. They replace the configured tools. */
+    temporaryTools?: unknown[] | undefined;
+}
+/**
+ * DeepSeek model provider. It calls the DeepSeek API through the OpenAI-compatible client.
  *
- * 输出:
- *   - completion: 生成的文本完成
- *   - message: 生成的响应消息
+ * Ports:
+ * - `prompt` (in): a text prompt. The answer is sent on `completion`.
+ * - `messages` (in): a list of chat messages. The reply is sent on `message`.
  */
 declare class Deepseek extends Component {
-    private client;
-    private model;
-    private temperature;
-    private maxTokens?;
-    private topP?;
-    private systemPrompt?;
-    private tools?;
+    private readonly client;
+    private readonly model;
+    private readonly temperature;
+    private readonly maxTokens;
+    private readonly topP;
+    private readonly systemPrompt;
+    private readonly tools;
+    private readonly verbose;
     constructor(config: DeepseekConfig);
     /**
-     * 生成文本完成
-     * @param prompt 提示文本
-     * @returns 生成的文本
+     * Generates a completion for a single prompt.
+     *
+     * @returns The text answer, or the JSON-encoded assistant message when it contains tool calls.
      */
     generateCompletion(prompt: string): Promise<string>;
     /**
-     * 流式处理对话消息
-     * @param messages 对话消息数组
-     * @param options 可选的调用选项，包含临时工具列表
-     * @returns 生成的流式响应消息异步生成器
+     * Sends a conversation and returns the assistant reply.
+     */
+    chatCompletion(messages: Message[], options?: ChatCompletionOptions): Promise<AssistantMessage>;
+    /**
+     * Streams the assistant reply. Each chunk holds a text delta, tool-call deltas, or usage.
      */
-    streamChatCompletion(messages: Message[], options?: {
-        temporaryTools?: unknown[];
-    }): AsyncGenerator<Partial<Message>>;
+    streamChatCompletion(messages: Message[], options?: ChatCompletionOptions): AsyncGenerator<StreamChunk>;
     /**
-     * 处理对话消息
-     * @param messages 对话消息数组
-     * @param options 可选的调用选项，包含临时工具列表
-     * @returns 生成的响应消息
+     * Runs the model outside a pipeline.
+     *
+     * @param input A prompt string or a list of messages.
      */
-    chatCompletion(messages: Message[], options?: {
-        temporaryTools?: unknown[];
-    }): Promise<Message>;
+    run(input: string | Message[]): Promise<string | AssistantMessage>;
     /**
-     * 在独立模式下运行组件
-     * @param input 输入参数，可以是提示文本或对话消息数组
-     * @returns 生成的文本或响应消息
+     * Connects the `prompt` and `messages` input ports to the model.
+     * API errors produce a fallback value so the pipeline keeps flowing.
      */
-    run(input: string | Message[]): Promise<string | Message>;
+    _transform($i: Port, $o: Port): void;
+    private baseRequest;
+    private toolsParam;
+    private systemMessages;
     /**
-     * 在流水线中运行组件
-     * @param $i 输入端口
-     * @param $o 输出端口
+     * Converts input messages to API messages. Assistant `tool_calls` are not forwarded:
+     * agents send tool results back as user messages, and the API rejects assistant tool
+     * calls that are not followed by tool messages.
      */
-    _transform($i: any, $o: any): void;
+    private formatMessages;
+    private firstMessage;
+    private logError;
 }
 
 type index_Deepseek = Deepseek;
 declare const index_Deepseek: typeof Deepseek;
 type index_DeepseekConfig = DeepseekConfig;
 declare namespace index {
-  export { index_Deepseek as Deepseek, type index_DeepseekConfig as DeepseekConfig, type Message as DeepseekMessage, type MessageRole as DeepseekMessageRole, type ToolCall as DeepseekToolCall };
+  export { index_Deepseek as Deepseek };
+  export type { AssistantMessage as DeepseekAssistantMessage, ChatCompletionOptions as DeepseekChatCompletionOptions, index_DeepseekConfig as DeepseekConfig, Message as DeepseekMessage, MessageRole as DeepseekMessageRole, RawTool as DeepseekRawTool, ResponseToolCall as DeepseekResponseToolCall, StreamChunk as DeepseekStreamChunk, StreamToolCall as DeepseekStreamToolCall, TokenUsage as DeepseekTokenUsage, ToolCall as DeepseekToolCall };
 }
 
-export { Deepseek, type DeepseekConfig, type Message as DeepseekMessage, type MessageRole as DeepseekMessageRole, type ToolCall as DeepseekToolCall, index as i };
+export { Deepseek, index as i };
+export type { AssistantMessage as DeepseekAssistantMessage, ChatCompletionOptions as DeepseekChatCompletionOptions, DeepseekConfig, Message as DeepseekMessage, MessageRole as DeepseekMessageRole, RawTool as DeepseekRawTool, ResponseToolCall as DeepseekResponseToolCall, StreamChunk as DeepseekStreamChunk, StreamToolCall as DeepseekStreamToolCall, TokenUsage as DeepseekTokenUsage, ToolCall as DeepseekToolCall };