vector-search

name	vector-search
description	Runs VECTOR_SEARCH against the Customer Experience retrieval indexes (moz-fx-data-shared-prod.customer_experience_derived) and returns the top-K most semantically similar documents. Use after the embed skill has produced an embedding file.

Vector Search Skill

Queries a Customer Experience retrieval index using a pre-computed embedding vector and returns the closest matching documents via cosine similarity.

This skill is locked to moz-fx-data-shared-prod.customer_experience_derived — it can read any table or view in that dataset, and anything outside it is rejected (a static allowlist check on the query, backed by the service account's IAM, which grants read access to that dataset only). Table and column names must be plain identifiers; columns that don't exist are rejected by BigQuery. The embedding, dates, and filter values are passed as typed query parameters (never interpolated into SQL).

VECTOR_SEARCH does not support logical views and the date-partitioned tables (kitsune, zendesk) require a creation_date bound, so the search runs against the base table via an inline subquery that carries the date filter. Pass --date-column creation_date with --s/--e; if you omit the range, the last 7 days is used automatically.

Authentication

This skill connects to BigQuery using a service account — read-only access is enforced on the impersonated token. Just log in:

gcloud auth application-default login

Your authenticated BigQuery credentials are only used to create a new and temporary read-only access token on behalf of the service account defined in SERVICE_ACCOUNT, which requires the roles/iam.serviceAccountTokenCreator role on that service account. Your login no longer needs --scopes.

Usage

python ${CLAUDE_PLUGIN_ROOT}/skills/vector-search/scripts/vector_search.py \
  --embedding-file /tmp/embedding.json \
  --table moz-fx-data-shared-prod.customer_experience_derived.<index> \
  [--embedding-column embedding] \
  [--columns col1,col2,...] \
  [--label "Display Name"] \
  [--date-column COLUMN] \
  [--s YYYY-MM-DD] [--e YYYY-MM-DD] \
  [--filter column:value] \
  [--top-k 5]

<index> is any table or view in moz-fx-data-shared-prod.customer_experience_derived; the retrieval indexes are kitsune_retrieval_index, zendesk_retrieval_index, and knowledge_base_retrieval_index.

Arguments

Flag	Required	Description
--embedding-file	yes	Path to the JSON embedding file produced by the embed skill
--table	yes	A table or view in moz-fx-data-shared-prod.customer_experience_derived (bare table name also accepted; resolved to the locked project/dataset)
--embedding-column	no	Name of the embedding column (default: embedding)
--columns	no	Comma-separated columns to return (default: all). Must be plain identifiers that exist in the table
--label	no	Display name for the results header (default: table name)
--date-column	no	Column to apply --s / --e date filters against (e.g. creation_date)
--s	no	Start date filter YYYY-MM-DD (requires --date-column)
--e	no	End date filter YYYY-MM-DD (requires --date-column)
--filter	no	Partial-match filter as column:value. Repeatable. Scalar columns only
--top-k	no	Number of results to return (default: 5)

Output

Formatted context block printed to stdout:

=== Display Name (5 results) ===
[1]
column_a: value
column_b: value
distance: 0.28
...

Typical workflow with the embed skill

# Step 1 — embed the question
python ${CLAUDE_PLUGIN_ROOT}/skills/embed/scripts/embed.py \
  --question "What are users saying about Firefox sync?" \
  > /tmp/embedding.json

# Step 2 — search a CX index
python ${CLAUDE_PLUGIN_ROOT}/skills/vector-search/scripts/vector_search.py \
  --embedding-file /tmp/embedding.json \
  --table moz-fx-data-shared-prod.customer_experience_derived.kitsune_retrieval_index_v1 \
  --columns title,content,question_summary_llm,question_sentiment_score,product,topic \
  --label "SUMO / Kitsune" \
  --date-column creation_date \
  --s 2026-01-01 --e 2026-03-31 \
  --filter "product:Fenix" \
  --filter "locale:es"

Troubleshooting

Symptom	Fix
Authentication rejected (401) / GCP authentication required	Re-run gcloud auth application-default login; confirm you have roles/iam.serviceAccountTokenCreator on the service account in SERVICE_ACCOUNT
Missing dependency	pip install google-auth requests
Table not allowed / Invalid column	Use a table or view in moz-fx-data-shared-prod.customer_experience_derived and plain column identifiers that exist in it
Failed to read embedding file	Check the path; ensure embed skill ran successfully
Invalid --filter format	Use column:value — no spaces around the colon
No results found	Broaden date range, remove filters, or increase --top-k