@aigne/doubao 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 (2025-07-30)
+
+
+### Features
+
+* **models:** support doubao llm adapter ([#289](https://github.com/AIGNE-io/aigne-framework/issues/289)) ([0f68887](https://github.com/AIGNE-io/aigne-framework/commit/0f688871d232e7a42613f4921491de8974b31b81))

package/LICENSE.md

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+*As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.*
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,112 @@
+# @aigne/doubao
+
+[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-framework?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-framework)
+[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-framework?style=flat-square)](https://github.com/AIGNE-io/aigne-framework/issues)
+[![codecov](https://codecov.io/gh/AIGNE-io/aigne-framework/graph/badge.svg?token=DO07834RQL)](https://codecov.io/gh/AIGNE-io/aigne-framework)
+[![NPM Version](https://img.shields.io/npm/v/@aigne/doubao)](https://www.npmjs.com/package/@aigne/doubao)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/doubao)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE.md)
+
+AIGNE Doubao SDK for integrating with Doubao AI models within the [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework).
+
+## Introduction
+
+`@aigne/doubao` provides a seamless integration between the AIGNE Framework and Doubao's powerful language models and API. This package enables developers to easily leverage Doubao's AI models in their AIGNE applications, providing a consistent interface across the framework while taking advantage of Doubao's advanced AI capabilities.
+
+## Features
+
+* **Doubao API Integration**: Direct connection to Doubao's API services
+* **Chat Completions**: Support for Doubao's chat completions API with all available models
+* **Function Calling**: Built-in support for function calling capabilities
+* **Streaming Responses**: Support for streaming responses for more responsive applications
+* **Type-Safe**: Comprehensive TypeScript typings for all APIs and models
+* **Consistent Interface**: Compatible with the AIGNE Framework's model interface
+* **Error Handling**: Robust error handling and retry mechanisms
+* **Full Configuration**: Extensive configuration options for fine-tuning behavior
+
+## Installation
+
+### Using npm
+
+```bash
+npm install @aigne/doubao @aigne/core
+```
+
+### Using yarn
+
+```bash
+yarn add @aigne/doubao @aigne/core
+```
+
+### Using pnpm
+
+```bash
+pnpm add @aigne/doubao @aigne/core
+```
+
+## Basic Usage
+
+// todo
+```typescript file="test/doubao-chat-model.test.ts" region="example-doubao-chat-model"
+import { DoubaoChatModel } from "@aigne/doubao";
+
+const model = new DoubaoChatModel({
+  // Provide API key directly or use environment variable DOUBAO_API_KEY
+  apiKey: "your-api-key", // Optional if set in env variables
+  // Specify model version (defaults to 'doubao-seed-1-6-250615')
+  model: "doubao-seed-1-6-250615",
+  modelOptions: {
+    temperature: 0.7,
+  },
+});
+
+const result = await model.invoke({
+  messages: [{ role: "user", content: "Introduce yourself" }],
+});
+
+console.log(result);
+/* Output:
+  {
+    text: "Hello! I'm Doubao, an AI developed by ByteDance. My main goal is to assist you with a wide range of tasks—whether you have questions to ask, need help brainstorming ideas, want explanations on topics, or just feel like chatting. I’m here to provide helpful, clear, and friendly responses. Feel free to let me know what you need—I’m happy to help! 😊",
+    usage: { inputTokens: 87, outputTokens: 219 },
+    model: 'doubao-seed-1-6-250615'
+  }
+  */
+```
+
+## Streaming Responses
+
+// todo
+```typescript file="test/doubao-seed-1-6-250615-model.test.ts" region="example-doubao-seed-1-6-250615-model-streaming"
+import { isAgentResponseDelta } from "@aigne/core";
+import { DoubaoChatModel } from "@aigne/doubao";
+
+const model = new DoubaoChatModel({
+  apiKey: "your-api-key",
+  model: "doubao-seed-1-6-250615",
+});
+
+const stream = await model.invoke(
+  {
+    messages: [{ role: "user", content: "Introduce yourself" }],
+  },
+  { streaming: true },
+);
+
+let fullText = "";
+const json = {};
+
+for await (const chunk of stream) {
+  if (isAgentResponseDelta(chunk)) {
+    const text = chunk.delta.text?.text;
+    if (text) fullText += text;
+    if (chunk.delta.json) Object.assign(json, chunk.delta.json);
+  }
+}
+
+console.log(fullText); // Output: "Hello! I'm an AI assistant powered by Doubao's language model."
+console.log(json); // { model: "doubao-seed-1-6-250615", usage: { inputTokens: 7, outputTokens: 12 } }
+```
+
+## License
+
+Elastic-2.0

package/lib/cjs/doubao-chat-model.d.ts

@@ -0,0 +1,21 @@
+import { OpenAIChatModel, type OpenAIChatModelOptions } from "@aigne/openai";
+/**
+ * Implementation of the ChatModel interface for Doubao's API
+ *
+ * This model uses OpenAI-compatible API format to interact with Doubao's models,
+ * but with specific configuration and capabilities for Doubao.
+ *
+ * Default model: 'doubao-seed-1-6-250615'
+ *
+ * @example
+ * Here's how to create and use a Doubao chat model:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model-streaming}
+ */
+export declare class DoubaoChatModel extends OpenAIChatModel {
+    constructor(options?: OpenAIChatModelOptions);
+    protected apiKeyEnvName: string;
+}

package/lib/cjs/doubao-chat-model.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DoubaoChatModel = void 0;
+const openai_1 = require("@aigne/openai");
+const DOUBAO_DEFAULT_CHAT_MODEL = "doubao-seed-1-6-250615";
+const DOUBAO_BASE_URL = "https://ark.cn-beijing.volces.com/api/v3";
+/**
+ * Implementation of the ChatModel interface for Doubao's API
+ *
+ * This model uses OpenAI-compatible API format to interact with Doubao's models,
+ * but with specific configuration and capabilities for Doubao.
+ *
+ * Default model: 'doubao-seed-1-6-250615'
+ *
+ * @example
+ * Here's how to create and use a Doubao chat model:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model-streaming}
+ */
+class DoubaoChatModel extends openai_1.OpenAIChatModel {
+    constructor(options) {
+        super({
+            ...options,
+            model: options?.model || DOUBAO_DEFAULT_CHAT_MODEL,
+            baseURL: options?.baseURL || DOUBAO_BASE_URL,
+        });
+    }
+    apiKeyEnvName = "DOUBAO_API_KEY";
+}
+exports.DoubaoChatModel = DoubaoChatModel;

package/lib/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from "./doubao-chat-model.js";

package/lib/cjs/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./doubao-chat-model.js"), exports);

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/dts/doubao-chat-model.d.ts

@@ -0,0 +1,21 @@
+import { OpenAIChatModel, type OpenAIChatModelOptions } from "@aigne/openai";
+/**
+ * Implementation of the ChatModel interface for Doubao's API
+ *
+ * This model uses OpenAI-compatible API format to interact with Doubao's models,
+ * but with specific configuration and capabilities for Doubao.
+ *
+ * Default model: 'doubao-seed-1-6-250615'
+ *
+ * @example
+ * Here's how to create and use a Doubao chat model:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model-streaming}
+ */
+export declare class DoubaoChatModel extends OpenAIChatModel {
+    constructor(options?: OpenAIChatModelOptions);
+    protected apiKeyEnvName: string;
+}

package/lib/dts/index.d.ts

@@ -0,0 +1 @@
+export * from "./doubao-chat-model.js";

package/lib/esm/doubao-chat-model.d.ts

@@ -0,0 +1,21 @@
+import { OpenAIChatModel, type OpenAIChatModelOptions } from "@aigne/openai";
+/**
+ * Implementation of the ChatModel interface for Doubao's API
+ *
+ * This model uses OpenAI-compatible API format to interact with Doubao's models,
+ * but with specific configuration and capabilities for Doubao.
+ *
+ * Default model: 'doubao-seed-1-6-250615'
+ *
+ * @example
+ * Here's how to create and use a Doubao chat model:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model-streaming}
+ */
+export declare class DoubaoChatModel extends OpenAIChatModel {
+    constructor(options?: OpenAIChatModelOptions);
+    protected apiKeyEnvName: string;
+}

package/lib/esm/doubao-chat-model.js

@@ -0,0 +1,29 @@
+import { OpenAIChatModel } from "@aigne/openai";
+const DOUBAO_DEFAULT_CHAT_MODEL = "doubao-seed-1-6-250615";
+const DOUBAO_BASE_URL = "https://ark.cn-beijing.volces.com/api/v3";
+/**
+ * Implementation of the ChatModel interface for Doubao's API
+ *
+ * This model uses OpenAI-compatible API format to interact with Doubao's models,
+ * but with specific configuration and capabilities for Doubao.
+ *
+ * Default model: 'doubao-seed-1-6-250615'
+ *
+ * @example
+ * Here's how to create and use a Doubao chat model:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/doubao-chat-model.test.ts#example-doubao-chat-model-streaming}
+ */
+export class DoubaoChatModel extends OpenAIChatModel {
+    constructor(options) {
+        super({
+            ...options,
+            model: options?.model || DOUBAO_DEFAULT_CHAT_MODEL,
+            baseURL: options?.baseURL || DOUBAO_BASE_URL,
+        });
+    }
+    apiKeyEnvName = "DOUBAO_API_KEY";
+}

package/lib/esm/index.d.ts

@@ -0,0 +1 @@
+export * from "./doubao-chat-model.js";

package/lib/esm/index.js

@@ -0,0 +1 @@
+export * from "./doubao-chat-model.js";

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@aigne/doubao",
+  "description": "AIGNE doubao SDK for integrating with doubao AI models",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "homepage": "https://github.com/AIGNE-io/aigne-framework",
+  "license": "Elastic-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+  },
+  "files": [
+    "lib/cjs",
+    "lib/dts",
+    "lib/esm",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "type": "module",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/dts/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/dts/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@aigne/openai": "^0.10.6"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.18",
+    "@types/node": "^24.0.12",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3",
+    "@aigne/test-utils": "^0.5.14",
+    "@aigne/core": "^1.39.0"
+  },
+  "version": "1.0.0",
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "build": "tsc --build scripts/tsconfig.build.json",
+    "clean": "rimraf lib test/coverage",
+    "test": "bun test",
+    "test:coverage": "bun test --coverage --coverage-reporter=lcov --coverage-reporter=text",
+    "postbuild": "node ../../scripts/post-build-lib.mjs"
+  }
+}