Skip to content

feat(types): align ConnectTo with embedded_by relation schema #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EricNGOntos merged 2 commits into from
Oct 16, 2026
Merged

feat(types): align ConnectTo with embedded_by relation schema #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c47e6a2
feat(types): align ConnectTo relations with embedded_by schema
EricNGOntos Oct 16, 2026
794a6ad
style: format ConnectTo type for prettier
EricNGOntos Oct 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/connect-to-embedded-by.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@ontos-ai/knowhere-sdk": patch
---

Align `ConnectTo.relation` with the API schema: add `embedded_by` (and reserved relation values), `targetDocumentId`, and `position`. Drop unused `score`/`keywords` fields that the API no longer emits.
18 changes: 12 additions & 6 deletions src/types/result.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,20 @@ export interface Manifest {
export interface ConnectTo {
/** Target chunk_id */
target: string;
/** Relationship type */
relation: 'embeds' | 'related';
/**
* Relationship type.
* - `embeds`: body chunk -> inline image/table asset
* - `embedded_by`: image/table asset -> owning body chunk (reverse of `embeds`)
* - `related`: same-page body chunk -> asset
* - `cross_doc_entity` / `intra_doc_ref`: reserved, not produced yet
*/
relation: 'embeds' | 'embedded_by' | 'related' | 'cross_doc_entity' | 'intra_doc_ref';
/** Reserved for cross-document targets; omitted for same-document edges */
targetDocumentId?: string;
/** Placeholder ref in content, e.g. '[images/a.png]' (embeds only) */
ref?: string;
/** Semantic similarity score (related only) */
score?: number;
/** Shared keywords (related only) */
keywords?: string[];
/** Character offsets of `ref` in the body content (embeds only) */
position?: { start: number; end: number };
}

/**
Expand Down
Loading