Commit Graph
19 Commits
Author SHA1 Message Date
Dylan CouzonandClaude Opus 4.7 fc299a0e9c Switch hybrid-rrf snippets to RrfQuery API
Replaces the older `FusionQuery(fusion=Fusion.RRF)` enum form with
`RrfQuery(rrf=Rrf())` across all language tabs (Python, TypeScript,
Rust, Go, Java, C#) plus the REST body in `http.md`, for both the
`hybrid-rrf/` snippet and the inner RRF prefetch inside
`hybrid-formula-decay/`. The newer dedicated `Rrf` message is the
recommended path going forward; the old enum stays supported for
backward compatibility. Server-side both forms converge to the same
`FusionInternal::Rrf { k: 2, weights: None }`, verified against the
qdrant/qdrant source.

`generated/*.md` files in both directories regenerated via
`./docker.sh ./generate-md.py`. `./docker.sh ./check.py build` passes
across all six SDKs.

Also softens the DBSF prose in hybrid-queries.md to drop the
"weighted RRF tends to win" framing. Neither method dominates the
other in general.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 21:04:09 -04:00
Dylan Couzon 8cdce983ed upload snippets 2026-05-15 16:49:56 -04:00
Abdon Pijpelink 5705d7e2a2 Fix HTTP code snippets (#2231) 2026-04-07 11:35:51 +02:00
378837432e Publish docs for version 1.17 (#2137)
* Cluster Telemetry docs (#2068)

* mention cluster telemetry

* small reword

* Docs for read_fan_out_delay_ms

* Add warning against setting threshold too low

* Small docs change for inference API keys

* Trigger Build

* Add guide with tips for low latency search (#2136)

* Update frontmatter weights

* Add 'Tips for Low-Latency Search' guide

* Review feedback

* Temporarily bump Rust client to v1-17-upgrade branch

* Docs for audit logging (#2141)

* Docs for audit logging

* Consistent title casing

* Review feedback

* Docs for optimization monitoring (#2121)

* Docs for optimization monitoring

* Review feedback

* Optimization monitoring is cluster-wide now

* Upgrade code snippet checker to 1.17

* Fix broken Python snippets

* Relevance Feedback docs (#2060)

* add relevance feedback in Explore page

* Review

* Trigger Build

* Trigger Build

* Create new 'Search Relevance' concept page

* Tweaks

* Update links to moved content

* add rust snippet

* TS anippets

* Clarification about using point IDs

* Add links

* Restructure paragraphs

* docs: Go snippet

Signed-off-by: Anush008 <mail@anush.sh>

* docs: Missed Java snippets with C#

Signed-off-by: Anush008 <mail@anush.sh>

* new: add python snippets

* Make Java and Rust snippets testable

* Remove unnecessary styling

---------

Signed-off-by: Anush008 <mail@anush.sh>
Co-authored-by: Evgeniya Sukhodolskaya <suxodolskaya97@gmail.com>
Co-authored-by: Abdon Pijpelink <abdon.pijpelink@qdrant.com>
Co-authored-by: Ivan Pleshkov <pleshkov.ivan@gmail.com>
Co-authored-by: Anush008 <mail@anush.sh>
Co-authored-by: George Panchuk <george.panchuk@qdrant.tech>

* Docs for enable_hnsw (#2080)

* Move 'Filterable HNSW Index' section under 'Vector Index'

* Add docs for enable_hnsw

* docs: Go snippets

Signed-off-by: Anush008 <mail@anush.sh>

* docs: Java snippets

Signed-off-by: Anush008 <mail@anush.sh>

* docs: C# snippets

Signed-off-by: Anush008 <mail@anush.sh>

* Add Rust snippet

* TS snippets

* new: add python snippets

---------

Signed-off-by: Anush008 <mail@anush.sh>
Co-authored-by: Anush008 <mail@anush.sh>
Co-authored-by: timvisee <tim@visee.me>
Co-authored-by: Ivan Pleshkov <pleshkov.ivan@gmail.com>
Co-authored-by: George Panchuk <george.panchuk@qdrant.tech>

* Docs for list shard keys API (#2082)

* Docs for list shard keys

* docs: Go snippets

Signed-off-by: Anush008 <mail@anush.sh>

* docs: Java snippets

Signed-off-by: Anush008 <mail@anush.sh>

* docs: C# snippets

Signed-off-by: Anush008 <mail@anush.sh>

* Add Rust snippet

* docs: TS snippets

* new: add python snippets

---------

Signed-off-by: Anush008 <mail@anush.sh>
Co-authored-by: Anush008 <mail@anush.sh>
Co-authored-by: timvisee <tim@visee.me>
Co-authored-by: Ivan Pleshkov <pleshkov.ivan@gmail.com>
Co-authored-by: George Panchuk <george.panchuk@qdrant.tech>

* Docs for update_mode (#2097)

* Docs for update_mode

* docs: C#, Go, Java snippets

Signed-off-by: Anush008 <mail@anush.sh>

* doc: Remove _ from C# snippet

Signed-off-by: Anush008 <mail@anush.sh>

* Add Rust snippet

* Fix some snippets

* Review feedback

* ts snippets

* new: add python snippets

* fix: add generated python.md

---------

Signed-off-by: Anush008 <mail@anush.sh>
Co-authored-by: Anush008 <mail@anush.sh>
Co-authored-by: timvisee <tim@visee.me>
Co-authored-by: Ivan Pleshkov <pleshkov.ivan@gmail.com>
Co-authored-by: George Panchuk <george.panchuk@qdrant.tech>

* Docs for weighted RRF (#2132)

* Docs for weighted RRF

* docs: Go, Java, C# snippets

Signed-off-by: Anush008 <mail@anush.sh>

* Add Rust snippet

* Apply suggestions from code review

Co-authored-by: Luis Cossío <luis.cossio@qdrant.com>

* Delete landing_page.sln

* Review feedback

* ts snippets

* new: add python snippets

* Trigger Build

---------

Signed-off-by: Anush008 <mail@anush.sh>
Co-authored-by: Anush008 <mail@anush.sh>
Co-authored-by: timvisee <tim@visee.me>
Co-authored-by: Luis Cossío <luis.cossio@qdrant.com>
Co-authored-by: Ivan Pleshkov <pleshkov.ivan@gmail.com>
Co-authored-by: George Panchuk <george.panchuk@qdrant.tech>

* Clean up Go and Java snippets

* Revert go snippet change; target Go client 1.17.1

* Updated Go snippet

* Trigger Build

* Update Rust lockfile

---------

Signed-off-by: Anush008 <mail@anush.sh>
Co-authored-by: Luis Cossío <luis.cossio@qdrant.com>
Co-authored-by: Daniel Boros <56868953+dancixx@users.noreply.github.com>
Co-authored-by: timvisee <tim@visee.me>
Co-authored-by: Evgeniya Sukhodolskaya <suxodolskaya97@gmail.com>
Co-authored-by: Ivan Pleshkov <pleshkov.ivan@gmail.com>
Co-authored-by: Anush008 <mail@anush.sh>
Co-authored-by: George Panchuk <george.panchuk@qdrant.tech>
2026-02-20 10:42:12 +01:00
xzfc 178a9bae72 Regenerate snippet .md files
Run `./generate-md.py` to update generated markdown files after
semi-manual changes made in the previous commit.
This commit serves as a gist of fixed issues found in snippets.

(it's easier to review 250 lines diff rather than 31k lines diff, isn't it?)
2025-11-28 22:02:34 +00:00
xzfc 74a785218b Fix type-checking errors in snippets (code only, no .md)
This commit both:
- Fixes pre-existing mistakes in snippets, aka wrong code samples.
- Adds hidden (`@hide`) statements that do not appear in the docs,
  but satisfy typecheckers.
2025-11-28 22:02:07 +00:00
xzfc 00896acb28 Automated snippet conversion by scripts
These changes are purely mechanical to differentiate them from manual
fixes/adjustments made in the next commit.
This results in broken code as some snippets contain errors.

Made in four steps:
1. Run ./migrate-snippet.py that converts `.md` files to code files
   and perhaps adds missing lines under `// @hide` comments.
2. Sort Java imports.
3. Remove old `.md` files.
4. Run ./generate.md to produce `*/generated/*.md` files.
2025-11-28 22:00:47 +00:00
xzfc 43aab46bba Migrate some code snippets
create-collection/simple
query-points/with-acorn
2025-11-26 06:23:31 +00:00
xzfcandTim Visée 69b90aadce [1.16] Add ACORN and Inline Storage docs (#1990)
* Add ACORN doc

* Add Inline Storage doc

* Use consistent version gate marker

* Update

---------

Co-authored-by: Tim Visée <tim@visee.me>
2025-11-17 15:16:51 +01:00
Anush 4bf27cb600 docs: Updated Java imports for 1.16.0 (#1993)
Signed-off-by: Anush008 <anushshetty90@gmail.com>
2025-11-17 15:06:05 +01:00
902e937a25 Document custom RRF (#1985)
* make dedicated fusion strategy sections

* docs: Java, Go, C# snippets

Signed-off-by: Anush008 <anushshetty90@gmail.com>

* add formula for rrf

* add rust and python snippets

* Use consistent formatting

---------

Signed-off-by: Anush008 <anushshetty90@gmail.com>
Co-authored-by: Anush008 <anushshetty90@gmail.com>
Co-authored-by: Tim Visée <tim@visee.me>
2025-11-17 15:05:52 +01:00
myyrakle 306d558618 Fix typo: Score boosting section (#1871)
* Fix typo

* docs: Insert newlines
2025-08-25 19:39:46 +02:00
Anush 9773f52e40 docs: Updated java.md 2025-08-20 13:36:01 +02:00
Evgeniya Sukhodolskaya 0345b298c1 other clients 2025-08-20 13:36:01 +02:00
Evgeniya Sukhodolskaya 7a60d47283 made example for explainable 2025-08-20 13:36:01 +02:00
Evgeniya Sukhodolskaya 13ed6b91b7 time boosting example 2025-08-20 13:36:01 +02:00
Luis CossíoandAnush 33c9c18f9a [v1.15.0] MMR docs (#1754)
* add mmr to hybrid queries section

* update to new interface

* proofread

* update for renaming `lambda` into `diversity`

* update for `candidates_limit`

* add formula

* fix rust snippet

* docs: Simplified go.md

* docs: Simplify csharp.md

* docs: Simplified java.md

* output is regular scores

---------

Co-authored-by: Anush <anushshetty90@gmail.com>
2025-07-18 13:24:16 +02:00
5698658bf3 Docs: Score boosting (#1506)
* Add score boosting section to hybrid queries

* add decay formulas docs

* Add datetime function to formula operators and update limitations

* add datetime_key expression

* use the name of the decay function in interface for the table

* update to use snippets in a dedicated folder

* mention that payload index is desired

* add python and rust snippets

* update snippets

* docs: Go snippets

Signed-off-by: Anush008 <anushshetty90@gmail.com>

* docs: C# snippets

Signed-off-by: Anush008 <anushshetty90@gmail.com>

* docs: Java snippets

Signed-off-by: Anush008 <anushshetty90@gmail.com>

* chore: Updated formula defaut C#, GO

Signed-off-by: Anush008 <anushshetty90@gmail.com>

* docs: Update C# snippets as per new changes

Signed-off-by: Anush008 <anushshetty90@gmail.com>

* add typescript snippets

* minor fixes

* Use score function in Rust client

---------

Signed-off-by: Anush008 <anushshetty90@gmail.com>
Co-authored-by: Anush008 <anushshetty90@gmail.com>
Co-authored-by: generall <andrey@vasnetsov.com>
Co-authored-by: timvisee <tim@visee.me>
2025-04-22 10:14:09 -04:00
treanandgenerall 784f11cba4 Shortcode for rendering code snippets from separate markdown files (#1548)
* shortcode for rendering code snippets from separate markdown files

* formatted code

* fix and readme

* semi-automatically extracts snippets from markdown

* extract snippets from points.md

* extract snippets from vectors.md

* extract snippets from payload.md

* extract snippets from search.md + fixes

* extract snippets from explore.md

* extract snippets from hybrid-queries.md + mode query by id into search

* extract snippets from filtering.md

* extract snippets from storage.md + update outdated info

* extract snippets from indexing.md

* extract snippets from snapshots.md

* extract snippets from guides/optimize.md

* extract snippets from guides/multiple-partitions.md + fix aside note

* extract snippets from guides/quantization.md

* use auto-generated descriptions

* order json snippets first

---------

Co-authored-by: generall <andrey@vasnetsov.com>
2025-04-07 00:40:39 +02:00