databricks-sdk 0.56.0__py3-none-any.whl → 0.58.0__py3-none-any.whl

databricks/sdk/service/dashboards.py

@@ -253,42 +253,6 @@ class DashboardView(Enum):
     DASHBOARD_VIEW_BASIC = "DASHBOARD_VIEW_BASIC"
 
 
-@dataclass
-class DeleteScheduleResponse:
-    def as_dict(self) -> dict:
-        """Serializes the DeleteScheduleResponse into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the DeleteScheduleResponse into a shallow dictionary of its immediate attributes."""
-        body = {}
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> DeleteScheduleResponse:
-        """Deserializes the DeleteScheduleResponse from a dictionary."""
-        return cls()
-
-
-@dataclass
-class DeleteSubscriptionResponse:
-    def as_dict(self) -> dict:
-        """Serializes the DeleteSubscriptionResponse into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the DeleteSubscriptionResponse into a shallow dictionary of its immediate attributes."""
-        body = {}
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> DeleteSubscriptionResponse:
-        """Deserializes the DeleteSubscriptionResponse from a dictionary."""
-        return cls()
-
-
 @dataclass
 class GenieAttachment:
     """Genie AI Response"""
@@ -409,6 +373,46 @@ class GenieConversation:
         )
 
 
+@dataclass
+class GenieConversationSummary:
+    conversation_id: str
+
+    title: str
+
+    created_timestamp: int
+
+    def as_dict(self) -> dict:
+        """Serializes the GenieConversationSummary into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.conversation_id is not None:
+            body["conversation_id"] = self.conversation_id
+        if self.created_timestamp is not None:
+            body["created_timestamp"] = self.created_timestamp
+        if self.title is not None:
+            body["title"] = self.title
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the GenieConversationSummary into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.conversation_id is not None:
+            body["conversation_id"] = self.conversation_id
+        if self.created_timestamp is not None:
+            body["created_timestamp"] = self.created_timestamp
+        if self.title is not None:
+            body["title"] = self.title
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> GenieConversationSummary:
+        """Deserializes the GenieConversationSummary from a dictionary."""
+        return cls(
+            conversation_id=d.get("conversation_id", None),
+            created_timestamp=d.get("created_timestamp", None),
+            title=d.get("title", None),
+        )
+
+
 @dataclass
 class GenieCreateConversationMessageRequest:
     content: str
@@ -453,80 +457,64 @@ class GenieCreateConversationMessageRequest:
 
 
 @dataclass
-class GenieGenerateDownloadFullQueryResultResponse:
-    download_id: Optional[str] = None
-    """Download ID. Use this ID to track the download request in subsequent polling calls"""
-
-    def as_dict(self) -> dict:
-        """Serializes the GenieGenerateDownloadFullQueryResultResponse into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.download_id is not None:
-            body["download_id"] = self.download_id
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the GenieGenerateDownloadFullQueryResultResponse into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.download_id is not None:
-            body["download_id"] = self.download_id
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> GenieGenerateDownloadFullQueryResultResponse:
-        """Deserializes the GenieGenerateDownloadFullQueryResultResponse from a dictionary."""
-        return cls(download_id=d.get("download_id", None))
-
-
-@dataclass
-class GenieGetDownloadFullQueryResultResponse:
+class GenieGetMessageQueryResultResponse:
     statement_response: Optional[sql.StatementResponse] = None
     """SQL Statement Execution response. See [Get status, manifest, and result first
     chunk](:method:statementexecution/getstatement) for more details."""
 
     def as_dict(self) -> dict:
-        """Serializes the GenieGetDownloadFullQueryResultResponse into a dictionary suitable for use as a JSON request body."""
+        """Serializes the GenieGetMessageQueryResultResponse into a dictionary suitable for use as a JSON request body."""
         body = {}
         if self.statement_response:
             body["statement_response"] = self.statement_response.as_dict()
         return body
 
     def as_shallow_dict(self) -> dict:
-        """Serializes the GenieGetDownloadFullQueryResultResponse into a shallow dictionary of its immediate attributes."""
+        """Serializes the GenieGetMessageQueryResultResponse into a shallow dictionary of its immediate attributes."""
         body = {}
         if self.statement_response:
             body["statement_response"] = self.statement_response
         return body
 
     @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> GenieGetDownloadFullQueryResultResponse:
-        """Deserializes the GenieGetDownloadFullQueryResultResponse from a dictionary."""
+    def from_dict(cls, d: Dict[str, Any]) -> GenieGetMessageQueryResultResponse:
+        """Deserializes the GenieGetMessageQueryResultResponse from a dictionary."""
         return cls(statement_response=_from_dict(d, "statement_response", sql.StatementResponse))
 
 
 @dataclass
-class GenieGetMessageQueryResultResponse:
-    statement_response: Optional[sql.StatementResponse] = None
-    """SQL Statement Execution response. See [Get status, manifest, and result first
-    chunk](:method:statementexecution/getstatement) for more details."""
+class GenieListConversationsResponse:
+    conversations: Optional[List[GenieConversationSummary]] = None
+    """List of conversations in the Genie space"""
+
+    next_page_token: Optional[str] = None
+    """Token to get the next page of results"""
 
     def as_dict(self) -> dict:
-        """Serializes the GenieGetMessageQueryResultResponse into a dictionary suitable for use as a JSON request body."""
+        """Serializes the GenieListConversationsResponse into a dictionary suitable for use as a JSON request body."""
         body = {}
-        if self.statement_response:
-            body["statement_response"] = self.statement_response.as_dict()
+        if self.conversations:
+            body["conversations"] = [v.as_dict() for v in self.conversations]
+        if self.next_page_token is not None:
+            body["next_page_token"] = self.next_page_token
         return body
 
     def as_shallow_dict(self) -> dict:
-        """Serializes the GenieGetMessageQueryResultResponse into a shallow dictionary of its immediate attributes."""
+        """Serializes the GenieListConversationsResponse into a shallow dictionary of its immediate attributes."""
         body = {}
-        if self.statement_response:
-            body["statement_response"] = self.statement_response
+        if self.conversations:
+            body["conversations"] = self.conversations
+        if self.next_page_token is not None:
+            body["next_page_token"] = self.next_page_token
         return body
 
     @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> GenieGetMessageQueryResultResponse:
-        """Deserializes the GenieGetMessageQueryResultResponse from a dictionary."""
-        return cls(statement_response=_from_dict(d, "statement_response", sql.StatementResponse))
+    def from_dict(cls, d: Dict[str, Any]) -> GenieListConversationsResponse:
+        """Deserializes the GenieListConversationsResponse from a dictionary."""
+        return cls(
+            conversations=_repeated_dict(d, "conversations", GenieConversationSummary),
+            next_page_token=d.get("next_page_token", None),
+        )
 
 
 @dataclass
@@ -595,20 +583,6 @@ class GenieMessage:
     `query_result_metadata` in `GenieQueryAttachment` instead."""
 
     status: Optional[MessageStatus] = None
-    """MessageStatus. The possible values are: * `FETCHING_METADATA`: Fetching metadata from the data
-    sources. * `FILTERING_CONTEXT`: Running smart context step to determine relevant context. *
-    `ASKING_AI`: Waiting for the LLM to respond to the user's question. * `PENDING_WAREHOUSE`:
-    Waiting for warehouse before the SQL query can start executing. * `EXECUTING_QUERY`: Executing a
-    generated SQL query. Get the SQL query result by calling
-    [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API. *
-    `FAILED`: The response generation or query execution failed. See `error` field. * `COMPLETED`:
-    Message processing is completed. Results are in the `attachments` field. Get the SQL query
-    result by calling
-    [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API. *
-    `SUBMITTED`: Message has been submitted. * `QUERY_RESULT_EXPIRED`: SQL result is not available
-    anymore. The user needs to rerun the query. Rerun the SQL query result by calling
-    [executeMessageAttachmentQuery](:method:genie/executeMessageAttachmentQuery) API. * `CANCELLED`:
-    Message has been cancelled."""
 
     user_id: Optional[int] = None
     """ID of the user who created the message"""
@@ -1758,9 +1732,7 @@ class GenieAPI:
         raise TimeoutError(f"timed out after {timeout}: {status_message}")
 
     def create_message(self, space_id: str, conversation_id: str, content: str) -> Wait[GenieMessage]:
-        """Create conversation message.
-
-        Create new message in a [conversation](:method:genie/startconversation). The AI response uses all
+        """Create new message in a [conversation](:method:genie/startconversation). The AI response uses all
         previously created messages in the conversation to respond.
 
         :param space_id: str
@@ -1803,12 +1775,27 @@ class GenieAPI:
             timeout=timeout
         )
 
+    def delete_conversation(self, space_id: str, conversation_id: str):
+        """Delete a conversation.
+
+        :param space_id: str
+          The ID associated with the Genie space where the conversation is located.
+        :param conversation_id: str
+          The ID of the conversation to delete.
+
+
+        """
+
+        headers = {
+            "Accept": "application/json",
+        }
+
+        self._api.do("DELETE", f"/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}", headers=headers)
+
     def execute_message_attachment_query(
         self, space_id: str, conversation_id: str, message_id: str, attachment_id: str
     ) -> GenieGetMessageQueryResultResponse:
-        """Execute message attachment SQL query.
-
-        Execute the SQL for a message query attachment. Use this API when the query attachment has expired and
+        """Execute the SQL for a message query attachment. Use this API when the query attachment has expired and
         needs to be re-executed.
 
         :param space_id: str
@@ -1837,9 +1824,7 @@ class GenieAPI:
     def execute_message_query(
         self, space_id: str, conversation_id: str, message_id: str
     ) -> GenieGetMessageQueryResultResponse:
-        """[Deprecated] Execute SQL query in a conversation message.
-
-        Execute the SQL query in the message.
+        """Execute the SQL query in the message.
 
         :param space_id: str
           Genie space ID
@@ -1862,83 +1847,8 @@ class GenieAPI:
         )
         return GenieGetMessageQueryResultResponse.from_dict(res)
 
-    def generate_download_full_query_result(
-        self, space_id: str, conversation_id: str, message_id: str, attachment_id: str
-    ) -> GenieGenerateDownloadFullQueryResultResponse:
-        """Generate full query result download.
-
-        Initiates a new SQL execution and returns a `download_id` that you can use to track the progress of
-        the download. The query result is stored in an external link and can be retrieved using the [Get
-        Download Full Query Result](:method:genie/getdownloadfullqueryresult) API. Warning: Databricks
-        strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.
-        See [Execute Statement](:method:statementexecution/executestatement) for more details.
-
-        :param space_id: str
-          Genie space ID
-        :param conversation_id: str
-          Conversation ID
-        :param message_id: str
-          Message ID
-        :param attachment_id: str
-          Attachment ID
-
-        :returns: :class:`GenieGenerateDownloadFullQueryResultResponse`
-        """
-
-        headers = {
-            "Accept": "application/json",
-        }
-
-        res = self._api.do(
-            "POST",
-            f"/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/downloads",
-            headers=headers,
-        )
-        return GenieGenerateDownloadFullQueryResultResponse.from_dict(res)
-
-    def get_download_full_query_result(
-        self, space_id: str, conversation_id: str, message_id: str, attachment_id: str, download_id: str
-    ) -> GenieGetDownloadFullQueryResultResponse:
-        """Get download full query result.
-
-        After [Generating a Full Query Result Download](:method:genie/getdownloadfullqueryresult) and
-        successfully receiving a `download_id`, use this API to poll the download progress. When the download
-        is complete, the API returns one or more external links to the query result files. Warning: Databricks
-        strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.
-        You must not set an Authorization header in download requests. When using the `EXTERNAL_LINKS`
-        disposition, Databricks returns presigned URLs that grant temporary access to data. See [Execute
-        Statement](:method:statementexecution/executestatement) for more details.
-
-        :param space_id: str
-          Genie space ID
-        :param conversation_id: str
-          Conversation ID
-        :param message_id: str
-          Message ID
-        :param attachment_id: str
-          Attachment ID
-        :param download_id: str
-          Download ID. This ID is provided by the [Generate Download
-          endpoint](:method:genie/generateDownloadFullQueryResult)
-
-        :returns: :class:`GenieGetDownloadFullQueryResultResponse`
-        """
-
-        headers = {
-            "Accept": "application/json",
-        }
-
-        res = self._api.do(
-            "GET",
-            f"/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/downloads/{download_id}",
-            headers=headers,
-        )
-        return GenieGetDownloadFullQueryResultResponse.from_dict(res)
-
     def get_message(self, space_id: str, conversation_id: str, message_id: str) -> GenieMessage:
-        """Get conversation message.
-
-        Get message from conversation.
+        """Get message from conversation.
 
         :param space_id: str
           The ID associated with the Genie space where the target conversation is located.
@@ -1964,9 +1874,7 @@ class GenieAPI:
     def get_message_attachment_query_result(
         self, space_id: str, conversation_id: str, message_id: str, attachment_id: str
     ) -> GenieGetMessageQueryResultResponse:
-        """Get message attachment SQL query result.
-
-        Get the result of SQL query if the message has a query attachment. This is only available if a message
+        """Get the result of SQL query if the message has a query attachment. This is only available if a message
         has a query attachment and the message status is `EXECUTING_QUERY` OR `COMPLETED`.
 
         :param space_id: str
@@ -1995,9 +1903,7 @@ class GenieAPI:
     def get_message_query_result(
         self, space_id: str, conversation_id: str, message_id: str
     ) -> GenieGetMessageQueryResultResponse:
-        """[Deprecated] Get conversation message SQL query result.
-
-        Get the result of SQL query if the message has a query attachment. This is only available if a message
+        """Get the result of SQL query if the message has a query attachment. This is only available if a message
         has a query attachment and the message status is `EXECUTING_QUERY`.
 
         :param space_id: str
@@ -2024,9 +1930,7 @@ class GenieAPI:
     def get_message_query_result_by_attachment(
         self, space_id: str, conversation_id: str, message_id: str, attachment_id: str
     ) -> GenieGetMessageQueryResultResponse:
-        """[Deprecated] Get conversation message SQL query result.
-
-        Get the result of SQL query if the message has a query attachment. This is only available if a message
+        """Get the result of SQL query if the message has a query attachment. This is only available if a message
         has a query attachment and the message status is `EXECUTING_QUERY` OR `COMPLETED`.
 
         :param space_id: str
@@ -2053,9 +1957,7 @@ class GenieAPI:
         return GenieGetMessageQueryResultResponse.from_dict(res)
 
     def get_space(self, space_id: str) -> GenieSpace:
-        """Get Genie Space.
-
-        Get details of a Genie Space.
+        """Get details of a Genie Space.
 
         :param space_id: str
           The ID associated with the Genie space
@@ -2070,12 +1972,37 @@ class GenieAPI:
         res = self._api.do("GET", f"/api/2.0/genie/spaces/{space_id}", headers=headers)
         return GenieSpace.from_dict(res)
 
+    def list_conversations(
+        self, space_id: str, *, page_size: Optional[int] = None, page_token: Optional[str] = None
+    ) -> GenieListConversationsResponse:
+        """Get a list of conversations in a Genie Space.
+
+        :param space_id: str
+          The ID of the Genie space to retrieve conversations from.
+        :param page_size: int (optional)
+          Maximum number of conversations to return per page
+        :param page_token: str (optional)
+          Token to get the next page of results
+
+        :returns: :class:`GenieListConversationsResponse`
+        """
+
+        query = {}
+        if page_size is not None:
+            query["page_size"] = page_size
+        if page_token is not None:
+            query["page_token"] = page_token
+        headers = {
+            "Accept": "application/json",
+        }
+
+        res = self._api.do("GET", f"/api/2.0/genie/spaces/{space_id}/conversations", query=query, headers=headers)
+        return GenieListConversationsResponse.from_dict(res)
+
     def list_spaces(
         self, *, page_size: Optional[int] = None, page_token: Optional[str] = None
     ) -> GenieListSpacesResponse:
-        """List Genie spaces.
-
-        Get list of Genie Spaces.
+        """Get list of Genie Spaces.
 
         :param page_size: int (optional)
           Maximum number of spaces to return per page
@@ -2098,9 +2025,7 @@ class GenieAPI:
         return GenieListSpacesResponse.from_dict(res)
 
     def start_conversation(self, space_id: str, content: str) -> Wait[GenieMessage]:
-        """Start conversation.
-
-        Start a new conversation.
+        """Start a new conversation.
 
         :param space_id: str
           The ID associated with the Genie space where you want to start a conversation.
@@ -2133,6 +2058,21 @@ class GenieAPI:
     def start_conversation_and_wait(self, space_id: str, content: str, timeout=timedelta(minutes=20)) -> GenieMessage:
         return self.start_conversation(content=content, space_id=space_id).result(timeout=timeout)
 
+    def trash_space(self, space_id: str):
+        """Move a Genie Space to the trash.
+
+        :param space_id: str
+          The ID associated with the Genie space to be sent to the trash.
+
+
+        """
+
+        headers = {
+            "Accept": "application/json",
+        }
+
+        self._api.do("DELETE", f"/api/2.0/genie/spaces/{space_id}", headers=headers)
+
 
 class LakeviewAPI:
     """These APIs provide specific management operations for Lakeview dashboards. Generic resource management can
@@ -2142,9 +2082,7 @@ class LakeviewAPI:
         self._api = api_client
 
     def create(self, dashboard: Dashboard) -> Dashboard:
-        """Create dashboard.
-
-        Create a draft dashboard.
+        """Create a draft dashboard.
 
         :param dashboard: :class:`Dashboard`
 
@@ -2165,6 +2103,7 @@ class LakeviewAPI:
         :param dashboard_id: str
           UUID identifying the dashboard to which the schedule belongs.
         :param schedule: :class:`Schedule`
+          The schedule to create. A dashboard is limited to 10 schedules.
 
         :returns: :class:`Schedule`
         """
@@ -2185,6 +2124,7 @@ class LakeviewAPI:
         :param schedule_id: str
           UUID identifying the schedule to which the subscription belongs.
         :param subscription: :class:`Subscription`
+          The subscription to create. A schedule is limited to 100 subscriptions.
 
         :returns: :class:`Subscription`
         """
@@ -2263,9 +2203,7 @@ class LakeviewAPI:
         )
 
     def get(self, dashboard_id: str) -> Dashboard:
-        """Get dashboard.
-
-        Get a draft dashboard.
+        """Get a draft dashboard.
 
         :param dashboard_id: str
           UUID identifying the dashboard.
@@ -2281,9 +2219,7 @@ class LakeviewAPI:
         return Dashboard.from_dict(res)
 
     def get_published(self, dashboard_id: str) -> PublishedDashboard:
-        """Get published dashboard.
-
-        Get the current published dashboard.
+        """Get the current published dashboard.
 
         :param dashboard_id: str
           UUID identifying the published dashboard.
@@ -2473,9 +2409,7 @@ class LakeviewAPI:
         parent_path: Optional[str] = None,
         update_parameter_syntax: Optional[bool] = None,
     ) -> Dashboard:
-        """Migrate dashboard.
-
-        Migrates a classic SQL dashboard to Lakeview.
+        """Migrates a classic SQL dashboard to Lakeview.
 
         :param source_dashboard_id: str
           UUID of the dashboard to be migrated.
@@ -2509,9 +2443,7 @@ class LakeviewAPI:
     def publish(
         self, dashboard_id: str, *, embed_credentials: Optional[bool] = None, warehouse_id: Optional[str] = None
     ) -> PublishedDashboard:
-        """Publish dashboard.
-
-        Publish the current draft dashboard.
+        """Publish the current draft dashboard.
 
         :param dashboard_id: str
           UUID identifying the dashboard to be published.
@@ -2537,9 +2469,7 @@ class LakeviewAPI:
         return PublishedDashboard.from_dict(res)
 
     def trash(self, dashboard_id: str):
-        """Trash dashboard.
-
-        Trash a dashboard.
+        """Trash a dashboard.
 
         :param dashboard_id: str
           UUID identifying the dashboard.
@@ -2554,9 +2484,7 @@ class LakeviewAPI:
         self._api.do("DELETE", f"/api/2.0/lakeview/dashboards/{dashboard_id}", headers=headers)
 
     def unpublish(self, dashboard_id: str):
-        """Unpublish dashboard.
-
-        Unpublish the dashboard.
+        """Unpublish the dashboard.
 
         :param dashboard_id: str
           UUID identifying the published dashboard.
@@ -2571,9 +2499,7 @@ class LakeviewAPI:
         self._api.do("DELETE", f"/api/2.0/lakeview/dashboards/{dashboard_id}/published", headers=headers)
 
     def update(self, dashboard_id: str, dashboard: Dashboard) -> Dashboard:
-        """Update dashboard.
-
-        Update a draft dashboard.
+        """Update a draft dashboard.
 
         :param dashboard_id: str
           UUID identifying the dashboard.
@@ -2598,6 +2524,7 @@ class LakeviewAPI:
         :param schedule_id: str
           UUID identifying the schedule.
         :param schedule: :class:`Schedule`
+          The schedule to update.
 
         :returns: :class:`Schedule`
         """
@@ -2622,9 +2549,7 @@ class LakeviewEmbeddedAPI:
     def get_published_dashboard_token_info(
         self, dashboard_id: str, *, external_value: Optional[str] = None, external_viewer_id: Optional[str] = None
     ) -> GetPublishedDashboardTokenInfoResponse:
-        """Read an information of a published dashboard to mint an OAuth token.
-
-        Get a required authorization details and scopes of a published dashboard to mint an OAuth token. The
+        """Get a required authorization details and scopes of a published dashboard to mint an OAuth token. The
         `authorization_details` can be enriched to apply additional restriction.
 
         Example: Adding the following `authorization_details` object to downscope the viewer permission to