langchain/docs/docs_skeleton
Michael Landis 8e45f720a8
feat: add momento vector index as a vector store provider (#11567)
**Description**:

- Added Momento Vector Index (MVI) as a vector store provider. This
includes an implementation with docstrings, integration tests, a
notebook, and documentation on the docs pages.
- Updated the Momento dependency in pyproject.toml and the lock file to
enable access to MVI.
- Refactored the Momento cache and chat history session store to prefer
using "MOMENTO_API_KEY" over "MOMENTO_AUTH_TOKEN" for consistency with
MVI. This change is backwards compatible with the previous "auth_token"
variable usage. Updated the code and tests accordingly.

**Dependencies**:

- Updated Momento dependency in pyproject.toml.

**Testing**:

- Run the integration tests with a Momento API key. Get one at the
[Momento Console](https://console.gomomento.com) for free. MVI is
available in AWS us-west-2 with a superuser key.
- `MOMENTO_API_KEY=<your key> poetry run pytest
tests/integration_tests/vectorstores/test_momento_vector_index.py`

**Tag maintainer:**

@eyurtsev

**Twitter handle**:

Please mention @momentohq for this addition to langchain. With the
integration of Momento Vector Index, Momento caching, and session store,
Momento provides serverless support for the core langchain data needs.

Also mention @mlonml for the integration.
2023-10-09 14:02:59 -07:00
..
docs feat: add momento vector index as a vector store provider (#11567) 2023-10-09 14:02:59 -07:00
src docs: Mendable Search Improvements (#11199) 2023-09-28 15:57:04 -07:00
static Update QA doc w/ Runnables (#11401) 2023-10-05 08:07:38 -07:00
.gitignore Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
babel.config.js Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
code-block-loader.js Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
docusaurus.config.js rename repo namespace to langchain-ai (#11259) 2023-10-01 15:30:58 -04:00
ignore_build.sh fix prod docs build (#6402) 2023-06-18 20:56:12 -07:00
package-lock.json docs: Mendable Search Improvements (#11199) 2023-09-28 15:57:04 -07:00
package.json docs: Mendable Search Improvements (#11199) 2023-09-28 15:57:04 -07:00
README.md Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
settings.ini Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
sidebars.js mv LCEL up in docs (#11395) 2023-10-04 15:34:06 -04:00
vercel_build.sh mv docs extras (#11399) 2023-10-06 10:09:41 -07:00
vercel.json docs: integrations/retrievers cleanup (#11388) 2023-10-06 13:40:46 -07:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Continuous Integration

Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.

$ yarn ci