Skip to content
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

Providing embedding field name to retriever #697

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions core_api/src/dependencies.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ def get_parameterised_retriever(
index_name=f"{env.elastic_root_index}-chunk",
params=default_params,
embedding_model=get_embedding_model(env),
embedding_field_name=env.embedding_document_field_name,
).configurable_fields(
params=ConfigurableField(
id="params", name="Retriever parameters", description="A dictionary of parameters to use for the retriever."
Expand Down
8 changes: 5 additions & 3 deletions core_api/src/retriever/queries.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,14 @@ def get_all(query: ESQuery) -> dict[str, Any]:
}
)
return {
"_source": {"excludes": ["embedding"]},
"_source": {"excludes": ["*embedding"]},
"query": {"bool": {"must": {"match_all": {}}, "filter": query_filter}},
}


def get_some(embedding_model: Embeddings, params: ESParams, query: ESQuery) -> dict[str, Any]:
def get_some(
embedding_model: Embeddings, params: ESParams, embedding_field_name: str, query: ESQuery
) -> dict[str, Any]:
vector = embedding_model.embed_query(query["question"])

query_filter = [
Expand Down Expand Up @@ -92,7 +94,7 @@ def get_some(embedding_model: Embeddings, params: ESParams, query: ESQuery) -> d
},
{
"knn": {
"field": "embedding",
"field": embedding_field_name,
"query_vector": vector,
"num_candidates": params["num_candidates"],
"filter": query_filter,
Expand Down
3 changes: 2 additions & 1 deletion core_api/src/retriever/retrievers.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,15 @@ def hit_to_doc(hit: dict[str, Any]) -> Document:
class ParameterisedElasticsearchRetriever(ElasticsearchRetriever):
params: ESParams
embedding_model: Embeddings
embedding_field_name: str = "embedding"

def __init__(self, **kwargs: Any) -> None:
# Hack to pass validation before overwrite
# Partly necessary due to how .with_config() interacts with a retriever
kwargs["body_func"] = get_some
kwargs["document_mapper"] = hit_to_doc
super().__init__(**kwargs)
self.body_func = partial(get_some, self.embedding_model, self.params)
self.body_func = partial(get_some, self.embedding_model, self.params, self.embedding_field_name)


class AllElasticsearchRetriever(ElasticsearchRetriever):
Expand Down
1 change: 1 addition & 0 deletions core_api/tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ def parameterised_retriever(env, es_client, embedding_model_dim):
index_name=f"{env.elastic_root_index}-chunk",
params=default_params,
embedding_model=FakeEmbeddings(size=embedding_model_dim),
embedding_field_name=env.embedding_document_field_name,
).configurable_fields(
params=ConfigurableField(
id="params", name="Retriever parameters", description="A dictionary of parameters to use for the retriever."
Expand Down
Loading