feat: add typed model IDs for chat and embedding models across providers

langchain/src/experimental/openai_assistant/index.ts

@@ -1,4 +1,8 @@
-import { type ClientOptions, OpenAIClient } from "@langchain/openai";
+import {
+  type ClientOptions,
+  type OpenAIChatModelId,
+  OpenAIClient,
+} from "@langchain/openai";
 import { StructuredTool } from "@langchain/core/tools";
 import { Runnable, RunnableConfig } from "@langchain/core/runnables";
 import { formatToOpenAIAssistantTool } from "@langchain/openai";
@@ -62,7 +66,7 @@ export class OpenAIAssistantRunnable<
     pollIntervalMs,
     fileIds,
   }: Omit<OpenAIAssistantRunnableInput<AsAgent>, "assistantId"> & {
-    model: string;
+    model: OpenAIChatModelId;
     name?: string;
     instructions?: string;
     tools?: OpenAIToolType | Array<StructuredTool>;
@@ -178,7 +182,7 @@ export class OpenAIAssistantRunnable<
     instructions,
     fileIds,
   }: Omit<OpenAIAssistantRunnableInput<AsAgent>, "assistantId" | "tools"> & {
-    model?: string;
+    model?: OpenAIChatModelId;
     name?: string;
     instructions?: string;
     fileIds?: string[];

libs/langchain-anthropic/src/chat_models.ts

@@ -116,6 +116,13 @@ function isBuiltinTool(tool: unknown): tool is AnthropicBuiltInToolUnion {
   );
 }
 
+/**
+ * @see https://docs.anthropic.com/claude/docs/models-overview
+ */
+export type AnthropicMessagesModelId =
+  | Anthropic.Model
+  | (string & NonNullable<unknown>);
+
 /**
  * Input to AnthropicChat class.
  */
@@ -170,9 +177,9 @@ export interface AnthropicInput {
   anthropicApiUrl?: string;
 
   /** @deprecated Use "model" instead */
-  modelName?: string;
+  modelName?: AnthropicMessagesModelId;
   /** Model name to use */
-  model?: string;
+  model?: AnthropicMessagesModelId;
 
   /** Overridable Anthropic ClientOptions */
   clientOptions?: ClientOptions;

libs/langchain-community/src/embeddings/fireworks.ts

@@ -11,6 +11,10 @@ export interface FireworksEmbeddingsParams extends EmbeddingsParams {
    * @deprecated Use `model` instead.
    */
   modelName: string;
+
+  /**
+   * Model name to use.
+   */
   model: string;
 
   /**

libs/langchain-openai/src/embeddings.ts

@@ -6,6 +6,13 @@ import { OpenAICoreRequestOptions } from "./types.js";
 import { getEndpoint, OpenAIEndpointConfig } from "./utils/azure.js";
 import { wrapOpenAIClientError } from "./utils/openai.js";
 
+/**
+ * @see https://platform.openai.com/docs/guides/embeddings#embedding-models
+ */
+export type OpenAIEmbeddingModelId =
+  | OpenAIClient.EmbeddingModel
+  | (string & NonNullable<unknown>);
+
 /**
  * Interface for OpenAIEmbeddings parameters. Extends EmbeddingsParams and
  * defines additional parameters specific to the OpenAIEmbeddings class.
@@ -16,9 +23,9 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
    * Alias for `model`
    * @deprecated Use "model" instead.
    */
-  modelName: string;
+  modelName: OpenAIEmbeddingModelId;
   /** Model name to use */
-  model: string;
+  model: OpenAIEmbeddingModelId;
 
   /**
    * The number of dimensions the resulting output embeddings should have.

libs/langchain-openai/src/tools/dalle.ts

@@ -7,6 +7,13 @@ import {
   MessageContentImageUrl,
 } from "@langchain/core/messages";
 
+/**
+ * @see https://platform.openai.com/docs/api-reference/images/create
+ */
+export type OpenAIImageModelId =
+  | OpenAIClient.ImageModel
+  | (string & NonNullable<unknown>);
+
 /**
  * An interface for the Dall-E API Wrapper.
  */
@@ -25,14 +32,15 @@ export interface DallEAPIWrapperParams extends ToolParams {
    * Alias for `model`
    * @params "dall-e-2" | "dall-e-3"
    * @default "dall-e-3"
+   * @deprecated Use `model` instead.
    */
-  modelName?: string;
+  modelName?: OpenAIImageModelId;
   /**
    * The model to use.
    * @params "dall-e-2" | "dall-e-3"
    * @default "dall-e-3"
    */
-  model?: string;
+  model?: OpenAIImageModelId;
   /**
    * The style of the generated images. Must be one of vivid or natural.
    * Vivid causes the model to lean towards generating hyper-real and dramatic images.

libs/langchain-openai/src/types.ts

@@ -13,6 +13,13 @@ import { InteropZodObject } from "@langchain/core/utils/types";
 // also makes it easier for folks to import this type without digging around into the dependent packages
 export type { TiktokenModel };
 
+/**
+ * @see https://platform.openai.com/docs/models
+ */
+export type OpenAIChatModelId =
+  | OpenAIClient.ChatModel
+  | (string & NonNullable<unknown>);
+
 export declare interface OpenAIBaseInput {
   /** Sampling temperature to use */
   temperature: number;
@@ -65,7 +72,7 @@ export declare interface OpenAIBaseInput {
   modelName: string;
 
   /** Model name to use */
-  model: string;
+  model: OpenAIChatModelId;
 
   /** Holds any additional parameters that are valid to pass to {@link
    * https://platform.openai.com/docs/api-reference/completions/create |