From 67b0b852d28eec1bccc4c8dfb2513138ec39dbc4 Mon Sep 17 00:00:00 2001
From: bracesproul <braceasproul@gmail.com>
Date: Wed, 7 Aug 2024 17:04:29 -0700
Subject: [PATCH 1/2] api_refs[minor]: Hide all properties and non whitelisted
 methods of chat models

---
 .../typedoc_plugins/hide_underscore_lc.js     | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/docs/api_refs/typedoc_plugins/hide_underscore_lc.js b/docs/api_refs/typedoc_plugins/hide_underscore_lc.js
index 16919b9e7695..e89561f1ff66 100644
--- a/docs/api_refs/typedoc_plugins/hide_underscore_lc.js
+++ b/docs/api_refs/typedoc_plugins/hide_underscore_lc.js
@@ -9,6 +9,28 @@ const {
 const fs = require("fs");
 const path = require("path");
 
+const WHITELISTED_CHAT_MODEL_INHERITED_METHODS = [
+  "invoke",
+  "stream",
+  "batch",
+  "streamLog",
+  "streamEvents",
+  "bind",
+  "bindTools",
+  "asTool",
+  "pipe",
+  "withConfig",
+  "withRetry",
+  "assign",
+  "getNumTokens",
+  "getGraph",
+  "pick",
+  "withFallbacks",
+  "withStructuredOutput",
+  "withListeners",
+  "transform",
+];
+
 const PATH_TO_LANGCHAIN_PKG_JSON = "../../langchain/package.json";
 const BASE_OUTPUT_DIR = "./public";
 const SCRIPT_HTML = `<script>
@@ -113,6 +135,40 @@ function load(application) {
    */
   function resolveReflection(_context, reflection) {
     const reflectionKind = reflection.kind;
+
+    if (
+      reflectionKind === ReflectionKind.Method &&
+      reflection?.parent &&
+      reflection.parent.kind === ReflectionKind.Class &&
+      reflection.parent.name.includes("Chat")
+    ) {
+      if (
+        !WHITELISTED_CHAT_MODEL_INHERITED_METHODS.find(
+          (n) => n === reflection.name
+        )
+      ) {
+        reflectionsToHide.push(reflection);
+      }
+    }
+
+    if (
+      reflectionKind === ReflectionKind.Property &&
+      reflection?.parent &&
+      reflection.parent.kind === ReflectionKind.Class &&
+      reflection.parent.name.includes("Chat")
+    ) {
+      // Hide all properties of chat models
+      reflectionsToHide.push(reflection);
+    }
+
+    if (
+      reflectionKind === ReflectionKind.Accessor &&
+      reflection.name === "callKeys"
+    ) {
+      // Hide all `callKeys` accessors
+      reflectionsToHide.push(reflection);
+    }
+
     if (reflectionKindsToHide.includes(reflectionKind)) {
       if (
         reflection.name.startsWith("_") ||

From be012a4d89d528037b2ad85e8d19ed2dbf09e255 Mon Sep 17 00:00:00 2001
From: bracesproul <braceasproul@gmail.com>
Date: Wed, 7 Aug 2024 17:15:58 -0700
Subject: [PATCH 2/2] refactor

---
 .../typedoc_plugins/hide_underscore_lc.js     | 107 +++++++++++++-----
 1 file changed, 77 insertions(+), 30 deletions(-)

diff --git a/docs/api_refs/typedoc_plugins/hide_underscore_lc.js b/docs/api_refs/typedoc_plugins/hide_underscore_lc.js
index e89561f1ff66..b53d191ce2c6 100644
--- a/docs/api_refs/typedoc_plugins/hide_underscore_lc.js
+++ b/docs/api_refs/typedoc_plugins/hide_underscore_lc.js
@@ -49,6 +49,82 @@ const VERSION_DROPDOWN_HTML = `<div class="version-select">
 </select>
 </div>`;
 
+/**
+ * Checks if the reflection is a property of a chat model class,
+ * and returns true (to hide the reflection) if it is.
+ *
+ * @param {DeclarationReflection} reflection
+ * @returns {boolean} Whether or not to hide the reflection
+ */
+function hideChatModelProperties(reflection) {
+  if (
+    reflection.kind === ReflectionKind.Property &&
+    reflection?.parent &&
+    reflection.parent.kind === ReflectionKind.Class &&
+    reflection.parent.name.includes("Chat")
+  ) {
+    return true;
+  }
+  return false;
+}
+
+/**
+ * Checks if the reflection is a method on a chat model class,
+ * and returns true (to hide the reflection) if it is.
+ *
+ * @param {DeclarationReflection} reflection
+ * @returns {boolean} Whether or not to hide the reflection
+ */
+function hideChatModelMethods(reflection) {
+  if (
+    reflection.kind === ReflectionKind.Method &&
+    reflection?.parent &&
+    reflection.parent.kind === ReflectionKind.Class &&
+    reflection.parent.name.includes("Chat")
+  ) {
+    if (
+      !WHITELISTED_CHAT_MODEL_INHERITED_METHODS.find(
+        (n) => n === reflection.name
+      )
+    ) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Checks if the reflection is an accessor and is named `callKeys`,
+ * and returns true (to hide the reflection) if it is.
+ *
+ * @param {DeclarationReflection} reflection
+ * @returns {boolean} Whether or not to hide the reflection
+ */
+function hideChatModelAccessors(reflection) {
+  if (
+    reflection.kind === ReflectionKind.Accessor &&
+    reflection.name === "callKeys"
+  ) {
+    return true;
+  }
+  return false;
+}
+
+/**
+ * Check if the reflection should be hidden. If it should, it
+ * returns true.
+ *
+ * @param {DeclarationReflection} reflection
+ * @returns {boolean} Whether or not to hide the reflection
+ */
+function hideChatModelReflection(reflection) {
+  return (
+    hideChatModelProperties(reflection) ||
+    hideChatModelMethods(reflection) ||
+    hideChatModelAccessors(reflection)
+  );
+}
+
 /**
  * @param {string | undefined} deprecationText
  * @returns {string}
@@ -136,36 +212,7 @@ function load(application) {
   function resolveReflection(_context, reflection) {
     const reflectionKind = reflection.kind;
 
-    if (
-      reflectionKind === ReflectionKind.Method &&
-      reflection?.parent &&
-      reflection.parent.kind === ReflectionKind.Class &&
-      reflection.parent.name.includes("Chat")
-    ) {
-      if (
-        !WHITELISTED_CHAT_MODEL_INHERITED_METHODS.find(
-          (n) => n === reflection.name
-        )
-      ) {
-        reflectionsToHide.push(reflection);
-      }
-    }
-
-    if (
-      reflectionKind === ReflectionKind.Property &&
-      reflection?.parent &&
-      reflection.parent.kind === ReflectionKind.Class &&
-      reflection.parent.name.includes("Chat")
-    ) {
-      // Hide all properties of chat models
-      reflectionsToHide.push(reflection);
-    }
-
-    if (
-      reflectionKind === ReflectionKind.Accessor &&
-      reflection.name === "callKeys"
-    ) {
-      // Hide all `callKeys` accessors
+    if (hideChatModelReflection(reflection)) {
       reflectionsToHide.push(reflection);
     }