feat(gooddata-sdk): [AUTO] Add AI catalog generateDescription, generateTitle, trendingObjects endpoints

Author: yenkins-admin

packages/gooddata-sdk/src/gooddata_sdk/compute/service.py

@@ -12,9 +12,14 @@
 from gooddata_api_client.model.chat_history_result import ChatHistoryResult
 from gooddata_api_client.model.chat_request import ChatRequest
 from gooddata_api_client.model.chat_result import ChatResult
+from gooddata_api_client.model.generate_description_request import GenerateDescriptionRequest
+from gooddata_api_client.model.generate_description_response import GenerateDescriptionResponse
+from gooddata_api_client.model.generate_title_request import GenerateTitleRequest
+from gooddata_api_client.model.generate_title_response import GenerateTitleResponse
 from gooddata_api_client.model.saved_visualization import SavedVisualization
 from gooddata_api_client.model.search_request import SearchRequest
 from gooddata_api_client.model.search_result import SearchResult
+from gooddata_api_client.model.trending_objects_result import TrendingObjectsResult
 
 from gooddata_sdk.client import GoodDataApiClient
 from gooddata_sdk.compute.model.execution import (
@@ -276,6 +281,7 @@ def search_ai(
         workspace_id: str,
         question: str,
         deep_search: bool | None = None,
+        enable_hybrid_search: bool | None = None,
         limit: int | None = None,
         object_types: list[str] | None = None,
         relevant_score_threshold: float | None = None,
@@ -288,6 +294,8 @@ def search_ai(
             workspace_id (str): workspace identifier
             question (str): keyword/sentence input for search
             deep_search (bool): turn on deep search - if true, content of complex objects will be searched as well
+            enable_hybrid_search (Optional[bool]): if true, enables hybrid search combining vector similarity and
+                keyword matching. Defaults to None.
             limit (Optional[int]): maximum number of results to return. Defaults to None.
             object_types (Optional[list[str]]): list of object types to search for. Enum items: "attribute", "metric", "fact",
                 "label", "date", "dataset", "visualization" and "dashboard". Defaults to None.
@@ -303,6 +311,8 @@ def search_ai(
         search_params: dict[str, Any] = {}
         if deep_search is not None:
             search_params["deep_search"] = deep_search
+        if enable_hybrid_search is not None:
+            search_params["enable_hybrid_search"] = enable_hybrid_search
         if limit is not None:
             search_params["limit"] = limit
         if object_types is not None:
@@ -315,6 +325,63 @@ def search_ai(
         response = self._actions_api.ai_search(workspace_id, search_request, _check_return_type=False)
         return response
 
+    def generate_description(
+        self,
+        workspace_id: str,
+        object_id: str,
+        object_type: str,
+    ) -> GenerateDescriptionResponse:
+        """
+        Generate a description for an analytics catalog object.
+
+        Args:
+            workspace_id (str): workspace identifier
+            object_id (str): identifier of the object to describe
+            object_type (str): type of the object to describe.
+                One of: "Visualization", "Dashboard", "Metric", "Fact", "Attribute"
+
+        Returns:
+            GenerateDescriptionResponse: Generated description and optional note
+        """
+        request = GenerateDescriptionRequest(object_id=object_id, object_type=object_type, _check_type=False)
+        response = self._actions_api.generate_description(workspace_id, request, _check_return_type=False)
+        return response
+
+    def generate_title(
+        self,
+        workspace_id: str,
+        object_id: str,
+        object_type: str,
+    ) -> GenerateTitleResponse:
+        """
+        Generate a title for an analytics catalog object.
+
+        Args:
+            workspace_id (str): workspace identifier
+            object_id (str): identifier of the object to generate a title for
+            object_type (str): type of the object to generate a title for.
+                One of: "Visualization", "Dashboard", "Metric", "Fact", "Attribute"
+
+        Returns:
+            GenerateTitleResponse: Generated title and optional note
+        """
+        request = GenerateTitleRequest(object_id=object_id, object_type=object_type, _check_type=False)
+        response = self._actions_api.generate_title(workspace_id, request, _check_return_type=False)
+        return response
+
+    def get_trending_objects(self, workspace_id: str) -> TrendingObjectsResult:
+        """
+        Get trending analytics catalog objects for a workspace.
+
+        Args:
+            workspace_id (str): workspace identifier
+
+        Returns:
+            TrendingObjectsResult: List of trending analytics catalog objects
+        """
+        response = self._actions_api.trending_objects(workspace_id, _check_return_type=False)
+        return response
+
     def cancel_executions(self, executions: dict[str, dict[str, str]]) -> None:
         """
         Try to cancel given executions using the cancel api endpoint.

packages/gooddata-sdk/tests/compute/test_compute_service.py

@@ -219,6 +219,81 @@ def test_ai_chat_stream(test_config):
         sdk.compute.reset_ai_chat_history(test_workspace_id)
 
 
+@gd_vcr.use_cassette(str(_fixtures_dir / "ai_search_hybrid.yaml"))
+def test_search_ai_with_hybrid_search(test_config):
+    """Test AI search with enable_hybrid_search parameter."""
+    sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"])
+    path = _current_dir / "load" / "ai"
+    test_workspace_id = test_config["workspace_test"]
+
+    try:
+        _setup_test_workspace(sdk, test_workspace_id, path)
+        result = sdk.compute.search_ai(
+            workspace_id=test_workspace_id,
+            question="What is the total revenue?",
+            enable_hybrid_search=True,
+        )
+        assert result is not None
+        assert hasattr(result, "results")
+    finally:
+        sdk.catalog_workspace.delete_workspace(test_workspace_id)
+
+
+@gd_vcr.use_cassette(str(_fixtures_dir / "generate_description.yaml"))
+def test_generate_description(test_config):
+    """Test generate description for an analytics catalog object."""
+    sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"])
+    path = _current_dir / "load" / "ai"
+    test_workspace_id = test_config["workspace_test"]
+
+    try:
+        _setup_test_workspace(sdk, test_workspace_id, path)
+        # Use a metric object type for description generation
+        result = sdk.compute.generate_description(
+            workspace_id=test_workspace_id,
+            object_id="revenue",
+            object_type="Metric",
+        )
+        assert result is not None
+    finally:
+        sdk.catalog_workspace.delete_workspace(test_workspace_id)
+
+
+@gd_vcr.use_cassette(str(_fixtures_dir / "generate_title.yaml"))
+def test_generate_title(test_config):
+    """Test generate title for an analytics catalog object."""
+    sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"])
+    path = _current_dir / "load" / "ai"
+    test_workspace_id = test_config["workspace_test"]
+
+    try:
+        _setup_test_workspace(sdk, test_workspace_id, path)
+        result = sdk.compute.generate_title(
+            workspace_id=test_workspace_id,
+            object_id="revenue",
+            object_type="Metric",
+        )
+        assert result is not None
+    finally:
+        sdk.catalog_workspace.delete_workspace(test_workspace_id)
+
+
+@gd_vcr.use_cassette(str(_fixtures_dir / "trending_objects.yaml"))
+def test_get_trending_objects(test_config):
+    """Test get trending analytics catalog objects."""
+    sdk = GoodDataSdk.create(host_=test_config["host"], token_=test_config["token"])
+    path = _current_dir / "load" / "ai"
+    test_workspace_id = test_config["workspace_test"]
+
+    try:
+        _setup_test_workspace(sdk, test_workspace_id, path)
+        result = sdk.compute.get_trending_objects(test_workspace_id)
+        assert result is not None
+        assert hasattr(result, "objects")
+    finally:
+        sdk.catalog_workspace.delete_workspace(test_workspace_id)
+
+
 @gd_vcr.use_cassette(str(_fixtures_dir / "build_exec_def_from_chat_result.yaml"))
 def test_build_exec_def_from_chat_result(test_config):
     """Test build execution definition from chat result."""