all[minor]: Unified model params

[bracesproul]

What changed:

Based on this notion page

High level

• Refactored all instances of the following inside docs, where applicable:
  • modelName -> model
  • openAIApiKey/azureOpenAIApiKey/(along with a few other smaller providers) -> apiKey

Code changes

In order to keep backwards compatibility, all modules still have modelName/the API key as a class property, since they're all public properties and removing would be breaking.

For example, if a class used modelName, it now would have an additional argument model and the modelName JSDoc is updated to say Alias for "model". Inside the constructor, we now prioritize fields?.model > fields?.modelName > this.model (if there is a default)

The above is then set to the modelName class property, and modelName is then assigned to model. The same logic applies to apiKey updates.

Here is an example of what it looks like in practice:

Class args:

export declare interface OpenAIBaseInput {
  /**
   * Model name to use
   * Alias for `model`
   */
  modelName: string;
  /** Model name to use */
  model: string;
}

Class constructor:

constructor(
  fields?: Partial<OpenAIChatInput> & ... other interfaces
) {
  super(fields ?? {});

  ...other

  this.modelName = fields?.model ?? fields?.modelName ?? this.model;
  this.model = this.modelName;
}

This way, users can still pass in & access modelName, however inside the class this.modelName is never used, and instead only this.model is.

---

Search keywords: docs updates: cookbook[patch] core_docs[patch] examples[patch] alises/code updates: langchain[minor] anthropic[minor] azure-openai[minor] cloudflare[minor] community[minor] google-common[minor] google-genai[minor] groq[minor] mistralai[minor] nomic[minor] openai[minor]

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
langchainjs-api-refs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 9, 2024 6:40pm
langchainjs-docs	✅ Ready (Inspect)	Visit Preview		Apr 9, 2024 6:40pm