Skip to content

Commit

Permalink
[Doc] Add Data Plane access documentation (#732)
Browse files Browse the repository at this point in the history
## Changes
Add Data Plane access documentation

## Tests
<!-- 
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->

- [ ] `make test` run locally
- [ ] `make fmt` applied
- [ ] relevant integration tests applied
  • Loading branch information
hectorcast-db committed Aug 30, 2024
1 parent b36a7b9 commit 1ccbcd2
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/dataplane.md
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(...)
```

0 comments on commit 1ccbcd2

Please sign in to comment.