Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] Add Data Plane access documentation #732

Merged
merged 1 commit into from
Aug 30, 2024
Merged

[Doc] Add Data Plane access documentation #732

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/dataplane.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Data Plane APIs

Some APIs such as Model Serving support direct Data Plane access for higher throughput and lower latency requests.
To access Data Plane access, a dedicated short-lived OAuth token must be used. The SDK is able to generate and refresh
such tokens transparently for the user.

## Prerequisites
Databricks SDK must be configured using a supported OAuth token. For more information, see
[Supported Databricks authentication types](https://docs.databricks.com/en/dev-tools/auth/index.html)

The desired service or endpoint must have direct Data Plane access enabled.

## Usage
Databricks SDK provides a separate service to be used for Data Plane access, which includes a `_data_plane` suffix.
This service contains the subset of the methods for the original service which are supported in the Data Plane.

Example:

```python
from databricks.sdk import WorkspaceClient
# Control Plane
w = WorkspaceClient()
w.serving_endpoints.query(...)
# Data Plane
w.serving_endpoints_data_plane.query(...)
```

Loading