api_refs[minor]: Improve DX

docs/api_refs/package.json

@@ -30,6 +30,7 @@
     "prettier": "^2.8.3",
     "tailwindcss": "^3.3.0",
     "typedoc": "^0.26.0",
+    "typedoc-plugin-expand-object-like-types": "^0.1.2",
     "typescript": "~5.1.6"
   }
 }

docs/api_refs/scripts/create-entrypoints.js

@@ -11,12 +11,15 @@ const BASE_TYPEDOC_CONFIG = {
     "required-first",
     "alphabetical",
   ],
-  plugin: ["./typedoc_plugins/hide_underscore_lc.js"],
+  plugin: [
+    "./typedoc_plugins/hide_underscore_lc.js",
+    "typedoc-plugin-expand-object-like-types",
+  ],
   tsconfig: "../../tsconfig.json",
   readme: "none",
   excludePrivate: true,
   excludeInternal: true,
-  excludeExternals: true,
+  excludeExternals: false, // trying this
   excludeNotDocumented: false,
   includeVersion: true,
   sourceLinkTemplate:

langchain-core/src/language_models/chat_models.ts

@@ -294,6 +294,7 @@ export abstract class BaseChatModel<
     }
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     return {
       ls_model_type: "chat",

libs/langchain-anthropic/src/chat_models.ts

@@ -293,6 +293,7 @@ export class ChatAnthropicMessages<
     this.streamUsage = fields?.streamUsage ?? this.streamUsage;
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-aws/src/chat_models.ts

@@ -266,6 +266,7 @@ export class ChatBedrockConverse
     this.guardrailConfig = rest?.guardrailConfig;
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-cloudflare/src/chat_models.ts

@@ -82,6 +82,7 @@ export class ChatCloudflareWorkersAI
     }
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     return {
       ls_provider: "cloudflare",

libs/langchain-cohere/src/chat_models.ts

@@ -321,6 +321,7 @@ export class ChatCohere<
     this.streamUsage = fields?.streamUsage ?? this.streamUsage;
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-community/src/chat_models/bedrock/web.ts

@@ -392,6 +392,7 @@ export class BedrockChat
     };
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

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

@@ -104,6 +104,7 @@ export class ChatFireworks extends ChatOpenAI<ChatFireworksCallOptions> {
     this.apiKey = fireworksApiKey;
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = super.getLsParams(options);
     params.ls_provider = "fireworks";

libs/langchain-community/src/chat_models/ollama.ts

@@ -185,6 +185,7 @@ export class ChatOllama
     this.format = fields.format;
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-community/src/chat_models/togetherai.ts

@@ -116,6 +116,7 @@ export class ChatTogetherAI extends ChatOpenAI<ChatTogetherAICallOptions> {
     });
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = super.getLsParams(options);
     params.ls_provider = "together";

libs/langchain-google-common/src/chat_models.ts

@@ -231,6 +231,7 @@ export abstract class ChatGoogleBase<AuthOptions>
     this.buildConnection(fields ?? {}, client);
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-google-genai/src/chat_models.ts

@@ -331,6 +331,7 @@ export class ChatGoogleGenerativeAI
     this.streamUsage = fields?.streamUsage ?? this.streamUsage;
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     return {
       ls_provider: "google_genai",

libs/langchain-groq/src/chat_models.ts

@@ -372,6 +372,7 @@ export class ChatGroq extends BaseChatModel<
     this.maxTokens = fields?.maxTokens;
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-mistralai/src/chat_models.ts

@@ -477,6 +477,7 @@ export class ChatMistralAI<
     this.streamUsage = fields?.streamUsage ?? this.streamUsage;
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-ollama/src/chat_models.ts

@@ -300,6 +300,7 @@ export class ChatOllama
     });
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-openai/src/chat_models.ts

@@ -398,6 +398,17 @@ export interface ChatOpenAIFields
  * console.log(message);
  *
  * ```
+ * @extends {BaseChatModel<CallOptions, AIMessageChunk>}
+ *
+ * @param {ChatOpenAICallOptions} callOptions - The call options for the ChatOpenAI instance
+ * @param {ChatOpenAIToolType[]} [callOptions.tools] - The tools to use with the model
+ * @param {OpenAIToolChoice} [callOptions.tool_choice] - The tool choice configuration
+ * @param {number} [callOptions.promptIndex] - The index of the prompt to use
+ * @param {{ type: "json_object" }} [callOptions.response_format] - The format of the response
+ * @param {number} [callOptions.seed] - The seed for random number generation
+ * @param {{ include_usage: boolean }} [callOptions.stream_options] - Options for streamed completions
+ * @param {boolean} [callOptions.parallel_tool_calls] - Whether to allow parallel tool calls
+ * @param {boolean} [callOptions.strict] - Whether to use strict mode for JSON schema validation
  */
 export class ChatOpenAI<
     CallOptions extends ChatOpenAICallOptions = ChatOpenAICallOptions
@@ -616,6 +627,7 @@ export class ChatOpenAI<
     }
   }
 
+  /** @ignore */
   getLsParams(options: this["ParsedCallOptions"]): LangSmithParams {
     const params = this.invocationParams(options);
     return {

libs/langchain-openai/src/types.ts

@@ -103,6 +103,11 @@ export type OpenAICoreRequestOptions<
   idempotencyKey?: string;
 };
 
+/**
+ * @typedef {Object} OpenAICallOptions
+ * @extends BaseLanguageModelCallOptions
+ * @property {OpenAICoreRequestOptions} [options] - Additional options to pass to the underlying axios request.
+ */
 export interface OpenAICallOptions extends BaseLanguageModelCallOptions {
   /**
    * Additional options to pass to the underlying axios request.

yarn.lock

@@ -20250,6 +20250,7 @@ __metadata:
     react-dom: ^18
     tailwindcss: ^3.3.0
     typedoc: ^0.26.0
+    typedoc-plugin-expand-object-like-types: ^0.1.2
     typescript: ~5.1.6
   languageName: unknown
   linkType: soft
@@ -39863,6 +39864,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"typedoc-plugin-expand-object-like-types@npm:^0.1.2":
+  version: 0.1.2
+  resolution: "typedoc-plugin-expand-object-like-types@npm:0.1.2"
+  peerDependencies:
+    typedoc: 0.22.x || 0.23.x
+  checksum: 9dd58ce283386709c821f7a30267edddff984cac69fc8dc994185378403d586ac53a58b790b553693a572ea5d417e5a9bb90c02d4e73dbf595ec5a3156b5252e
+  languageName: node
+  linkType: hard
+
 "typedoc-plugin-markdown@npm:4.0.0-next.6":
   version: 4.0.0-next.6
   resolution: "typedoc-plugin-markdown@npm:4.0.0-next.6"