github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-10 15:06:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove _get_kwarg_value function (#13184)

Browse Source 
`_get_kwarg_value` function is useless, one can rely on python builtin
functionalities to do the exact same thing.

- **Description:** Removed `_get_kwarg_value`. Helps with code
readability.
  - **Issue:** the issue # it fixes (if applicable),
  - **Twitter handle:** @Guillem_96
This commit is contained in:
Guillem Orellana Trullols 2023-11-13 09:09:54 +01:00 committed by GitHub
parent e1c020dfe1
commit 0f31cd8b49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
libs/langchain/langchain/vectorstores/opensearch_vector_search.py
View File

@ -306,13 +306,6 @@ def _default_painless_scripting_query(
} }
def _get_kwargs_value(kwargs: Any, key: str, default_value: Any) -> Any:
"""Get the value of the key if present. Else get the default_value."""
if key in kwargs:
return kwargs.get(key)
return default_value
class OpenSearchVectorSearch(VectorStore): class OpenSearchVectorSearch(VectorStore):
"""`Amazon OpenSearch Vector Engine` vector store. """`Amazon OpenSearch Vector Engine` vector store.
@ -338,10 +331,10 @@ class OpenSearchVectorSearch(VectorStore):
"""Initialize with necessary components.""" """Initialize with necessary components."""
self.embedding_function = embedding_function self.embedding_function = embedding_function
self.index_name = index_name self.index_name = index_name
http_auth = _get_kwargs_value(kwargs, "http_auth", None) http_auth = kwargs.get("http_auth")
self.is_aoss = _is_aoss_enabled(http_auth=http_auth) self.is_aoss = _is_aoss_enabled(http_auth=http_auth)
self.client = _get_opensearch_client(opensearch_url, **kwargs) self.client = _get_opensearch_client(opensearch_url, **kwargs)
self.engine = _get_kwargs_value(kwargs, "engine", None) self.engine = kwargs.get("engine")
@property @property
def embeddings(self) -> Embeddings: def embeddings(self) -> Embeddings:
@ -357,16 +350,16 @@ class OpenSearchVectorSearch(VectorStore):
**kwargs: Any, **kwargs: Any,
) -> List[str]: ) -> List[str]:
_validate_embeddings_and_bulk_size(len(embeddings), bulk_size) _validate_embeddings_and_bulk_size(len(embeddings), bulk_size)
index_name = _get_kwargs_value(kwargs, "index_name", self.index_name) index_name = kwargs.get("index_name", self.index_name)
text_field = _get_kwargs_value(kwargs, "text_field", "text") text_field = kwargs.get("text_field", "text")
dim = len(embeddings[0]) dim = len(embeddings[0])
engine = _get_kwargs_value(kwargs, "engine", "nmslib") engine = kwargs.get("engine", "nmslib")
space_type = _get_kwargs_value(kwargs, "space_type", "l2") space_type = kwargs.get("space_type", "l2")
ef_search = _get_kwargs_value(kwargs, "ef_search", 512) ef_search = kwargs.get("ef_search", 512)
ef_construction = _get_kwargs_value(kwargs, "ef_construction", 512) ef_construction = kwargs.get("ef_construction", 512)
m = _get_kwargs_value(kwargs, "m", 16) m = kwargs.get("m", 16)
vector_field = _get_kwargs_value(kwargs, "vector_field", "vector_field") vector_field = kwargs.get("vector_field", "vector_field")
max_chunk_bytes = _get_kwargs_value(kwargs, "max_chunk_bytes", 1 * 1024 * 1024) max_chunk_bytes = kwargs.get("max_chunk_bytes", 1 * 1024 * 1024)
_validate_aoss_with_engines(self.is_aoss, engine) _validate_aoss_with_engines(self.is_aoss, engine)
@ -542,8 +535,8 @@ class OpenSearchVectorSearch(VectorStore):
same as `similarity_search` same as `similarity_search`
""" """
text_field = _get_kwargs_value(kwargs, "text_field", "text") text_field = kwargs.get("text_field", "text")
metadata_field = _get_kwargs_value(kwargs, "metadata_field", "metadata") metadata_field = kwargs.get("metadata_field", "metadata")
hits = self._raw_similarity_search_with_score(query=query, k=k, **kwargs) hits = self._raw_similarity_search_with_score(query=query, k=k, **kwargs)
@ -581,10 +574,10 @@ class OpenSearchVectorSearch(VectorStore):
same as `similarity_search` same as `similarity_search`
""" """
embedding = self.embedding_function.embed_query(query) embedding = self.embedding_function.embed_query(query)
search_type = _get_kwargs_value(kwargs, "search_type", "approximate_search") search_type = kwargs.get("search_type", "approximate_search")
vector_field = _get_kwargs_value(kwargs, "vector_field", "vector_field") vector_field = kwargs.get("vector_field", "vector_field")
index_name = _get_kwargs_value(kwargs, "index_name", self.index_name) index_name = kwargs.get("index_name", self.index_name)
filter = _get_kwargs_value(kwargs, "filter", {}) filter = kwargs.get("filter", {})
if ( if (
self.is_aoss self.is_aoss
@ -597,11 +590,11 @@ class OpenSearchVectorSearch(VectorStore):
) )
if search_type == "approximate_search": if search_type == "approximate_search":
boolean_filter = _get_kwargs_value(kwargs, "boolean_filter", {}) boolean_filter = kwargs.get("boolean_filter", {})
subquery_clause = _get_kwargs_value(kwargs, "subquery_clause", "must") subquery_clause = kwargs.get("subquery_clause", "must")
efficient_filter = _get_kwargs_value(kwargs, "efficient_filter", {}) efficient_filter = kwargs.get("efficient_filter", {})
# `lucene_filter` is deprecated, added for Backwards Compatibility # `lucene_filter` is deprecated, added for Backwards Compatibility
lucene_filter = _get_kwargs_value(kwargs, "lucene_filter", {}) lucene_filter = kwargs.get("lucene_filter", {})
if boolean_filter != {} and efficient_filter != {}: if boolean_filter != {} and efficient_filter != {}:
raise ValueError( raise ValueError(
@ -657,14 +650,14 @@ class OpenSearchVectorSearch(VectorStore):
embedding, k=k, vector_field=vector_field embedding, k=k, vector_field=vector_field
) )
elif search_type == SCRIPT_SCORING_SEARCH: elif search_type == SCRIPT_SCORING_SEARCH:
space_type = _get_kwargs_value(kwargs, "space_type", "l2") space_type = kwargs.get("space_type", "l2")
pre_filter = _get_kwargs_value(kwargs, "pre_filter", MATCH_ALL_QUERY) pre_filter = kwargs.get("pre_filter", MATCH_ALL_QUERY)
search_query = _default_script_query( search_query = _default_script_query(
embedding, k, space_type, pre_filter, vector_field embedding, k, space_type, pre_filter, vector_field
) )
elif search_type == PAINLESS_SCRIPTING_SEARCH: elif search_type == PAINLESS_SCRIPTING_SEARCH:
space_type = _get_kwargs_value(kwargs, "space_type", "l2Squared") space_type = kwargs.get("space_type", "l2Squared")
pre_filter = _get_kwargs_value(kwargs, "pre_filter", MATCH_ALL_QUERY) pre_filter = kwargs.get("pre_filter", MATCH_ALL_QUERY)
search_query = _default_painless_scripting_query( search_query = _default_painless_scripting_query(
embedding, k, space_type, pre_filter, vector_field embedding, k, space_type, pre_filter, vector_field
) )
@ -701,9 +694,9 @@ class OpenSearchVectorSearch(VectorStore):
List of Documents selected by maximal marginal relevance. List of Documents selected by maximal marginal relevance.
""" """
vector_field = _get_kwargs_value(kwargs, "vector_field", "vector_field") vector_field = kwargs.get("vector_field", "vector_field")
text_field = _get_kwargs_value(kwargs, "text_field", "text") text_field = kwargs.get("text_field", "text")
metadata_field = _get_kwargs_value(kwargs, "metadata_field", "metadata") metadata_field = kwargs.get("metadata_field", "metadata")
# Get embedding of the user query # Get embedding of the user query
embedding = self.embedding_function.embed_query(query) embedding = self.embedding_function.embed_query(query)
@ -874,11 +867,11 @@ class OpenSearchVectorSearch(VectorStore):
index_name = get_from_dict_or_env( index_name = get_from_dict_or_env(
kwargs, "index_name", "OPENSEARCH_INDEX_NAME", default=uuid.uuid4().hex kwargs, "index_name", "OPENSEARCH_INDEX_NAME", default=uuid.uuid4().hex
) )
is_appx_search = _get_kwargs_value(kwargs, "is_appx_search", True) is_appx_search = kwargs.get("is_appx_search", True)
vector_field = _get_kwargs_value(kwargs, "vector_field", "vector_field") vector_field = kwargs.get("vector_field", "vector_field")
text_field = _get_kwargs_value(kwargs, "text_field", "text") text_field = kwargs.get("text_field", "text")
max_chunk_bytes = _get_kwargs_value(kwargs, "max_chunk_bytes", 1 * 1024 * 1024) max_chunk_bytes = kwargs.get("max_chunk_bytes", 1 * 1024 * 1024)
http_auth = _get_kwargs_value(kwargs, "http_auth", None) http_auth = kwargs.get("http_auth")
is_aoss = _is_aoss_enabled(http_auth=http_auth) is_aoss = _is_aoss_enabled(http_auth=http_auth)
engine = None engine = None
@ -889,11 +882,11 @@ class OpenSearchVectorSearch(VectorStore):
) )
if is_appx_search: if is_appx_search:
engine = _get_kwargs_value(kwargs, "engine", "nmslib") engine = kwargs.get("engine", "nmslib")
space_type = _get_kwargs_value(kwargs, "space_type", "l2") space_type = kwargs.get("space_type", "l2")
ef_search = _get_kwargs_value(kwargs, "ef_search", 512) ef_search = kwargs.get("ef_search", 512)
ef_construction = _get_kwargs_value(kwargs, "ef_construction", 512) ef_construction = kwargs.get("ef_construction", 512)
m = _get_kwargs_value(kwargs, "m", 16) m = kwargs.get("m", 16)
_validate_aoss_with_engines(is_aoss, engine) _validate_aoss_with_engines(is_aoss, engine)