langchain/libs/community/langchain_community/vectorstores
WU LIFU 86698b02a9
doc: fix wrong documentation on FAISS load_local function (#22310)
### Issue: #22299 

### descriptions
The documentation appears to be wrong. When the user actually sets this
parameter "asynchronous" to be True, it fails because the __init__
function of FAISS class doesn't allow this parameter. In fact, most of
the class/instance functions of this class have both the sync/async
version, so it looks like what we need is just to remove this parameter
from the doc.

Thank you for contributing to LangChain!

- [x] **PR title**: "package: description"
- Where "package" is whichever of langchain, community, core,
experimental, etc. is being modified. Use "docs: ..." for purely docs
changes, "templates: ..." for template changes, "infra: ..." for CI
changes.
  - Example: "community: add foobar LLM"


- [x] **PR message**: ***Delete this entire checklist*** and replace
with
    - **Description:** a description of the change
    - **Issue:** the issue # it fixes, if applicable
    - **Dependencies:** any dependencies required for this change
- **Twitter handle:** if your PR gets announced, and you'd like a
mention, we'll gladly shout you out!


- [ ] **Add tests and docs**: If you're adding a new integration, please
include
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in
`docs/docs/integrations` directory.


- [ ] **Lint and test**: Run `make format`, `make lint` and `make test`
from the root of the package(s) you've modified. See contribution
guidelines for more: https://python.langchain.com/docs/contributing/

Additional guidelines:
- Make sure optional dependencies are imported within a function.
- Please do not add dependencies to pyproject.toml files (even optional
ones) unless they are required for unit tests.
- Most PRs should not touch more than one package.
- Changes should be backwards compatible.
- If you are adding something to community, do not re-import it in
langchain.

If no one reviews your PR within a few days, please @-mention one of
baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.

Co-authored-by: Lifu Wu <lifu@nextbillion.ai>
2024-05-30 15:15:04 +00:00
..
docarray community[patch]: docarray requires hnsw installation (#19416) 2024-03-22 22:39:07 +00:00
redis infra: rm unused # noqa violations (#22049) 2024-05-22 15:21:08 -07:00
__init__.py community[minor]: Add Zep Cloud components + docs + examples (#21671) 2024-05-27 12:50:13 -07:00
aerospike.py community[minor]: add aerospike vectorstore integration (#21735) 2024-05-21 01:01:47 +00:00
alibabacloud_opensearch.py infra: add -p to mkdir in lint steps (#17013) 2024-02-05 11:22:06 -08:00
analyticdb.py community[patch]: Use uuid4 not uuid1 (#20487) 2024-04-16 09:40:44 -04:00
annoy.py community[patch]: fix typo in ValueError message in load_local function (#21818) 2024-05-17 17:19:04 +00:00
apache_doris.py comminuty[patch]:Fix Error in apache doris insert (#19989) 2024-04-18 16:34:32 -04:00
astradb.py (all): update removal in deprecation warnings from 0.2 to 0.3 (#21265) 2024-05-03 14:29:36 -04:00
atlas.py community[patch]: Use uuid4 not uuid1 (#20487) 2024-04-16 09:40:44 -04:00
awadb.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
azure_cosmos_db.py community[patch]: Fixing some caching issues for AzureCosmosDBSemanticCache (#18884) 2024-03-25 19:06:17 -07:00
azuresearch.py community[patch]: AzureSearchVectorStoreRetriever Fixed to account for search_kwargs (#21572) 2024-05-22 14:46:41 -07:00
bagel.py community[patch]: update package name to bagelML (#19948) 2024-05-01 01:17:33 -04:00
bageldb.py community[patch]: update package name to bagelML (#19948) 2024-05-01 01:17:33 -04:00
baiducloud_vector_search.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
baiduvectordb.py community[patch]: fix bugs in baiduvectordb as vectorstore (#19380) 2024-03-22 17:03:59 -07:00
bigquery_vector_search.py (all): update removal in deprecation warnings from 0.2 to 0.3 (#21265) 2024-05-03 14:29:36 -04:00
cassandra.py community[patch]: Improve Cassandra VectorStore docsctrings (#21620) 2024-05-13 15:24:26 -04:00
chroma.py community[minor]: import fix (#20995) 2024-04-29 10:32:50 -04:00
clarifai.py community[patch] : Tidy up and update Clarifai SDK functions (#18314) 2024-03-07 19:47:44 -08:00
clickhouse.py community[minor]: clickhouse -- ability to use secure connection (#22108) 2024-05-24 17:30:22 +00:00
couchbase.py community: add Couchbase Vector Store (#18994) 2024-03-19 12:39:51 -07:00
dashvector.py community[minor]: import fix (#20995) 2024-04-29 10:32:50 -04:00
databricks_vector_search.py community[minor]: Add mmr and similarity_score_threshold retrieval to DatabricksVectorSearch (#16829) 2024-02-12 12:51:37 -08:00
deeplake.py community[minor]: import fix (#20995) 2024-04-29 10:32:50 -04:00
dingo.py community[patch]: Use uuid4 not uuid1 (#20487) 2024-04-16 09:40:44 -04:00
documentdb.py community[minor]: Add DocumentDBVectorSearch VectorStore (#17757) 2024-03-06 15:11:34 -08:00
duckdb.py community[patch]: DuckDB VS - expose similarity, improve performance of from_texts (#20971) 2024-05-24 15:17:52 -07:00
ecloud_vector_search.py community[minor]: integrate China Mobile Ecloud vector search (#15298) 2024-03-27 23:02:40 +00:00
elastic_vector_search.py elasticsearch[patch], community[patch]: update references, deprecate community classes (#18506) 2024-03-06 15:09:12 -08:00
elasticsearch.py elasticsearch[patch], community[patch]: update references, deprecate community classes (#18506) 2024-03-06 15:09:12 -08:00
epsilla.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
faiss.py doc: fix wrong documentation on FAISS load_local function (#22310) 2024-05-30 15:15:04 +00:00
hanavector.py community[patch]: Performant filter columns option for Hanavector (#21971) 2024-05-22 13:21:21 -07:00
hippo.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
hologres.py community[patch]: Use uuid4 not uuid1 (#20487) 2024-04-16 09:40:44 -04:00
infinispanvs.py community: VectorStore Infinispan, adding autoconfiguration (#18967) 2024-03-18 21:33:45 -07:00
inmemory.py community[patch]: Fix in memory vectorstore to take into account ids when adding docs (#21384) 2024-05-07 15:05:16 -04:00
jaguar.py infra: rm unused # noqa violations (#22049) 2024-05-22 15:21:08 -07:00
kdbai.py community: vectorstores.kdbai - Added support for when no docs are present (#18103) 2024-02-26 12:47:06 -08:00
kinetica.py community[patch]: Use uuid4 not uuid1 (#20487) 2024-04-16 09:40:44 -04:00
lancedb.py community[patch]: vectorstores import update (#21169) 2024-05-13 10:45:31 -04:00
lantern.py community[patch]: Use uuid4 not uuid1 (#20487) 2024-04-16 09:40:44 -04:00
llm_rails.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
manticore_search.py community[minor]: ManticoreSearch engine added to vectorstore (#19117) 2024-05-23 13:56:18 -07:00
marqo.py infra: add print rule to ruff (#16221) 2024-02-09 16:13:30 -08:00
matching_engine.py (all): update removal in deprecation warnings from 0.2 to 0.3 (#21265) 2024-05-03 14:29:36 -04:00
meilisearch.py community[patch]: update for compatibility with Meilisearch v1.8 (#21979) 2024-05-22 13:37:01 -07:00
milvus.py milvus: New langchain_milvus package and new milvus features (#21077) 2024-05-28 08:24:20 -07:00
momento_vector_index.py infra: rm unused # noqa violations (#22049) 2024-05-22 15:21:08 -07:00
mongodb_atlas.py (all): update removal in deprecation warnings from 0.2 to 0.3 (#21265) 2024-05-03 14:29:36 -04:00
myscale.py community: fix myscale delete function bug (#15675) 2024-01-08 12:26:29 -08:00
neo4j_vector.py community[patch]: Better error message for neo4j vector when text is null (#21861) 2024-05-20 10:25:58 -07:00
nucliadb.py community[minor]: import fix (#20995) 2024-04-29 10:32:50 -04:00
opensearch_vector_search.py community[patch]: Add OpenSearch as semantic cache (#20254) 2024-04-27 00:20:24 +00:00
oraclevs.py Replaced bind variable in SQL with formatted string for compatibility with sql syntax. (#21439) 2024-05-08 13:51:30 -07:00
pathway.py docs: remove repetitive words (#21058) 2024-05-01 01:10:42 +00:00
pgembedding.py community[patch]: Use uuid4 not uuid1 (#20487) 2024-04-16 09:40:44 -04:00
pgvecto_rs.py infra: add -p to mkdir in lint steps (#17013) 2024-02-05 11:22:06 -08:00
pgvector.py community[patch]: pgvector: Slight refactoring to make code a bit more reusable (#16243) 2024-05-08 17:21:30 -04:00
pinecone.py (all): update removal in deprecation warnings from 0.2 to 0.3 (#21265) 2024-05-03 14:29:36 -04:00
qdrant.py infra: rm unused # noqa violations (#22049) 2024-05-22 15:21:08 -07:00
relyt.py community[minor]: Add relyt vector database (#20316) 2024-04-25 19:49:29 +00:00
rocksetdb.py community[patch]: mmr search for Rockset vectorstore integration (#16908) 2024-03-29 18:45:22 +00:00
scann.py community[patch]: fix typo in ValueError message in load_local function (#21818) 2024-05-17 17:19:04 +00:00
semadb.py infra: add print rule to ruff (#16221) 2024-02-09 16:13:30 -08:00
singlestoredb.py community[patch]: add hybrid search to singlestoredb vectorstore (#20793) 2024-04-24 21:34:50 +00:00
sklearn.py community[patch]: docstrings update (#20301) 2024-04-11 16:23:27 -04:00
sqlitevss.py community[patch]: docstrings update (#20301) 2024-04-11 16:23:27 -04:00
starrocks.py infra: add print rule to ruff (#16221) 2024-02-09 16:13:30 -08:00
supabase.py community: enable SupabaseVectorStore to support extended table fields (#21762) 2024-05-20 16:32:26 -07:00
surrealdb.py community[patch]: surrealdb provide functions for MMR (Maximal Marginal Relevance) (#21185) 2024-05-22 22:53:55 +00:00
tair.py community[minor]: import fix (#20995) 2024-04-29 10:32:50 -04:00
tencentvectordb.py docs: community docstring updates (#21040) 2024-04-29 17:40:23 -04:00
thirdai_neuraldb.py Ndb enterprise (#21233) 2024-05-08 16:30:58 -07:00
tidb_vector.py community[patch]: docstrings update (#20301) 2024-04-11 16:23:27 -04:00
tigris.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
tiledb.py community[patch]: vectorstores import update (#21169) 2024-05-13 10:45:31 -04:00
timescalevector.py infra: rm unused # noqa violations (#22049) 2024-05-22 15:21:08 -07:00
typesense.py community[minor]: import fix (#20995) 2024-04-29 10:32:50 -04:00
upstash.py community[minor]: Add support for Upstash Vector (#20824) 2024-04-29 17:25:01 -04:00
usearch.py community[patch]: vectorstores import update (#21169) 2024-05-13 10:45:31 -04:00
utils.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
vald.py community[minor]: import fix (#20995) 2024-04-29 10:32:50 -04:00
vdms.py community[patch]: Use uuid4 not uuid1 (#20487) 2024-04-16 09:40:44 -04:00
vearch.py community[minor]: import fix (#20995) 2024-04-29 10:32:50 -04:00
vectara.py community[patch]: docstrings update (#20301) 2024-04-11 16:23:27 -04:00
vespa.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
vikingdb.py community[patch]: Modify the text field type and add new exception handling (#20116) 2024-04-29 20:06:00 -04:00
vlite.py community[minor]: Added VLite as VectorStore (#20245) 2024-04-17 01:24:38 +00:00
weaviate.py community: Fixed schema discrepancy in from_texts function for weaviate vectorstore (#16693) 2024-01-28 16:53:31 -08:00
xata.py multiple: Remove unnecessary Ruff suppression comments (#21050) 2024-04-30 17:13:48 +00:00
yellowbrick.py community[minor]: Add indexing via locality sensitive hashing to the Yellowbrick vector store (#20856) 2024-05-06 20:18:02 +00:00
zep_cloud.py community[minor]: Add Zep Cloud components + docs + examples (#21671) 2024-05-27 12:50:13 -07:00
zep.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
zilliz.py community[patch]: Milvus supports add & delete texts by ids (#16256) 2024-01-29 11:19:50 -08:00