-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generate api refs with typedoc #3152
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
.gitignore
Outdated
**/convex/tsconfig.json | ||
|
||
langchain/docs_dist/**/* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not just langchain/docs/dist
api-docs/.eslintrc.json
Outdated
@@ -0,0 +1,3 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest putting this within docs/
rather than adding a new workspace if possible
package.json
Outdated
@@ -8,7 +8,8 @@ | |||
"workspaces": [ | |||
"langchain", | |||
"examples", | |||
"docs" | |||
"docs", | |||
"api-docs" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would prefer not to have a new workspace if possible - can we move into docs
and add new commands there?
api-docs/README.md
Outdated
@@ -0,0 +1,11 @@ | |||
# Autogeneratd API documentation for LangChainJS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo
api-docs/generate_typedoc.sh
Outdated
BASE_DIR="../langchain" | ||
# Create a directory to temp hold the files in src | ||
# `docs_dist` is gitignored by default. | ||
mkdir -p "$BASE_DIR/docs_dist/src" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep dist file in workspace?
docs/package.json
Outdated
@@ -5,7 +5,8 @@ | |||
"scripts": { | |||
"docusaurus": "docusaurus", | |||
"start": "rimraf ./docs/api && NODE_OPTIONS=--max-old-space-size=7168 docusaurus start", | |||
"build": "rimraf ./build && NODE_OPTIONS=--max-old-space-size=7168 DOCUSAURUS_SSR_CONCURRENCY=4 docusaurus build", | |||
"build": "yarn gen:typedoc && rimraf ./build && NODE_OPTIONS=--max-old-space-size=7168 DOCUSAURUS_SSR_CONCURRENCY=4 docusaurus build", | |||
"gen:typedoc": "cd ../api-docs && yarn gen:typedoc", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah let's keep in same workspace if possible
@@ -29,12 +29,6 @@ const config = { | |||
onBrokenMarkdownLinks: "throw", | |||
|
|||
plugins: [ | |||
[ | |||
"docusaurus-plugin-typedoc", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can remove this as a dep and .yarn/patch
right?
langchain/package.json
Outdated
@@ -806,7 +806,8 @@ | |||
"build:esm": "NODE_OPTIONS=--max-old-space-size=4096 tsc --outDir dist/ && rimraf dist/tests dist/**/tests", | |||
"build:cjs": "NODE_OPTIONS=--max-old-space-size=4096 tsc --outDir dist-cjs/ -p tsconfig.cjs.json && node scripts/move-cjs-to-dist.js && rimraf dist-cjs", | |||
"build:watch": "node scripts/create-entrypoints.js && tsc --outDir dist/ --watch", | |||
"build:scripts": "node scripts/create-entrypoints.js && node scripts/check-tree-shaking.js && node scripts/generate-docs-llm-compatibility-table", | |||
"build:scripts": "node scripts/create-entrypoints.js && node scripts/check-tree-shaking.js && yarn conditional:api-docs && node scripts/generate-docs-llm-compatibility-table", | |||
"conditional:api-docs": "bash scripts/build-api-refs.sh", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think fine to leave out conditional:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't need this to run during the gh actions for exports (plus it causes those actions to fail) so the build command needs a way to skip that part only during those gh actions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good overall, high level I would really love to avoid making another workspace if possible
docs/api-docs/generate_typedoc.sh
Outdated
# Create a directory to temp hold the files in src | ||
# `docs_dist` is gitignored by default. | ||
mkdir -p "$BASE_DIR/docs_dist/src" | ||
mkdir -p "$BASE_DIR/docs/dist" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about /docs/api-docs/dist
to keep everything localized?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or actually sorry but how about docs/api_refs/
(we use snake case for directories elsewhere and docs/api_docs
feels redundant)
docs/package.json
Outdated
@@ -6,7 +6,7 @@ | |||
"docusaurus": "docusaurus", | |||
"start": "rimraf ./docs/api && NODE_OPTIONS=--max-old-space-size=7168 docusaurus start", | |||
"build": "yarn gen:typedoc && rimraf ./build && NODE_OPTIONS=--max-old-space-size=7168 DOCUSAURUS_SSR_CONCURRENCY=4 docusaurus build", | |||
"gen:typedoc": "cd ../api-docs && yarn gen:typedoc", | |||
"gen:typedoc": "cd ./api-docs && yarn gen:typedoc", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
build:typedoc
is a better name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small naming nits and then I think we're good to go!
And fix CI |
8290812
to
4ff2817
Compare
…to brace/api-refs-docs
[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [eslint](https://eslint.org) ([source](https://togithub.com/eslint/eslint)) | [`8.53.0` -> `8.54.0`](https://renovatebot.com/diffs/npm/eslint/8.53.0/8.54.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/eslint/8.54.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/eslint/8.54.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/eslint/8.53.0/8.54.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/eslint/8.53.0/8.54.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [langchain](https://togithub.com/langchain-ai/langchainjs) | [`^0.0.181` -> `^0.0.194`](https://renovatebot.com/diffs/npm/langchain/0.0.181/0.0.194) | [![age](https://developer.mend.io/api/mc/badges/age/npm/langchain/0.0.194?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/langchain/0.0.194?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/langchain/0.0.181/0.0.194?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/langchain/0.0.181/0.0.194?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [openai](https://togithub.com/openai/openai-node) | [`4.17.4` -> `4.19.0`](https://renovatebot.com/diffs/npm/openai/4.17.4/4.19.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/openai/4.19.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/openai/4.19.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/openai/4.17.4/4.19.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/openai/4.17.4/4.19.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>eslint/eslint (eslint)</summary> ### [`v8.54.0`](https://togithub.com/eslint/eslint/releases/tag/v8.54.0) [Compare Source](https://togithub.com/eslint/eslint/compare/v8.53.0...v8.54.0) #### Features - [`a7a883b`](https://togithub.com/eslint/eslint/commit/a7a883bd6ba4f140b60cbbb2be5b53d750f6c8db) feat: for-direction rule add check for condition in reverse order ([#​17755](https://togithub.com/eslint/eslint/issues/17755)) (Angelo Annunziata) - [`1452dc9`](https://togithub.com/eslint/eslint/commit/1452dc9f12c45c05d7c569f737221f0d988ecef1) feat: Add suggestions to no-console ([#​17680](https://togithub.com/eslint/eslint/issues/17680)) (Joel Mathew Koshy) - [`21ebf8a`](https://togithub.com/eslint/eslint/commit/21ebf8a811be9f4b009cf70a10be5062d4fdc736) feat: update `no-array-constructor` rule ([#​17711](https://togithub.com/eslint/eslint/issues/17711)) (Francesco Trotta) #### Bug Fixes - [`98926e6`](https://togithub.com/eslint/eslint/commit/98926e6e7323e5dd12a9f016cb558144296665af) fix: Ensure that extra data is not accidentally stored in the cache file ([#​17760](https://togithub.com/eslint/eslint/issues/17760)) (Milos Djermanovic) - [`e8cf9f6`](https://togithub.com/eslint/eslint/commit/e8cf9f6a524332293f8b2c90a2db4a532e47d919) fix: Make dark scroll bar in dark theme ([#​17753](https://togithub.com/eslint/eslint/issues/17753)) (Pavel) - [`3cbeaad`](https://togithub.com/eslint/eslint/commit/3cbeaad7b943c153937ce34365cec2c406f2b98b) fix: Use `cwd` constructor option as config `basePath` in Linter ([#​17705](https://togithub.com/eslint/eslint/issues/17705)) (Milos Djermanovic) #### Documentation - [`becfdd3`](https://togithub.com/eslint/eslint/commit/becfdd39b25d795e56c9a13eb3e77af6b9c86e8a) docs: Make clear when rules are removed ([#​17728](https://togithub.com/eslint/eslint/issues/17728)) (Nicholas C. Zakas) - [`05d6e99`](https://togithub.com/eslint/eslint/commit/05d6e99153ed6d94eb30f46c57609371918a41f3) docs: update "Submit a Pull Request" page ([#​17712](https://togithub.com/eslint/eslint/issues/17712)) (Francesco Trotta) - [`eb2279e`](https://togithub.com/eslint/eslint/commit/eb2279e5148cee8fdea7dae614f4f8af7a2d06c3) docs: display info about deprecated rules ([#​17749](https://togithub.com/eslint/eslint/issues/17749)) (Percy Ma) - [`d245326`](https://togithub.com/eslint/eslint/commit/d24532601e64714ac5d08507e05aa5c14ecd1d5a) docs: Correct working in migrating plugin docs ([#​17722](https://togithub.com/eslint/eslint/issues/17722)) (Filip Tammergård) #### Chores - [`d644de9`](https://togithub.com/eslint/eslint/commit/d644de9a4b593b565617303a095bc9aa69e7b768) chore: upgrade [@​eslint/js](https://togithub.com/eslint/js)[@​8](https://togithub.com/8).54.0 ([#​17773](https://togithub.com/eslint/eslint/issues/17773)) (Milos Djermanovic) - [`1e6e314`](https://togithub.com/eslint/eslint/commit/1e6e31415cc429a3a9fc64b2ec03df0e0ec0c91b) chore: package.json update for [@​eslint/js](https://togithub.com/eslint/js) release (Jenkins) - [`6fb8805`](https://togithub.com/eslint/eslint/commit/6fb8805310afe7476d6c404f172177a6d15fcf11) chore: Fixed grammar in issue_templates/rule_change ([#​17770](https://togithub.com/eslint/eslint/issues/17770)) (Joel Mathew Koshy) - [`85db724`](https://togithub.com/eslint/eslint/commit/85db7243ddb8706ed60ab64a7ddf604d0d7de493) chore: upgrade `markdownlint` to 0.31.1 ([#​17754](https://togithub.com/eslint/eslint/issues/17754)) (Nitin Kumar) - [`6d470d2`](https://togithub.com/eslint/eslint/commit/6d470d2e74535761bd56dcb1c021b463ef9e8a9c) chore: update dependency recast to ^0.23.0 ([#​17736](https://togithub.com/eslint/eslint/issues/17736)) (renovate\[bot]) - [`b7121b5`](https://togithub.com/eslint/eslint/commit/b7121b590d578c9c9b38ee481313317f30e54817) chore: update dependency markdownlint-cli to ^0.37.0 ([#​17735](https://togithub.com/eslint/eslint/issues/17735)) (renovate\[bot]) - [`633b9a1`](https://togithub.com/eslint/eslint/commit/633b9a19752b6a22ab4d6c824f27a75ac0e4151b) chore: update dependency regenerator-runtime to ^0.14.0 ([#​17739](https://togithub.com/eslint/eslint/issues/17739)) (renovate\[bot]) - [`acac16f`](https://togithub.com/eslint/eslint/commit/acac16fdf8540f7ba86cf637e3c1b253bd35a268) chore: update dependency vite-plugin-commonjs to ^0.10.0 ([#​17740](https://togithub.com/eslint/eslint/issues/17740)) (renovate\[bot]) - [`ba8ca7e`](https://togithub.com/eslint/eslint/commit/ba8ca7e3debcba68ee7015b9221cf5acd7870206) chore: add .github/renovate.json5 ([#​17567](https://togithub.com/eslint/eslint/issues/17567)) (Josh Goldberg ✨) </details> <details> <summary>langchain-ai/langchainjs (langchain)</summary> ### [`v0.0.194`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.194) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.193...0.0.194) #### What's Changed - Release 0.0.193 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3337](https://togithub.com/langchain-ai/langchainjs/pull/3337) - Pin zod-to-json-schema version by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3343](https://togithub.com/langchain-ai/langchainjs/pull/3343) **Full Changelog**: langchain-ai/langchainjs@0.0.193...0.0.194 ### [`v0.0.193`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.193) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.192...0.0.193) #### What's Changed - Release 0.0.192 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3311](https://togithub.com/langchain-ai/langchainjs/pull/3311) - Use .invoke for all agent docs and examples by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3319](https://togithub.com/langchain-ai/langchainjs/pull/3319) - \[AUTO-GENERATED] Add JSDoc examples to classes. by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3309](https://togithub.com/langchain-ai/langchainjs/pull/3309) - updated langchain stack img to be svg by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3324](https://togithub.com/langchain-ai/langchainjs/pull/3324) - \[AUTO-GENERATED] Add JSDoc examples to classes. by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3325](https://togithub.com/langchain-ai/langchainjs/pull/3325) - \[AUTO-GENERATED] Add JSDoc examples to classes. by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3327](https://togithub.com/langchain-ai/langchainjs/pull/3327) - \[AUTO-GENERATED] Add JSDoc examples to classes. by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3329](https://togithub.com/langchain-ai/langchainjs/pull/3329) - \[AUTO-GENERATED] Add JSDoc examples to classes. by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3330](https://togithub.com/langchain-ai/langchainjs/pull/3330) - Update Ollama functions by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3336](https://togithub.com/langchain-ai/langchainjs/pull/3336) - Remove console.log from googlevertexai-connection.ts by [@​raioalbano](https://togithub.com/raioalbano) in [https://github.com/langchain-ai/langchainjs/pull/3322](https://togithub.com/langchain-ai/langchainjs/pull/3322) - Add batch size arg by [@​hinthornw](https://togithub.com/hinthornw) in [https://github.com/langchain-ai/langchainjs/pull/3310](https://togithub.com/langchain-ai/langchainjs/pull/3310) - feat: Added support of terms filter in OpenSearch vector store by [@​faileon](https://togithub.com/faileon) in [https://github.com/langchain-ai/langchainjs/pull/3312](https://togithub.com/langchain-ai/langchainjs/pull/3312) - Improve MessageContent type by [@​netzhuffle](https://togithub.com/netzhuffle) in [https://github.com/langchain-ai/langchainjs/pull/3318](https://togithub.com/langchain-ai/langchainjs/pull/3318) - Add missing PrismaVectorStore filter operators by [@​Njuelle](https://togithub.com/Njuelle) in [https://github.com/langchain-ai/langchainjs/pull/3321](https://togithub.com/langchain-ai/langchainjs/pull/3321) #### New Contributors - [@​raioalbano](https://togithub.com/raioalbano) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3322](https://togithub.com/langchain-ai/langchainjs/pull/3322) - [@​faileon](https://togithub.com/faileon) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3312](https://togithub.com/langchain-ai/langchainjs/pull/3312) - [@​netzhuffle](https://togithub.com/netzhuffle) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3318](https://togithub.com/langchain-ai/langchainjs/pull/3318) **Full Changelog**: langchain-ai/langchainjs@0.0.192...0.0.193 ### [`v0.0.192`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.192) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.191...0.0.192) #### What's Changed - Release 0.0.191 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3300](https://togithub.com/langchain-ai/langchainjs/pull/3300) - Delete artifacts by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3305](https://togithub.com/langchain-ai/langchainjs/pull/3305) - Add missing docs by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3290](https://togithub.com/langchain-ai/langchainjs/pull/3290) - Brace/new api refs build by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3303](https://togithub.com/langchain-ai/langchainjs/pull/3303) - Fix broken fetch usage for CFW by [@​dqbd](https://togithub.com/dqbd) in [https://github.com/langchain-ai/langchainjs/pull/3302](https://togithub.com/langchain-ai/langchainjs/pull/3302) - Bump Anthropic + OpenAI versions by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3308](https://togithub.com/langchain-ai/langchainjs/pull/3308) - Hotfix pdf by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3306](https://togithub.com/langchain-ai/langchainjs/pull/3306) - Add PrismaVectorStore filter IN operator by [@​Njuelle](https://togithub.com/Njuelle) in [https://github.com/langchain-ai/langchainjs/pull/3304](https://togithub.com/langchain-ai/langchainjs/pull/3304) - feat(apify): support Document\[] return type for mapping function by [@​omikader](https://togithub.com/omikader) in [https://github.com/langchain-ai/langchainjs/pull/3262](https://togithub.com/langchain-ai/langchainjs/pull/3262) - Integrate Rockset as a vector store by [@​kwadhwa18](https://togithub.com/kwadhwa18) in [https://github.com/langchain-ai/langchainjs/pull/3231](https://togithub.com/langchain-ai/langchainjs/pull/3231) - feat: add file-system based cache by [@​vdeturckheim](https://togithub.com/vdeturckheim) in [https://github.com/langchain-ai/langchainjs/pull/3089](https://togithub.com/langchain-ai/langchainjs/pull/3089) #### New Contributors - [@​Njuelle](https://togithub.com/Njuelle) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3304](https://togithub.com/langchain-ai/langchainjs/pull/3304) - [@​kwadhwa18](https://togithub.com/kwadhwa18) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3231](https://togithub.com/langchain-ai/langchainjs/pull/3231) - [@​vdeturckheim](https://togithub.com/vdeturckheim) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3089](https://togithub.com/langchain-ai/langchainjs/pull/3089) **Full Changelog**: langchain-ai/langchainjs@0.0.191...0.0.192 ### [`v0.0.191`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.191) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.190...0.0.191) #### What's Changed - Release 0.0.190 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3298](https://togithub.com/langchain-ai/langchainjs/pull/3298) **Full Changelog**: langchain-ai/langchainjs@0.0.190...0.0.191 ### [`v0.0.190`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.190) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.189...0.0.190) #### What's Changed - Release 0.0.189 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3278](https://togithub.com/langchain-ai/langchainjs/pull/3278) - Brace/move syntaxtypes up by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3281](https://togithub.com/langchain-ai/langchainjs/pull/3281) - Brace/api refs css by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3282](https://togithub.com/langchain-ai/langchainjs/pull/3282) - Added runnable to xml agent, moved legacy to hidden page by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3287](https://togithub.com/langchain-ai/langchainjs/pull/3287) - redo intro docs page by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3288](https://togithub.com/langchain-ai/langchainjs/pull/3288) - Add better docstrings for runnables by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3291](https://togithub.com/langchain-ai/langchainjs/pull/3291) - Update HTTP response output parser logic by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3295](https://togithub.com/langchain-ai/langchainjs/pull/3295) **Full Changelog**: langchain-ai/langchainjs@0.0.189...0.0.190 ### [`v0.0.189`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.189) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.188...0.0.189) #### What's Changed - Release 0.0.188 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3276](https://togithub.com/langchain-ai/langchainjs/pull/3276) - Revert Cohere update by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3277](https://togithub.com/langchain-ai/langchainjs/pull/3277) **Full Changelog**: langchain-ai/langchainjs@0.0.188...0.0.189 ### [`v0.0.188`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.188) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.187...0.0.188) #### What's Changed - Release 0.0.187 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3255](https://togithub.com/langchain-ai/langchainjs/pull/3255) - Break words on api refs sidebar instead of scrolling by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3265](https://togithub.com/langchain-ai/langchainjs/pull/3265) - Use replaceAll instead of replace when generating operationid. by [@​Manouchehri](https://togithub.com/Manouchehri) in [https://github.com/langchain-ai/langchainjs/pull/3267](https://togithub.com/langchain-ai/langchainjs/pull/3267) - Brace/bump cohere by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3263](https://togithub.com/langchain-ai/langchainjs/pull/3263) - Added documentation for few shot prompting by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3122](https://togithub.com/langchain-ai/langchainjs/pull/3122) - Allow custom system prompt for Ollama functions by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3264](https://togithub.com/langchain-ai/langchainjs/pull/3264) - Brace/add ignore with tsmorph by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3271](https://togithub.com/langchain-ai/langchainjs/pull/3271) - Added rag over code example by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3109](https://togithub.com/langchain-ai/langchainjs/pull/3109) - Meta Llama2 support for BedrockChat by [@​shafkevi](https://togithub.com/shafkevi) in [https://github.com/langchain-ai/langchainjs/pull/3260](https://togithub.com/langchain-ai/langchainjs/pull/3260) - Adds HTTP output parser to parse chunks into different content types by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3273](https://togithub.com/langchain-ai/langchainjs/pull/3273) #### New Contributors - [@​shafkevi](https://togithub.com/shafkevi) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3260](https://togithub.com/langchain-ai/langchainjs/pull/3260) **Full Changelog**: langchain-ai/langchainjs@0.0.187...0.0.188 ### [`v0.0.187`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.187) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.186...0.0.187) #### What's Changed - Update ollama.mdx by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3234](https://togithub.com/langchain-ai/langchainjs/pull/3234) - Release 0.0.186 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3233](https://togithub.com/langchain-ai/langchainjs/pull/3233) - Format and update docs by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3235](https://togithub.com/langchain-ai/langchainjs/pull/3235) - Update documentation for ToolMessageChunk by [@​Stadly](https://togithub.com/Stadly) in [https://github.com/langchain-ai/langchainjs/pull/3244](https://togithub.com/langchain-ai/langchainjs/pull/3244) - ollama: handle chunks that are not newline delimited by [@​jmorganca](https://togithub.com/jmorganca) in [https://github.com/langchain-ai/langchainjs/pull/3241](https://togithub.com/langchain-ai/langchainjs/pull/3241) - LLMonitor Callback Handler: support for future OpenAI kwargs by [@​vincelwt](https://togithub.com/vincelwt) in [https://github.com/langchain-ai/langchainjs/pull/3209](https://togithub.com/langchain-ai/langchainjs/pull/3209) - Generate api refs with typedoc by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3152](https://togithub.com/langchain-ai/langchainjs/pull/3152) - Remove unused CI actions, update Vercel.json by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3253](https://togithub.com/langchain-ai/langchainjs/pull/3253) - Adds experimental Ollama functions wrapper by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3251](https://togithub.com/langchain-ai/langchainjs/pull/3251) - \[Feature] Implementation of token buffer memory by [@​ychen5601](https://togithub.com/ychen5601) in [https://github.com/langchain-ai/langchainjs/pull/3211](https://togithub.com/langchain-ai/langchainjs/pull/3211) #### New Contributors - [@​Stadly](https://togithub.com/Stadly) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3244](https://togithub.com/langchain-ai/langchainjs/pull/3244) - [@​jmorganca](https://togithub.com/jmorganca) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3241](https://togithub.com/langchain-ai/langchainjs/pull/3241) - [@​ychen5601](https://togithub.com/ychen5601) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3211](https://togithub.com/langchain-ai/langchainjs/pull/3211) **Full Changelog**: langchain-ai/langchainjs@0.0.186...0.0.187 ### [`v0.0.186`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.186) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.185...0.0.186) #### What's Changed - Release 0.0.185 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3219](https://togithub.com/langchain-ai/langchainjs/pull/3219) - Update cookbook by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3220](https://togithub.com/langchain-ai/langchainjs/pull/3220) - Update docs by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3227](https://togithub.com/langchain-ai/langchainjs/pull/3227) - Fix chat prompt serialization by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3230](https://togithub.com/langchain-ai/langchainjs/pull/3230) - Adds JSON mode to Ollama and ChatOllama by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3229](https://togithub.com/langchain-ai/langchainjs/pull/3229) - Fix delta role error when using custom LLM by [@​ninjamaster1337](https://togithub.com/ninjamaster1337) in [https://github.com/langchain-ai/langchainjs/pull/3223](https://togithub.com/langchain-ai/langchainjs/pull/3223) - Brace/runnable chain by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3200](https://togithub.com/langchain-ai/langchainjs/pull/3200) - Adds tool calling output parser by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3232](https://togithub.com/langchain-ai/langchainjs/pull/3232) #### New Contributors - [@​ninjamaster1337](https://togithub.com/ninjamaster1337) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3223](https://togithub.com/langchain-ai/langchainjs/pull/3223) **Full Changelog**: langchain-ai/langchainjs@0.0.185...0.0.186 ### [`v0.0.185`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.185) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.184...0.0.185) #### What's Changed - Release 0.0.184 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3201](https://togithub.com/langchain-ai/langchainjs/pull/3201) - Fix OpenAI Assistant docs by [@​igo](https://togithub.com/igo) in [https://github.com/langchain-ai/langchainjs/pull/3207](https://togithub.com/langchain-ai/langchainjs/pull/3207) - Fix json mode docs by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3210](https://togithub.com/langchain-ai/langchainjs/pull/3210) - Add detail param to message content for gpt-4v by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3215](https://togithub.com/langchain-ai/langchainjs/pull/3215) - feat(apify): support async dataset mapping function by [@​omikader](https://togithub.com/omikader) in [https://github.com/langchain-ai/langchainjs/pull/3213](https://togithub.com/langchain-ai/langchainjs/pull/3213) - Adds OpenAI tools agent example by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3216](https://togithub.com/langchain-ai/langchainjs/pull/3216) - Added screenshotting method for puppeteer tool by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3217](https://togithub.com/langchain-ai/langchainjs/pull/3217) - format prompt messages with openai image content by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3212](https://togithub.com/langchain-ai/langchainjs/pull/3212) - chore: bump momento dependency and refactor search hit usage by [@​malandis](https://togithub.com/malandis) in [https://github.com/langchain-ai/langchainjs/pull/3203](https://togithub.com/langchain-ai/langchainjs/pull/3203) - Fix excessive PDF newlines by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3218](https://togithub.com/langchain-ai/langchainjs/pull/3218) - Jtcorrin/plan execute structured tools by [@​JTCorrin](https://togithub.com/JTCorrin) in [https://github.com/langchain-ai/langchainjs/pull/3076](https://togithub.com/langchain-ai/langchainjs/pull/3076) #### New Contributors - [@​igo](https://togithub.com/igo) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3207](https://togithub.com/langchain-ai/langchainjs/pull/3207) **Full Changelog**: langchain-ai/langchainjs@0.0.184...0.0.185 ### [`v0.0.184`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.184) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.183...0.0.184) #### What's Changed - Release 0.0.183 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3192](https://togithub.com/langchain-ai/langchainjs/pull/3192) - Adds tool message docs by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3198](https://togithub.com/langchain-ai/langchainjs/pull/3198) - Cleanup gen llm comp table script by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3194](https://togithub.com/langchain-ai/langchainjs/pull/3194) - feat(pinecone): add support for delete by metadata filter by [@​omikader](https://togithub.com/omikader) in [https://github.com/langchain-ai/langchainjs/pull/3193](https://togithub.com/langchain-ai/langchainjs/pull/3193) - Brace/openai assistant by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3171](https://togithub.com/langchain-ai/langchainjs/pull/3171) **Full Changelog**: langchain-ai/langchainjs@0.0.183...0.0.184 ### [`v0.0.183`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.183) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.182...0.0.183) #### What's Changed - Release 0.0.182 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3190](https://togithub.com/langchain-ai/langchainjs/pull/3190) - Fix GooglePaLM example typing with base message inputs by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3191](https://togithub.com/langchain-ai/langchainjs/pull/3191) **Full Changelog**: langchain-ai/langchainjs@0.0.182...0.0.183 ### [`v0.0.182`](https://togithub.com/langchain-ai/langchainjs/releases/tag/0.0.182) [Compare Source](https://togithub.com/langchain-ai/langchainjs/compare/0.0.181...0.0.182) #### What's Changed - Release 0.0.181 by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3163](https://togithub.com/langchain-ai/langchainjs/pull/3163) - OpenAI Multimodal schema changes by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3168](https://togithub.com/langchain-ai/langchainjs/pull/3168) - Rc staging by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3170](https://togithub.com/langchain-ai/langchainjs/pull/3170) - Adds JSON mode support by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3175](https://togithub.com/langchain-ai/langchainjs/pull/3175) - add an example and how to documentation page for cancelling LCEL chains by [@​jondwillis](https://togithub.com/jondwillis) in [https://github.com/langchain-ai/langchainjs/pull/3183](https://togithub.com/langchain-ai/langchainjs/pull/3183) - fix: updated convex chat message history indexes to match documentation by [@​WrongGoose](https://togithub.com/WrongGoose) in [https://github.com/langchain-ai/langchainjs/pull/3176](https://togithub.com/langchain-ai/langchainjs/pull/3176) - feat(apify): pass through Document metadata generic type by [@​omikader](https://togithub.com/omikader) in [https://github.com/langchain-ai/langchainjs/pull/3121](https://togithub.com/langchain-ai/langchainjs/pull/3121) - Fix typo by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3184](https://togithub.com/langchain-ai/langchainjs/pull/3184) - Merge OpenAI vision schema changes by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3185](https://togithub.com/langchain-ai/langchainjs/pull/3185) - Added script to generate compatibility tables for llm/chat models by [@​bracesproul](https://togithub.com/bracesproul) in [https://github.com/langchain-ai/langchainjs/pull/3148](https://togithub.com/langchain-ai/langchainjs/pull/3148) - Fix invalid usage of defaultProvider in Bedrock web. by [@​Manouchehri](https://togithub.com/Manouchehri) in [https://github.com/langchain-ai/langchainjs/pull/3189](https://togithub.com/langchain-ai/langchainjs/pull/3189) - Fix docs build by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3188](https://togithub.com/langchain-ai/langchainjs/pull/3188) - Add tools and tool_choice param for ChatOpenAI by [@​jacoblee93](https://togithub.com/jacoblee93) in [https://github.com/langchain-ai/langchainjs/pull/3186](https://togithub.com/langchain-ai/langchainjs/pull/3186) #### New Contributors - [@​jondwillis](https://togithub.com/jondwillis) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3183](https://togithub.com/langchain-ai/langchainjs/pull/3183) - [@​WrongGoose](https://togithub.com/WrongGoose) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3176](https://togithub.com/langchain-ai/langchainjs/pull/3176) - [@​omikader](https://togithub.com/omikader) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3121](https://togithub.com/langchain-ai/langchainjs/pull/3121) - [@​Manouchehri](https://togithub.com/Manouchehri) made their first contribution in [https://github.com/langchain-ai/langchainjs/pull/3189](https://togithub.com/langchain-ai/langchainjs/pull/3189) **Full Changelog**: langchain-ai/langchainjs@0.0.181...0.0.182 </details> <details> <summary>openai/openai-node (openai)</summary> ### [`v4.19.0`](https://togithub.com/openai/openai-node/blob/HEAD/CHANGELOG.md#4190-2023-11-15) [Compare Source](https://togithub.com/openai/openai-node/compare/v4.18.0...v4.19.0) Full Changelog: [v4.18.0...v4.19.0](https://togithub.com/openai/openai-node/compare/v4.18.0...v4.19.0) ##### Features - **api:** updates ([#​501](https://togithub.com/openai/openai-node/issues/501)) ([944d58e](https://togithub.com/openai/openai-node/commit/944d58e5fc46f1a0671aaa2b809d28e67edf6023)) ### [`v4.18.0`](https://togithub.com/openai/openai-node/blob/HEAD/CHANGELOG.md#4180-2023-11-14) [Compare Source](https://togithub.com/openai/openai-node/compare/v4.17.5...v4.18.0) Full Changelog: [v4.17.5...v4.18.0](https://togithub.com/openai/openai-node/compare/v4.17.5...v4.18.0) ##### Features - **api:** add gpt-3.5-turbo-1106 ([#​496](https://togithub.com/openai/openai-node/issues/496)) ([45f7672](https://togithub.com/openai/openai-node/commit/45f7672ccf4856ac309b08c6c96f0e73ab48b525)) ### [`v4.17.5`](https://togithub.com/openai/openai-node/blob/HEAD/CHANGELOG.md#4175-2023-11-13) [Compare Source](https://togithub.com/openai/openai-node/compare/v4.17.4...v4.17.5) Full Changelog: [v4.17.4...v4.17.5](https://togithub.com/openai/openai-node/compare/v4.17.4...v4.17.5) ##### Chores - fix typo in docs and add request header for function calls ([#​494](https://togithub.com/openai/openai-node/issues/494)) ([22ce244](https://togithub.com/openai/openai-node/commit/22ce2443a77f10988b3215bd81ba17d4eda4b10e)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/autoblocksai/javascript-sdk). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy41OS44IiwidXBkYXRlZEluVmVyIjoiMzcuNTkuOCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Nicole White <[email protected]>
API refs now on standalone site (typedoc, served via the public folder of a next.js app lol)
Update code block generation to link to new site