@dbx-tools/shared-genie 0.9.38 → 0.9.43

package/src/dashboards.ts

@@ -6,20 +6,11 @@
 import { z } from "zod";
 
 export const authorizationDetailsGrantRuleSchema = z.object({
-    /**
- * @description Permission sets for dashboard are defined in iam-common/rbac-common/permission-sets/definitions/TreeStoreBasePermissionSets Ex: `permissionSets/dashboard.runner`
- */
     permission_set: z.string().optional().describe("Permission sets for dashboard are defined in iam-common/rbac-common/permission-sets/definitions/TreeStoreBasePermissionSets Ex: `permissionSets/dashboard.runner`")
 });
 
 export const cronScheduleSchema = z.object({
-    /**
- * @description A cron expression using quartz syntax. EX: `0 0 8 * * ?` represents everyday at 8am. See [Cron Trigger] for details. [Cron Trigger]: http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html
- */
     quartz_cron_expression: z.string().describe("A cron expression using quartz syntax. EX: `0 0 8 * * ?` represents everyday at 8am. See [Cron Trigger] for details. [Cron Trigger]: http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html"),
-    /**
- * @description A Java timezone id. The schedule will be resolved with respect to this timezone. See [Java TimeZone] for details. [Java TimeZone]: https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html
- */
     timezone_id: z.string().describe("A Java timezone id. The schedule will be resolved with respect to this timezone. See [Java TimeZone] for details. [Java TimeZone]: https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html")
 });
 
@@ -28,77 +19,29 @@ export const lifecycleStateSchema = z.union([z.literal("ACTIVE"), z.literal("TRA
 export const dashboardViewSchema = z.literal("DASHBOARD_VIEW_BASIC");
 
 export const deleteScheduleRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard to which the schedule belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard to which the schedule belongs."),
-    /**
- * @description The etag for the schedule. Optionally, it can be provided to verify that the schedule has not been modified from its last retrieval.
- */
     etag: z.string().optional().describe("The etag for the schedule. Optionally, it can be provided to verify that the schedule has not been modified from its last retrieval."),
-    /**
- * @description UUID identifying the schedule.
- */
     schedule_id: z.string().describe("UUID identifying the schedule.")
 });
 
 export const deleteSubscriptionRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard which the subscription belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard which the subscription belongs."),
-    /**
- * @description The etag for the subscription. Can be optionally provided to ensure that the subscription has not been modified since the last read.
- */
     etag: z.string().optional().describe("The etag for the subscription. Can be optionally provided to ensure that the subscription has not been modified since the last read."),
-    /**
- * @description UUID identifying the schedule which the subscription belongs.
- */
     schedule_id: z.string().describe("UUID identifying the schedule which the subscription belongs."),
-    /**
- * @description UUID identifying the subscription.
- */
     subscription_id: z.string().describe("UUID identifying the subscription.")
 });
 
-/**
- * @description Follow-up questions suggested by Genie
- */
 export const genieSuggestedQuestionsAttachmentSchema = z.object({
-    /**
- * @description The suggested follow-up questions
- */
     questions: z.array(z.string()).optional().describe("The suggested follow-up questions")
 });
 
 export const genieConversationSchema = z.object({
-    /**
- * @description Conversation ID
- */
     conversation_id: z.string().describe("Conversation ID"),
-    /**
- * @description Timestamp when the message was created
- */
     created_timestamp: z.number().optional().describe("Timestamp when the message was created"),
-    /**
- * @description Conversation ID. Legacy identifier, use conversation_id instead
- */
     id: z.string().describe("Conversation ID. Legacy identifier, use conversation_id instead"),
-    /**
- * @description Timestamp when the message was last updated
- */
     last_updated_timestamp: z.number().optional().describe("Timestamp when the message was last updated"),
-    /**
- * @description Genie space ID
- */
     space_id: z.string().describe("Genie space ID"),
-    /**
- * @description Conversation title
- */
     title: z.string().describe("Conversation title"),
-    /**
- * @description ID of the user who created the conversation
- */
     user_id: z.number().describe("ID of the user who created the conversation")
 });
 
@@ -109,278 +52,113 @@ export const genieConversationSummarySchema = z.object({
 });
 
 export const genieCreateConversationMessageRequestSchema = z.object({
-    /**
- * @description User message content.
- */
     content: z.string().describe("User message content."),
-    /**
- * @description The ID associated with the conversation.
- */
     conversation_id: z.string().describe("The ID associated with the conversation."),
-    /**
- * @description The ID associated with the Genie space where the conversation is started.
- */
     space_id: z.string().describe("The ID associated with the Genie space where the conversation is started.")
 });
 
 export const genieDeleteConversationMessageRequestSchema = z.object({
-    /**
- * @description The ID associated with the conversation.
- */
     conversation_id: z.string().describe("The ID associated with the conversation."),
-    /**
- * @description The ID associated with the message to delete.
- */
     message_id: z.string().describe("The ID associated with the message to delete."),
-    /**
- * @description The ID associated with the Genie space where the message is located.
- */
     space_id: z.string().describe("The ID associated with the Genie space where the message is located.")
 });
 
 export const genieDeleteConversationRequestSchema = z.object({
-    /**
- * @description The ID of the conversation to delete.
- */
     conversation_id: z.string().describe("The ID of the conversation to delete."),
-    /**
- * @description The ID associated with the Genie space where the conversation is located.
- */
     space_id: z.string().describe("The ID associated with the Genie space where the conversation is located.")
 });
 
 export const genieExecuteMessageAttachmentQueryRequestSchema = z.object({
-    /**
- * @description Attachment ID
- */
     attachment_id: z.string().describe("Attachment ID"),
-    /**
- * @description Conversation ID
- */
     conversation_id: z.string().describe("Conversation ID"),
-    /**
- * @description Message ID
- */
     message_id: z.string().describe("Message ID"),
-    /**
- * @description Genie space ID
- */
     space_id: z.string().describe("Genie space ID")
 });
 
 export const genieExecuteMessageQueryRequestSchema = z.object({
-    /**
- * @description Conversation ID
- */
     conversation_id: z.string().describe("Conversation ID"),
-    /**
- * @description Message ID
- */
     message_id: z.string().describe("Message ID"),
-    /**
- * @description Genie space ID
- */
     space_id: z.string().describe("Genie space ID")
 });
 
-/**
- * @description Feedback rating for Genie messages
- */
 export const genieFeedbackRatingSchema = z.union([z.literal("NEGATIVE"), z.literal("NONE"), z.literal("POSITIVE")]).describe("Feedback rating for Genie messages");
 
 export const genieGetConversationMessageRequestSchema = z.object({
-    /**
- * @description The ID associated with the target conversation.
- */
     conversation_id: z.string().describe("The ID associated with the target conversation."),
-    /**
- * @description The ID associated with the target message from the identified conversation.
- */
     message_id: z.string().describe("The ID associated with the target message from the identified conversation."),
-    /**
- * @description The ID associated with the Genie space where the target conversation is located.
- */
     space_id: z.string().describe("The ID associated with the Genie space where the target conversation is located.")
 });
 
 export const genieGetMessageAttachmentQueryResultRequestSchema = z.object({
-    /**
- * @description Attachment ID
- */
     attachment_id: z.string().describe("Attachment ID"),
-    /**
- * @description Conversation ID
- */
     conversation_id: z.string().describe("Conversation ID"),
-    /**
- * @description Message ID
- */
     message_id: z.string().describe("Message ID"),
-    /**
- * @description Genie space ID
- */
     space_id: z.string().describe("Genie space ID")
 });
 
 export const genieGetMessageQueryResultRequestSchema = z.object({
-    /**
- * @description Conversation ID
- */
     conversation_id: z.string().describe("Conversation ID"),
-    /**
- * @description Message ID
- */
     message_id: z.string().describe("Message ID"),
-    /**
- * @description Genie space ID
- */
     space_id: z.string().describe("Genie space ID")
 });
 
 export const genieGetMessageQueryResultResponseSchema = z.object({
-    /**
- * @description SQL Statement Execution response. See [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) for more details.
- */
     statement_response: z.unknown().optional().describe("SQL Statement Execution response. See [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) for more details.")
 });
 
 export const genieGetQueryResultByAttachmentRequestSchema = z.object({
-    /**
- * @description Attachment ID
- */
     attachment_id: z.string().describe("Attachment ID"),
-    /**
- * @description Conversation ID
- */
     conversation_id: z.string().describe("Conversation ID"),
-    /**
- * @description Message ID
- */
     message_id: z.string().describe("Message ID"),
-    /**
- * @description Genie space ID
- */
     space_id: z.string().describe("Genie space ID")
 });
 
 export const genieGetSpaceRequestSchema = z.object({
-    /**
- * @description The ID associated with the Genie space
- */
     space_id: z.string().describe("The ID associated with the Genie space")
 });
 
 export const genieListConversationMessagesRequestSchema = z.object({
-    /**
- * @description The ID of the conversation to list messages from
- */
     conversation_id: z.string().describe("The ID of the conversation to list messages from"),
-    /**
- * @description Maximum number of messages to return per page
- */
     page_size: z.number().optional().describe("Maximum number of messages to return per page"),
-    /**
- * @description Token to get the next page of results
- */
     page_token: z.string().optional().describe("Token to get the next page of results"),
-    /**
- * @description The ID associated with the Genie space where the conversation is located
- */
     space_id: z.string().describe("The ID associated with the Genie space where the conversation is located")
 });
 
 export const genieListConversationsRequestSchema = z.object({
-    /**
- * @description Include all conversations in the space across all users. Requires at least CAN MANAGE permission on the space.
- */
     include_all: z.boolean().optional().describe("Include all conversations in the space across all users. Requires at least CAN MANAGE permission on the space."),
-    /**
- * @description Maximum number of conversations to return per page
- */
     page_size: z.number().optional().describe("Maximum number of conversations to return per page"),
-    /**
- * @description Token to get the next page of results
- */
     page_token: z.string().optional().describe("Token to get the next page of results"),
-    /**
- * @description The ID of the Genie space to retrieve conversations from.
- */
     space_id: z.string().describe("The ID of the Genie space to retrieve conversations from.")
 });
 
 export const genieListConversationsResponseSchema = z.object({
-    /**
- * @description List of conversations in the Genie space
- */
     conversations: z.array(genieConversationSummarySchema).optional().describe("List of conversations in the Genie space"),
-    /**
- * @description Token to get the next page of results
- */
     next_page_token: z.string().optional().describe("Token to get the next page of results")
 });
 
 export const genieListSpacesRequestSchema = z.object({
-    /**
- * @description Maximum number of spaces to return per page
- */
     page_size: z.number().optional().describe("Maximum number of spaces to return per page"),
-    /**
- * @description Pagination token for getting the next page of results
- */
     page_token: z.string().optional().describe("Pagination token for getting the next page of results")
 });
 
 export const genieSpaceSchema = z.object({
-    /**
- * @description Description of the Genie Space
- */
     description: z.string().optional().describe("Description of the Genie Space"),
-    /**
- * @description Genie space ID
- */
     space_id: z.string().describe("Genie space ID"),
-    /**
- * @description Title of the Genie Space
- */
     title: z.string().describe("Title of the Genie Space"),
-    /**
- * @description Warehouse associated with the Genie Space
- */
     warehouse_id: z.string().optional().describe("Warehouse associated with the Genie Space")
 });
 
-/**
- * @description Feedback containing rating and optional comment
- */
 export const genieFeedbackSchema = z.object({
-    /**
- * @description The feedback rating
- */
     rating: genieFeedbackRatingSchema.optional().describe("The feedback rating")
 });
 
 export const resultSchema = z.object({
-    /**
- * @description If result is truncated
- */
     is_truncated: z.boolean().optional().describe("If result is truncated"),
-    /**
- * @description Row count of the result
- */
     row_count: z.number().optional().describe("Row count of the result"),
-    /**
- * @description Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data.
- */
     statement_id: z.string().optional().describe("Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data."),
-    /**
- * @description JWT corresponding to the statement contained in this result
- */
     statement_id_signature: z.string().optional().describe("JWT corresponding to the statement contained in this result")
 });
 
-/**
- * @description 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.
- */
 export const messageStatusSchema = z.union([z.literal("ASKING_AI"), z.literal("CANCELLED"), z.literal("COMPLETED"), z.literal("EXECUTING_QUERY"), z.literal("FAILED"), z.literal("FETCHING_METADATA"), z.literal("FILTERING_CONTEXT"), z.literal("PENDING_WAREHOUSE"), z.literal("QUERY_RESULT_EXPIRED"), z.literal("SUBMITTED")]).describe("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.");
 
 export const queryAttachmentParameterSchema = z.object({
@@ -390,368 +168,152 @@ export const queryAttachmentParameterSchema = z.object({
 });
 
 export const genieResultMetadataSchema = z.object({
-    /**
- * @description Indicates whether the result set is truncated.
- */
     is_truncated: z.boolean().optional().describe("Indicates whether the result set is truncated."),
-    /**
- * @description The number of rows in the result set.
- */
     row_count: z.number().optional().describe("The number of rows in the result set.")
 });
 
 export const genieSendMessageFeedbackRequestSchema = z.object({
-    /**
- * @description The ID associated with the conversation.
- */
     conversation_id: z.string().describe("The ID associated with the conversation."),
-    /**
- * @description The ID associated with the message to provide feedback for.
- */
     message_id: z.string().describe("The ID associated with the message to provide feedback for."),
-    /**
- * @description The rating (POSITIVE, NEGATIVE, or NONE).
- */
     rating: genieFeedbackRatingSchema.describe("The rating (POSITIVE, NEGATIVE, or NONE)."),
-    /**
- * @description The ID associated with the Genie space where the message is located.
- */
     space_id: z.string().describe("The ID associated with the Genie space where the message is located.")
 });
 
 export const genieStartConversationMessageRequestSchema = z.object({
-    /**
- * @description The text of the message that starts the conversation.
- */
     content: z.string().describe("The text of the message that starts the conversation."),
-    /**
- * @description The ID associated with the Genie space where you want to start a conversation.
- */
     space_id: z.string().describe("The ID associated with the Genie space where you want to start a conversation.")
 });
 
 export const genieTrashSpaceRequestSchema = z.object({
-    /**
- * @description The ID associated with the Genie space to be sent to the trash.
- */
     space_id: z.string().describe("The ID associated with the Genie space to be sent to the trash.")
 });
 
 export const getDashboardRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard.")
 });
 
 export const getPublishedDashboardRequestSchema = z.object({
-    /**
- * @description UUID identifying the published dashboard.
- */
     dashboard_id: z.string().describe("UUID identifying the published dashboard.")
 });
 
 export const getPublishedDashboardTokenInfoRequestSchema = z.object({
-    /**
- * @description UUID identifying the published dashboard.
- */
     dashboard_id: z.string().describe("UUID identifying the published dashboard."),
-    /**
- * @description Provided external value to be included in the custom claim.
- */
     external_value: z.string().optional().describe("Provided external value to be included in the custom claim."),
-    /**
- * @description Provided external viewer id to be included in the custom claim.
- */
     external_viewer_id: z.string().optional().describe("Provided external viewer id to be included in the custom claim.")
 });
 
 export const authorizationDetailsSchema = z.object({
-    /**
- * @description Represents downscoped permission rules with specific access rights. This field is specific to `workspace_rule_set` constraint.
- */
     grant_rules: z.array(authorizationDetailsGrantRuleSchema).optional().describe("Represents downscoped permission rules with specific access rights. This field is specific to `workspace_rule_set` constraint."),
-    /**
- * @description The acl path of the tree store resource resource.
- */
     resource_legacy_acl_path: z.string().optional().describe("The acl path of the tree store resource resource."),
-    /**
- * @description The resource name to which the authorization rule applies. This field is specific to `workspace_rule_set` constraint. Format: `workspaces/{workspace_id}/dashboards/{dashboard_id}`
- */
     resource_name: z.string().optional().describe("The resource name to which the authorization rule applies. This field is specific to `workspace_rule_set` constraint. Format: `workspaces/{workspace_id}/dashboards/{dashboard_id}`"),
-    /**
- * @description The type of authorization downscoping policy. Ex: `workspace_rule_set` defines access rules for a specific workspace resource
- */
     type: z.string().optional().describe("The type of authorization downscoping policy. Ex: `workspace_rule_set` defines access rules for a specific workspace resource")
 });
 
 export const getScheduleRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard to which the schedule belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard to which the schedule belongs."),
-    /**
- * @description UUID identifying the schedule.
- */
     schedule_id: z.string().describe("UUID identifying the schedule.")
 });
 
 export const getSubscriptionRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard which the subscription belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard which the subscription belongs."),
-    /**
- * @description UUID identifying the schedule which the subscription belongs.
- */
     schedule_id: z.string().describe("UUID identifying the schedule which the subscription belongs."),
-    /**
- * @description UUID identifying the subscription.
- */
     subscription_id: z.string().describe("UUID identifying the subscription.")
 });
 
 export const listDashboardsRequestSchema = z.object({
-    /**
- * @description The number of dashboards to return per page.
- */
     page_size: z.number().optional().describe("The number of dashboards to return per page."),
-    /**
- * @description A page token, received from a previous `ListDashboards` call. This token can be used to retrieve the subsequent page.
- */
     page_token: z.string().optional().describe("A page token, received from a previous `ListDashboards` call. This token can be used to retrieve the subsequent page."),
-    /**
- * @description The flag to include dashboards located in the trash. If unspecified, only active dashboards will be returned.
- */
     show_trashed: z.boolean().optional().describe("The flag to include dashboards located in the trash. If unspecified, only active dashboards will be returned."),
-    /**
- * @description `DASHBOARD_VIEW_BASIC`only includes summary metadata from the dashboard.
- */
     view: dashboardViewSchema.optional().describe("`DASHBOARD_VIEW_BASIC`only includes summary metadata from the dashboard.")
 });
 
 export const dashboardSchema = z.object({
-    /**
- * @description The timestamp of when the dashboard was created.
- */
     create_time: z.string().optional().describe("The timestamp of when the dashboard was created."),
-    /**
- * @description UUID identifying the dashboard.
- */
     dashboard_id: z.string().optional().describe("UUID identifying the dashboard."),
-    /**
- * @description The display name of the dashboard.
- */
     display_name: z.string().optional().describe("The display name of the dashboard."),
-    /**
- * @description The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard has not been modified since the last read. This field is excluded in List Dashboards responses.
- */
     etag: z.string().optional().describe("The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard has not been modified since the last read. This field is excluded in List Dashboards responses."),
-    /**
- * @description The state of the dashboard resource. Used for tracking trashed status.
- */
     lifecycle_state: lifecycleStateSchema.optional().describe("The state of the dashboard resource. Used for tracking trashed status."),
-    /**
- * @description The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash. This field is excluded in List Dashboards responses.
- */
     parent_path: z.string().optional().describe("The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash. This field is excluded in List Dashboards responses."),
-    /**
- * @description The workspace path of the dashboard asset, including the file name. Exported dashboards always have the file extension `.lvdash.json`. This field is excluded in List Dashboards responses.
- */
     path: z.string().optional().describe("The workspace path of the dashboard asset, including the file name. Exported dashboards always have the file extension `.lvdash.json`. This field is excluded in List Dashboards responses."),
-    /**
- * @description The contents of the dashboard in serialized string form. This field is excluded in List Dashboards responses. Use the [get dashboard API] to retrieve an example response, which includes the `serialized_dashboard` field. This field provides the structure of the JSON string that represents the dashboard's layout and components. [get dashboard API]: https://docs.databricks.com/api/workspace/lakeview/get
- */
     serialized_dashboard: z.string().optional().describe("The contents of the dashboard in serialized string form. This field is excluded in List Dashboards responses. Use the [get dashboard API] to retrieve an example response, which includes the `serialized_dashboard` field. This field provides the structure of the JSON string that represents the dashboard's layout and components. [get dashboard API]: https://docs.databricks.com/api/workspace/lakeview/get"),
-    /**
- * @description The timestamp of when the dashboard was last updated by the user. This field is excluded in List Dashboards responses.
- */
     update_time: z.string().optional().describe("The timestamp of when the dashboard was last updated by the user. This field is excluded in List Dashboards responses."),
-    /**
- * @description The warehouse ID used to run the dashboard.
- */
     warehouse_id: z.string().optional().describe("The warehouse ID used to run the dashboard.")
 });
 
 export const listSchedulesRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard to which the schedules belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard to which the schedules belongs."),
-    /**
- * @description The number of schedules to return per page.
- */
     page_size: z.number().optional().describe("The number of schedules to return per page."),
-    /**
- * @description A page token, received from a previous `ListSchedules` call. Use this to retrieve the subsequent page.
- */
     page_token: z.string().optional().describe("A page token, received from a previous `ListSchedules` call. Use this to retrieve the subsequent page.")
 });
 
 export const listSubscriptionsRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard which the subscriptions belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard which the subscriptions belongs."),
-    /**
- * @description The number of subscriptions to return per page.
- */
     page_size: z.number().optional().describe("The number of subscriptions to return per page."),
-    /**
- * @description A page token, received from a previous `ListSubscriptions` call. Use this to retrieve the subsequent page.
- */
     page_token: z.string().optional().describe("A page token, received from a previous `ListSubscriptions` call. Use this to retrieve the subsequent page."),
-    /**
- * @description UUID identifying the schedule which the subscriptions belongs.
- */
     schedule_id: z.string().describe("UUID identifying the schedule which the subscriptions belongs.")
 });
 
 export const messageErrorTypeSchema = z.union([z.literal("BLOCK_MULTIPLE_EXECUTIONS_EXCEPTION"), z.literal("CHAT_COMPLETION_CLIENT_EXCEPTION"), z.literal("CHAT_COMPLETION_CLIENT_TIMEOUT_EXCEPTION"), z.literal("CHAT_COMPLETION_NETWORK_EXCEPTION"), z.literal("CONTENT_FILTER_EXCEPTION"), z.literal("CONTEXT_EXCEEDED_EXCEPTION"), z.literal("COULD_NOT_GET_MODEL_DEPLOYMENTS_EXCEPTION"), z.literal("COULD_NOT_GET_UC_SCHEMA_EXCEPTION"), z.literal("DEPLOYMENT_NOT_FOUND_EXCEPTION"), z.literal("DESCRIBE_QUERY_INVALID_SQL_ERROR"), z.literal("DESCRIBE_QUERY_TIMEOUT"), z.literal("DESCRIBE_QUERY_UNEXPECTED_FAILURE"), z.literal("EXCEEDED_MAX_TOKEN_LENGTH_EXCEPTION"), z.literal("FUNCTIONS_NOT_AVAILABLE_EXCEPTION"), z.literal("FUNCTION_ARGUMENTS_INVALID_EXCEPTION"), z.literal("FUNCTION_ARGUMENTS_INVALID_JSON_EXCEPTION"), z.literal("FUNCTION_ARGUMENTS_INVALID_TYPE_EXCEPTION"), z.literal("FUNCTION_CALL_MISSING_PARAMETER_EXCEPTION"), z.literal("GENERATED_SQL_QUERY_TOO_LONG_EXCEPTION"), z.literal("GENERIC_CHAT_COMPLETION_EXCEPTION"), z.literal("GENERIC_CHAT_COMPLETION_SERVICE_EXCEPTION"), z.literal("GENERIC_SQL_EXEC_API_CALL_EXCEPTION"), z.literal("ILLEGAL_PARAMETER_DEFINITION_EXCEPTION"), z.literal("INTERNAL_CATALOG_ASSET_CREATION_FAILED_EXCEPTION"), z.literal("INTERNAL_CATALOG_ASSET_CREATION_ONGOING_EXCEPTION"), z.literal("INTERNAL_CATALOG_ASSET_CREATION_UNSUPPORTED_EXCEPTION"), z.literal("INTERNAL_CATALOG_MISSING_UC_PATH_EXCEPTION"), z.literal("INTERNAL_CATALOG_PATH_OVERLAP_EXCEPTION"), z.literal("INVALID_CERTIFIED_ANSWER_FUNCTION_EXCEPTION"), z.literal("INVALID_CERTIFIED_ANSWER_IDENTIFIER_EXCEPTION"), z.literal("INVALID_CHAT_COMPLETION_ARGUMENTS_JSON_EXCEPTION"), z.literal("INVALID_CHAT_COMPLETION_JSON_EXCEPTION"), z.literal("INVALID_COMPLETION_REQUEST_EXCEPTION"), z.literal("INVALID_FUNCTION_CALL_EXCEPTION"), z.literal("INVALID_SQL_MULTIPLE_DATASET_REFERENCES_EXCEPTION"), z.literal("INVALID_SQL_MULTIPLE_STATEMENTS_EXCEPTION"), z.literal("INVALID_SQL_UNKNOWN_TABLE_EXCEPTION"), z.literal("INVALID_TABLE_IDENTIFIER_EXCEPTION"), z.literal("LOCAL_CONTEXT_EXCEEDED_EXCEPTION"), z.literal("MESSAGE_ATTACHMENT_TOO_LONG_ERROR"), z.literal("MESSAGE_CANCELLED_WHILE_EXECUTING_EXCEPTION"), z.literal("MESSAGE_DELETED_WHILE_EXECUTING_EXCEPTION"), z.literal("MESSAGE_UPDATED_WHILE_EXECUTING_EXCEPTION"), z.literal("MISSING_SQL_QUERY_EXCEPTION"), z.literal("NO_DEPLOYMENTS_AVAILABLE_TO_WORKSPACE"), z.literal("NO_QUERY_TO_VISUALIZE_EXCEPTION"), z.literal("NO_TABLES_TO_QUERY_EXCEPTION"), z.literal("RATE_LIMIT_EXCEEDED_GENERIC_EXCEPTION"), z.literal("RATE_LIMIT_EXCEEDED_SPECIFIED_WAIT_EXCEPTION"), z.literal("REPLY_PROCESS_TIMEOUT_EXCEPTION"), z.literal("RETRYABLE_PROCESSING_EXCEPTION"), z.literal("SQL_EXECUTION_EXCEPTION"), z.literal("STOP_PROCESS_DUE_TO_AUTO_REGENERATE"), z.literal("TABLES_MISSING_EXCEPTION"), z.literal("TOO_MANY_CERTIFIED_ANSWERS_EXCEPTION"), z.literal("TOO_MANY_TABLES_EXCEPTION"), z.literal("UNEXPECTED_REPLY_PROCESS_EXCEPTION"), z.literal("UNKNOWN_AI_MODEL"), z.literal("UNSUPPORTED_CONVERSATION_TYPE_EXCEPTION"), z.literal("WAREHOUSE_ACCESS_MISSING_EXCEPTION"), z.literal("WAREHOUSE_NOT_FOUND_EXCEPTION")]);
 
 export const migrateDashboardRequestSchema = z.object({
-    /**
- * @description Display name for the new Lakeview dashboard.
- */
     display_name: z.string().optional().describe("Display name for the new Lakeview dashboard."),
-    /**
- * @description The workspace path of the folder to contain the migrated Lakeview dashboard.
- */
     parent_path: z.string().optional().describe("The workspace path of the folder to contain the migrated Lakeview dashboard."),
-    /**
- * @description UUID of the dashboard to be migrated.
- */
     source_dashboard_id: z.string().describe("UUID of the dashboard to be migrated."),
-    /**
- * @description Flag to indicate if mustache parameter syntax ({{ param }}) should be auto-updated to named syntax (:param) when converting datasets in the dashboard.
- */
     update_parameter_syntax: z.boolean().optional().describe("Flag to indicate if mustache parameter syntax ({{ param }}) should be auto-updated to named syntax (:param) when converting datasets in the dashboard.")
 });
 
 export const publishRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard to be published.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard to be published."),
-    /**
- * @description Flag to indicate if the publisher's credentials should be embedded in the published dashboard. These embedded credentials will be used to execute the published dashboard's queries.
- */
     embed_credentials: z.boolean().optional().describe("Flag to indicate if the publisher's credentials should be embedded in the published dashboard. These embedded credentials will be used to execute the published dashboard's queries."),
-    /**
- * @description The ID of the warehouse that can be used to override the warehouse which was set in the draft.
- */
     warehouse_id: z.string().optional().describe("The ID of the warehouse that can be used to override the warehouse which was set in the draft.")
 });
 
 export const publishedDashboardSchema = z.object({
-    /**
- * @description The display name of the published dashboard.
- */
     display_name: z.string().optional().describe("The display name of the published dashboard."),
-    /**
- * @description Indicates whether credentials are embedded in the published dashboard.
- */
     embed_credentials: z.boolean().optional().describe("Indicates whether credentials are embedded in the published dashboard."),
-    /**
- * @description The timestamp of when the published dashboard was last revised.
- */
     revision_create_time: z.string().optional().describe("The timestamp of when the published dashboard was last revised."),
-    /**
- * @description The warehouse ID used to run the published dashboard.
- */
     warehouse_id: z.string().optional().describe("The warehouse ID used to run the published dashboard.")
 });
 
 export const schedulePauseStatusSchema = z.union([z.literal("PAUSED"), z.literal("UNPAUSED")]);
 
 export const subscriptionSubscriberDestinationSchema = z.object({
-    /**
- * @description The canonical identifier of the destination to receive email notification.
- */
     destination_id: z.string().describe("The canonical identifier of the destination to receive email notification.")
 });
 
 export const subscriptionSubscriberUserSchema = z.object({
-    /**
- * @description UserId of the subscriber.
- */
     user_id: z.number().describe("UserId of the subscriber.")
 });
 
 export const subscriberSchema = z.object({
-    /**
- * @description The destination to receive the subscription email. This parameter is mutually exclusive with `user_subscriber`.
- */
     destination_subscriber: subscriptionSubscriberDestinationSchema.optional().describe("The destination to receive the subscription email. This parameter is mutually exclusive with `user_subscriber`."),
-    /**
- * @description The user to receive the subscription email. This parameter is mutually exclusive with `destination_subscriber`.
- */
     user_subscriber: subscriptionSubscriberUserSchema.optional().describe("The user to receive the subscription email. This parameter is mutually exclusive with `destination_subscriber`.")
 });
 
-/**
- * @description Purpose/intent of a text attachment
- */
 export const textAttachmentPurposeSchema = z.literal("FOLLOW_UP_QUESTION").describe("Purpose/intent of a text attachment");
 
 export const trashDashboardRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard.")
 });
 
 export const unpublishDashboardRequestSchema = z.object({
-    /**
- * @description UUID identifying the published dashboard.
- */
     dashboard_id: z.string().describe("UUID identifying the published dashboard.")
 });
 
 export const updateDashboardRequestSchema = z.object({
     dashboard: dashboardSchema,
-    /**
- * @description UUID identifying the dashboard.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard.")
 });
 
 export const scheduleSchema = z.object({
-    /**
- * @description A timestamp indicating when the schedule was created.
- */
     create_time: z.string().optional().describe("A timestamp indicating when the schedule was created."),
-    /**
- * @description The cron expression describing the frequency of the periodic refresh for this schedule.
- */
     cron_schedule: cronScheduleSchema.describe("The cron expression describing the frequency of the periodic refresh for this schedule."),
-    /**
- * @description UUID identifying the dashboard to which the schedule belongs.
- */
     dashboard_id: z.string().optional().describe("UUID identifying the dashboard to which the schedule belongs."),
-    /**
- * @description The display name for schedule.
- */
     display_name: z.string().optional().describe("The display name for schedule."),
-    /**
- * @description The etag for the schedule. Must be left empty on create, must be provided on updates to ensure that the schedule has not been modified since the last read, and can be optionally provided on delete.
- */
     etag: z.string().optional().describe("The etag for the schedule. Must be left empty on create, must be provided on updates to ensure that the schedule has not been modified since the last read, and can be optionally provided on delete."),
-    /**
- * @description The status indicates whether this schedule is paused or not.
- */
     pause_status: schedulePauseStatusSchema.optional().describe("The status indicates whether this schedule is paused or not."),
-    /**
- * @description UUID identifying the schedule.
- */
     schedule_id: z.string().optional().describe("UUID identifying the schedule."),
-    /**
- * @description A timestamp indicating when the schedule was last updated.
- */
     update_time: z.string().optional().describe("A timestamp indicating when the schedule was last updated."),
-    /**
- * @description The warehouse id to run the dashboard with for the schedule.
- */
     warehouse_id: z.string().optional().describe("The warehouse id to run the dashboard with for the schedule.")
 });
 
@@ -760,122 +322,47 @@ export const createDashboardRequestSchema = z.object({
 });
 
 export const createScheduleRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard to which the schedule belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard to which the schedule belongs."),
-    /**
- * @description The schedule to create. A dashboard is limited to 10 schedules.
- */
     schedule: scheduleSchema.describe("The schedule to create. A dashboard is limited to 10 schedules.")
 });
 
 export const subscriptionSchema = z.object({
-    /**
- * @description A timestamp indicating when the subscription was created.
- */
     create_time: z.string().optional().describe("A timestamp indicating when the subscription was created."),
-    /**
- * @description UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule.
- */
     created_by_user_id: z.number().optional().describe("UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule."),
-    /**
- * @description UUID identifying the dashboard to which the subscription belongs.
- */
     dashboard_id: z.string().optional().describe("UUID identifying the dashboard to which the subscription belongs."),
-    /**
- * @description The etag for the subscription. Must be left empty on create, can be optionally provided on delete to ensure that the subscription has not been deleted since the last read.
- */
     etag: z.string().optional().describe("The etag for the subscription. Must be left empty on create, can be optionally provided on delete to ensure that the subscription has not been deleted since the last read."),
-    /**
- * @description UUID identifying the schedule to which the subscription belongs.
- */
     schedule_id: z.string().optional().describe("UUID identifying the schedule to which the subscription belongs."),
-    /**
- * @description Subscriber details for users and destinations to be added as subscribers to the schedule.
- */
     subscriber: subscriberSchema.describe("Subscriber details for users and destinations to be added as subscribers to the schedule."),
-    /**
- * @description UUID identifying the subscription.
- */
     subscription_id: z.string().optional().describe("UUID identifying the subscription."),
-    /**
- * @description A timestamp indicating when the subscription was last updated.
- */
     update_time: z.string().optional().describe("A timestamp indicating when the subscription was last updated.")
 });
 
 export const genieQueryAttachmentSchema = z.object({
-    /**
- * @description Description of the query
- */
     description: z.string().optional().describe("Description of the query"),
     id: z.string().optional(),
-    /**
- * @description Time when the user updated the query last
- */
     last_updated_timestamp: z.number().optional().describe("Time when the user updated the query last"),
     parameters: z.array(queryAttachmentParameterSchema).optional(),
-    /**
- * @description AI generated SQL query
- */
     query: z.string().optional().describe("AI generated SQL query"),
-    /**
- * @description Metadata associated with the query result.
- */
     query_result_metadata: genieResultMetadataSchema.optional().describe("Metadata associated with the query result."),
-    /**
- * @description Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data.
- */
     statement_id: z.string().optional().describe("Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data."),
-    /**
- * @description Name of the query
- */
     title: z.string().optional().describe("Name of the query")
 });
 
 export const textAttachmentSchema = z.object({
-    /**
- * @description AI generated message
- */
     content: z.string().optional().describe("AI generated message"),
     id: z.string().optional(),
-    /**
- * @description Purpose/intent of this text attachment
- */
     purpose: textAttachmentPurposeSchema.optional().describe("Purpose/intent of this text attachment")
 });
 
 export const genieListSpacesResponseSchema = z.object({
-    /**
- * @description Token to get the next page of results
- */
     next_page_token: z.string().optional().describe("Token to get the next page of results"),
-    /**
- * @description List of Genie spaces
- */
     spaces: z.array(genieSpaceSchema).optional().describe("List of Genie spaces")
 });
 
-/**
- * @description Genie AI Response
- */
 export const genieAttachmentSchema = z.object({
-    /**
- * @description Attachment ID
- */
     attachment_id: z.string().optional().describe("Attachment ID"),
-    /**
- * @description Query Attachment if Genie responds with a SQL query
- */
     query: genieQueryAttachmentSchema.optional().describe("Query Attachment if Genie responds with a SQL query"),
-    /**
- * @description Follow-up questions suggested by Genie
- */
     suggested_questions: genieSuggestedQuestionsAttachmentSchema.optional().describe("Follow-up questions suggested by Genie"),
-    /**
- * @description Text Attachment if Genie responds with text
- */
     text: textAttachmentSchema.optional().describe("Text Attachment if Genie responds with text")
 });
 
@@ -885,150 +372,63 @@ export const messageErrorSchema = z.object({
 });
 
 export const genieMessageSchema = z.object({
-    /**
- * @description AI-generated response to the message
- */
     attachments: z.array(genieAttachmentSchema).optional().describe("AI-generated response to the message"),
-    /**
- * @description User message content
- */
     content: z.string().describe("User message content"),
-    /**
- * @description Conversation ID
- */
     conversation_id: z.string().describe("Conversation ID"),
-    /**
- * @description Timestamp when the message was created
- */
     created_timestamp: z.number().optional().describe("Timestamp when the message was created"),
-    /**
- * @description Error message if Genie failed to respond to the message
- */
     error: messageErrorSchema.optional().describe("Error message if Genie failed to respond to the message"),
-    /**
- * @description User feedback for the message if provided
- */
     feedback: genieFeedbackSchema.optional().describe("User feedback for the message if provided"),
-    /**
- * @description Message ID. Legacy identifier, use message_id instead
- */
     id: z.string().describe("Message ID. Legacy identifier, use message_id instead"),
-    /**
- * @description Timestamp when the message was last updated
- */
     last_updated_timestamp: z.number().optional().describe("Timestamp when the message was last updated"),
-    /**
- * @description Message ID
- */
     message_id: z.string().describe("Message ID"),
-    /**
- * @description The result of SQL query if the message includes a query attachment. Deprecated. Use `query_result_metadata` in `GenieQueryAttachment` instead.
- */
     query_result: resultSchema.optional().describe("The result of SQL query if the message includes a query attachment. Deprecated. Use `query_result_metadata` in `GenieQueryAttachment` instead."),
-    /**
- * @description Genie space ID
- */
     space_id: z.string().describe("Genie space ID"),
-    /**
- * @description 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.
- */
     status: messageStatusSchema.optional().describe("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."),
-    /**
- * @description ID of the user who created the message
- */
     user_id: z.number().optional().describe("ID of the user who created the message")
 });
 
 export const getPublishedDashboardTokenInfoResponseSchema = z.object({
-    /**
- * @description Authorization constraints for accessing the published dashboard. Currently includes `workspace_rule_set` and could be enriched with `unity_catalog_privileges` before oAuth token generation.
- */
     authorization_details: z.array(authorizationDetailsSchema).optional().describe("Authorization constraints for accessing the published dashboard. Currently includes `workspace_rule_set` and could be enriched with `unity_catalog_privileges` before oAuth token generation."),
-    /**
- * @description Custom claim generated from external_value and external_viewer_id. Format: `urn:aibi:external_data:<external_value>:<external_viewer_id>:<dashboard_id>`
- */
     custom_claim: z.string().optional().describe("Custom claim generated from external_value and external_viewer_id. Format: `urn:aibi:external_data:<external_value>:<external_viewer_id>:<dashboard_id>`"),
-    /**
- * @description Scope defining access permissions.
- */
     scope: z.string().optional().describe("Scope defining access permissions.")
 });
 
 export const listDashboardsResponseSchema = z.object({
     dashboards: z.array(dashboardSchema).optional(),
-    /**
- * @description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent dashboards.
- */
     next_page_token: z.string().optional().describe("A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent dashboards.")
 });
 
 export const listSchedulesResponseSchema = z.object({
-    /**
- * @description A token that can be used as a `page_token` in subsequent requests to retrieve the next page of results. If this field is omitted, there are no subsequent schedules.
- */
     next_page_token: z.string().optional().describe("A token that can be used as a `page_token` in subsequent requests to retrieve the next page of results. If this field is omitted, there are no subsequent schedules."),
     schedules: z.array(scheduleSchema).optional()
 });
 
 export const listSubscriptionsResponseSchema = z.object({
-    /**
- * @description A token that can be used as a `page_token` in subsequent requests to retrieve the next page of results. If this field is omitted, there are no subsequent subscriptions.
- */
     next_page_token: z.string().optional().describe("A token that can be used as a `page_token` in subsequent requests to retrieve the next page of results. If this field is omitted, there are no subsequent subscriptions."),
     subscriptions: z.array(subscriptionSchema).optional()
 });
 
 export const updateScheduleRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard to which the schedule belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard to which the schedule belongs."),
-    /**
- * @description The schedule to update.
- */
     schedule: scheduleSchema.describe("The schedule to update."),
-    /**
- * @description UUID identifying the schedule.
- */
     schedule_id: z.string().describe("UUID identifying the schedule.")
 });
 
 export const createSubscriptionRequestSchema = z.object({
-    /**
- * @description UUID identifying the dashboard to which the subscription belongs.
- */
     dashboard_id: z.string().describe("UUID identifying the dashboard to which the subscription belongs."),
-    /**
- * @description UUID identifying the schedule to which the subscription belongs.
- */
     schedule_id: z.string().describe("UUID identifying the schedule to which the subscription belongs."),
-    /**
- * @description The subscription to create. A schedule is limited to 100 subscriptions.
- */
     subscription: subscriptionSchema.describe("The subscription to create. A schedule is limited to 100 subscriptions.")
 });
 
 export const genieListConversationMessagesResponseSchema = z.object({
-    /**
- * @description List of messages in the conversation.
- */
     messages: z.array(genieMessageSchema).optional().describe("List of messages in the conversation."),
-    /**
- * @description The token to use for retrieving the next page of results.
- */
     next_page_token: z.string().optional().describe("The token to use for retrieving the next page of results.")
 });
 
 export const genieStartConversationResponseSchema = z.object({
     conversation: genieConversationSchema.optional(),
-    /**
- * @description Conversation ID
- */
     conversation_id: z.string().describe("Conversation ID"),
     message: genieMessageSchema.optional(),
-    /**
- * @description Message ID
- */
     message_id: z.string().describe("Message ID")
 });