From d94b33de0d2a27227ced0846cd221197b0823071 Mon Sep 17 00:00:00 2001 From: bracesproul Date: Tue, 30 Jul 2024 18:11:51 -0700 Subject: [PATCH] scripts[patch]: Nits to chat integration template --- libs/langchain-scripts/src/cli/docs/chat.ts | 2 +- .../src/cli/docs/templates/chat.ipynb | 14 ++++---------- 2 files changed, 5 insertions(+), 11 deletions(-) diff --git a/libs/langchain-scripts/src/cli/docs/chat.ts b/libs/langchain-scripts/src/cli/docs/chat.ts index c0760bb32c54..ae739bddf0ae 100644 --- a/libs/langchain-scripts/src/cli/docs/chat.ts +++ b/libs/langchain-scripts/src/cli/docs/chat.ts @@ -202,7 +202,7 @@ export async function fillChatIntegrationDocTemplate(fields: { .replace(TOKEN_USAGE_PLACEHOLDER, extraFields?.tokenUsage ? "✅" : "❌") .replace(LOGPROBS_PLACEHOLDER, extraFields?.logprobs ? "✅" : "❌") .replace(LOCAL_PLACEHOLDER, extraFields?.local ? "✅" : "❌") - .replace(SERIALIZABLE_PLACEHOLDER, extraFields?.serializable ? "✅" : "❌") + .replace(SERIALIZABLE_PLACEHOLDER, extraFields?.serializable ? "✅" : "beta") .replace(PY_SUPPORT_PLACEHOLDER, extraFields?.pySupport ? "✅" : "❌"); const docPath = path.join( diff --git a/libs/langchain-scripts/src/cli/docs/templates/chat.ipynb b/libs/langchain-scripts/src/cli/docs/templates/chat.ipynb index 8aaca9a8d14c..623cd04832e2 100644 --- a/libs/langchain-scripts/src/cli/docs/templates/chat.ipynb +++ b/libs/langchain-scripts/src/cli/docs/templates/chat.ipynb @@ -17,18 +17,12 @@ "source": [ "# __ModuleName__\n", "\n", - "- TODO: Make sure API reference link is correct.\n", - "\n", - "This will help you getting started with __ModuleName__ [chat models](/docs/concepts/#chat-models). For detailed documentation of all __ModuleName__ features and configurations head to the [API reference](https://api.js.langchain.com/classes/__package_name_snake_case__.__ModuleName__.html).\n", - "\n", - "- TODO: Add any other relevant links, like information about models, prices, context windows, etc. See https://js.langchain.com/v0.2/docs/integrations/chat/openai/ for an example.\n", + "This will help you getting started with `__ModuleName__` [chat models](/docs/concepts/#chat-models). For detailed documentation of all `__ModuleName__` features and configurations head to the [API reference](https://api.js.langchain.com/classes/__package_name_snake_case__.__ModuleName__.html).\n", "\n", "## Overview\n", "### Integration details\n", "\n", - "- TODO: Fill in table features.\n", - "- TODO: Remove PY support link if not relevant, otherwise ensure link is correct.\n", - "- TODO: Make sure API reference links are correct.\n", + "- TODO: Make sure Python integration doc link is correct, if applicable.\n", "\n", "| Class | Package | Local | Serializable | [PY support](https:/py.langchain.com/v0.2/docs/integrations/chat/__package_name_short_snake_case__) | Package downloads | Package latest |\n", "| :--- | :--- | :---: | :---: | :---: | :---: | :---: |\n", @@ -43,13 +37,13 @@ "\n", "- TODO: Update with relevant info.\n", "\n", - "To access __ModuleName__ models you'll need to create a/an __ModuleName__ account, get an API key, and install the `__package_name_pretty__` integration package.\n", + "To access `__ModuleName__` models you'll need to create a/an `__ModuleName__` account, get an API key, and install the `__package_name_pretty__` integration package.\n", "\n", "### Credentials\n", "\n", "- TODO: Update with relevant info.\n", "\n", - "Head to (TODO: link) to sign up to __ModuleName__ and generate an API key. Once you've done this set the __MODULE_NAME_ALL_CAPS___API_KEY environment variable:\n", + "Head to (TODO: link) to sign up to `__ModuleName__` and generate an API key. Once you've done this set the `__MODULE_NAME_ALL_CAPS___API_KEY` environment variable:\n", "\n", "```{=mdx}\n", "\n",