Skip to content

feat: RAG - Add Serverless and Spanner modes in preview. #6281

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.

Sign up for GitHub

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

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
+392 −7
Open

feat: RAG - Add Serverless and Spanner modes in preview. #6281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 63 additions & 0 deletions tests/unit/vertex_rag/test_rag_constants_preview.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,12 @@
RankService,
Ranking,
Scaled,
Serverless,
SharePointSource,
SharePointSources,
SlackChannel,
SlackChannelsSource,
Spanner,
Unprovisioned,
VertexAiSearchConfig,
VertexFeatureStore,
Expand Down Expand Up @@ -584,6 +586,34 @@
TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME = (
f"projects/{TEST_PROJECT_NUMBER}/locations/{TEST_REGION}/ragEngineConfig"
)
TEST_RAG_ENGINE_CONFIG_SERVERLESS = RagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=RagManagedDbConfig(mode=Serverless()),
)
TEST_RAG_ENGINE_CONFIG_SPANNER_BASIC = RagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=RagManagedDbConfig(
mode=Spanner(tier=Basic()),
),
)
TEST_RAG_ENGINE_CONFIG_SPANNER_SCALED = RagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=RagManagedDbConfig(
mode=Spanner(tier=Scaled()),
),
)
TEST_RAG_ENGINE_CONFIG_SPANNER_UNPROVISIONED = RagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=RagManagedDbConfig(
mode=Spanner(tier=Unprovisioned()),
),
)
TEST_RAG_ENGINE_CONFIG_SPANNER_NO_TIER = RagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=RagManagedDbConfig(
mode=Spanner(),
),
)
TEST_RAG_ENGINE_CONFIG_BASIC = RagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=RagManagedDbConfig(tier=Basic()),
Expand All @@ -604,6 +634,39 @@
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=None,
)
TEST_BAD_RAG_ENGINE_CONFIG_WITH_MODE_AND_TIER = RagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=RagManagedDbConfig(
mode=Spanner(tier=Basic()),
tier=Scaled(),
),
)
TEST_GAPIC_RAG_ENGINE_CONFIG_SERVERLESS = GapicRagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=GapicRagManagedDbConfig(
serverless=GapicRagManagedDbConfig.Serverless()
),
)
TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_BASIC = GapicRagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=GapicRagManagedDbConfig(
spanner=GapicRagManagedDbConfig.Spanner(basic=GapicRagManagedDbConfig.Basic())
),
)
TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_SCALED = GapicRagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=GapicRagManagedDbConfig(
spanner=GapicRagManagedDbConfig.Spanner(scaled=GapicRagManagedDbConfig.Scaled())
),
)
TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_UNPROVISIONED = GapicRagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=GapicRagManagedDbConfig(
spanner=GapicRagManagedDbConfig.Spanner(
unprovisioned=GapicRagManagedDbConfig.Unprovisioned()
)
),
)
TEST_GAPIC_RAG_ENGINE_CONFIG_BASIC = GapicRagEngineConfig(
name=TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
rag_managed_db_config=GapicRagManagedDbConfig(
Expand Down
240 changes: 240 additions & 0 deletions tests/unit/vertex_rag/test_rag_data_preview.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,91 @@ def update_rag_engine_config_enterprise_mock():
yield update_rag_engine_config_enterprise_mock


@pytest.fixture()
def update_rag_engine_config_serverless_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"update_rag_engine_config",
) as update_rag_engine_config_serverless_mock:
update_rag_engine_config_lro_mock = mock.Mock(ga_operation.Operation)
update_rag_engine_config_lro_mock.done.return_value = True
update_rag_engine_config_lro_mock.result.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SERVERLESS
)
update_rag_engine_config_serverless_mock.return_value = (
update_rag_engine_config_lro_mock
)
yield update_rag_engine_config_serverless_mock


@pytest.fixture()
def update_rag_engine_config_spanner_basic_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"update_rag_engine_config",
) as update_rag_engine_config_spanner_basic_mock:
update_rag_engine_config_lro_mock = mock.Mock(ga_operation.Operation)
update_rag_engine_config_lro_mock.done.return_value = True
update_rag_engine_config_lro_mock.result.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_BASIC
)
update_rag_engine_config_spanner_basic_mock.return_value = (
update_rag_engine_config_lro_mock
)
yield update_rag_engine_config_spanner_basic_mock


@pytest.fixture()
def update_rag_engine_config_spanner_scaled_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"update_rag_engine_config",
) as update_rag_engine_config_spanner_scaled_mock:
update_rag_engine_config_lro_mock = mock.Mock(ga_operation.Operation)
update_rag_engine_config_lro_mock.done.return_value = True
update_rag_engine_config_lro_mock.result.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_SCALED
)
update_rag_engine_config_spanner_scaled_mock.return_value = (
update_rag_engine_config_lro_mock
)
yield update_rag_engine_config_spanner_scaled_mock


@pytest.fixture()
def update_rag_engine_config_spanner_no_tier_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"update_rag_engine_config",
) as update_rag_engine_config_spanner_no_tier_mock:
update_rag_engine_config_lro_mock = mock.Mock(ga_operation.Operation)
update_rag_engine_config_lro_mock.done.return_value = True
update_rag_engine_config_lro_mock.result.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_SCALED
)
update_rag_engine_config_spanner_no_tier_mock.return_value = (
update_rag_engine_config_lro_mock
)
yield update_rag_engine_config_spanner_no_tier_mock


@pytest.fixture()
def update_rag_engine_config_spanner_unprovisioned_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"update_rag_engine_config",
) as update_rag_engine_config_spanner_unprovisioned_mock:
update_rag_engine_config_lro_mock = mock.Mock(ga_operation.Operation)
update_rag_engine_config_lro_mock.done.return_value = True
update_rag_engine_config_lro_mock.result.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_UNPROVISIONED
)
update_rag_engine_config_spanner_unprovisioned_mock.return_value = (
update_rag_engine_config_lro_mock
)
yield update_rag_engine_config_spanner_unprovisioned_mock


@pytest.fixture()
def update_rag_engine_config_scaled_mock():
with mock.patch.object(
Expand Down Expand Up @@ -584,6 +669,54 @@ def get_rag_engine_enterprise_config_mock():
yield get_rag_engine_enterprise_config_mock


@pytest.fixture()
def get_rag_engine_spanner_basic_config_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"get_rag_engine_config",
) as get_rag_engine_spanner_basic_config_mock:
get_rag_engine_spanner_basic_config_mock.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_BASIC
)
yield get_rag_engine_spanner_basic_config_mock


@pytest.fixture()
def get_rag_engine_spanner_scaled_config_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"get_rag_engine_config",
) as get_rag_engine_spanner_scaled_config_mock:
get_rag_engine_spanner_scaled_config_mock.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_SCALED
)
yield get_rag_engine_spanner_scaled_config_mock


@pytest.fixture()
def get_rag_engine_spanner_unprovisioned_config_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"get_rag_engine_config",
) as get_rag_engine_spanner_unprovisioned_config_mock:
get_rag_engine_spanner_unprovisioned_config_mock.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SPANNER_UNPROVISIONED
)
yield get_rag_engine_spanner_unprovisioned_config_mock


@pytest.fixture()
def get_rag_engine_serverless_config_mock():
with mock.patch.object(
VertexRagDataServiceClient,
"get_rag_engine_config",
) as get_rag_engine_serverless_config_mock:
get_rag_engine_serverless_config_mock.return_value = (
test_rag_constants_preview.TEST_GAPIC_RAG_ENGINE_CONFIG_SERVERLESS
)
yield get_rag_engine_serverless_config_mock


@pytest.fixture()
def get_rag_engine_config_mock_exception():
with mock.patch.object(
Expand Down Expand Up @@ -1765,6 +1898,73 @@ def test_update_rag_engine_config_unprovisioned_success(
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_UNPROVISIONED,
)

def test_update_rag_engine_config_spanner_basic_success(
self, update_rag_engine_config_spanner_basic_mock
):
rag_config = rag.update_rag_engine_config(
rag_engine_config=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_BASIC,
)
assert update_rag_engine_config_spanner_basic_mock.call_count == 1
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_BASIC,
)

def test_update_rag_engine_config_spanner_scaled_success(
self, update_rag_engine_config_spanner_scaled_mock
):
rag_config = rag.update_rag_engine_config(
rag_engine_config=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_SCALED,
)
assert update_rag_engine_config_spanner_scaled_mock.call_count == 1
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_SCALED,
)

def test_update_rag_engine_config_spanner_unprovisioned_success(
self, update_rag_engine_config_spanner_unprovisioned_mock
):
rag_config = rag.update_rag_engine_config(
rag_engine_config=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_UNPROVISIONED,
)
assert update_rag_engine_config_spanner_unprovisioned_mock.call_count == 1
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_UNPROVISIONED,
)

def test_update_rag_engine_config_spanner_no_tier_success(
self, update_rag_engine_config_spanner_no_tier_mock
):
rag_config = rag.update_rag_engine_config(
rag_engine_config=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_NO_TIER,
)
assert update_rag_engine_config_spanner_no_tier_mock.call_count == 1
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_SCALED,
)

def test_update_rag_engine_config_serverless_success(
self, update_rag_engine_config_serverless_mock
):
rag_config = rag.update_rag_engine_config(
rag_engine_config=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SERVERLESS,
)
assert update_rag_engine_config_serverless_mock.call_count == 1
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SERVERLESS,
)

def test_update_rag_engine_config_with_mode_and_tier_failure(self):
with pytest.raises(ValueError) as e:
rag.update_rag_engine_config(
rag_engine_config=test_rag_constants_preview.TEST_BAD_RAG_ENGINE_CONFIG_WITH_MODE_AND_TIER,
)
e.match("mode and tier both cannot be set at the same time")

@pytest.mark.usefixtures("update_rag_engine_config_mock_exception")
def test_update_rag_engine_config_failure(self):
with pytest.raises(RuntimeError) as e:
Expand All @@ -1786,6 +1986,46 @@ def test_update_rag_engine_config_bad_input(
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_BASIC,
)

@pytest.mark.usefixtures("get_rag_engine_serverless_config_mock")
def test_get_rag_engine_config_serverless_success(self):
rag_config = rag.get_rag_engine_config(
name=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
)
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SERVERLESS,
)

@pytest.mark.usefixtures("get_rag_engine_spanner_basic_config_mock")
def test_get_rag_engine_config_spanner_basic_success(self):
rag_config = rag.get_rag_engine_config(
name=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
)
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_BASIC,
)

@pytest.mark.usefixtures("get_rag_engine_spanner_scaled_config_mock")
def test_get_rag_engine_config_spanner_scaled_success(self):
rag_config = rag.get_rag_engine_config(
name=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
)
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_SCALED,
)

@pytest.mark.usefixtures("get_rag_engine_spanner_unprovisioned_config_mock")
def test_get_rag_engine_config_spanner_unprovisioned_success(self):
rag_config = rag.get_rag_engine_config(
name=test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_RESOURCE_NAME,
)
rag_engine_config_eq(
rag_config,
test_rag_constants_preview.TEST_RAG_ENGINE_CONFIG_SPANNER_UNPROVISIONED,
)

@pytest.mark.usefixtures("get_rag_engine_basic_config_mock")
def test_get_rag_engine_config_success(self):
rag_config = rag.get_rag_engine_config(
Expand Down
4 changes: 4 additions & 0 deletions vertexai/preview/rag/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,12 @@
RankService,
Ranking,
Scaled,
Serverless,
SharePointSource,
SharePointSources,
SlackChannel,
SlackChannelsSource,
Spanner,
TransformationConfig,
Unprovisioned,
VertexAiSearchConfig,
Expand Down Expand Up @@ -111,10 +113,12 @@
"RankService",
"Retrieval",
"Scaled",
"Serverless",
"SharePointSource",
"SharePointSources",
"SlackChannel",
"SlackChannelsSource",
"Spanner",
"TransformationConfig",
"Unprovisioned",
"VertexAiSearchConfig",
Expand Down
Loading
Loading