@aigne/anthropic 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [0.1.0](https://github.com/AIGNE-io/aigne-framework/compare/anthropic-v0.0.1...anthropic-v0.1.0) (2025-05-23)
+
+
+### Features
+
+* **models:** publish model adapters as standalone packages ([#126](https://github.com/AIGNE-io/aigne-framework/issues/126)) ([588b8ae](https://github.com/AIGNE-io/aigne-framework/commit/588b8aea6abcee5fa87def1358bf51f84021c6ef))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.16.0
+  * devDependencies
+    * @aigne/test-utils bumped to 0.3.0

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,114 @@
+# @aigne/anthropic
+
+[![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/anthropic)](https://www.npmjs.com/package/@aigne/anthropic)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/anthropic)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE.md)
+
+**English** | [中文](README.zh.md)
+
+AIGNE Anthropic SDK for integrating with Claude AI models within the [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework).
+
+## Introduction
+
+`@aigne/anthropic` provides a seamless integration between the AIGNE Framework and Anthropic's Claude language models and API. This package enables developers to easily leverage Anthropic's Claude models in their AIGNE applications, providing a consistent interface across the framework while taking advantage of Claude's advanced AI capabilities.
+
+## Features
+
+* **Anthropic API Integration**: Direct connection to Anthropic's API services using the official SDK
+* **Chat Completions**: Support for Claude's chat completions API with all available models
+* **Tool Calling**: Built-in support for Claude's tool calling capability
+* **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/anthropic @aigne/core
+```
+
+### Using yarn
+
+```bash
+yarn add @aigne/anthropic @aigne/core
+```
+
+### Using pnpm
+
+```bash
+pnpm add @aigne/anthropic @aigne/core
+```
+
+## Basic Usage
+
+```typescript file="test/anthropic-chat-model.test.ts" region="example-anthropic-chat-model"
+import { AnthropicChatModel } from "@aigne/anthropic";
+
+const model = new AnthropicChatModel({
+  // Provide API key directly or use environment variable ANTHROPIC_API_KEY or CLAUDE_API_KEY
+  apiKey: "your-api-key", // Optional if set in env variables
+  // Specify Claude model version (defaults to 'claude-3-7-sonnet-latest')
+  model: "claude-3-haiku-20240307",
+  // Configure model behavior
+  modelOptions: {
+    temperature: 0.7,
+  },
+});
+
+const result = await model.invoke({
+  messages: [{ role: "user", content: "Tell me about yourself" }],
+});
+
+console.log(result);
+/* Output:
+  {
+    text: "I'm Claude, an AI assistant created by Anthropic. How can I help you today?",
+    model: "claude-3-haiku-20240307",
+    usage: {
+      inputTokens: 8,
+      outputTokens: 15
+    }
+  }
+  */
+```
+
+## Streaming Responses
+
+```typescript file="test/anthropic-chat-model.test.ts" region="example-anthropic-chat-model-streaming-async-generator"
+import { AnthropicChatModel } from "@aigne/anthropic";
+
+const model = new AnthropicChatModel({
+  apiKey: "your-api-key",
+  model: "claude-3-haiku-20240307",
+});
+
+const stream = await model.invoke(
+  {
+    messages: [{ role: "user", content: "Tell me about yourself" }],
+  },
+  undefined,
+  { streaming: true },
+);
+
+let fullText = "";
+const json = {};
+
+for await (const chunk of stream) {
+  const text = chunk.delta.text?.text;
+  if (text) fullText += text;
+  if (chunk.delta.json) Object.assign(json, chunk.delta.json);
+}
+
+console.log(fullText); // Output: "I'm Claude, an AI assistant created by Anthropic. How can I help you today?"
+console.log(json); // { model: "claude-3-haiku-20240307", usage: { inputTokens: 8, outputTokens: 15 } }
+```
+
+## License
+
+Elastic-2.0

package/README.zh.md

@@ -0,0 +1,114 @@
+# @aigne/anthropic
+
+[![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/anthropic)](https://www.npmjs.com/package/@aigne/anthropic)
+[![Elastic-2.0 licensed](https://img.shields.io/npm/l/@aigne/anthropic)](https://github.com/AIGNE-io/aigne-framework/blob/main/LICENSE.md)
+
+[English](README.md) | **中文**
+
+AIGNE Anthropic SDK，用于在 [AIGNE 框架](https://github.com/AIGNE-io/aigne-framework) 中集成 Anthropic 的 Claude AI 模型。
+
+## 简介
+
+`@aigne/anthropic` 提供了 AIGNE 框架与 Anthropic 的 Claude 语言模型和 API 之间的无缝集成。该包使开发者能够在 AIGNE 应用程序中轻松利用 Anthropic 的 Claude 模型，同时提供框架内一致的接口，充分发挥 Claude 先进的 AI 能力。
+
+## 特性
+
+* **Anthropic API 集成**：使用官方 SDK 直接连接到 Anthropic 的 API 服务
+* **聊天完成**：支持 Claude 的聊天完成 API 和所有可用模型
+* **工具调用**：内置支持 Claude 的工具调用功能
+* **流式响应**：支持流式响应，提供更高响应性的应用程序体验
+* **类型安全**：为所有 API 和模型提供全面的 TypeScript 类型定义
+* **一致接口**：兼容 AIGNE 框架的模型接口
+* **错误处理**：健壮的错误处理和重试机制
+* **完整配置**：丰富的配置选项用于微调行为
+
+## 安装
+
+### 使用 npm
+
+```bash
+npm install @aigne/anthropic @aigne/core
+```
+
+### 使用 yarn
+
+```bash
+yarn add @aigne/anthropic @aigne/core
+```
+
+### 使用 pnpm
+
+```bash
+pnpm add @aigne/anthropic @aigne/core
+```
+
+## 基本用法
+
+```typescript file="test/anthropic-chat-model.test.ts" region="example-anthropic-chat-model"
+import { AnthropicChatModel } from "@aigne/anthropic";
+
+const model = new AnthropicChatModel({
+  // Provide API key directly or use environment variable ANTHROPIC_API_KEY or CLAUDE_API_KEY
+  apiKey: "your-api-key", // Optional if set in env variables
+  // Specify Claude model version (defaults to 'claude-3-7-sonnet-latest')
+  model: "claude-3-haiku-20240307",
+  // Configure model behavior
+  modelOptions: {
+    temperature: 0.7,
+  },
+});
+
+const result = await model.invoke({
+  messages: [{ role: "user", content: "Tell me about yourself" }],
+});
+
+console.log(result);
+/* Output:
+  {
+    text: "I'm Claude, an AI assistant created by Anthropic. How can I help you today?",
+    model: "claude-3-haiku-20240307",
+    usage: {
+      inputTokens: 8,
+      outputTokens: 15
+    }
+  }
+  */
+```
+
+## 流式响应
+
+```typescript file="test/anthropic-chat-model.test.ts" region="example-anthropic-chat-model-streaming-async-generator"
+import { AnthropicChatModel } from "@aigne/anthropic";
+
+const model = new AnthropicChatModel({
+  apiKey: "your-api-key",
+  model: "claude-3-haiku-20240307",
+});
+
+const stream = await model.invoke(
+  {
+    messages: [{ role: "user", content: "Tell me about yourself" }],
+  },
+  undefined,
+  { streaming: true },
+);
+
+let fullText = "";
+const json = {};
+
+for await (const chunk of stream) {
+  const text = chunk.delta.text?.text;
+  if (text) fullText += text;
+  if (chunk.delta.json) Object.assign(json, chunk.delta.json);
+}
+
+console.log(fullText); // Output: "I'm Claude, an AI assistant created by Anthropic. How can I help you today?"
+console.log(json); // { model: "claude-3-haiku-20240307", usage: { inputTokens: 8, outputTokens: 15 } }
+```
+
+## 许可证
+
+Elastic-2.0

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

@@ -0,0 +1,113 @@
+import { type AgentProcessResult, ChatModel, type ChatModelInput, type ChatModelOptions, type ChatModelOutput } from "@aigne/core";
+import { type PromiseOrValue } from "@aigne/core/utils/type-utils.js";
+import Anthropic from "@anthropic-ai/sdk";
+import { z } from "zod";
+/**
+ * Configuration options for Claude Chat Model
+ */
+export interface AnthropicChatModelOptions {
+    /**
+     * API key for Anthropic's Claude API
+     *
+     * If not provided, will look for ANTHROPIC_API_KEY or CLAUDE_API_KEY in environment variables
+     */
+    apiKey?: string;
+    /**
+     * Claude model to use
+     *
+     * Defaults to 'claude-3-7-sonnet-latest'
+     */
+    model?: string;
+    /**
+     * Additional model options to control behavior
+     */
+    modelOptions?: ChatModelOptions;
+}
+/**
+ * @hidden
+ */
+export declare const claudeChatModelOptionsSchema: z.ZodObject<{
+    apiKey: z.ZodOptional<z.ZodString>;
+    model: z.ZodOptional<z.ZodString>;
+    modelOptions: z.ZodOptional<z.ZodObject<{
+        model: z.ZodOptional<z.ZodString>;
+        temperature: z.ZodOptional<z.ZodNumber>;
+        topP: z.ZodOptional<z.ZodNumber>;
+        frequencyPenalty: z.ZodOptional<z.ZodNumber>;
+        presencePenalty: z.ZodOptional<z.ZodNumber>;
+        parallelToolCalls: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        parallelToolCalls: boolean;
+        model?: string | undefined;
+        temperature?: number | undefined;
+        topP?: number | undefined;
+        frequencyPenalty?: number | undefined;
+        presencePenalty?: number | undefined;
+    }, {
+        model?: string | undefined;
+        temperature?: number | undefined;
+        topP?: number | undefined;
+        frequencyPenalty?: number | undefined;
+        presencePenalty?: number | undefined;
+        parallelToolCalls?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    apiKey?: string | undefined;
+    model?: string | undefined;
+    modelOptions?: {
+        parallelToolCalls: boolean;
+        model?: string | undefined;
+        temperature?: number | undefined;
+        topP?: number | undefined;
+        frequencyPenalty?: number | undefined;
+        presencePenalty?: number | undefined;
+    } | undefined;
+}, {
+    apiKey?: string | undefined;
+    model?: string | undefined;
+    modelOptions?: {
+        model?: string | undefined;
+        temperature?: number | undefined;
+        topP?: number | undefined;
+        frequencyPenalty?: number | undefined;
+        presencePenalty?: number | undefined;
+        parallelToolCalls?: boolean | undefined;
+    } | undefined;
+}>;
+/**
+ * Implementation of the ChatModel interface for Anthropic's Claude API
+ *
+ * This model provides access to Claude's capabilities including:
+ * - Text generation
+ * - Tool use
+ * - JSON structured output
+ *
+ * Default model: 'claude-3-7-sonnet-latest'
+ *
+ * @example
+ * Here's how to create and use a Claude chat model:
+ * {@includeCode ../test/anthropic-chat-model.test.ts#example-anthropic-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../test/anthropic-chat-model.test.ts#example-anthropic-chat-model-streaming-async-generator}
+ */
+export declare class AnthropicChatModel extends ChatModel {
+    options?: AnthropicChatModelOptions | undefined;
+    constructor(options?: AnthropicChatModelOptions | undefined);
+    /**
+     * @hidden
+     */
+    protected _client?: Anthropic;
+    get client(): Anthropic;
+    get modelOptions(): ChatModelOptions | undefined;
+    /**
+     * Process the input using Claude's chat model
+     * @param input - The input to process
+     * @returns The processed output from the model
+     */
+    process(input: ChatModelInput): PromiseOrValue<AgentProcessResult<ChatModelOutput>>;
+    private _process;
+    private extractResultFromAnthropicStream;
+    private requestStructuredOutput;
+}