Skip to content
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
20 changes: 17 additions & 3 deletions python/semantic_kernel/connectors/azure_cosmos_db.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import ast
import asyncio
import json
import re
import sys
from collections.abc import Sequence
Expand Down Expand Up @@ -833,11 +834,24 @@ def _substitute(match: "re.Match[str]", mapping: dict[str, str] = rename) -> str
elif search_type == SearchType.KEYWORD_HYBRID:
# Hybrid search: requires both a vector and keywords
params.append({"name": "@keywords", "value": values})
text_field = options.additional_property_name
if not text_field:
requested_text_field_name = options.additional_property_name
if not requested_text_field_name:
raise VectorStoreModelException("Hybrid search requires 'keyword_field_name' in options.")
text_field = next(
(
field
for field in self.definition.data_fields
if requested_text_field_name in {field.name, field.storage_name}
),
None,
)
if not text_field:
raise VectorStoreModelException(
f"Data field '{requested_text_field_name}' not found in the data model definition."
)
text_field_reference = f"c[{json.dumps(text_field.storage_name or text_field.name)}]"
distance_clause = (
f"RRF(VectorDistance(c.{vector_field_name}, @vector), FullTextScore(c.{text_field}, @keywords))"
f"RRF(VectorDistance(c.{vector_field_name}, @vector), FullTextScore({text_field_reference}, @keywords))"
)
else:
raise VectorStoreModelException(f"Search type '{search_type}' is not supported.")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,90 @@ async def _empty_results():
assert {"name": "@filter_p1", "value": "beta"} in parameters


@pytest.mark.parametrize("additional_property_name", ["content", "stored_content"])
async def test_azure_cosmos_db_no_sql_inner_search_resolves_hybrid_text_field(
azure_cosmos_db_no_sql_unit_test_env,
record_type,
definition,
collection_name: str,
additional_property_name: str,
) -> None:
"""Test hybrid search resolves logical and storage field names before building the query."""
from semantic_kernel.data.vector import SearchType, VectorSearchOptions

definition.data_fields[0].storage_name = "stored_content"
vector_collection = CosmosNoSqlCollection(
record_type=record_type,
definition=definition,
collection_name=collection_name,
)

async def _empty_results():
for item in []:
yield item

mock_container_proxy = MagicMock()
mock_container_proxy.query_items = MagicMock(return_value=_empty_results())
options = VectorSearchOptions(
vector_property_name="vector",
additional_property_name=additional_property_name,
top=3,
)

with patch.object(
CosmosNoSqlCollection,
"_get_container_proxy",
new=AsyncMock(return_value=mock_container_proxy),
):
await vector_collection._inner_search(
search_type=SearchType.KEYWORD_HYBRID,
options=options,
values="alpha",
vector=[0.1, 0.2, 0.3, 0.4, 0.5],
)

query, kwargs = mock_container_proxy.query_items.call_args
assert 'FullTextScore(c["stored_content"], @keywords)' in query[0]
assert {"name": "@keywords", "value": "alpha"} in kwargs["parameters"]


async def test_azure_cosmos_db_no_sql_inner_search_rejects_unknown_hybrid_text_field(
azure_cosmos_db_no_sql_unit_test_env,
record_type,
collection_name: str,
) -> None:
"""Test hybrid search rejects injection-shaped text fields before executing a query."""
from semantic_kernel.data.vector import SearchType, VectorSearchOptions

vector_collection = CosmosNoSqlCollection(
record_type=record_type,
collection_name=collection_name,
)
mock_container_proxy = MagicMock()
options = VectorSearchOptions(
vector_property_name="vector",
additional_property_name="content), @keywords)) FROM c WHERE true --",
top=3,
)

with (
patch.object(
CosmosNoSqlCollection,
"_get_container_proxy",
new=AsyncMock(return_value=mock_container_proxy),
),
pytest.raises(VectorStoreModelException, match="not found in the data model definition"),
):
await vector_collection._inner_search(
search_type=SearchType.KEYWORD_HYBRID,
options=options,
values="alpha",
vector=[0.1, 0.2, 0.3, 0.4, 0.5],
)

mock_container_proxy.query_items.assert_not_called()


@pytest.mark.parametrize("exclude_list", [["AZURE_COSMOS_DB_NO_SQL_URL"]], indirect=True)
def test_azure_cosmos_db_no_sql_collection_init_no_url(
azure_cosmos_db_no_sql_unit_test_env,
Expand Down
Loading