Skip to content

Commit 2a3e5b9

Browse files
authored
Update product suite (#204)
* Initial pass * More sanitization and clarity fixes
1 parent b2aab77 commit 2a3e5b9

50 files changed

Lines changed: 180 additions & 775 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/api-reference/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Python, Typescript and Rust SDKs are officially supported by LanceDB. You can us
2727

2828
<Badge color="red">Enterprise</Badge>
2929

30-
REST API-based SDKs provide a convenient way to interact with LanceDB Cloud and Enterprise deployments using the Lance REST Namespace API.
30+
REST API-based SDKs provide a convenient way to interact with LanceDB Enterprise deployments using the Lance REST Namespace API.
3131

3232
| Reference | Description |
3333
|:--------------|-------------------|

docs/api-reference/rest/index.mdx

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,64 +10,68 @@ is an OpenAPI protocol that enables reading, writing and managing Lance tables b
1010
those metadata services or building a custom metadata server in a standardized way.
1111

1212
LanceDB OSS allows you to interface with Lance tables via the REST Namespace.
13-
However, LanceDB's Cloud and Enterprise products provide an extended REST API with
14-
additional endpoints for managing projects, tables, and data.
15-
If you have specific needs or questions about the Enterprise/Cloud REST API Namespace,
13+
LanceDB Enterprise provides an extended REST API with
14+
additional endpoints for managing tables and data.
15+
If you have specific needs or questions about the Enterprise REST API Namespace,
1616
please [contact us](mailto:support@lancedb.com).
1717

1818
## Authentication
1919

20-
<Badge color="blue">Cloud</Badge>
2120
<Badge color="red">Enterprise</Badge>
2221

2322
All HTTP requests to LanceDB APIs must contain an <u>x-api-key</u> header that specifies a valid API key and
2423
must be encoded as JSON or Arrow RPC.
2524

26-
The tutorial below demonstrates how to connect to LanceDB Cloud using the REST API.
25+
To authenticate to the Enterprise REST API, you need the endpoint for your deployment and a valid API key for that deployment.
2726

28-
### Get the API Key
27+
### Get your Enterprise credentials
2928

30-
1. Go to [LanceDB Cloud](https://accounts.lancedb.com/sign-up) and complete the onboarding.
29+
1. Obtain the following values from your LanceDB administrator or the LanceDB team that provisioned your Enterprise deployment:
30+
- an API key
31+
- your Enterprise REST endpoint
32+
- your database name, if your deployment uses a private endpoint or `host_override`
3133

32-
![create](/static/assets/images/api-reference/create.png)
34+
2. Export those values in your terminal:
3335

34-
2. Let's call this particular **Project** `embedding`.
35-
3. Save the API key and the project instance name: `embedding-yhs6bg`.
36+
```bash
37+
export LANCEDB_API_KEY="<your-api-key>"
38+
export LANCEDB_URI="https://your-enterprise-endpoint.com"
39+
export LANCEDB_DATABASE="your-database-name"
40+
```
3641

37-
This is how the Project looks in the LanceDB Cloud Dashboard:
38-
![projects](/static/assets/images/api-reference/projects.png)
42+
3. If your Enterprise deployment is private, connect through the private network endpoint provided for your deployment. For example, Azure Private Link deployments commonly use a private IP or an internal DNS name as the endpoint.
3943

40-
4. In your terminal, check the existence of the remote **Project**. Specify the remote LanceDB **Project** `db` and `region`.
44+
### Verify authentication
45+
46+
4. Check that you can reach the deployment and list tables:
4147

4248
```bash
43-
curl -X GET "https://{db}.{region}.api.lancedb.com/v1/tables" \
49+
curl -X GET "$LANCEDB_URI/v1/tables" \
4450
-H "Content-Type: application/json" \
45-
-H "x-api-key: LANCEDB_API_KEY"
51+
-H "x-api-key: $LANCEDB_API_KEY" \
52+
-H "x-lancedb-database: $LANCEDB_DATABASE"
4653
```
4754

48-
5. Now, create a **Table** to store data. Let's call it `words`.
55+
If your deployment endpoint already includes the database host name, you can omit the `x-lancedb-database` header.
56+
57+
5. Create a table to confirm write access. Let's call it `words`.
4958

5059
```bash
51-
curl -X POST "https://embedding-yhs6bg.us-east-1.api.lancedb.com/v1/tables/words" \
60+
curl -X POST "$LANCEDB_URI/v1/tables/words" \
5261
-H "Content-Type: application/vnd.apache.arrow.stream" \
53-
-H "x-api-key: LANCEDB_API_KEY"
62+
-H "x-api-key: $LANCEDB_API_KEY" \
63+
-H "x-lancedb-database: $LANCEDB_DATABASE"
5464
```
55-
- the `db` is `embedding-yhs6bg`
56-
- the `region` is `us-east-1`
57-
- the name of the table is `words`.
5865

59-
6. Now check that the **Table has** been created:
66+
6. Check that the table has been created:
6067

6168
```bash
62-
curl -X GET "https://embedding-yhs6bg.us-east-1.api.lancedb.com/v1/tables" \
69+
curl -X GET "$LANCEDB_URI/v1/tables" \
6370
-H "Content-Type: application/json" \
64-
-H "x-api-key: LANCEDB_API_KEY"
71+
-H "x-api-key: $LANCEDB_API_KEY" \
72+
-H "x-lancedb-database: $LANCEDB_DATABASE"
6573
```
6674

67-
You can always check from the LanceDB Cloud Dashboard:
68-
69-
![words](/static/assets/images/api-reference/words.png)
70-
7175
That's it -- you're connected! Now, you can start adding data and querying it.
7276
You can visit the tutorial section to build your own applications with LanceDB.
7377

@@ -78,5 +82,3 @@ You can visit the tutorial section to build your own applications with LanceDB.
7882
>
7983
Check out our tutorials on building various applications with LanceDB.
8084
</Card>
81-
82-

0 commit comments

Comments
 (0)