Skip to content

Commit

Permalink
fix docs (run-llama#630)
Browse files Browse the repository at this point in the history
Co-authored-by: Jerry Liu <jerryliu@Jerrys-MacBook-Pro.local>
  • Loading branch information
jerryjliu and Jerry Liu authored Mar 7, 2023
1 parent eb0877d commit ffbba46
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions gpt_index/vector_stores/opensearch.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,10 @@


class OpensearchVectorClient:
"""
Object encapsulating an Opensearch index that has vector search enabled.
"""Object encapsulating an Opensearch index that has vector search enabled.
If the index does not yet exist, it is created during init.
Therefore, The underlying index is assumed to either:
Therefore, the underlying index is assumed to either:
1) not exist yet or 2) be created due to previous usage of this class.
Args:
Expand All @@ -28,12 +27,9 @@ class OpensearchVectorClient:
method (Optional[dict]): Opensearch "method" JSON obj for configuring
the KNN index.
This includes engine, metric, and other config params. Defaults to:
{
"name": "hnsw",
"space_type": "l2",
"engine": "faiss",
"parameters": {"ef_construction": 256, "m": 48}
}
{"name": "hnsw", "space_type": "l2", "engine": "faiss",
"parameters": {"ef_construction": 256, "m": 48}}
"""

def __init__(
Expand Down

0 comments on commit ffbba46

Please sign in to comment.