alicloud-ai-search-dashvector
Original:🇺🇸 English
Translated
1 scriptsChecked / no sensitive code detected
Build vector retrieval with DashVector using the Python SDK. Use when creating collections, upserting docs, and running similarity search with filters in Claude Code/Codex.
3installs
Sourcecinience/alicloud-skills
Added on
NPX Install
npx skill4agent add cinience/alicloud-skills alicloud-ai-search-dashvectorTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Category: provider
DashVector Vector Search
Use DashVector to manage collections and perform vector similarity search with optional filters and sparse vectors.
Prerequisites
- Install SDK (recommended in a venv to avoid PEP 668 limits):
bash
python3 -m venv .venv
. .venv/bin/activate
python -m pip install dashvector- Provide credentials and endpoint via environment variables:
DASHVECTOR_API_KEY- (cluster endpoint)
DASHVECTOR_ENDPOINT
Normalized operations
Create collection
- (str)
name - (int)
dimension - (str:
metric|cosine|dotproduct)euclidean - (optional dict of field types)
fields_schema
Upsert docs
- list of
docsor tuples{id, vector, fields} - Supports and multi-vector collections
sparse_vector
Query docs
- or
vector(one required; if both empty, only filter is applied)id - (int)
topk - (SQL-like where clause)
filter - (list of field names)
output_fields - (bool)
include_vector
Quickstart (Python SDK)
python
import os
import dashvector
from dashvector import Doc
client = dashvector.Client(
api_key=os.getenv("DASHVECTOR_API_KEY"),
endpoint=os.getenv("DASHVECTOR_ENDPOINT"),
)
# 1) Create a collection
ret = client.create(
name="docs",
dimension=768,
metric="cosine",
fields_schema={"title": str, "source": str, "chunk": int},
)
assert ret
# 2) Upsert docs
collection = client.get(name="docs")
ret = collection.upsert(
[
Doc(id="1", vector=[0.01] * 768, fields={"title": "Intro", "source": "kb", "chunk": 0}),
Doc(id="2", vector=[0.02] * 768, fields={"title": "FAQ", "source": "kb", "chunk": 1}),
]
)
assert ret
# 3) Query
ret = collection.query(
vector=[0.01] * 768,
topk=5,
filter="source = 'kb' AND chunk >= 0",
output_fields=["title", "source", "chunk"],
include_vector=False,
)
for doc in ret:
print(doc.id, doc.fields)Script quickstart
bash
python skills/ai/search/alicloud-ai-search-dashvector/scripts/quickstart.pyEnvironment variables:
DASHVECTOR_API_KEYDASHVECTOR_ENDPOINT- (optional)
DASHVECTOR_COLLECTION - (optional)
DASHVECTOR_DIMENSION
Optional args: , , , .
--collection--dimension--topk--filterNotes for Claude Code/Codex
- Prefer for idempotent ingestion.
upsert - Keep aligned to your embedding model output size.
dimension - Use filters to enforce tenant or dataset scoping.
- If using sparse vectors, pass when upserting/querying.
sparse_vector={token_id: weight, ...}
Error handling
- 401/403: invalid
DASHVECTOR_API_KEY - 400: invalid collection schema or dimension mismatch
- 429/5xx: retry with exponential backoff
References
-
DashVector Python SDK:,
Client.create,Collection.upsertCollection.query -
Source list:
references/sources.md