{"_id":"@agentxin-ai/plugin-volcengine","name":"@agentxin-ai/plugin-volcengine","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.2":{"name":"@agentxin-ai/plugin-volcengine","version":"0.0.2","author":{"name":"AgentXinAI","url":"https://agentxinai.cn"},"license":"AGPL-3.0","repository":{"type":"git","url":"git+https://github.com/agentxin-ai/agentxin-plugins.git"},"bugs":{"url":"https://github.com/agentxin-ai/agentxin-plugins/issues"},"type":"module","main":"./dist/index.js","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{"./package.json":"./package.json",".":{"@agentxin-plugins-starter/source":"./src/index.ts","types":"./dist/index.d.ts","import":"./dist/index.js","default":"./dist/index.js"}},"dependencies":{"tslib":"^2.3.0"},"peerDependencies":{"@langchain/openai":"0.6.9","@metad/contracts":"^3.6.1","@nestjs/common":"^11.1.6","@nestjs/config":"^4.0.2","@agentxin-ai/plugin-sdk":"^3.6.1","lodash-es":"4.17.21","chalk":"4.1.2","zod":"3.25.67"},"scripts":{},"_id":"@agentxin-ai/plugin-volcengine@0.0.2","description":"`@agentxin-ai/plugin-volcengine` is a standard adapter for the [AgentXinAI](https://github.com/agentxin-ai/agentxin) platform to access Volcengine (Doubao, etc.) large model services. The plugin connects to Volc Ark's OpenAI-compatible API, providing a un","homepage":"https://github.com/agentxin-ai/agentxin-plugins#readme","_nodeVersion":"22.22.0","_npmVersion":"10.9.4","dist":{"integrity":"sha512-x8E2MGnyMatFV0psiXkaI77BxNwtLxnbe6JxRmf1rYgptMEaPEq6dCTekHhfyf8R78Gn/0qNRuzGP8h+IO+kWg==","shasum":"78060d3a300b778e57a2c96f9059131bee13f9f5","tarball":"https://registry.npmjs.org/@agentxin-ai/plugin-volcengine/-/plugin-volcengine-0.0.2.tgz","fileCount":45,"unpackedSize":63996,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDWpvWL4wiLwg47mQOhXieQgSYyQ7o3RJ5w7IxyWNt+nAIhAOE3Mum49h2lJbRdfXBMR/gHs1UNmV90jsUigQfsXybZ"}]},"_npmUser":{"name":"agentxin-ai","email":"1304040880@qq.com"},"directories":{},"maintainers":[{"name":"agentxin-ai","email":"1304040880@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/plugin-volcengine_0.0.2_1775181814373_0.1393450341916569"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-03T02:03:34.272Z","0.0.2":"2026-04-03T02:03:34.553Z","modified":"2026-04-03T02:03:34.738Z"},"maintainers":[{"name":"agentxin-ai","email":"1304040880@qq.com"}],"description":"`@agentxin-ai/plugin-volcengine` is a standard adapter for the [AgentXinAI](https://github.com/agentxin-ai/agentxin) platform to access Volcengine (Doubao, etc.) large model services. The plugin connects to Volc Ark's OpenAI-compatible API, providing a un","homepage":"https://github.com/agentxin-ai/agentxin-plugins#readme","repository":{"type":"git","url":"git+https://github.com/agentxin-ai/agentxin-plugins.git"},"author":{"name":"AgentXinAI","url":"https://agentxinai.cn"},"bugs":{"url":"https://github.com/agentxin-ai/agentxin-plugins/issues"},"license":"AGPL-3.0","readme":"# AgentXin Plugin: Volcengine\n\n## Introduction\n\n`@agentxin-ai/plugin-volcengine` is a standard adapter for the [AgentXinAI](https://github.com/agentxin-ai/agentxin) platform to access Volcengine (Doubao, etc.) large model services. The plugin connects to Volc Ark's OpenAI-compatible API, providing a unified entry point for agents to access capabilities such as conversation and function calling within a workflow.\n\n## Core Features\n\n- Integrates Volcengine Ark platform's LLM/OpenAI-compatible interface, supporting key authentication, region selection, and multi-tenant configuration.\n- Registers the `VolcenginePlugin` NestJS module, automatically wiring up model providers, lifecycle logging, and configuration validation logic for easy enablement in AgentXinAI applications.\n- Provides `VolcengineLargeLanguageModel`, encapsulating Doubao-like conversational models with support for function calling, streaming output, token counting, and chain-of-thought exposure.\n\n## Supported Model Types\n\n- **Conversational Models**: Function calling, tool calling, streaming output, and chain-of-thought reasoning.\n\n## Installation\n\n```bash\nnpm install @agentxin-ai/plugin-volcengine\n```\n\n> **Peer Dependencies**: The host project must also provide libraries such as `@agentxin-ai/plugin-sdk`, `@nestjs/common`, `@metad/contracts`, `@langchain/openai`, `lodash-es`, `chalk`, and `zod`. Please refer to `package.json` for specific versions.\n\n## Enabling in AgentXinAI\n\n1. Install the plugin in the project where the AgentXinAI service runs, and ensure Node.js can resolve the package.\n2. Before starting the service, declare the plugin via environment variables:\n    ```bash\n    PLUGINS=@agentxin-ai/plugin-volcengine\n    ```\n3. In the AgentXinAI console or configuration file, add a new model provider, select `volcengine`, and fill in the corresponding Ark/Doubao model configuration.\n\n## Configuration\n\nThe configuration form is defined by `volcengine.yaml`, covering common Ark model deployment scenarios:\n\n| Field | Description |\n| --- | --- |\n| `api_key` | Required. Access key for Volcengine Ark platform (temporary token generated by AK/SK or long-term token). |\n| `endpoint_url` | Required. Base URL for Volc Ark's OpenAI-compatible API, e.g., `https://ark.cn-beijing.volces.com/api/v3`. |\n| `endpoint_model_name` | Optional. If the server model name differs from the logical model name in AgentXinAI, override it here. |\n| `mode` | Choose `chat` or `completion`, corresponding to different Ark inference channels. |\n| `context_size` / `max_tokens_to_sample` | Controls context window and generation length; recommended to match Doubao model specs. |\n| `agent_thought_support`, `function_calling_type`, `stream_function_calling`, `vision_support` | Configure model capability tags for frontend display and agent strategy selection. |\n| `region` / `workspace_id` | Optional. Additional info for multi-region or multi-tenant Volc Ark deployments. |\n| `stream_mode_delimiter` | Custom delimiter for streaming output, useful for rendering and rich text processing. |\n\nAfter saving, the plugin will call `validateCredentials` to send a minimal verification request to the Volc Ark API, ensuring the key and endpoint are correct.\n\n## Development & Debugging\n\nIn the repository root, enter `agentxinai/` and use Nx commands to build and test:\n\n```bash\nnpx nx build @agentxin-ai/plugin-volcengine\nnpx nx test @agentxin-ai/plugin-volcengine\n```\n\nBuild artifacts are output to the `dist/` directory by default. Unit test configuration is in `jest.config.ts`; you can extend coverage as needed.\n\n## License\n\nThis project follows the [AGPL-3.0 License](../../../LICENSE) in the repository root.\n","readmeFilename":"README.md","_rev":"1-8c595bdc5e4aae1836455610c513314a"}