Skip to content

Commit 4200540

Browse files
committed
Update docs for renamed products (AI Search, Lakeflow, Git folders)
Follow-up to review feedback on #153: update renamed Databricks products in hand-maintained docs, keeping directory/file names and bundle resource types (vector_search_*) unchanged for link and config compatibility. - Vector Search -> AI Search (vector_search_product_discovery example); notes that resource types keep the legacy vector_search_* names - Delta Live Tables -> Lakeflow Spark Declarative Pipelines (pipeline_with_schema) - Databricks Workflows -> Lakeflow Jobs; UI references -> Jobs & Pipelines - Databricks Repos -> Git folders (mlops_stacks docs) - Point links for moved docs pages at their current locations Deliberately untouched: - default_python, default_sql, dbt_sql, lakeflow_pipelines_*, default_minimal, pydabs: regenerated wholesale from databricks/cli templates by scripts/update_from_templates.sh; the CLI templates still emit "Databricks asset bundle" wording, so that rename belongs in databricks/cli followed by a template refresh here - conftest.py dlt warning filters (must match the runtime warning text) - SDK identifiers (w.lakeview.*) and YAML resource type keys 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent e6d00cb commit 4200540

12 files changed

Lines changed: 30 additions & 26 deletions

File tree

contrib/job_with_ai_parse_document/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Source Documents (UC Volume)
6363

6464
5. **Upload documents** to your source volume
6565

66-
6. **Run job** from the Databricks UI (Workflows)
66+
6. **Run job** from the Databricks UI (Jobs & Pipelines)
6767

6868
## Configuration
6969

@@ -172,7 +172,7 @@ The included notebook visualizes parsing results with interactive bounding boxes
172172
## Resources
173173
174174
- [Declarative Automation Bundles](https://docs.databricks.com/dev-tools/bundles/)
175-
- [Databricks Workflows](https://docs.databricks.com/workflows/)
175+
- [Lakeflow Jobs](https://docs.databricks.com/aws/en/jobs/)
176176
- [Structured Streaming](https://docs.databricks.com/structured-streaming/)
177177
- [`ai_parse_document` Function](https://docs.databricks.com/aws/en/sql/language-manual/functions/ai_parse_document)
178178
- [`ai_query` Function](https://docs.databricks.com/aws/en/sql/language-manual/functions/ai_query)

contrib/templates/default-scala/template/{{.project_name}}/README.md.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The '{{.project_name}}' project was generated by using the default-scala templat
2121
This deploys everything that's defined for this project.
2222
For example, the default template would deploy a job called
2323
`[dev yourname] {{.project_name}}_job` to your workspace.
24-
You can find that job by opening your workspace and clicking on **Workflows**.
24+
You can find that job by opening your workspace and clicking on **Jobs & Pipelines**.
2525

2626
4. Similarly, to deploy a production copy, type:
2727
```

knowledge_base/job_backfill_data/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ with this project. You can also use the CLI:
6060
(Note: "dev" is the default target, so `--target` is optional.)
6161

6262
This deploys everything defined for this project, including the job
63-
`[dev yourname] sql_backfill_example`. You can find it under **Workflows** (or **Jobs & Pipelines**) in your workspace.
63+
`[dev yourname] sql_backfill_example`. You can find it under **Jobs & Pipelines** in your workspace.
6464

6565
3. To run the job with the default `run_date`:
6666
```

knowledge_base/pipeline_with_schema/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Pipeline with a dedicated Unity Catalog schema
22

3-
This example demonstrates how to define a Unity Catalog schema and a Delta Live Tables pipeline that uses it.
3+
This example demonstrates how to define a Unity Catalog schema and a [Lakeflow Spark Declarative Pipelines](https://docs.databricks.com/aws/en/dlt/) pipeline that uses it.
44

55
## Prerequisites
66

knowledge_base/serverless_job/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This Declarative Automation Bundles example demonstrates how to define a job that runs on serverless compute.
44

5-
For more information, please refer to the [documentation](https://docs.databricks.com/en/workflows/jobs/how-to/use-bundles-with-jobs.html#configure-a-job-that-uses-serverless-compute).
5+
For more information, please refer to the [documentation](https://docs.databricks.com/aws/en/dev-tools/bundles/jobs-tutorial).
66

77
## Prerequisites
88

knowledge_base/vector_search_product_discovery/README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Vector Search: Semantic Product Discovery
1+
# AI Search: Semantic Product Discovery
22

33
A Declarative Automation Bundle demonstrating semantic product search using
4-
[Databricks Vector Search](https://docs.databricks.com/en/generative-ai/vector-search.html).
5-
It automates the full setup — the Unity Catalog schema, the Vector Search endpoint and
4+
[Databricks AI Search](https://docs.databricks.com/aws/en/ai-search/ai-search) (formerly
5+
Vector Search).
6+
It automates the full setup — the Unity Catalog schema, the AI Search endpoint and
67
index, and the jobs that load and query the catalog — so a single `databricks bundle deploy`
78
gives you a working semantic-search example to explore and adapt.
89

@@ -22,7 +23,7 @@ products in vector space.
2223
```
2324
data/products.json (synced to workspace by bundle deploy)
2425
↓ embed descriptions → upsert_data()
25-
product_index (Direct Access Vector Search index)
26+
product_index (Direct Access AI Search index)
2627
↓ embed query → similarity_search(query_vector=...)
2728
ranked results
2829
```
@@ -36,7 +37,7 @@ ranked results
3637
│ └── products.json # Product catalog — synced to the workspace on deploy
3738
├── resources/
3839
│ ├── schema.yml # Unity Catalog schema that namespaces the index
39-
│ ├── vector-search-endpoint.yml # Vector Search endpoint (managed ANN serving)
40+
│ ├── vector-search-endpoint.yml # AI Search endpoint (managed ANN serving)
4041
│ ├── vector-search-index.yml # Direct Access index — schema defined inline
4142
│ ├── setup-job.yml # Job: embed product descriptions and upsert them
4243
│ └── query-job.yml # Job: embed a query and return ranked results
@@ -45,6 +46,9 @@ ranked results
4546
└── 02_query_demo.py # Semantic search — runs as a job or interactively
4647
```
4748

49+
Bundle resource types are unchanged by the rename to AI Search: the endpoint and index
50+
are still declared as `vector_search_endpoints` and `vector_search_indexes`.
51+
4852
## Prerequisites
4953

5054
- Databricks workspace with Unity Catalog enabled
@@ -69,7 +73,7 @@ ranked results
6973
you — and several people can deploy into the same workspace without colliding. Use
7074
`databricks bundle deploy --target prod` for the shared production copy.
7175

72-
> Vector Search endpoint creation takes a few minutes to reach ONLINE status.
76+
> AI Search endpoint creation takes a few minutes to reach ONLINE status.
7377
7478
4. Load the catalog by running the bundle. This embeds all product descriptions and upserts them into the index.
7579
```bash
@@ -103,7 +107,7 @@ databricks bundle deploy \
103107
|---|---|---|
104108
| `catalog` | `main` | Existing Unity Catalog catalog |
105109
| `schema` | `product_search` | Schema created by the bundle |
106-
| `endpoint_name` | `product-search-endpoint` | Vector Search endpoint name. Shared in prod; the `dev` target overrides it per user. |
110+
| `endpoint_name` | `product-search-endpoint` | AI Search endpoint name. Shared in prod; the `dev` target overrides it per user. |
107111
| `embedding_model` | `databricks-gte-large-en` | Foundation model used for embeddings |
108112
| `embedding_dimension` | `1024` | Vector dimension. Drives both the index and the embedding requests; immutable after the index is created. |
109113

@@ -150,6 +154,6 @@ table and it keeps itself up to date. Replace `index_type: DIRECT_ACCESS` and
150154

151155
## Resources
152156

153-
- [Databricks Vector Search](https://docs.databricks.com/en/generative-ai/vector-search.html)
157+
- [Databricks AI Search](https://docs.databricks.com/aws/en/ai-search/ai-search)
154158
- [Declarative Automation Bundles](https://docs.databricks.com/dev-tools/bundles/)
155159
- [Foundation Models — GTE Large](https://docs.databricks.com/en/machine-learning/foundation-models/supported-models.html)

knowledge_base/vector_search_product_discovery/databricks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ variables:
1212
description: Unity Catalog schema name for the product search use case
1313
default: product_search
1414
endpoint_name:
15-
description: Name of the Vector Search endpoint
15+
description: Name of the AI Search endpoint
1616
default: product-search-endpoint
1717
embedding_model:
1818
description: Model serving endpoint used to embed product descriptions

knowledge_base/vector_search_product_discovery/resources/setup-job.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ resources:
2424

2525
tasks:
2626
- task_key: upsert_products
27-
description: Load products from JSON, embed descriptions, and upsert into the Vector Search index
27+
description: Load products from JSON, embed descriptions, and upsert into the AI Search index
2828
environment_key: serverless_env
2929
notebook_task:
3030
notebook_path: ../src/01_upsert_products.py

knowledge_base/vector_search_product_discovery/src/01_upsert_products.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Databricks notebook source
22
# MAGIC %md
3-
# MAGIC # Upsert Products into Vector Search Index
3+
# MAGIC # Upsert Products into AI Search Index
44
# MAGIC
55
# MAGIC Reads the product catalog from the JSON file deployed with the bundle,
6-
# MAGIC embeds each product description, then upserts all records into the Vector
7-
# MAGIC Search index. Re-running is safe — upsert is idempotent on `product_id`.
6+
# MAGIC embeds each product description, then upserts all records into the AI Search
7+
# MAGIC index. Re-running is safe — upsert is idempotent on `product_id`.
88

99
# COMMAND ----------
1010

knowledge_base/vector_search_product_discovery/src/02_query_demo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# MAGIC %md
33
# MAGIC # Semantic Product Search Demo
44
# MAGIC
5-
# MAGIC Queries the Vector Search index to find products that match a natural-language
5+
# MAGIC Queries the AI Search index to find products that match a natural-language
66
# MAGIC description. Try queries that would fail keyword search — e.g. *"something to
77
# MAGIC keep my coffee hot all day"* or *"gear for sleeping outside in freezing weather"*.
88

0 commit comments

Comments
 (0)