@langchain/anthropic 0.1.12 → 0.1.13

package/README.md

@@ -52,7 +52,7 @@ Then initialize
 import { ChatAnthropicMessages } from "@langchain/anthropic";
 
 const model = new ChatAnthropic({
-  anthropicApiKey: process.env.ANTHROPIC_API_KEY,
+  apiKey: process.env.ANTHROPIC_API_KEY,
 });
 const response = await model.invoke(new HumanMessage("Hello world!"));
 ```
@@ -63,8 +63,8 @@ const response = await model.invoke(new HumanMessage("Hello world!"));
 import { ChatAnthropicMessages } from "@langchain/anthropic";
 
 const model = new ChatAnthropic({
-  anthropicApiKey: process.env.ANTHROPIC_API_KEY,
-  modelName: "claude-3-sonnet-20240229",
+  apiKey: process.env.ANTHROPIC_API_KEY,
+  model: "claude-3-sonnet-20240229",
 });
 const response = await model.stream(new HumanMessage("Hello world!"));
 ```

package/dist/chat_models.cjs

@@ -71,7 +71,7 @@ function isAnthropicTool(tool) {
  *
  * const model = new ChatAnthropic({
  *   temperature: 0.9,
- *   anthropicApiKey: 'YOUR-API-KEY',
+ *   apiKey: 'YOUR-API-KEY',
  * });
  * const res = await model.invoke({ input: 'Hello!' });
  * console.log(res);
@@ -84,6 +84,7 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
     get lc_secrets() {
         return {
             anthropicApiKey: "ANTHROPIC_API_KEY",
+            apiKey: "ANTHROPIC_API_KEY",
         };
     }
     get lc_aliases() {
@@ -105,6 +106,12 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "apiUrl", {
             enumerable: true,
             configurable: true,
@@ -141,6 +148,12 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
             writable: true,
             value: "claude-2.1"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "claude-2.1"
+        });
         Object.defineProperty(this, "invocationKwargs", {
             enumerable: true,
             configurable: true,
@@ -180,13 +193,19 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
             value: void 0
         });
         this.anthropicApiKey =
-            fields?.anthropicApiKey ?? (0, env_1.getEnvironmentVariable)("ANTHROPIC_API_KEY");
+            fields?.apiKey ??
+                fields?.anthropicApiKey ??
+                (0, env_1.getEnvironmentVariable)("ANTHROPIC_API_KEY");
         if (!this.anthropicApiKey) {
             throw new Error("Anthropic API key not found");
         }
+        /** Keep anthropicApiKey for backwards compatibility */
+        this.apiKey = this.anthropicApiKey;
         // Support overriding the default API URL (i.e., https://api.anthropic.com)
         this.apiUrl = fields?.anthropicApiUrl;
-        this.modelName = fields?.modelName ?? this.modelName;
+        /** Keep modelName for backwards compatibility */
+        this.modelName = fields?.model ?? fields?.modelName ?? this.model;
+        this.model = this.modelName;
         this.invocationKwargs = fields?.invocationKwargs ?? {};
         this.temperature = fields?.temperature ?? this.temperature;
         this.topK = fields?.topK ?? this.topK;
@@ -228,7 +247,7 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
      */
     invocationParams(options) {
         return {
-            model: this.modelName,
+            model: this.model,
             temperature: this.temperature,
             top_k: this.topK,
             top_p: this.topP,
@@ -262,7 +281,7 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
     /** @ignore */
     _identifyingParams() {
         return {
-            model_name: this.modelName,
+            model_name: this.model,
             ...this.invocationParams(),
         };
     }
@@ -271,7 +290,7 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
      */
     identifyingParams() {
         return {
-            model_name: this.modelName,
+            model_name: this.model,
             ...this.invocationParams(),
         };
     }
@@ -508,7 +527,7 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
             this.streamingClient = new sdk_1.Anthropic({
                 ...this.clientOptions,
                 ...options_,
-                apiKey: this.anthropicApiKey,
+                apiKey: this.apiKey,
                 // Prefer LangChain built-in retries
                 maxRetries: 0,
             });
@@ -522,7 +541,7 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
     }
     /** @ignore */
     async completionWithRetry(request, options) {
-        if (!this.anthropicApiKey) {
+        if (!this.apiKey) {
             throw new Error("Missing Anthropic API key.");
         }
         if (!this.batchClient) {
@@ -530,7 +549,7 @@ class ChatAnthropicMessages extends chat_models_1.BaseChatModel {
             this.batchClient = new sdk_1.Anthropic({
                 ...this.clientOptions,
                 ...options,
-                apiKey: this.anthropicApiKey,
+                apiKey: this.apiKey,
                 maxRetries: 0,
             });
         }

package/dist/chat_models.d.ts

@@ -64,10 +64,14 @@ export interface AnthropicInput {
     streaming?: boolean;
     /** Anthropic API key */
     anthropicApiKey?: string;
+    /** Anthropic API key */
+    apiKey?: string;
     /** Anthropic API URL */
     anthropicApiUrl?: string;
     /** Model name to use */
     modelName: string;
+    /** Model name to use */
+    model: string;
     /** Overridable Anthropic ClientOptions */
     clientOptions: ClientOptions;
     /** Holds any additional parameters that are valid to pass to {@link
@@ -98,7 +102,7 @@ type Kwargs = Record<string, any>;
  *
  * const model = new ChatAnthropic({
  *   temperature: 0.9,
- *   anthropicApiKey: 'YOUR-API-KEY',
+ *   apiKey: 'YOUR-API-KEY',
  * });
  * const res = await model.invoke({ input: 'Hello!' });
  * console.log(res);
@@ -112,12 +116,14 @@ export declare class ChatAnthropicMessages<CallOptions extends ChatAnthropicCall
     get lc_aliases(): Record<string, string>;
     lc_serializable: boolean;
     anthropicApiKey?: string;
+    apiKey?: string;
     apiUrl?: string;
     temperature: number;
     topK: number;
     topP: number;
     maxTokens: number;
     modelName: string;
+    model: string;
     invocationKwargs?: Kwargs;
     stopSequences?: string[];
     streaming: boolean;

package/dist/chat_models.js

@@ -68,7 +68,7 @@ function isAnthropicTool(tool) {
  *
  * const model = new ChatAnthropic({
  *   temperature: 0.9,
- *   anthropicApiKey: 'YOUR-API-KEY',
+ *   apiKey: 'YOUR-API-KEY',
  * });
  * const res = await model.invoke({ input: 'Hello!' });
  * console.log(res);
@@ -81,6 +81,7 @@ export class ChatAnthropicMessages extends BaseChatModel {
     get lc_secrets() {
         return {
             anthropicApiKey: "ANTHROPIC_API_KEY",
+            apiKey: "ANTHROPIC_API_KEY",
         };
     }
     get lc_aliases() {
@@ -102,6 +103,12 @@ export class ChatAnthropicMessages extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "apiUrl", {
             enumerable: true,
             configurable: true,
@@ -138,6 +145,12 @@ export class ChatAnthropicMessages extends BaseChatModel {
             writable: true,
             value: "claude-2.1"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "claude-2.1"
+        });
         Object.defineProperty(this, "invocationKwargs", {
             enumerable: true,
             configurable: true,
@@ -177,13 +190,19 @@ export class ChatAnthropicMessages extends BaseChatModel {
             value: void 0
         });
         this.anthropicApiKey =
-            fields?.anthropicApiKey ?? getEnvironmentVariable("ANTHROPIC_API_KEY");
+            fields?.apiKey ??
+                fields?.anthropicApiKey ??
+                getEnvironmentVariable("ANTHROPIC_API_KEY");
         if (!this.anthropicApiKey) {
             throw new Error("Anthropic API key not found");
         }
+        /** Keep anthropicApiKey for backwards compatibility */
+        this.apiKey = this.anthropicApiKey;
         // Support overriding the default API URL (i.e., https://api.anthropic.com)
         this.apiUrl = fields?.anthropicApiUrl;
-        this.modelName = fields?.modelName ?? this.modelName;
+        /** Keep modelName for backwards compatibility */
+        this.modelName = fields?.model ?? fields?.modelName ?? this.model;
+        this.model = this.modelName;
         this.invocationKwargs = fields?.invocationKwargs ?? {};
         this.temperature = fields?.temperature ?? this.temperature;
         this.topK = fields?.topK ?? this.topK;
@@ -225,7 +244,7 @@ export class ChatAnthropicMessages extends BaseChatModel {
      */
     invocationParams(options) {
         return {
-            model: this.modelName,
+            model: this.model,
             temperature: this.temperature,
             top_k: this.topK,
             top_p: this.topP,
@@ -259,7 +278,7 @@ export class ChatAnthropicMessages extends BaseChatModel {
     /** @ignore */
     _identifyingParams() {
         return {
-            model_name: this.modelName,
+            model_name: this.model,
             ...this.invocationParams(),
         };
     }
@@ -268,7 +287,7 @@ export class ChatAnthropicMessages extends BaseChatModel {
      */
     identifyingParams() {
         return {
-            model_name: this.modelName,
+            model_name: this.model,
             ...this.invocationParams(),
         };
     }
@@ -505,7 +524,7 @@ export class ChatAnthropicMessages extends BaseChatModel {
             this.streamingClient = new Anthropic({
                 ...this.clientOptions,
                 ...options_,
-                apiKey: this.anthropicApiKey,
+                apiKey: this.apiKey,
                 // Prefer LangChain built-in retries
                 maxRetries: 0,
             });
@@ -519,7 +538,7 @@ export class ChatAnthropicMessages extends BaseChatModel {
     }
     /** @ignore */
     async completionWithRetry(request, options) {
-        if (!this.anthropicApiKey) {
+        if (!this.apiKey) {
             throw new Error("Missing Anthropic API key.");
         }
         if (!this.batchClient) {
@@ -527,7 +546,7 @@ export class ChatAnthropicMessages extends BaseChatModel {
             this.batchClient = new Anthropic({
                 ...this.clientOptions,
                 ...options,
-                apiKey: this.anthropicApiKey,
+                apiKey: this.apiKey,
                 maxRetries: 0,
             });
         }

package/dist/tests/chat_models.int.test.js

@@ -244,7 +244,7 @@ test("Test ChatAnthropic headers passed through", async () => {
     const chat = new ChatAnthropic({
         modelName: "claude-3-sonnet-20240229",
         maxRetries: 0,
-        anthropicApiKey: "NOT_REAL",
+        apiKey: "NOT_REAL",
         clientOptions: {
             defaultHeaders: {
                 "X-Api-Key": process.env.ANTHROPIC_API_KEY,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/anthropic",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "Anthropic integrations for LangChain.js",
   "type": "module",
   "engines": {