Repository navigation
Docs sync — week of 2026-10-05 - #78
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ahellegit
approved these changes
Oct 13, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the
include-argument validation change that landed in the week of 2026-10-05 across cyborgdb-core, cyborgdb-service, and cyborgdb-py.Previously, unsupported
includevalues onquery()andget()(e.g. asking a search for"contents", or a typo like"Metadata") were silently ignored — the method returned fewer fields than the caller expected, with no error. Now:index.query()andindex.get()raiseValueError, naming the bad value and listing the accepted ones. Passing a bare string instead of a list (e.g.include="metadata") is also an error./v1/vectors/query,/v1/vectors/query_binary,/v1/vectors/get) and the service Python SDK return422with the same semantics.All three source PRs are ahead of the latest
v0.18.0tag in their repos (unreleased), so every edit lands underdocs-site/versions/next/. Those pages are deliberately unpublished —versions/next/is not referenced indocs.json, and every page carriesnoindex: true. Reviewers should check technical accuracy of the wording and the accepted-value lists; release timing is not in scope here.versions/next/embedded/python/encrypted-index/query.mdx— acceptedincludevalues +ValueErrorbullet in single + batch Exceptionsversions/next/(unreleased)versions/next/embedded/python/encrypted-index/get.mdx— acceptedincludevalues +ValueErrorbulletversions/next/(unreleased)versions/next/service/python-sdk/encrypted-index/query.mdx— acceptedincludevalues; corrected the "silently stripped" callout;ValidationErroraccordionversions/next/(unreleased)versions/next/service/python-sdk/encrypted-index/query-binary.mdx— acceptedincludevalues;ValidationErroraccordionversions/next/(unreleased)versions/next/service/python-sdk/encrypted-index/get.mdx— acceptedincludevalues; newValidationErroraccordionversions/next/(unreleased)versions/next/service/rest-api/encrypted-index/query.mdx— acceptedincludevalues +422noteversions/next/(unreleased)versions/next/service/rest-api/encrypted-index/query-binary.mdx— acceptedincludevalues +422noteversions/next/(unreleased)versions/next/service/rest-api/encrypted-index/get.mdx— acceptedincludevalues +422noteversions/next/(unreleased)Not covered in this PR
Treat api_key=None as free tier) — the documented API already matches what users should write (api_key=""for free tier), andapi_key=Nonewas an undocumented crash path only hit by LangChain's keyword-passthrough. No doc gap to patch.cyborgdb-tests) — test-infrastructure migration. The two in-tree src diffs are a C++ docstring correction (nested metadata dot paths were already functional, the comment was wrong) and a lower-layer upsert vector/metadata count-mismatch check that didn't change the observable Python/REST API. No user-facing drift.422. No SDK surface change.Routing note on PR #59 (
Publish v0.18 docs)Open docs PR #59 already touches many of the same
versions/next/files to prep the v0.18 publish. This PR and #59 both edit:versions/next/embedded/python/encrypted-index/query.mdxversions/next/service/python-sdk/encrypted-index/query.mdxversions/next/service/python-sdk/encrypted-index/upsert.mdx(not touched here; listed only for context)Expect to resolve a small merge when whichever PR lands second rebases. The content is additive on both sides.
Review routing
Each source-PR author reviews the docs patches derived from their own PR. All eight edits here derive from PRs authored by @JimA-cyborg.
@JimA-cyborg
versions/next/embedded/python/encrypted-index/query.mdx(from cyborgdb-core#2659)versions/next/embedded/python/encrypted-index/get.mdx(from cyborgdb-core#2659)versions/next/service/python-sdk/encrypted-index/query.mdx(from cyborgdb-service#297)versions/next/service/python-sdk/encrypted-index/query-binary.mdx(from cyborgdb-service#297)versions/next/service/python-sdk/encrypted-index/get.mdx(from cyborgdb-service#297)versions/next/service/rest-api/encrypted-index/query.mdx(from cyborgdb-service#297)versions/next/service/rest-api/encrypted-index/query-binary.mdx(from cyborgdb-service#297)versions/next/service/rest-api/encrypted-index/get.mdx(from cyborgdb-service#297)Please confirm the accepted-value lists match the actual validators and that the
422wording matches what the service returns.