Skip to content

Commit

Permalink
scripts[patch]: Nits to chat integration template
Browse files Browse the repository at this point in the history
  • Loading branch information
bracesproul committed Jul 31, 2024
1 parent 39229f9 commit d94b33d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 11 deletions.
2 changes: 1 addition & 1 deletion libs/langchain-scripts/src/cli/docs/chat.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
14 changes: 4 additions & 10 deletions libs/langchain-scripts/src/cli/docs/templates/chat.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down

0 comments on commit d94b33d

Please sign in to comment.