@arbidocs/client 0.3.138 → 0.3.139
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +243 -191
- package/dist/index.d.ts +243 -191
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1942,7 +1942,7 @@ interface paths {
|
|
|
1942
1942
|
patch: operations['update_tag'];
|
|
1943
1943
|
trace?: never;
|
|
1944
1944
|
};
|
|
1945
|
-
'/v1/
|
|
1945
|
+
'/v1/notes/': {
|
|
1946
1946
|
parameters: {
|
|
1947
1947
|
query?: never;
|
|
1948
1948
|
header?: never;
|
|
@@ -1952,17 +1952,17 @@ interface paths {
|
|
|
1952
1952
|
get?: never;
|
|
1953
1953
|
put?: never;
|
|
1954
1954
|
/**
|
|
1955
|
-
* Create
|
|
1956
|
-
* @description Create a
|
|
1955
|
+
* Create Note Endpoint
|
|
1956
|
+
* @description Create a note in the active workspace.
|
|
1957
1957
|
*/
|
|
1958
|
-
post: operations['
|
|
1958
|
+
post: operations['create_note'];
|
|
1959
1959
|
delete?: never;
|
|
1960
1960
|
options?: never;
|
|
1961
1961
|
head?: never;
|
|
1962
1962
|
patch?: never;
|
|
1963
1963
|
trace?: never;
|
|
1964
1964
|
};
|
|
1965
|
-
'/v1/
|
|
1965
|
+
'/v1/notes/list': {
|
|
1966
1966
|
parameters: {
|
|
1967
1967
|
query?: never;
|
|
1968
1968
|
header?: never;
|
|
@@ -1970,10 +1970,10 @@ interface paths {
|
|
|
1970
1970
|
cookie?: never;
|
|
1971
1971
|
};
|
|
1972
1972
|
/**
|
|
1973
|
-
* List
|
|
1974
|
-
* @description List
|
|
1973
|
+
* List Notes Endpoint
|
|
1974
|
+
* @description List notes visible in the active workspace (newest first).
|
|
1975
1975
|
*/
|
|
1976
|
-
get: operations['
|
|
1976
|
+
get: operations['list_notes'];
|
|
1977
1977
|
put?: never;
|
|
1978
1978
|
post?: never;
|
|
1979
1979
|
delete?: never;
|
|
@@ -1982,7 +1982,7 @@ interface paths {
|
|
|
1982
1982
|
patch?: never;
|
|
1983
1983
|
trace?: never;
|
|
1984
1984
|
};
|
|
1985
|
-
'/v1/
|
|
1985
|
+
'/v1/notes/search': {
|
|
1986
1986
|
parameters: {
|
|
1987
1987
|
query?: never;
|
|
1988
1988
|
header?: never;
|
|
@@ -1992,17 +1992,17 @@ interface paths {
|
|
|
1992
1992
|
get?: never;
|
|
1993
1993
|
put?: never;
|
|
1994
1994
|
/**
|
|
1995
|
-
* Search
|
|
1996
|
-
* @description Hybrid recall over the workspace's
|
|
1995
|
+
* Search Notes Endpoint
|
|
1996
|
+
* @description Hybrid recall over the workspace's notes.
|
|
1997
1997
|
*/
|
|
1998
|
-
post: operations['
|
|
1998
|
+
post: operations['search_notes'];
|
|
1999
1999
|
delete?: never;
|
|
2000
2000
|
options?: never;
|
|
2001
2001
|
head?: never;
|
|
2002
2002
|
patch?: never;
|
|
2003
2003
|
trace?: never;
|
|
2004
2004
|
};
|
|
2005
|
-
'/v1/
|
|
2005
|
+
'/v1/notes/{note_ext_id}': {
|
|
2006
2006
|
parameters: {
|
|
2007
2007
|
query?: never;
|
|
2008
2008
|
header?: never;
|
|
@@ -2013,17 +2013,17 @@ interface paths {
|
|
|
2013
2013
|
put?: never;
|
|
2014
2014
|
post?: never;
|
|
2015
2015
|
/**
|
|
2016
|
-
* Delete
|
|
2017
|
-
* @description Soft-delete a
|
|
2016
|
+
* Delete Note Endpoint
|
|
2017
|
+
* @description Soft-delete a note. RLS governs permission; a blocked delete returns 403.
|
|
2018
2018
|
*/
|
|
2019
|
-
delete: operations['
|
|
2019
|
+
delete: operations['delete_note'];
|
|
2020
2020
|
options?: never;
|
|
2021
2021
|
head?: never;
|
|
2022
2022
|
/**
|
|
2023
|
-
* Update
|
|
2024
|
-
* @description Patch a
|
|
2023
|
+
* Update Note Endpoint
|
|
2024
|
+
* @description Patch a note. A content edit replaces it (append + soft-delete); pin/share toggle in place.
|
|
2025
2025
|
*/
|
|
2026
|
-
patch: operations['
|
|
2026
|
+
patch: operations['update_note'];
|
|
2027
2027
|
trace?: never;
|
|
2028
2028
|
};
|
|
2029
2029
|
'/v1/notifications/ws-schemas': {
|
|
@@ -3500,14 +3500,14 @@ interface components {
|
|
|
3500
3500
|
*/
|
|
3501
3501
|
PERSONAL_AGENT: boolean;
|
|
3502
3502
|
/**
|
|
3503
|
-
*
|
|
3504
|
-
* @description Workspace memory is readable AND writable by the agent: pinned core memories are injected into the prompt, and the agent gets the
|
|
3503
|
+
* Notes Enabled
|
|
3504
|
+
* @description Workspace memory is readable AND writable by the agent: pinned core memories are injected into the prompt, and the agent gets the note_search (recall) and note_update (write) tools.
|
|
3505
3505
|
* @default false
|
|
3506
3506
|
*/
|
|
3507
|
-
|
|
3507
|
+
NOTES_ENABLED: boolean;
|
|
3508
3508
|
/**
|
|
3509
3509
|
* Persist Learnings
|
|
3510
|
-
* @description After each turn, the curator consolidates this turn's learnings into durable memories (dedupe + supersede). Independent of
|
|
3510
|
+
* @description After each turn, the curator consolidates this turn's learnings into durable memories (dedupe + supersede). Independent of NOTES_ENABLED.
|
|
3511
3511
|
* @default false
|
|
3512
3512
|
*/
|
|
3513
3513
|
PERSIST_LEARNINGS: boolean;
|
|
@@ -3536,7 +3536,7 @@ interface components {
|
|
|
3536
3536
|
ENABLED_SKILLS?: string[] | null;
|
|
3537
3537
|
/**
|
|
3538
3538
|
* Memory Creation
|
|
3539
|
-
* @description Transient flag set by /setup command to enable the
|
|
3539
|
+
* @description Transient flag set by /setup command to enable the save_profile agent tool (authors the per-workspace practice-profile memory document).
|
|
3540
3540
|
* @default false
|
|
3541
3541
|
*/
|
|
3542
3542
|
MEMORY_CREATION: boolean;
|
|
@@ -3737,14 +3737,14 @@ interface components {
|
|
|
3737
3737
|
*/
|
|
3738
3738
|
CONVERSATION_SEARCH_ENABLED: boolean;
|
|
3739
3739
|
/**
|
|
3740
|
-
*
|
|
3741
|
-
* @description Workspace memory is readable AND writable by the agent: pinned core memories are injected into the prompt, and the agent gets the
|
|
3740
|
+
* Notes Enabled
|
|
3741
|
+
* @description Workspace memory is readable AND writable by the agent: pinned core memories are injected into the prompt, and the agent gets the note_search (recall) and note_update (write) tools.
|
|
3742
3742
|
* @default false
|
|
3743
3743
|
*/
|
|
3744
|
-
|
|
3744
|
+
NOTES_ENABLED: boolean;
|
|
3745
3745
|
/**
|
|
3746
3746
|
* Persist Learnings
|
|
3747
|
-
* @description After each turn, the curator consolidates this turn's learnings into durable memories (dedupe + supersede). Independent of
|
|
3747
|
+
* @description After each turn, the curator consolidates this turn's learnings into durable memories (dedupe + supersede). Independent of NOTES_ENABLED.
|
|
3748
3748
|
* @default false
|
|
3749
3749
|
*/
|
|
3750
3750
|
PERSIST_LEARNINGS: boolean;
|
|
@@ -3820,7 +3820,7 @@ interface components {
|
|
|
3820
3820
|
* "VISION_ENABLED": false,
|
|
3821
3821
|
* "CONVERSATION_SEARCH_ENABLED": false,
|
|
3822
3822
|
* "PERSONAL_AGENT": false,
|
|
3823
|
-
* "
|
|
3823
|
+
* "NOTES_ENABLED": false,
|
|
3824
3824
|
* "PERSIST_LEARNINGS": false,
|
|
3825
3825
|
* "SKILLS_ENABLED": false,
|
|
3826
3826
|
* "SKILL_CREATION": false,
|
|
@@ -3973,7 +3973,6 @@ interface components {
|
|
|
3973
3973
|
* "API_TYPE": "remote",
|
|
3974
3974
|
* "ENABLE_THINKING": false,
|
|
3975
3975
|
* "MODEL_NAME": "Wise",
|
|
3976
|
-
* "SYSTEM_INSTRUCTION": "You are a knowledge synthesizer. You receive the full agent scratchpad from a completed conversation and decide what, if anything, is worth saving.\n\n## Work Product Types\n- **\"memory\"**: Facts, findings, reference data — for *looking up* information.\n- **\"skill\"**: Procedures, workflows, step-by-step instructions — for *doing* something.\n\nWhen ambiguous, default to memory.\n\n## Rules\n- Return an empty work_products array if the conversation is trivial or produced nothing substantive.\n- Each work product must cover ONE coherent topic. Never combine disparate subjects into a single document — create separate documents for each distinct topic.\n- Ground everything in the provided context. Do not invent information.\n- Be concise. These are reference documents, not essays.\n\n## Output Format\nJSON with a `work_products` array. Each item has `wp_type`, `title`, and `content` (markdown).\n\nMemory content: `# Title`, date, source, key findings as bullets, source documents.\nSkill content: `# Title`, prerequisites, numbered steps, when to apply.",
|
|
3977
3976
|
* "TEMPERATURE": 0.3,
|
|
3978
3977
|
* "MAX_TOKENS": 0,
|
|
3979
3978
|
* "MAX_TOKEN_CONTEXT": 200000,
|
|
@@ -4101,7 +4100,7 @@ interface components {
|
|
|
4101
4100
|
* },
|
|
4102
4101
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
4103
4102
|
* "MODEL_NAME": "Qwen/Qwen3-Reranker-0.6B",
|
|
4104
|
-
* "API_TYPE": "
|
|
4103
|
+
* "API_TYPE": "remote",
|
|
4105
4104
|
* "RETRIEVAL_INSTRUCTION": "Judge whether the passage contains the specific facts, figures, names, or references mentioned in the query. Only answer yes if the passage directly contains these details"
|
|
4106
4105
|
* }
|
|
4107
4106
|
*/
|
|
@@ -4122,7 +4121,7 @@ interface components {
|
|
|
4122
4121
|
/**
|
|
4123
4122
|
* @default {
|
|
4124
4123
|
* "MODEL_NAME": "Qwen/Qwen3-Embedding-0.6B",
|
|
4125
|
-
* "API_TYPE": "
|
|
4124
|
+
* "API_TYPE": "remote",
|
|
4126
4125
|
* "BATCH_SIZE": 128,
|
|
4127
4126
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
4128
4127
|
* "DOCUMENT_PREFIX": "",
|
|
@@ -4647,7 +4646,14 @@ interface components {
|
|
|
4647
4646
|
};
|
|
4648
4647
|
/**
|
|
4649
4648
|
* CitationData
|
|
4650
|
-
* @description Data for a single citation
|
|
4649
|
+
* @description Data for a single citation — one statement anchored inside a longer text.
|
|
4650
|
+
*
|
|
4651
|
+
* Used by ModelCitationTool for assistant answers, where a multi-paragraph
|
|
4652
|
+
* reply makes many separate claims and each needs its own span + sources so
|
|
4653
|
+
* the client can render inline, per-claim citation markers.
|
|
4654
|
+
*
|
|
4655
|
+
* Grounded *notes* (memories, DocTags) do NOT use this — see
|
|
4656
|
+
* :class:`CitationSources`.
|
|
4651
4657
|
*/
|
|
4652
4658
|
CitationData: {
|
|
4653
4659
|
/** Chunk Ids */
|
|
@@ -4664,6 +4670,51 @@ interface components {
|
|
|
4664
4670
|
/** Offset End */
|
|
4665
4671
|
offset_end: number;
|
|
4666
4672
|
};
|
|
4673
|
+
/**
|
|
4674
|
+
* CitationSources
|
|
4675
|
+
* @description Flat provenance for a grounded note: the passages that back it.
|
|
4676
|
+
*
|
|
4677
|
+
* A note or a DocTag answers ONE question, so the per-statement
|
|
4678
|
+
* :class:`CitationData` map it used to carry was almost entirely redundant —
|
|
4679
|
+
* the ``statement`` duplicated the note text and the offsets spanned it end to
|
|
4680
|
+
* end. All a reader needs is *which passages support this*, best-first.
|
|
4681
|
+
*
|
|
4682
|
+
* One object per passage, deliberately, rather than parallel arrays: document
|
|
4683
|
+
* and page belong to a specific chunk, and keeping them together removes any
|
|
4684
|
+
* alignment invariant to maintain. Everything a client renders derives from
|
|
4685
|
+
* this single list — document pills by deduping ``doc_ext_id``, page ranges by
|
|
4686
|
+
* grouping on it — so there is exactly one way to express provenance.
|
|
4687
|
+
*
|
|
4688
|
+
* Rerank scores are NOT stored. Nothing ever read them back, and a score is
|
|
4689
|
+
* not comparable across reranker versions, so persisting one would imply a
|
|
4690
|
+
* precision it does not have. Order carries the only durable signal.
|
|
4691
|
+
*
|
|
4692
|
+
* Holds no document text, so it is **plaintext at rest** — chunk and doc ext
|
|
4693
|
+
* ids are opaque identifiers, and the passage content behind them stays
|
|
4694
|
+
* SecretBox-encrypted in Qdrant.
|
|
4695
|
+
*/
|
|
4696
|
+
CitationSources: {
|
|
4697
|
+
/** Passages */
|
|
4698
|
+
passages: components['schemas']['CitedPassage'][];
|
|
4699
|
+
};
|
|
4700
|
+
/**
|
|
4701
|
+
* CitedPassage
|
|
4702
|
+
* @description One passage backing a grounded note, with enough to render it.
|
|
4703
|
+
*
|
|
4704
|
+
* ``doc_ext_id`` is captured at grounding time from the chunk's metadata so a
|
|
4705
|
+
* client can show the source as a document pill without resolving every chunk
|
|
4706
|
+
* against Qdrant first. It is optional only because citations written before
|
|
4707
|
+
* that capture existed carry the chunk alone — a missing value means "not
|
|
4708
|
+
* recorded", never "no document" (every chunk belongs to exactly one).
|
|
4709
|
+
*/
|
|
4710
|
+
CitedPassage: {
|
|
4711
|
+
/** Chunk Id */
|
|
4712
|
+
chunk_id: string;
|
|
4713
|
+
/** Doc Ext Id */
|
|
4714
|
+
doc_ext_id?: string | null;
|
|
4715
|
+
/** Page */
|
|
4716
|
+
page?: number | null;
|
|
4717
|
+
};
|
|
4667
4718
|
/**
|
|
4668
4719
|
* CodeAgentConfig
|
|
4669
4720
|
* @description Configuration for CodeAgent — sub-agent that writes and executes code via sandbox.
|
|
@@ -5389,18 +5440,15 @@ interface components {
|
|
|
5389
5440
|
doc_ext_ids: string[];
|
|
5390
5441
|
/** Note */
|
|
5391
5442
|
note?: string | null;
|
|
5392
|
-
|
|
5393
|
-
citations?: {
|
|
5394
|
-
[key: string]: components['schemas']['CitationData'];
|
|
5395
|
-
} | null;
|
|
5443
|
+
citations?: components['schemas']['CitationSources'] | null;
|
|
5396
5444
|
};
|
|
5397
5445
|
/**
|
|
5398
|
-
*
|
|
5399
|
-
* @description Create a
|
|
5446
|
+
* CreateNoteRequest
|
|
5447
|
+
* @description Create a note in the active workspace.
|
|
5400
5448
|
*/
|
|
5401
|
-
|
|
5402
|
-
/**
|
|
5403
|
-
|
|
5449
|
+
CreateNoteRequest: {
|
|
5450
|
+
/** Text */
|
|
5451
|
+
text: string;
|
|
5404
5452
|
/**
|
|
5405
5453
|
* Pinned
|
|
5406
5454
|
* @default false
|
|
@@ -5417,6 +5465,14 @@ interface components {
|
|
|
5417
5465
|
* @enum {string}
|
|
5418
5466
|
*/
|
|
5419
5467
|
source: 'manual' | 'learning' | 'curator';
|
|
5468
|
+
/** Note Date */
|
|
5469
|
+
note_date?: string | null;
|
|
5470
|
+
/**
|
|
5471
|
+
* Tag Ext Ids
|
|
5472
|
+
* @default []
|
|
5473
|
+
*/
|
|
5474
|
+
tag_ext_ids: string[];
|
|
5475
|
+
citations?: components['schemas']['CitationSources'] | null;
|
|
5420
5476
|
};
|
|
5421
5477
|
/**
|
|
5422
5478
|
* CreatePlanDetail
|
|
@@ -5752,15 +5808,13 @@ interface components {
|
|
|
5752
5808
|
* @description Response for doctag operations - the link between a document and a tag.
|
|
5753
5809
|
*
|
|
5754
5810
|
* ``note`` + ``citations`` are inherited from :class:`GroundedText` (the shared
|
|
5755
|
-
* grounded-text payload a DocTag note and a memory both carry)
|
|
5811
|
+
* grounded-text payload a DocTag note and a memory both carry) — free text plus
|
|
5812
|
+
* the source passages backing it.
|
|
5756
5813
|
*/
|
|
5757
5814
|
DocTagResponse: {
|
|
5758
5815
|
/** Note */
|
|
5759
5816
|
note?: string | null;
|
|
5760
|
-
|
|
5761
|
-
citations?: {
|
|
5762
|
-
[key: string]: components['schemas']['CitationData'];
|
|
5763
|
-
} | null;
|
|
5817
|
+
citations?: components['schemas']['CitationSources'] | null;
|
|
5764
5818
|
/** Doc Ext Id */
|
|
5765
5819
|
doc_ext_id: string;
|
|
5766
5820
|
/** Tag Ext Id */
|
|
@@ -6082,7 +6136,7 @@ interface components {
|
|
|
6082
6136
|
/**
|
|
6083
6137
|
* Api Type
|
|
6084
6138
|
* @description The inference type (local or remote).
|
|
6085
|
-
* @default
|
|
6139
|
+
* @default remote
|
|
6086
6140
|
* @enum {string}
|
|
6087
6141
|
*/
|
|
6088
6142
|
API_TYPE: 'local' | 'remote';
|
|
@@ -6882,21 +6936,19 @@ interface components {
|
|
|
6882
6936
|
/** Tools */
|
|
6883
6937
|
tools: components['schemas']['McpToolInfo'][];
|
|
6884
6938
|
};
|
|
6885
|
-
/** MemoryDeleteResponse */
|
|
6886
|
-
MemoryDeleteResponse: {
|
|
6887
|
-
/**
|
|
6888
|
-
* Detail
|
|
6889
|
-
* @default Memory deleted successfully
|
|
6890
|
-
*/
|
|
6891
|
-
detail: string;
|
|
6892
|
-
};
|
|
6893
6939
|
/**
|
|
6894
6940
|
* MemoryLLMConfig
|
|
6895
|
-
* @description Configuration for MemoryLLM
|
|
6941
|
+
* @description Configuration for MemoryLLM — the post-turn curator.
|
|
6896
6942
|
*
|
|
6897
|
-
*
|
|
6898
|
-
*
|
|
6899
|
-
*
|
|
6943
|
+
* Judges which of a turn's learnings are worth keeping as durable Notes and
|
|
6944
|
+
* reconciles them against existing ones (dedupe + supersede). It never
|
|
6945
|
+
* re-authors text: each kept learning is stored verbatim.
|
|
6946
|
+
*
|
|
6947
|
+
* It used to also synthesize whole markdown *documents* (a "memory" or a
|
|
6948
|
+
* "skill") from the scratchpad after every turn. That path is gone — its
|
|
6949
|
+
* "memory" output was discarded by the caller, and skills are authored
|
|
6950
|
+
* deliberately via ``save_skill`` / ``/skill``. Hence no SYSTEM_INSTRUCTION
|
|
6951
|
+
* here: the consolidation prompts are rendered per-call.
|
|
6900
6952
|
*/
|
|
6901
6953
|
MemoryLLMConfig: {
|
|
6902
6954
|
/**
|
|
@@ -6914,43 +6966,19 @@ interface components {
|
|
|
6914
6966
|
ENABLE_THINKING: boolean;
|
|
6915
6967
|
/**
|
|
6916
6968
|
* Model Name
|
|
6917
|
-
* @description The model for
|
|
6969
|
+
* @description The model for note consolidation. Defaults to reasoning model.
|
|
6918
6970
|
* @default Wise
|
|
6919
6971
|
*/
|
|
6920
6972
|
MODEL_NAME: string;
|
|
6921
|
-
/**
|
|
6922
|
-
* System Instruction
|
|
6923
|
-
* @description System instruction for memory classification and synthesis.
|
|
6924
|
-
* @default You are a knowledge synthesizer. You receive the full agent scratchpad from a completed conversation and decide what, if anything, is worth saving.
|
|
6925
|
-
*
|
|
6926
|
-
* ## Work Product Types
|
|
6927
|
-
* - **"memory"**: Facts, findings, reference data — for *looking up* information.
|
|
6928
|
-
* - **"skill"**: Procedures, workflows, step-by-step instructions — for *doing* something.
|
|
6929
|
-
*
|
|
6930
|
-
* When ambiguous, default to memory.
|
|
6931
|
-
*
|
|
6932
|
-
* ## Rules
|
|
6933
|
-
* - Return an empty work_products array if the conversation is trivial or produced nothing substantive.
|
|
6934
|
-
* - Each work product must cover ONE coherent topic. Never combine disparate subjects into a single document — create separate documents for each distinct topic.
|
|
6935
|
-
* - Ground everything in the provided context. Do not invent information.
|
|
6936
|
-
* - Be concise. These are reference documents, not essays.
|
|
6937
|
-
*
|
|
6938
|
-
* ## Output Format
|
|
6939
|
-
* JSON with a `work_products` array. Each item has `wp_type`, `title`, and `content` (markdown).
|
|
6940
|
-
*
|
|
6941
|
-
* Memory content: `# Title`, date, source, key findings as bullets, source documents.
|
|
6942
|
-
* Skill content: `# Title`, prerequisites, numbered steps, when to apply.
|
|
6943
|
-
*/
|
|
6944
|
-
SYSTEM_INSTRUCTION: string;
|
|
6945
6973
|
/**
|
|
6946
6974
|
* Temperature
|
|
6947
|
-
* @description Temperature for
|
|
6975
|
+
* @description Temperature for consolidation.
|
|
6948
6976
|
* @default 0.3
|
|
6949
6977
|
*/
|
|
6950
6978
|
TEMPERATURE: number;
|
|
6951
6979
|
/**
|
|
6952
6980
|
* Max Tokens
|
|
6953
|
-
* @description Max output tokens
|
|
6981
|
+
* @description Max output tokens; 0 = uncapped (run to EOS).
|
|
6954
6982
|
* @default 0
|
|
6955
6983
|
*/
|
|
6956
6984
|
MAX_TOKENS: number;
|
|
@@ -6962,87 +6990,11 @@ interface components {
|
|
|
6962
6990
|
MAX_TOKEN_CONTEXT: number;
|
|
6963
6991
|
/**
|
|
6964
6992
|
* Max Concurrent
|
|
6965
|
-
* @description Maximum concurrent
|
|
6993
|
+
* @description Maximum concurrent consolidation operations.
|
|
6966
6994
|
* @default 5
|
|
6967
6995
|
*/
|
|
6968
6996
|
MAX_CONCURRENT: number;
|
|
6969
6997
|
};
|
|
6970
|
-
/** MemoryResponse */
|
|
6971
|
-
MemoryResponse: {
|
|
6972
|
-
/** Note */
|
|
6973
|
-
note?: string | null;
|
|
6974
|
-
/** Citations */
|
|
6975
|
-
citations?: {
|
|
6976
|
-
[key: string]: components['schemas']['CitationData'];
|
|
6977
|
-
} | null;
|
|
6978
|
-
/** External Id */
|
|
6979
|
-
external_id: string;
|
|
6980
|
-
/** Workspace Ext Id */
|
|
6981
|
-
workspace_ext_id: string;
|
|
6982
|
-
/** Pinned */
|
|
6983
|
-
pinned: boolean;
|
|
6984
|
-
/** Shared */
|
|
6985
|
-
shared: boolean;
|
|
6986
|
-
/** Source */
|
|
6987
|
-
source: string;
|
|
6988
|
-
/** Created By Ext Id */
|
|
6989
|
-
created_by_ext_id: string;
|
|
6990
|
-
/**
|
|
6991
|
-
* Created At
|
|
6992
|
-
* Format: date-time
|
|
6993
|
-
*/
|
|
6994
|
-
created_at: string;
|
|
6995
|
-
/**
|
|
6996
|
-
* Updated At
|
|
6997
|
-
* Format: date-time
|
|
6998
|
-
*/
|
|
6999
|
-
updated_at: string;
|
|
7000
|
-
};
|
|
7001
|
-
/** MemorySearchHit */
|
|
7002
|
-
MemorySearchHit: {
|
|
7003
|
-
/** External Id */
|
|
7004
|
-
external_id: string;
|
|
7005
|
-
/** Note */
|
|
7006
|
-
note: string;
|
|
7007
|
-
/** Pinned */
|
|
7008
|
-
pinned: boolean;
|
|
7009
|
-
/** Source */
|
|
7010
|
-
source: string;
|
|
7011
|
-
/** Score */
|
|
7012
|
-
score: number;
|
|
7013
|
-
};
|
|
7014
|
-
/**
|
|
7015
|
-
* MemorySearchRequest
|
|
7016
|
-
* @description Hybrid recall over the workspace's memories.
|
|
7017
|
-
*/
|
|
7018
|
-
MemorySearchRequest: {
|
|
7019
|
-
/**
|
|
7020
|
-
* Query
|
|
7021
|
-
* @description Search query text
|
|
7022
|
-
*/
|
|
7023
|
-
query: string;
|
|
7024
|
-
/**
|
|
7025
|
-
* Search Mode
|
|
7026
|
-
* @description Retrieval mode
|
|
7027
|
-
* @default hybrid
|
|
7028
|
-
* @enum {string}
|
|
7029
|
-
*/
|
|
7030
|
-
search_mode: 'semantic' | 'keyword' | 'hybrid';
|
|
7031
|
-
/**
|
|
7032
|
-
* Limit
|
|
7033
|
-
* @description Maximum number of memories to return
|
|
7034
|
-
* @default 10
|
|
7035
|
-
*/
|
|
7036
|
-
limit: number;
|
|
7037
|
-
};
|
|
7038
|
-
/** MemorySearchResponse */
|
|
7039
|
-
MemorySearchResponse: {
|
|
7040
|
-
/**
|
|
7041
|
-
* Memories
|
|
7042
|
-
* @default []
|
|
7043
|
-
*/
|
|
7044
|
-
memories: components['schemas']['MemorySearchHit'][];
|
|
7045
|
-
};
|
|
7046
6998
|
/** MemoryTool */
|
|
7047
6999
|
MemoryTool: {
|
|
7048
7000
|
/**
|
|
@@ -7489,6 +7441,104 @@ interface components {
|
|
|
7489
7441
|
DoctagLLM: components['schemas']['DoctagLLMUserConfig'];
|
|
7490
7442
|
Parser: components['schemas']['ParserUserConfig'];
|
|
7491
7443
|
};
|
|
7444
|
+
/** NoteDeleteResponse */
|
|
7445
|
+
NoteDeleteResponse: {
|
|
7446
|
+
/**
|
|
7447
|
+
* Detail
|
|
7448
|
+
* @default Note deleted successfully
|
|
7449
|
+
*/
|
|
7450
|
+
detail: string;
|
|
7451
|
+
};
|
|
7452
|
+
/** NoteResponse */
|
|
7453
|
+
NoteResponse: {
|
|
7454
|
+
/** Text */
|
|
7455
|
+
text: string;
|
|
7456
|
+
citations?: components['schemas']['CitationSources'] | null;
|
|
7457
|
+
/** External Id */
|
|
7458
|
+
external_id: string;
|
|
7459
|
+
/** Workspace Ext Id */
|
|
7460
|
+
workspace_ext_id: string;
|
|
7461
|
+
/** Pinned */
|
|
7462
|
+
pinned: boolean;
|
|
7463
|
+
/** Shared */
|
|
7464
|
+
shared: boolean;
|
|
7465
|
+
/** Source */
|
|
7466
|
+
source: string;
|
|
7467
|
+
/** Note Date */
|
|
7468
|
+
note_date?: string | null;
|
|
7469
|
+
/**
|
|
7470
|
+
* Tags
|
|
7471
|
+
* @default []
|
|
7472
|
+
*/
|
|
7473
|
+
tags: components['schemas']['NoteTagResponse'][];
|
|
7474
|
+
/** Created By Ext Id */
|
|
7475
|
+
created_by_ext_id: string;
|
|
7476
|
+
/**
|
|
7477
|
+
* Created At
|
|
7478
|
+
* Format: date-time
|
|
7479
|
+
*/
|
|
7480
|
+
created_at: string;
|
|
7481
|
+
/**
|
|
7482
|
+
* Updated At
|
|
7483
|
+
* Format: date-time
|
|
7484
|
+
*/
|
|
7485
|
+
updated_at: string;
|
|
7486
|
+
};
|
|
7487
|
+
/** NoteSearchHit */
|
|
7488
|
+
NoteSearchHit: {
|
|
7489
|
+
/** External Id */
|
|
7490
|
+
external_id: string;
|
|
7491
|
+
/** Text */
|
|
7492
|
+
text: string;
|
|
7493
|
+
/** Pinned */
|
|
7494
|
+
pinned: boolean;
|
|
7495
|
+
/** Source */
|
|
7496
|
+
source: string;
|
|
7497
|
+
/** Score */
|
|
7498
|
+
score: number;
|
|
7499
|
+
};
|
|
7500
|
+
/**
|
|
7501
|
+
* NoteSearchRequest
|
|
7502
|
+
* @description Hybrid recall over the workspace's notes.
|
|
7503
|
+
*/
|
|
7504
|
+
NoteSearchRequest: {
|
|
7505
|
+
/**
|
|
7506
|
+
* Query
|
|
7507
|
+
* @description Search query text
|
|
7508
|
+
*/
|
|
7509
|
+
query: string;
|
|
7510
|
+
/**
|
|
7511
|
+
* Search Mode
|
|
7512
|
+
* @description Retrieval mode
|
|
7513
|
+
* @default hybrid
|
|
7514
|
+
* @enum {string}
|
|
7515
|
+
*/
|
|
7516
|
+
search_mode: 'semantic' | 'keyword' | 'hybrid';
|
|
7517
|
+
/**
|
|
7518
|
+
* Limit
|
|
7519
|
+
* @description Maximum number of notes to return
|
|
7520
|
+
* @default 10
|
|
7521
|
+
*/
|
|
7522
|
+
limit: number;
|
|
7523
|
+
};
|
|
7524
|
+
/** NoteSearchResponse */
|
|
7525
|
+
NoteSearchResponse: {
|
|
7526
|
+
/**
|
|
7527
|
+
* Notes
|
|
7528
|
+
* @default []
|
|
7529
|
+
*/
|
|
7530
|
+
notes: components['schemas']['NoteSearchHit'][];
|
|
7531
|
+
};
|
|
7532
|
+
/**
|
|
7533
|
+
* NoteTagResponse
|
|
7534
|
+
* @description A tag attached to a note — the tag's identity, decrypted name included.
|
|
7535
|
+
*/
|
|
7536
|
+
NoteTagResponse: {
|
|
7537
|
+
/** Tag Ext Id */
|
|
7538
|
+
tag_ext_id: string;
|
|
7539
|
+
/** Name */
|
|
7540
|
+
name: string;
|
|
7541
|
+
};
|
|
7492
7542
|
/**
|
|
7493
7543
|
* NotificationResponse
|
|
7494
7544
|
* @description Notification response model for API and WebSocket.
|
|
@@ -8423,7 +8473,7 @@ interface components {
|
|
|
8423
8473
|
/**
|
|
8424
8474
|
* Api Type
|
|
8425
8475
|
* @description The inference type (local or remote).
|
|
8426
|
-
* @default
|
|
8476
|
+
* @default remote
|
|
8427
8477
|
* @enum {string}
|
|
8428
8478
|
*/
|
|
8429
8479
|
API_TYPE: 'local' | 'remote';
|
|
@@ -10409,10 +10459,7 @@ interface components {
|
|
|
10409
10459
|
doc_ext_id: string;
|
|
10410
10460
|
/** Note */
|
|
10411
10461
|
note?: string | null;
|
|
10412
|
-
|
|
10413
|
-
citations?: {
|
|
10414
|
-
[key: string]: components['schemas']['CitationData'];
|
|
10415
|
-
} | null;
|
|
10462
|
+
citations?: components['schemas']['CitationSources'] | null;
|
|
10416
10463
|
};
|
|
10417
10464
|
/**
|
|
10418
10465
|
* UpdateDocumentsRequest
|
|
@@ -10423,18 +10470,23 @@ interface components {
|
|
|
10423
10470
|
documents: components['schemas']['DocUpdateRequest'][];
|
|
10424
10471
|
};
|
|
10425
10472
|
/**
|
|
10426
|
-
*
|
|
10427
|
-
* @description Patch a
|
|
10428
|
-
* inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared
|
|
10429
|
-
*
|
|
10473
|
+
* UpdateNoteRequest
|
|
10474
|
+
* @description Patch a note. An edit to ``text`` soft-deletes the old row and
|
|
10475
|
+
* inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
|
|
10476
|
+
* ``note_date``/``tag_ext_ids`` update in place.
|
|
10430
10477
|
*/
|
|
10431
|
-
|
|
10432
|
-
/**
|
|
10433
|
-
|
|
10478
|
+
UpdateNoteRequest: {
|
|
10479
|
+
/** Text */
|
|
10480
|
+
text?: string | null;
|
|
10434
10481
|
/** Pinned */
|
|
10435
10482
|
pinned?: boolean | null;
|
|
10436
10483
|
/** Shared */
|
|
10437
10484
|
shared?: boolean | null;
|
|
10485
|
+
/** Note Date */
|
|
10486
|
+
note_date?: string | null;
|
|
10487
|
+
/** Tag Ext Ids */
|
|
10488
|
+
tag_ext_ids?: string[] | null;
|
|
10489
|
+
citations?: components['schemas']['CitationSources'] | null;
|
|
10438
10490
|
};
|
|
10439
10491
|
/**
|
|
10440
10492
|
* UpdateNotificationsRequest
|
|
@@ -14154,7 +14206,7 @@ interface operations {
|
|
|
14154
14206
|
};
|
|
14155
14207
|
};
|
|
14156
14208
|
};
|
|
14157
|
-
|
|
14209
|
+
create_note: {
|
|
14158
14210
|
parameters: {
|
|
14159
14211
|
query?: never;
|
|
14160
14212
|
header?: never;
|
|
@@ -14163,7 +14215,7 @@ interface operations {
|
|
|
14163
14215
|
};
|
|
14164
14216
|
requestBody: {
|
|
14165
14217
|
content: {
|
|
14166
|
-
'application/json': components['schemas']['
|
|
14218
|
+
'application/json': components['schemas']['CreateNoteRequest'];
|
|
14167
14219
|
};
|
|
14168
14220
|
};
|
|
14169
14221
|
responses: {
|
|
@@ -14173,7 +14225,7 @@ interface operations {
|
|
|
14173
14225
|
[name: string]: unknown;
|
|
14174
14226
|
};
|
|
14175
14227
|
content: {
|
|
14176
|
-
'application/json': components['schemas']['
|
|
14228
|
+
'application/json': components['schemas']['NoteResponse'];
|
|
14177
14229
|
};
|
|
14178
14230
|
};
|
|
14179
14231
|
/** @description Validation Error */
|
|
@@ -14187,7 +14239,7 @@ interface operations {
|
|
|
14187
14239
|
};
|
|
14188
14240
|
};
|
|
14189
14241
|
};
|
|
14190
|
-
|
|
14242
|
+
list_notes: {
|
|
14191
14243
|
parameters: {
|
|
14192
14244
|
query?: {
|
|
14193
14245
|
pinned_only?: boolean;
|
|
@@ -14204,7 +14256,7 @@ interface operations {
|
|
|
14204
14256
|
[name: string]: unknown;
|
|
14205
14257
|
};
|
|
14206
14258
|
content: {
|
|
14207
|
-
'application/json': components['schemas']['
|
|
14259
|
+
'application/json': components['schemas']['NoteResponse'][];
|
|
14208
14260
|
};
|
|
14209
14261
|
};
|
|
14210
14262
|
/** @description Validation Error */
|
|
@@ -14218,7 +14270,7 @@ interface operations {
|
|
|
14218
14270
|
};
|
|
14219
14271
|
};
|
|
14220
14272
|
};
|
|
14221
|
-
|
|
14273
|
+
search_notes: {
|
|
14222
14274
|
parameters: {
|
|
14223
14275
|
query?: never;
|
|
14224
14276
|
header?: never;
|
|
@@ -14227,7 +14279,7 @@ interface operations {
|
|
|
14227
14279
|
};
|
|
14228
14280
|
requestBody: {
|
|
14229
14281
|
content: {
|
|
14230
|
-
'application/json': components['schemas']['
|
|
14282
|
+
'application/json': components['schemas']['NoteSearchRequest'];
|
|
14231
14283
|
};
|
|
14232
14284
|
};
|
|
14233
14285
|
responses: {
|
|
@@ -14237,7 +14289,7 @@ interface operations {
|
|
|
14237
14289
|
[name: string]: unknown;
|
|
14238
14290
|
};
|
|
14239
14291
|
content: {
|
|
14240
|
-
'application/json': components['schemas']['
|
|
14292
|
+
'application/json': components['schemas']['NoteSearchResponse'];
|
|
14241
14293
|
};
|
|
14242
14294
|
};
|
|
14243
14295
|
/** @description Validation Error */
|
|
@@ -14251,12 +14303,12 @@ interface operations {
|
|
|
14251
14303
|
};
|
|
14252
14304
|
};
|
|
14253
14305
|
};
|
|
14254
|
-
|
|
14306
|
+
delete_note: {
|
|
14255
14307
|
parameters: {
|
|
14256
14308
|
query?: never;
|
|
14257
14309
|
header?: never;
|
|
14258
14310
|
path: {
|
|
14259
|
-
|
|
14311
|
+
note_ext_id: string;
|
|
14260
14312
|
};
|
|
14261
14313
|
cookie?: never;
|
|
14262
14314
|
};
|
|
@@ -14268,7 +14320,7 @@ interface operations {
|
|
|
14268
14320
|
[name: string]: unknown;
|
|
14269
14321
|
};
|
|
14270
14322
|
content: {
|
|
14271
|
-
'application/json': components['schemas']['
|
|
14323
|
+
'application/json': components['schemas']['NoteDeleteResponse'];
|
|
14272
14324
|
};
|
|
14273
14325
|
};
|
|
14274
14326
|
/** @description Validation Error */
|
|
@@ -14282,18 +14334,18 @@ interface operations {
|
|
|
14282
14334
|
};
|
|
14283
14335
|
};
|
|
14284
14336
|
};
|
|
14285
|
-
|
|
14337
|
+
update_note: {
|
|
14286
14338
|
parameters: {
|
|
14287
14339
|
query?: never;
|
|
14288
14340
|
header?: never;
|
|
14289
14341
|
path: {
|
|
14290
|
-
|
|
14342
|
+
note_ext_id: string;
|
|
14291
14343
|
};
|
|
14292
14344
|
cookie?: never;
|
|
14293
14345
|
};
|
|
14294
14346
|
requestBody: {
|
|
14295
14347
|
content: {
|
|
14296
|
-
'application/json': components['schemas']['
|
|
14348
|
+
'application/json': components['schemas']['UpdateNoteRequest'];
|
|
14297
14349
|
};
|
|
14298
14350
|
};
|
|
14299
14351
|
responses: {
|
|
@@ -14303,7 +14355,7 @@ interface operations {
|
|
|
14303
14355
|
[name: string]: unknown;
|
|
14304
14356
|
};
|
|
14305
14357
|
content: {
|
|
14306
|
-
'application/json': components['schemas']['
|
|
14358
|
+
'application/json': components['schemas']['NoteResponse'];
|
|
14307
14359
|
};
|
|
14308
14360
|
};
|
|
14309
14361
|
/** @description Validation Error */
|