Skip to content

feat(vector-search): migrate to databricks-ai-search SDK, add filtering reference#571

Open
jiayi-wu-3150 wants to merge 1 commit into
databricks-solutions:mainfrom
jiayi-wu-3150:update/ai-search-sdk-migration
Open

feat(vector-search): migrate to databricks-ai-search SDK, add filtering reference#571
jiayi-wu-3150 wants to merge 1 commit into
databricks-solutions:mainfrom
jiayi-wu-3150:update/ai-search-sdk-migration

Conversation

@jiayi-wu-3150

Copy link
Copy Markdown

Summary

  • Migrate all Python SDK code from deprecated WorkspaceClient.vector_search_* / VectorSearchClient APIs to AISearchClient from databricks-ai-search (SDK migration reference)
  • Add filtering.md — new comprehensive filter operator reference for Standard (dict) and Storage-Optimized (SQL string) endpoints
  • Add DatabricksReranker section to search-modes.md (~10% quality gain, ~1.5s overhead)
  • Add Performance & Capacity section to troubleshooting-and-operations.md with SLA targets, sizing guidance, OAuth vs PAT performance, and debug_level=1 latency breakdown
  • Update product name references to "AI Search (formerly Vector Search)" throughout

Files changed

File Change
SKILL.md AISearchClient flat-param API; unified filters= parameter; Installation section; filtering.md reference added
index-types.md create_delta_sync_index/create_direct_access_index flat params; index.upsert(list)/index.delete(primary_keys) replacing inputs_json/schema_json
search-modes.md index.similarity_search(); lowercase query_type values ("hybrid" not "HYBRID"); filters_json removed; DatabricksReranker section added
end-to-end-rag.md AISearchClient in agent example; unified filters= syntax; lowercase query_type
troubleshooting-and-operations.md client.get_endpoint/get_index, index.sync/describe; Performance & Capacity section; 429 error row added
filtering.md New file — full operator reference for both endpoint types

Notes

  • All changes are grounded in the official Databricks AI Search documentation
  • CLI commands (databricks vector-search-endpoints, databricks vector-search-indexes) are unchanged — official CLI docs have not been updated yet

Test plan

This pull request and its description were written by Isaac.

…ng reference

Replace deprecated databricks-sdk WorkspaceClient vector_search_* APIs and
databricks-vectorsearch VectorSearchClient with AISearchClient from the
databricks-ai-search package across all skill files.

Key changes:
- SKILL.md: AISearchClient flat-param API, unified filters= parameter, add
  Installation section and filtering.md reference
- index-types.md: flat create_delta_sync_index/create_direct_access_index,
  index.upsert(list)/index.delete(primary_keys) instead of inputs_json/schema_json
- search-modes.md: index.similarity_search(), lowercase query_type values
  ("hybrid" not "HYBRID"), drop filters_json, add DatabricksReranker section
- end-to-end-rag.md: AISearchClient in agent example, unified filters= syntax
- troubleshooting-and-operations.md: client.get_endpoint/get_index, index.sync/
  describe, add Performance & Capacity section with SLA targets and debug_level
- filtering.md: new file with full operator reference for Standard (dict) and
  Storage-Optimized (SQL string) filter syntax

Co-authored-by: Isaac
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant