@arbidocs/client 0.3.47 → 0.3.49
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 +33 -24
- package/dist/index.d.ts +33 -24
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2350,7 +2350,7 @@ interface components {
|
|
|
2350
2350
|
* @default {
|
|
2351
2351
|
* "API_TYPE": "remote",
|
|
2352
2352
|
* "ENABLE_THINKING": true,
|
|
2353
|
-
* "MODEL_NAME": "
|
|
2353
|
+
* "MODEL_NAME": "Premium",
|
|
2354
2354
|
* "SYSTEM_INSTRUCTION": "You are a code execution agent. You write and run code to accomplish tasks.\n\nYou have access to an execute_code tool that runs code in a sandboxed Docker container.\n\nThe sandbox has:\n- Python 3.12 with numpy, pandas, matplotlib, requests, beautifulsoup4,\n httpx, pillow, sympy, pyyaml (plus uv for installing more)\n- Node.js 22 with TypeScript (ts-node) and npm\n- Bash with git, curl, wget, jq, sqlite3, build-essential\n- Network access (can pip/npm install additional packages)\n\nInstructions:\n1. Write clean, correct code to accomplish the user's task\n2. Always call execute_code to run your code — never guess the output\n3. If execution errors, analyze the traceback, fix the code, and retry\n4. Once you have the correct output, respond with ONLY the final result\n\nKeep code simple and direct. Prefer Python unless the task specifically requires another language.",
|
|
2355
2355
|
* "TEMPERATURE": 0.2,
|
|
2356
2356
|
* "MAX_TOKENS": 8000,
|
|
@@ -2386,7 +2386,7 @@ interface components {
|
|
|
2386
2386
|
* "MAX_NUMB_OF_CHUNKS": 30,
|
|
2387
2387
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
2388
2388
|
* "MODEL_NAME": "Qwen/Qwen3-Reranker-0.6B",
|
|
2389
|
-
* "API_TYPE": "
|
|
2389
|
+
* "API_TYPE": "local",
|
|
2390
2390
|
* "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"
|
|
2391
2391
|
* }
|
|
2392
2392
|
*/
|
|
@@ -2400,15 +2400,14 @@ interface components {
|
|
|
2400
2400
|
/**
|
|
2401
2401
|
* @default {
|
|
2402
2402
|
* "MAX_CHUNK_TOKENS": 1200,
|
|
2403
|
-
* "
|
|
2404
|
-
* "TOKENIZER_NAME": "Qwen/Qwen3-Embedding-0.6B"
|
|
2403
|
+
* "TOKENIZER_NAME": "cl100k_base"
|
|
2405
2404
|
* }
|
|
2406
2405
|
*/
|
|
2407
2406
|
Chunker: components['schemas']['ChunkerConfig'];
|
|
2408
2407
|
/**
|
|
2409
2408
|
* @default {
|
|
2410
2409
|
* "MODEL_NAME": "Qwen/Qwen3-Embedding-0.6B",
|
|
2411
|
-
* "API_TYPE": "
|
|
2410
|
+
* "API_TYPE": "local",
|
|
2412
2411
|
* "BATCH_SIZE": 128,
|
|
2413
2412
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
2414
2413
|
* "DOCUMENT_PREFIX": "",
|
|
@@ -2762,21 +2761,14 @@ interface components {
|
|
|
2762
2761
|
ChunkerConfig: {
|
|
2763
2762
|
/**
|
|
2764
2763
|
* Max Chunk Tokens
|
|
2765
|
-
* @description Maximum tokens per chunk.
|
|
2764
|
+
* @description Maximum tokens per chunk. Enforces a hard upper bound on chunk size; the tiktoken encoding is model-agnostic and used only for counting.
|
|
2766
2765
|
* @default 1200
|
|
2767
2766
|
*/
|
|
2768
2767
|
MAX_CHUNK_TOKENS: number;
|
|
2769
|
-
/**
|
|
2770
|
-
* Tokenizer Type
|
|
2771
|
-
* @description Tokenizer backend: 'tiktoken' for OpenAI models (cl100k_base, etc.) or 'huggingface' for HF models (Qwen3-Embedding, etc.).
|
|
2772
|
-
* @default huggingface
|
|
2773
|
-
* @enum {string}
|
|
2774
|
-
*/
|
|
2775
|
-
TOKENIZER_TYPE: 'tiktoken' | 'huggingface';
|
|
2776
2768
|
/**
|
|
2777
2769
|
* Tokenizer Name
|
|
2778
|
-
* @description
|
|
2779
|
-
* @default
|
|
2770
|
+
* @description Name of the tiktoken encoding used for chunk-size counting (e.g. 'cl100k_base', 'o200k_base').
|
|
2771
|
+
* @default cl100k_base
|
|
2780
2772
|
*/
|
|
2781
2773
|
TOKENIZER_NAME: string;
|
|
2782
2774
|
};
|
|
@@ -2820,7 +2812,7 @@ interface components {
|
|
|
2820
2812
|
/**
|
|
2821
2813
|
* Model Name
|
|
2822
2814
|
* @description Model for code generation. Should be a strong coding model.
|
|
2823
|
-
* @default
|
|
2815
|
+
* @default Premium
|
|
2824
2816
|
*/
|
|
2825
2817
|
MODEL_NAME: string;
|
|
2826
2818
|
/**
|
|
@@ -3410,8 +3402,8 @@ interface components {
|
|
|
3410
3402
|
* @description A pair of documents identified as near-duplicates by centroid similarity.
|
|
3411
3403
|
*/
|
|
3412
3404
|
DocSimPair: {
|
|
3413
|
-
doc_a: components['schemas']['
|
|
3414
|
-
doc_b: components['schemas']['
|
|
3405
|
+
doc_a: components['schemas']['DocSimSummary'];
|
|
3406
|
+
doc_b: components['schemas']['DocSimSummary'];
|
|
3415
3407
|
/** Similarity */
|
|
3416
3408
|
similarity: number;
|
|
3417
3409
|
};
|
|
@@ -3425,6 +3417,16 @@ interface components {
|
|
|
3425
3417
|
/** Pairs */
|
|
3426
3418
|
pairs: components['schemas']['DocSimPair'][];
|
|
3427
3419
|
};
|
|
3420
|
+
/**
|
|
3421
|
+
* DocSimSummary
|
|
3422
|
+
* @description Lightweight document summary for the similar-documents endpoint.
|
|
3423
|
+
*/
|
|
3424
|
+
DocSimSummary: {
|
|
3425
|
+
/** External Id */
|
|
3426
|
+
external_id: string;
|
|
3427
|
+
/** File Name */
|
|
3428
|
+
file_name?: string | null;
|
|
3429
|
+
};
|
|
3428
3430
|
/**
|
|
3429
3431
|
* DocTagResponse
|
|
3430
3432
|
* @description Response for doctag operations - the link between a document and a tag.
|
|
@@ -3466,7 +3468,7 @@ interface components {
|
|
|
3466
3468
|
shared?: boolean | null;
|
|
3467
3469
|
doc_metadata?: components['schemas']['DocMetadata'] | null;
|
|
3468
3470
|
/** Status */
|
|
3469
|
-
status?: 'processing' | null;
|
|
3471
|
+
status?: ('processing' | 'reindex-sparse') | null;
|
|
3470
3472
|
/** Content */
|
|
3471
3473
|
content?: string | null;
|
|
3472
3474
|
/**
|
|
@@ -3589,7 +3591,7 @@ interface components {
|
|
|
3589
3591
|
/**
|
|
3590
3592
|
* Api Type
|
|
3591
3593
|
* @description The inference type (local or remote).
|
|
3592
|
-
* @default
|
|
3594
|
+
* @default local
|
|
3593
3595
|
* @enum {string}
|
|
3594
3596
|
*/
|
|
3595
3597
|
API_TYPE: 'local' | 'remote';
|
|
@@ -3940,7 +3942,7 @@ interface components {
|
|
|
3940
3942
|
* @default uploading
|
|
3941
3943
|
* @enum {string}
|
|
3942
3944
|
*/
|
|
3943
|
-
status: 'uploading' | 'duplicate' | 'quota_exceeded' | 'unsupported' | 'empty';
|
|
3945
|
+
status: 'uploading' | 'duplicate' | 'quota_exceeded' | 'unsupported' | 'empty' | 'low-content';
|
|
3944
3946
|
/** Reason */
|
|
3945
3947
|
reason?: string | null;
|
|
3946
3948
|
};
|
|
@@ -5278,7 +5280,7 @@ interface components {
|
|
|
5278
5280
|
/**
|
|
5279
5281
|
* Api Type
|
|
5280
5282
|
* @description The inference type (local or remote).
|
|
5281
|
-
* @default
|
|
5283
|
+
* @default local
|
|
5282
5284
|
* @enum {string}
|
|
5283
5285
|
*/
|
|
5284
5286
|
API_TYPE: 'local' | 'remote';
|
|
@@ -6570,7 +6572,7 @@ interface components {
|
|
|
6570
6572
|
* Status
|
|
6571
6573
|
* @enum {string}
|
|
6572
6574
|
*/
|
|
6573
|
-
status: 'uploading' | 'queued' | 'parsing' | 'encrypting' | 'indexing' | 'analysing' | 'completed' | 'failed' | 'skipped' | 'empty';
|
|
6575
|
+
status: 'uploading' | 'queued' | 'parsing' | 'encrypting' | 'indexing' | 'analysing' | 'completed' | 'failed' | 'skipped' | 'empty' | 'low-content';
|
|
6574
6576
|
/** Progress */
|
|
6575
6577
|
progress: number;
|
|
6576
6578
|
};
|
|
@@ -7117,6 +7119,11 @@ interface components {
|
|
|
7117
7119
|
* @default false
|
|
7118
7120
|
*/
|
|
7119
7121
|
show_agent_sessions: boolean;
|
|
7122
|
+
/**
|
|
7123
|
+
* Use S3 Direct Upload
|
|
7124
|
+
* @default false
|
|
7125
|
+
*/
|
|
7126
|
+
use_s3_direct_upload: boolean;
|
|
7120
7127
|
/**
|
|
7121
7128
|
* Hide Online Status
|
|
7122
7129
|
* @default false
|
|
@@ -7161,6 +7168,8 @@ interface components {
|
|
|
7161
7168
|
show_pa_mode?: boolean | null;
|
|
7162
7169
|
/** Show Agent Sessions */
|
|
7163
7170
|
show_agent_sessions?: boolean | null;
|
|
7171
|
+
/** Use S3 Direct Upload */
|
|
7172
|
+
use_s3_direct_upload?: boolean | null;
|
|
7164
7173
|
/** Hide Online Status */
|
|
7165
7174
|
hide_online_status?: boolean | null;
|
|
7166
7175
|
/** Muted Users */
|
|
@@ -8676,7 +8685,7 @@ interface operations {
|
|
|
8676
8685
|
get_similar_documents: {
|
|
8677
8686
|
parameters: {
|
|
8678
8687
|
query?: {
|
|
8679
|
-
/** @description Minimum similarity score (default 0.
|
|
8688
|
+
/** @description Minimum similarity score (default 0.95 for near-duplicates) */
|
|
8680
8689
|
threshold?: number;
|
|
8681
8690
|
/** @description Filter pairs involving a specific document */
|
|
8682
8691
|
doc_ext_id?: string | null;
|
package/dist/index.d.ts
CHANGED
|
@@ -2350,7 +2350,7 @@ interface components {
|
|
|
2350
2350
|
* @default {
|
|
2351
2351
|
* "API_TYPE": "remote",
|
|
2352
2352
|
* "ENABLE_THINKING": true,
|
|
2353
|
-
* "MODEL_NAME": "
|
|
2353
|
+
* "MODEL_NAME": "Premium",
|
|
2354
2354
|
* "SYSTEM_INSTRUCTION": "You are a code execution agent. You write and run code to accomplish tasks.\n\nYou have access to an execute_code tool that runs code in a sandboxed Docker container.\n\nThe sandbox has:\n- Python 3.12 with numpy, pandas, matplotlib, requests, beautifulsoup4,\n httpx, pillow, sympy, pyyaml (plus uv for installing more)\n- Node.js 22 with TypeScript (ts-node) and npm\n- Bash with git, curl, wget, jq, sqlite3, build-essential\n- Network access (can pip/npm install additional packages)\n\nInstructions:\n1. Write clean, correct code to accomplish the user's task\n2. Always call execute_code to run your code — never guess the output\n3. If execution errors, analyze the traceback, fix the code, and retry\n4. Once you have the correct output, respond with ONLY the final result\n\nKeep code simple and direct. Prefer Python unless the task specifically requires another language.",
|
|
2355
2355
|
* "TEMPERATURE": 0.2,
|
|
2356
2356
|
* "MAX_TOKENS": 8000,
|
|
@@ -2386,7 +2386,7 @@ interface components {
|
|
|
2386
2386
|
* "MAX_NUMB_OF_CHUNKS": 30,
|
|
2387
2387
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
2388
2388
|
* "MODEL_NAME": "Qwen/Qwen3-Reranker-0.6B",
|
|
2389
|
-
* "API_TYPE": "
|
|
2389
|
+
* "API_TYPE": "local",
|
|
2390
2390
|
* "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"
|
|
2391
2391
|
* }
|
|
2392
2392
|
*/
|
|
@@ -2400,15 +2400,14 @@ interface components {
|
|
|
2400
2400
|
/**
|
|
2401
2401
|
* @default {
|
|
2402
2402
|
* "MAX_CHUNK_TOKENS": 1200,
|
|
2403
|
-
* "
|
|
2404
|
-
* "TOKENIZER_NAME": "Qwen/Qwen3-Embedding-0.6B"
|
|
2403
|
+
* "TOKENIZER_NAME": "cl100k_base"
|
|
2405
2404
|
* }
|
|
2406
2405
|
*/
|
|
2407
2406
|
Chunker: components['schemas']['ChunkerConfig'];
|
|
2408
2407
|
/**
|
|
2409
2408
|
* @default {
|
|
2410
2409
|
* "MODEL_NAME": "Qwen/Qwen3-Embedding-0.6B",
|
|
2411
|
-
* "API_TYPE": "
|
|
2410
|
+
* "API_TYPE": "local",
|
|
2412
2411
|
* "BATCH_SIZE": 128,
|
|
2413
2412
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
2414
2413
|
* "DOCUMENT_PREFIX": "",
|
|
@@ -2762,21 +2761,14 @@ interface components {
|
|
|
2762
2761
|
ChunkerConfig: {
|
|
2763
2762
|
/**
|
|
2764
2763
|
* Max Chunk Tokens
|
|
2765
|
-
* @description Maximum tokens per chunk.
|
|
2764
|
+
* @description Maximum tokens per chunk. Enforces a hard upper bound on chunk size; the tiktoken encoding is model-agnostic and used only for counting.
|
|
2766
2765
|
* @default 1200
|
|
2767
2766
|
*/
|
|
2768
2767
|
MAX_CHUNK_TOKENS: number;
|
|
2769
|
-
/**
|
|
2770
|
-
* Tokenizer Type
|
|
2771
|
-
* @description Tokenizer backend: 'tiktoken' for OpenAI models (cl100k_base, etc.) or 'huggingface' for HF models (Qwen3-Embedding, etc.).
|
|
2772
|
-
* @default huggingface
|
|
2773
|
-
* @enum {string}
|
|
2774
|
-
*/
|
|
2775
|
-
TOKENIZER_TYPE: 'tiktoken' | 'huggingface';
|
|
2776
2768
|
/**
|
|
2777
2769
|
* Tokenizer Name
|
|
2778
|
-
* @description
|
|
2779
|
-
* @default
|
|
2770
|
+
* @description Name of the tiktoken encoding used for chunk-size counting (e.g. 'cl100k_base', 'o200k_base').
|
|
2771
|
+
* @default cl100k_base
|
|
2780
2772
|
*/
|
|
2781
2773
|
TOKENIZER_NAME: string;
|
|
2782
2774
|
};
|
|
@@ -2820,7 +2812,7 @@ interface components {
|
|
|
2820
2812
|
/**
|
|
2821
2813
|
* Model Name
|
|
2822
2814
|
* @description Model for code generation. Should be a strong coding model.
|
|
2823
|
-
* @default
|
|
2815
|
+
* @default Premium
|
|
2824
2816
|
*/
|
|
2825
2817
|
MODEL_NAME: string;
|
|
2826
2818
|
/**
|
|
@@ -3410,8 +3402,8 @@ interface components {
|
|
|
3410
3402
|
* @description A pair of documents identified as near-duplicates by centroid similarity.
|
|
3411
3403
|
*/
|
|
3412
3404
|
DocSimPair: {
|
|
3413
|
-
doc_a: components['schemas']['
|
|
3414
|
-
doc_b: components['schemas']['
|
|
3405
|
+
doc_a: components['schemas']['DocSimSummary'];
|
|
3406
|
+
doc_b: components['schemas']['DocSimSummary'];
|
|
3415
3407
|
/** Similarity */
|
|
3416
3408
|
similarity: number;
|
|
3417
3409
|
};
|
|
@@ -3425,6 +3417,16 @@ interface components {
|
|
|
3425
3417
|
/** Pairs */
|
|
3426
3418
|
pairs: components['schemas']['DocSimPair'][];
|
|
3427
3419
|
};
|
|
3420
|
+
/**
|
|
3421
|
+
* DocSimSummary
|
|
3422
|
+
* @description Lightweight document summary for the similar-documents endpoint.
|
|
3423
|
+
*/
|
|
3424
|
+
DocSimSummary: {
|
|
3425
|
+
/** External Id */
|
|
3426
|
+
external_id: string;
|
|
3427
|
+
/** File Name */
|
|
3428
|
+
file_name?: string | null;
|
|
3429
|
+
};
|
|
3428
3430
|
/**
|
|
3429
3431
|
* DocTagResponse
|
|
3430
3432
|
* @description Response for doctag operations - the link between a document and a tag.
|
|
@@ -3466,7 +3468,7 @@ interface components {
|
|
|
3466
3468
|
shared?: boolean | null;
|
|
3467
3469
|
doc_metadata?: components['schemas']['DocMetadata'] | null;
|
|
3468
3470
|
/** Status */
|
|
3469
|
-
status?: 'processing' | null;
|
|
3471
|
+
status?: ('processing' | 'reindex-sparse') | null;
|
|
3470
3472
|
/** Content */
|
|
3471
3473
|
content?: string | null;
|
|
3472
3474
|
/**
|
|
@@ -3589,7 +3591,7 @@ interface components {
|
|
|
3589
3591
|
/**
|
|
3590
3592
|
* Api Type
|
|
3591
3593
|
* @description The inference type (local or remote).
|
|
3592
|
-
* @default
|
|
3594
|
+
* @default local
|
|
3593
3595
|
* @enum {string}
|
|
3594
3596
|
*/
|
|
3595
3597
|
API_TYPE: 'local' | 'remote';
|
|
@@ -3940,7 +3942,7 @@ interface components {
|
|
|
3940
3942
|
* @default uploading
|
|
3941
3943
|
* @enum {string}
|
|
3942
3944
|
*/
|
|
3943
|
-
status: 'uploading' | 'duplicate' | 'quota_exceeded' | 'unsupported' | 'empty';
|
|
3945
|
+
status: 'uploading' | 'duplicate' | 'quota_exceeded' | 'unsupported' | 'empty' | 'low-content';
|
|
3944
3946
|
/** Reason */
|
|
3945
3947
|
reason?: string | null;
|
|
3946
3948
|
};
|
|
@@ -5278,7 +5280,7 @@ interface components {
|
|
|
5278
5280
|
/**
|
|
5279
5281
|
* Api Type
|
|
5280
5282
|
* @description The inference type (local or remote).
|
|
5281
|
-
* @default
|
|
5283
|
+
* @default local
|
|
5282
5284
|
* @enum {string}
|
|
5283
5285
|
*/
|
|
5284
5286
|
API_TYPE: 'local' | 'remote';
|
|
@@ -6570,7 +6572,7 @@ interface components {
|
|
|
6570
6572
|
* Status
|
|
6571
6573
|
* @enum {string}
|
|
6572
6574
|
*/
|
|
6573
|
-
status: 'uploading' | 'queued' | 'parsing' | 'encrypting' | 'indexing' | 'analysing' | 'completed' | 'failed' | 'skipped' | 'empty';
|
|
6575
|
+
status: 'uploading' | 'queued' | 'parsing' | 'encrypting' | 'indexing' | 'analysing' | 'completed' | 'failed' | 'skipped' | 'empty' | 'low-content';
|
|
6574
6576
|
/** Progress */
|
|
6575
6577
|
progress: number;
|
|
6576
6578
|
};
|
|
@@ -7117,6 +7119,11 @@ interface components {
|
|
|
7117
7119
|
* @default false
|
|
7118
7120
|
*/
|
|
7119
7121
|
show_agent_sessions: boolean;
|
|
7122
|
+
/**
|
|
7123
|
+
* Use S3 Direct Upload
|
|
7124
|
+
* @default false
|
|
7125
|
+
*/
|
|
7126
|
+
use_s3_direct_upload: boolean;
|
|
7120
7127
|
/**
|
|
7121
7128
|
* Hide Online Status
|
|
7122
7129
|
* @default false
|
|
@@ -7161,6 +7168,8 @@ interface components {
|
|
|
7161
7168
|
show_pa_mode?: boolean | null;
|
|
7162
7169
|
/** Show Agent Sessions */
|
|
7163
7170
|
show_agent_sessions?: boolean | null;
|
|
7171
|
+
/** Use S3 Direct Upload */
|
|
7172
|
+
use_s3_direct_upload?: boolean | null;
|
|
7164
7173
|
/** Hide Online Status */
|
|
7165
7174
|
hide_online_status?: boolean | null;
|
|
7166
7175
|
/** Muted Users */
|
|
@@ -8676,7 +8685,7 @@ interface operations {
|
|
|
8676
8685
|
get_similar_documents: {
|
|
8677
8686
|
parameters: {
|
|
8678
8687
|
query?: {
|
|
8679
|
-
/** @description Minimum similarity score (default 0.
|
|
8688
|
+
/** @description Minimum similarity score (default 0.95 for near-duplicates) */
|
|
8680
8689
|
threshold?: number;
|
|
8681
8690
|
/** @description Filter pairs involving a specific document */
|
|
8682
8691
|
doc_ext_id?: string | null;
|
package/package.json
CHANGED