Skip to content

Document vector query helpers#3078

Open
atharva-appwrite wants to merge 1 commit into
mainfrom
docs/vector-query-helpers
Open

Document vector query helpers#3078
atharva-appwrite wants to merge 1 commit into
mainfrom
docs/vector-query-helpers

Conversation

@atharva-appwrite

Copy link
Copy Markdown

Summary

  • Add vector query helper coverage for vectorDot, vectorCosine, and vectorEuclidean to the Databases queries docs
  • Add a changelog entry announcing vector query helper availability across SDKs

Validation

  • git diff --check
  • Static Markdoc fence/tag balance check
  • Could not run full project checks: bun is not installed; pnpm install --frozen-lockfile fails because pnpm-lock.yaml is out of sync with package.json

@appwrite

appwrite Bot commented Jul 3, 2026

Copy link
Copy Markdown

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Ready Ready View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Processing Processing View Logs Preview URL QR Code


Tip

Each function runs in its own isolated container with custom environment variables

@greptile-apps

greptile-apps Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds documentation for three new vector query helpers (vectorDot, vectorCosine, vectorEuclidean) to the Databases queries page and a companion changelog entry announcing their availability across Appwrite SDKs.

  • The new "Vector queries" section covers all SDK languages with a multicode block, a comparison table for similarity metrics, and the raw HTTP JSON format — all consistent with the existing geo-query documentation structure.
  • Two areas need attention: the server-swift examples use a vector: labeled parameter absent in all existing server-swift geo-query examples, and the phrase "VectorsDB document list endpoints" doesn't match the TablesDB terminology used everywhere else on the page.

Confidence Score: 4/5

Safe to merge after verifying the server-swift method signature and confirming the VectorsDB/TablesDB terminology.

The change is purely documentation with no runtime code modified. The multicode block structure, HTTP JSON format, and most SDK examples are consistent with existing geo-query patterns. The server-swift parameter label inconsistency and VectorsDB terminology mismatch are the two areas that warrant verification before merging.

src/routes/docs/products/databases/queries/+page.markdoc — specifically the server-swift examples and the introductory prose of the vector queries section.

Important Files Changed

Filename Overview
src/routes/docs/products/databases/queries/+page.markdoc Adds a new "Vector queries" section with multicode examples for vectorDot, vectorCosine, and vectorEuclidean across all SDKs; server-swift labeled parameter and VectorsDB terminology are inconsistent with the rest of the page.
src/routes/changelog/(entries)/2026-07-03.markdoc New changelog entry announcing vector query helpers with a correct anchor link; mirrors the VectorsDB terminology from the docs page.

Reviews (1): Last reviewed commit: "Document vector query helpers" | Re-trigger Greptile

Comment on lines +2077 to +2081
```client-apple
Query.vectorDot("embeddings", vector: [0.12, 0.24, 0.48])
Query.vectorCosine("embeddings", vector: [0.12, 0.24, 0.48])
Query.vectorEuclidean("embeddings", vector: [0.12, 0.24, 0.48])
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 server-swift uses labeled parameter inconsistent with geo-query convention

The existing geo-query server-swift examples omit the parameter label (e.g., Query.distanceEqual("location", [-73.9851, 40.7589], 200)), but the new vector-query server-swift examples use vector: (e.g., Query.vectorDot("embeddings", vector: [0.12, 0.24, 0.48])). Meanwhile the client-apple (iOS SDK) block correctly uses the label for both. If the server Swift SDK's vectorDot method follows the same unlabeled convention as distanceEqual, the generated docs would show incorrect call syntax that won't compile for users copying the snippet. Could you confirm the actual server-swift SDK method signature?

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


# Vector queries {% #vector-queries %}

Vector query helpers search vector attributes by similarity to a query vector. Use them with VectorsDB document list endpoints and pass a numeric vector with the same dimensions as the stored embeddings.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 "VectorsDB document list endpoints" terminology is inconsistent with the rest of the page

This page's description and all code examples refer exclusively to TablesDB / listRows. Calling out "VectorsDB document list endpoints" here implies these helpers only work with a separate VectorsDB product — but there's no other mention of VectorsDB anywhere on the page, and the same phrasing appears in the changelog entry. If VectorsDB is a distinct product, the cross-linking and context need clarification; if it's not, the reference should be updated to match the TablesDB terminology used throughout.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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