From f0aa22de62f752a77bd67c9c40f20da01979ecea Mon Sep 17 00:00:00 2001 From: "databricks-ci-ghec-1[bot]" <184311507+databricks-ci-ghec-1[bot]@users.noreply.github.com> Date: Thu, 10 Sep 2026 04:16:58 +0000 Subject: [PATCH] Release databricks-sdk-py --- .codegen/_last_sha | 2 +- CHANGELOG.md | 8 ++ databricks/sdk/service/aifunctions.py | 11 ++- databricks/sdk/service/catalog.py | 13 +-- databricks/sdk/service/compute.py | 2 +- databricks/sdk/service/jobs.py | 10 ++ databricks/sdk/service/ml.py | 92 +++++++++++++++++++ databricks/sdk/service/pipelines.py | 7 ++ databricks/sdk/service/sandbox.py | 2 +- databricks/sdk/service/sql.py | 2 +- databricks/sdk/service/tags.py | 18 ++-- databricks/sdk/version.py | 2 +- docs/dbdataclasses/compute.rst | 2 +- docs/dbdataclasses/ml.rst | 8 ++ docs/dbdataclasses/sql.rst | 2 +- docs/workspace/aifunctions/ai_functions.rst | 11 ++- docs/workspace/catalog/ai_gateway.rst | 9 +- docs/workspace/catalog/model_versions.rst | 4 +- docs/workspace/pipelines/pipelines.rst | 6 +- .../tags/workspace_entity_tag_assignments.rst | 16 ++-- 20 files changed, 180 insertions(+), 47 deletions(-) mode change 100755 => 100644 docs/workspace/catalog/model_versions.rst mode change 100755 => 100644 docs/workspace/tags/workspace_entity_tag_assignments.rst diff --git a/.codegen/_last_sha b/.codegen/_last_sha index e44f2b9eb..a7263c9d5 100644 --- a/.codegen/_last_sha +++ b/.codegen/_last_sha @@ -1 +1 @@ -d4a68ff2811115e3aeb9d7e148ff9b4efb6e2a15 \ No newline at end of file +1be65bf808bb8c9084188c53218d71fa3a4b22e9 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index d703535e0..597862c01 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Version changelog +## Release v0.138.0 (2026-09-10) + +### API Changes +* Add `unity_catalog_image_path` field for `databricks.sdk.service.jobs.AiRuntimeTask`. +* Add `feature_view_source` field for `databricks.sdk.service.ml.DataSource`. +* Add `budget_policy_id` and `tags` fields for `databricks.sdk.service.ml.PublishSpec`. +* Add `development` field for `databricks.sdk.service.pipelines.StartUpdate`. + ## Release v0.137.0 (2026-09-09) ### API Changes diff --git a/databricks/sdk/service/aifunctions.py b/databricks/sdk/service/aifunctions.py index 7c00d79d8..04ab3dc9a 100644 --- a/databricks/sdk/service/aifunctions.py +++ b/databricks/sdk/service/aifunctions.py @@ -632,7 +632,9 @@ def __init__(self, api_client): def ai_classify( self, content: any, labels: any, *, options: Optional[AiClassifyOptions] = None ) -> AiClassifyResponse: - """Classifies content according to a set of provided labels. + """Classifies content according to a set of provided labels. For REST API requests, the default rate + limit is 1,200 requests per minute per workspace. Contact your Databricks account team to request a + higher limit. :param content: any The content to classify. It accepts a plain string or the response object of @@ -667,7 +669,9 @@ def ai_classify( return AiClassifyResponse.from_dict(res) def ai_extract(self, content: any, schema: any, *, options: Optional[AiExtractOptions] = None) -> AiExtractResponse: - """Extracts structured data from text and documents according to a provided schema. + """Extracts structured data from text and documents according to a provided schema. For REST API + requests, the default rate limit is 120 requests per minute per workspace. Contact your Databricks + account team to request a higher limit. :param content: any The text to extract from. It accepts a plain string or the response object of @@ -706,7 +710,8 @@ def ai_extract(self, content: any, schema: any, *, options: Optional[AiExtractOp def ai_parse_document( self, content: str, *, options: Optional[AiParseDocumentOptions] = None ) -> AiParseDocumentResponse: - """Parse structured content from unstructured documents. + """Parse structured content from unstructured documents. For REST API requests, the default rate limit is + 120 pages per minute per workspace. Contact your Databricks account team to request a higher limit. :param content: str The document to parse, given as a Unity Catalog volume path to the source file (the REST API accepts diff --git a/databricks/sdk/service/catalog.py b/databricks/sdk/service/catalog.py index e9982a128..66a621934 100644 --- a/databricks/sdk/service/catalog.py +++ b/databricks/sdk/service/catalog.py @@ -14307,8 +14307,7 @@ def update_mcp_service( Fields to update. Use ``config`` to replace the entire configuration. The replacement must include every required field; any optional field you omit is cleared. To preserve sibling fields, use one or more granular paths: ``comment``, ``config.source_connection.name``, - ``config.include_tool_selectors``, or ``config.rate_limits``. Wildcard paths such as ``*`` are not - supported. + ``config.include_tool_selectors``, or ``config.rate_limits``. :param etag: str (optional) Optimistic concurrency token from the most recent read. When set, the update succeeds only if the resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the @@ -14369,8 +14368,7 @@ def update_model_provider_service( (for example, ``config.openai``; the mask path remains ``config.provider``); ``config.allow_all_targets``, ``config.targets``, ``config.forward_headers``, ``config.forward_query_parameters``, ``config.forward_unmanaged_paths``, ``config.rate_limits``, or - ``config.inference_table``. The provider type is immutable, and wildcard paths such as ``*`` are not - supported. + ``config.inference_table``. The provider type is immutable. :param etag: str (optional) Optimistic concurrency token from the most recent read. When set, the update succeeds only if the resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the @@ -14424,8 +14422,7 @@ def update_model_service( every required field; any optional field you omit is cleared. To preserve sibling fields, use one or more granular paths: ``comment``, ``config.routing.destinations``, ``config.routing.fallback.destinations``, ``config.rate_limits``, or ``config.inference_table``. - Intermediate paths such as ``config.routing`` and ``config.routing.fallback``, and wildcard paths - such as ``*``, are not supported. + Intermediate paths such as ``config.routing`` and ``config.routing.fallback`` are not supported. :param etag: str (optional) Optimistic concurrency token from the most recent read. When set, the update succeeds only if the resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the @@ -17299,8 +17296,8 @@ def list( max_results: Optional[int] = None, page_token: Optional[str] = None, ) -> Iterator[ModelVersionInfo]: - """List model versions. You can list model versions under a particular schema, or list all model versions - in the current metastore. + """List the model versions of the specified registered model, identified by its full three-level name + (catalog.schema.model). The returned models are filtered based on the privileges of the calling user. For example, the metastore admin is able to list all the model versions. A regular user needs to be the owner or have diff --git a/databricks/sdk/service/compute.py b/databricks/sdk/service/compute.py index 14c5cd36e..5a07f08c9 100644 --- a/databricks/sdk/service/compute.py +++ b/databricks/sdk/service/compute.py @@ -7804,7 +7804,7 @@ def from_dict(cls, d: Dict[str, Any]) -> TerminationReason: class TerminationReasonCode(Enum): - """The status code indicating why the cluster was terminated""" + """The status code indicating why the cluster was terminated.""" ABUSE_DETECTED = "ABUSE_DETECTED" ACCESS_TOKEN_FAILURE = "ACCESS_TOKEN_FAILURE" diff --git a/databricks/sdk/service/jobs.py b/databricks/sdk/service/jobs.py index 13facd994..ea792926c 100644 --- a/databricks/sdk/service/jobs.py +++ b/databricks/sdk/service/jobs.py @@ -81,6 +81,11 @@ class AiRuntimeTask: """Optional display name for the MLflow run created under ``experiment``. If omitted, MLflow generates a default name.""" + unity_catalog_image_path: Optional[str] = None + """Optional Unity Catalog path for a custom container image. When set, the task runs on the + specified container image instead of the default Databricks client image. Format: + ``{catalog}.{schema}.{image_name}:{tag}``""" + def as_dict(self) -> dict: """Serializes the AiRuntimeTask into a dictionary suitable for use as a JSON request body.""" body = {} @@ -98,6 +103,8 @@ def as_dict(self) -> dict: body["mlflow_experiment_directory"] = self.mlflow_experiment_directory if self.mlflow_run is not None: body["mlflow_run"] = self.mlflow_run + if self.unity_catalog_image_path is not None: + body["unity_catalog_image_path"] = self.unity_catalog_image_path return body def as_shallow_dict(self) -> dict: @@ -117,6 +124,8 @@ def as_shallow_dict(self) -> dict: body["mlflow_experiment_directory"] = self.mlflow_experiment_directory if self.mlflow_run is not None: body["mlflow_run"] = self.mlflow_run + if self.unity_catalog_image_path is not None: + body["unity_catalog_image_path"] = self.unity_catalog_image_path return body @classmethod @@ -130,6 +139,7 @@ def from_dict(cls, d: Dict[str, Any]) -> AiRuntimeTask: mlflow_artifact_location=d.get("mlflow_artifact_location", None), mlflow_experiment_directory=d.get("mlflow_experiment_directory", None), mlflow_run=d.get("mlflow_run", None), + unity_catalog_image_path=d.get("unity_catalog_image_path", None), ) diff --git a/databricks/sdk/service/ml.py b/databricks/sdk/service/ml.py index 64c87379b..cdcdc1e8b 100644 --- a/databricks/sdk/service/ml.py +++ b/databricks/sdk/service/ml.py @@ -1214,6 +1214,9 @@ class DataSource: delta_table_source: Optional[DeltaTableSource] = None """A Delta table data source.""" + feature_view_source: Optional[FeatureViewSource] = None + """A data source composed from registered upstream Features.""" + kafka_source: Optional[KafkaSource] = None """A Kafka stream data source.""" @@ -1232,6 +1235,8 @@ def as_dict(self) -> dict: body = {} if self.delta_table_source: body["delta_table_source"] = self.delta_table_source.as_dict() + if self.feature_view_source: + body["feature_view_source"] = self.feature_view_source.as_dict() if self.kafka_source: body["kafka_source"] = self.kafka_source.as_dict() if self.lateness: @@ -1247,6 +1252,8 @@ def as_shallow_dict(self) -> dict: body = {} if self.delta_table_source: body["delta_table_source"] = self.delta_table_source + if self.feature_view_source: + body["feature_view_source"] = self.feature_view_source if self.kafka_source: body["kafka_source"] = self.kafka_source if self.lateness: @@ -1262,6 +1269,7 @@ def from_dict(cls, d: Dict[str, Any]) -> DataSource: """Deserializes the DataSource from a dictionary.""" return cls( delta_table_source=_from_dict(d, "delta_table_source", DeltaTableSource), + feature_view_source=_from_dict(d, "feature_view_source", FeatureViewSource), kafka_source=_from_dict(d, "kafka_source", KafkaSource), lateness=_from_dict(d, "lateness", SourceLateness), request_source=_from_dict(d, "request_source", RequestSource), @@ -2616,6 +2624,34 @@ def from_dict(cls, d: Dict[str, Any]) -> FeatureList: return cls(features=_repeated_dict(d, "features", LinkedFeature)) +@dataclass +class FeatureReference: + """A reference to one registered upstream Feature. A message rather than a bare name so an upstream + can later be pinned more precisely (e.g. by version) without a breaking type change.""" + + feature: str + """The three-part full name of the upstream Feature.""" + + def as_dict(self) -> dict: + """Serializes the FeatureReference into a dictionary suitable for use as a JSON request body.""" + body = {} + if self.feature is not None: + body["feature"] = self.feature + return body + + def as_shallow_dict(self) -> dict: + """Serializes the FeatureReference into a shallow dictionary of its immediate attributes.""" + body = {} + if self.feature is not None: + body["feature"] = self.feature + return body + + @classmethod + def from_dict(cls, d: Dict[str, Any]) -> FeatureReference: + """Deserializes the FeatureReference from a dictionary.""" + return cls(feature=d.get("feature", None)) + + @dataclass class FeatureTag: """Represents a tag on a feature in a feature table.""" @@ -2648,6 +2684,33 @@ def from_dict(cls, d: Dict[str, Any]) -> FeatureTag: return cls(key=d.get("key", None), value=d.get("value", None)) +@dataclass +class FeatureViewSource: + """A data source composed from registered upstream Features.""" + + feature_references: Optional[List[FeatureReference]] = None + """The upstream Features this source reads. Must include at least one feature.""" + + def as_dict(self) -> dict: + """Serializes the FeatureViewSource into a dictionary suitable for use as a JSON request body.""" + body = {} + if self.feature_references: + body["feature_references"] = [v.as_dict() for v in self.feature_references] + return body + + def as_shallow_dict(self) -> dict: + """Serializes the FeatureViewSource into a shallow dictionary of its immediate attributes.""" + body = {} + if self.feature_references: + body["feature_references"] = self.feature_references + return body + + @classmethod + def from_dict(cls, d: Dict[str, Any]) -> FeatureViewSource: + """Deserializes the FeatureViewSource from a dictionary.""" + return cls(feature_references=_repeated_dict(d, "feature_references", FeatureReference)) + + @dataclass class FieldDefinition: """A single field definition within a FlatSchema, specifying the field name and its scalar data @@ -6306,14 +6369,27 @@ class PublishSpec: publish_mode: PublishSpecPublishMode """The publish mode of the pipeline that syncs the online table with the source table.""" + budget_policy_id: Optional[str] = None + """Budget policy id used to attribute the serverless compute cost of the synced online-table sync + pipeline. Applied only when the sync pipeline is first created (the initial publish of a new + online table); republishing to an existing online table does not update it.""" + full_feature_name: Optional[str] = None """Full Unity Catalog name of one of the features materialized in the source table, used to derive the synced online table's entity and timeseries columns. Required for view sources without a UC PrimaryKeyConstraint; ignored when the source already has one.""" + tags: Optional[Dict[str, str]] = None + """Custom tags to apply to the synced online-table sync pipeline created for this publish. They are + forwarded to the pipeline's compute as cluster tags so its cost can be attributed in the billing + system tables. Applied only when the sync pipeline is first created (the initial publish of a + new online table); republishing to an existing online table does not update them.""" + def as_dict(self) -> dict: """Serializes the PublishSpec into a dictionary suitable for use as a JSON request body.""" body = {} + if self.budget_policy_id is not None: + body["budget_policy_id"] = self.budget_policy_id if self.full_feature_name is not None: body["full_feature_name"] = self.full_feature_name if self.online_store is not None: @@ -6322,11 +6398,15 @@ def as_dict(self) -> dict: body["online_table_name"] = self.online_table_name if self.publish_mode is not None: body["publish_mode"] = self.publish_mode.value + if self.tags: + body["tags"] = self.tags return body def as_shallow_dict(self) -> dict: """Serializes the PublishSpec into a shallow dictionary of its immediate attributes.""" body = {} + if self.budget_policy_id is not None: + body["budget_policy_id"] = self.budget_policy_id if self.full_feature_name is not None: body["full_feature_name"] = self.full_feature_name if self.online_store is not None: @@ -6335,16 +6415,20 @@ def as_shallow_dict(self) -> dict: body["online_table_name"] = self.online_table_name if self.publish_mode is not None: body["publish_mode"] = self.publish_mode + if self.tags: + body["tags"] = self.tags return body @classmethod def from_dict(cls, d: Dict[str, Any]) -> PublishSpec: """Deserializes the PublishSpec from a dictionary.""" return cls( + budget_policy_id=d.get("budget_policy_id", None), full_feature_name=d.get("full_feature_name", None), online_store=d.get("online_store", None), online_table_name=d.get("online_table_name", None), publish_mode=_enum(d, "publish_mode", PublishSpecPublishMode), + tags=d.get("tags", None), ) @@ -6469,6 +6553,9 @@ class PurgeFeatureEntitiesMetadataState(Enum): class PurgeFeatureEntitiesResponse: """Result of a completed feature entity purge.""" + error: Optional[DatabricksServiceExceptionWithDetailsProto] = None + """Operation-level error, if the purge failed outside an individual feature target.""" + metadata: Optional[PurgeFeatureEntitiesMetadata] = None """Metadata about the purge operation.""" @@ -6481,6 +6568,8 @@ class PurgeFeatureEntitiesResponse: def as_dict(self) -> dict: """Serializes the PurgeFeatureEntitiesResponse into a dictionary suitable for use as a JSON request body.""" body = {} + if self.error: + body["error"] = self.error.as_dict() if self.metadata: body["metadata"] = self.metadata.as_dict() if self.results: @@ -6492,6 +6581,8 @@ def as_dict(self) -> dict: def as_shallow_dict(self) -> dict: """Serializes the PurgeFeatureEntitiesResponse into a shallow dictionary of its immediate attributes.""" body = {} + if self.error: + body["error"] = self.error if self.metadata: body["metadata"] = self.metadata if self.results: @@ -6504,6 +6595,7 @@ def as_shallow_dict(self) -> dict: def from_dict(cls, d: Dict[str, Any]) -> PurgeFeatureEntitiesResponse: """Deserializes the PurgeFeatureEntitiesResponse from a dictionary.""" return cls( + error=_from_dict(d, "error", DatabricksServiceExceptionWithDetailsProto), metadata=_from_dict(d, "metadata", PurgeFeatureEntitiesMetadata), results=_repeated_dict(d, "results", PurgeFeatureEntitiesResult), state=_enum(d, "state", PurgeFeatureEntitiesMetadataState), diff --git a/databricks/sdk/service/pipelines.py b/databricks/sdk/service/pipelines.py index 128eba095..591e7882d 100644 --- a/databricks/sdk/service/pipelines.py +++ b/databricks/sdk/service/pipelines.py @@ -6491,6 +6491,7 @@ def start_update( pipeline_id: str, *, cause: Optional[StartUpdateCause] = None, + development: Optional[bool] = None, full_refresh: Optional[bool] = None, full_refresh_selection: Optional[List[str]] = None, parameters: Optional[Dict[str, str]] = None, @@ -6505,6 +6506,10 @@ def start_update( :param pipeline_id: str :param cause: :class:`StartUpdateCause` (optional) + :param development: bool (optional) + Whether the update is started in the development mode. This is recommended for interactive + development and testing. Reuses compute for faster iteration and disables automatic retries. Not + recommended for production. :param full_refresh: bool (optional) If true, this update will reset all tables before running. :param full_refresh_selection: List[str] (optional) @@ -6536,6 +6541,8 @@ def start_update( body = {} if cause is not None: body["cause"] = cause.value + if development is not None: + body["development"] = development if full_refresh is not None: body["full_refresh"] = full_refresh if full_refresh_selection is not None: diff --git a/databricks/sdk/service/sandbox.py b/databricks/sdk/service/sandbox.py index c9f98b747..f5b1f88f7 100644 --- a/databricks/sdk/service/sandbox.py +++ b/databricks/sdk/service/sandbox.py @@ -177,7 +177,7 @@ class Sandbox: """Output only. The creation time of the sandbox.""" display_name: Optional[str] = None - """Human-readable display label for the sandbox. At most 256 bytes.""" + """Human-readable display label for the sandbox. At most 256 characters.""" name: Optional[str] = None """The AIP-compliant resource name, such as "sandboxes/my-sandbox".""" diff --git a/databricks/sdk/service/sql.py b/databricks/sdk/service/sql.py index d657bdfea..82aedccc0 100644 --- a/databricks/sdk/service/sql.py +++ b/databricks/sdk/service/sql.py @@ -6502,7 +6502,7 @@ def from_dict(cls, d: Dict[str, Any]) -> TerminationReason: class TerminationReasonCode(Enum): - """The status code indicating why the cluster was terminated""" + """The status code indicating why the cluster was terminated.""" ABUSE_DETECTED = "ABUSE_DETECTED" ACCESS_TOKEN_FAILURE = "ACCESS_TOKEN_FAILURE" diff --git a/databricks/sdk/service/tags.py b/databricks/sdk/service/tags.py index 1eb6f3ba4..012cd7c80 100644 --- a/databricks/sdk/service/tags.py +++ b/databricks/sdk/service/tags.py @@ -91,7 +91,7 @@ def from_dict(cls, d: Dict[str, Any]) -> ListTagPoliciesResponse: class TagAssignment: entity_type: str """The type of entity to which the tag is assigned. Allowed values are apps, dashboards, - geniespaces, notebooks""" + designerfiles, geniespaces, notebooks""" entity_id: str """The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app @@ -419,8 +419,8 @@ def delete_tag_assignment(self, entity_type: str, entity_id: str, tag_key: str): """Delete a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, - notebooks + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, designerfiles, + geniespaces, notebooks :param entity_id: str The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str @@ -445,8 +445,8 @@ def get_tag_assignment(self, entity_type: str, entity_id: str, tag_key: str) -> """Get a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, - notebooks + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, designerfiles, + geniespaces, notebooks :param entity_id: str The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str @@ -474,8 +474,8 @@ def list_tag_assignments( """List the tag assignments for an entity :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, - notebooks + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, designerfiles, + geniespaces, notebooks :param entity_id: str The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param page_size: int (optional) @@ -516,8 +516,8 @@ def update_tag_assignment( """Update a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, - notebooks + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, designerfiles, + geniespaces, notebooks :param entity_id: str The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str diff --git a/databricks/sdk/version.py b/databricks/sdk/version.py index da56c9c74..354f1bc8b 100644 --- a/databricks/sdk/version.py +++ b/databricks/sdk/version.py @@ -1 +1 @@ -__version__ = "0.137.0" +__version__ = "0.138.0" diff --git a/docs/dbdataclasses/compute.rst b/docs/dbdataclasses/compute.rst index d3f9aedf2..9e66ce456 100644 --- a/docs/dbdataclasses/compute.rst +++ b/docs/dbdataclasses/compute.rst @@ -1118,7 +1118,7 @@ These dataclasses are used in the SDK to represent API requests and responses fo .. py:class:: TerminationReasonCode - The status code indicating why the cluster was terminated + The status code indicating why the cluster was terminated. .. py:attribute:: ABUSE_DETECTED :value: "ABUSE_DETECTED" diff --git a/docs/dbdataclasses/ml.rst b/docs/dbdataclasses/ml.rst index 892de6900..ca3c47ce2 100644 --- a/docs/dbdataclasses/ml.rst +++ b/docs/dbdataclasses/ml.rst @@ -621,10 +621,18 @@ These dataclasses are used in the SDK to represent API requests and responses fo :members: :undoc-members: +.. autoclass:: FeatureReference + :members: + :undoc-members: + .. autoclass:: FeatureTag :members: :undoc-members: +.. autoclass:: FeatureViewSource + :members: + :undoc-members: + .. autoclass:: FieldDefinition :members: :undoc-members: diff --git a/docs/dbdataclasses/sql.rst b/docs/dbdataclasses/sql.rst index 42d9c2431..cf9f58e92 100644 --- a/docs/dbdataclasses/sql.rst +++ b/docs/dbdataclasses/sql.rst @@ -1127,7 +1127,7 @@ These dataclasses are used in the SDK to represent API requests and responses fo .. py:class:: TerminationReasonCode - The status code indicating why the cluster was terminated + The status code indicating why the cluster was terminated. .. py:attribute:: ABUSE_DETECTED :value: "ABUSE_DETECTED" diff --git a/docs/workspace/aifunctions/ai_functions.rst b/docs/workspace/aifunctions/ai_functions.rst index e485f259f..d2384cd07 100644 --- a/docs/workspace/aifunctions/ai_functions.rst +++ b/docs/workspace/aifunctions/ai_functions.rst @@ -8,7 +8,9 @@ .. py:method:: ai_classify(content: any, labels: any [, options: Optional[AiClassifyOptions]]) -> AiClassifyResponse - Classifies content according to a set of provided labels. + Classifies content according to a set of provided labels. For REST API requests, the default rate + limit is 1,200 requests per minute per workspace. Contact your Databricks account team to request a + higher limit. :param content: any The content to classify. It accepts a plain string or the response object of @@ -25,7 +27,9 @@ .. py:method:: ai_extract(content: any, schema: any [, options: Optional[AiExtractOptions]]) -> AiExtractResponse - Extracts structured data from text and documents according to a provided schema. + Extracts structured data from text and documents according to a provided schema. For REST API + requests, the default rate limit is 120 requests per minute per workspace. Contact your Databricks + account team to request a higher limit. :param content: any The text to extract from. It accepts a plain string or the response object of @@ -44,7 +48,8 @@ .. py:method:: ai_parse_document(content: str [, options: Optional[AiParseDocumentOptions]]) -> AiParseDocumentResponse - Parse structured content from unstructured documents. + Parse structured content from unstructured documents. For REST API requests, the default rate limit is + 120 pages per minute per workspace. Contact your Databricks account team to request a higher limit. :param content: str The document to parse, given as a Unity Catalog volume path to the source file (the REST API accepts diff --git a/docs/workspace/catalog/ai_gateway.rst b/docs/workspace/catalog/ai_gateway.rst index 653d8ee33..23e44bdf9 100644 --- a/docs/workspace/catalog/ai_gateway.rst +++ b/docs/workspace/catalog/ai_gateway.rst @@ -281,8 +281,7 @@ Fields to update. Use ``config`` to replace the entire configuration. The replacement must include every required field; any optional field you omit is cleared. To preserve sibling fields, use one or more granular paths: ``comment``, ``config.source_connection.name``, - ``config.include_tool_selectors``, or ``config.rate_limits``. Wildcard paths such as ``*`` are not - supported. + ``config.include_tool_selectors``, or ``config.rate_limits``. :param etag: str (optional) Optimistic concurrency token from the most recent read. When set, the update succeeds only if the resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the @@ -319,8 +318,7 @@ (for example, ``config.openai``; the mask path remains ``config.provider``); ``config.allow_all_targets``, ``config.targets``, ``config.forward_headers``, ``config.forward_query_parameters``, ``config.forward_unmanaged_paths``, ``config.rate_limits``, or - ``config.inference_table``. The provider type is immutable, and wildcard paths such as ``*`` are not - supported. + ``config.inference_table``. The provider type is immutable. :param etag: str (optional) Optimistic concurrency token from the most recent read. When set, the update succeeds only if the resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the @@ -355,8 +353,7 @@ every required field; any optional field you omit is cleared. To preserve sibling fields, use one or more granular paths: ``comment``, ``config.routing.destinations``, ``config.routing.fallback.destinations``, ``config.rate_limits``, or ``config.inference_table``. - Intermediate paths such as ``config.routing`` and ``config.routing.fallback``, and wildcard paths - such as ``*``, are not supported. + Intermediate paths such as ``config.routing`` and ``config.routing.fallback`` are not supported. :param etag: str (optional) Optimistic concurrency token from the most recent read. When set, the update succeeds only if the resource has not changed. Leave unset for an unconditional update. For REST requests, URL-encode the diff --git a/docs/workspace/catalog/model_versions.rst b/docs/workspace/catalog/model_versions.rst old mode 100755 new mode 100644 index a320a23fc..faed9c493 --- a/docs/workspace/catalog/model_versions.rst +++ b/docs/workspace/catalog/model_versions.rst @@ -69,8 +69,8 @@ .. py:method:: list(full_name: str [, include_browse: Optional[bool], max_results: Optional[int], page_token: Optional[str]]) -> Iterator[ModelVersionInfo] - List model versions. You can list model versions under a particular schema, or list all model versions - in the current metastore. + List the model versions of the specified registered model, identified by its full three-level name + (catalog.schema.model). The returned models are filtered based on the privileges of the calling user. For example, the metastore admin is able to list all the model versions. A regular user needs to be the owner or have diff --git a/docs/workspace/pipelines/pipelines.rst b/docs/workspace/pipelines/pipelines.rst index 161beed7d..db6005427 100644 --- a/docs/workspace/pipelines/pipelines.rst +++ b/docs/workspace/pipelines/pipelines.rst @@ -464,13 +464,17 @@ :returns: :class:`PipelinePermissions` - .. py:method:: start_update(pipeline_id: str [, cause: Optional[StartUpdateCause], full_refresh: Optional[bool], full_refresh_selection: Optional[List[str]], parameters: Optional[Dict[str, str]], refresh_selection: Optional[List[str]], replace_where_overrides: Optional[List[ReplaceWhereOverride]], reset_checkpoint_selection: Optional[List[str]], rewind_spec: Optional[RewindSpec], validate_only: Optional[bool]]) -> StartUpdateResponse + .. py:method:: start_update(pipeline_id: str [, cause: Optional[StartUpdateCause], development: Optional[bool], full_refresh: Optional[bool], full_refresh_selection: Optional[List[str]], parameters: Optional[Dict[str, str]], refresh_selection: Optional[List[str]], replace_where_overrides: Optional[List[ReplaceWhereOverride]], reset_checkpoint_selection: Optional[List[str]], rewind_spec: Optional[RewindSpec], validate_only: Optional[bool]]) -> StartUpdateResponse Starts a new update for the pipeline. If there is already an active update for the pipeline, the request will fail and the active update will remain running. :param pipeline_id: str :param cause: :class:`StartUpdateCause` (optional) + :param development: bool (optional) + Whether the update is started in the development mode. This is recommended for interactive + development and testing. Reuses compute for faster iteration and disables automatic retries. Not + recommended for production. :param full_refresh: bool (optional) If true, this update will reset all tables before running. :param full_refresh_selection: List[str] (optional) diff --git a/docs/workspace/tags/workspace_entity_tag_assignments.rst b/docs/workspace/tags/workspace_entity_tag_assignments.rst old mode 100755 new mode 100644 index c8d7d8c85..e91770687 --- a/docs/workspace/tags/workspace_entity_tag_assignments.rst +++ b/docs/workspace/tags/workspace_entity_tag_assignments.rst @@ -20,8 +20,8 @@ Delete a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, - notebooks + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, designerfiles, + geniespaces, notebooks :param entity_id: str The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str @@ -35,8 +35,8 @@ Get a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, - notebooks + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, designerfiles, + geniespaces, notebooks :param entity_id: str The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str @@ -50,8 +50,8 @@ List the tag assignments for an entity :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, - notebooks + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, designerfiles, + geniespaces, notebooks :param entity_id: str The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param page_size: int (optional) @@ -67,8 +67,8 @@ Update a tag assignment :param entity_type: str - The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, - notebooks + The type of entity to which the tag is assigned. Allowed values are apps, dashboards, designerfiles, + geniespaces, notebooks :param entity_id: str The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name :param tag_key: str