@arbidocs/client 0.3.45 → 0.3.47
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 +9 -120
- package/dist/index.d.ts +9 -120
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -744,35 +744,6 @@ interface paths {
|
|
|
744
744
|
patch?: never;
|
|
745
745
|
trace?: never;
|
|
746
746
|
};
|
|
747
|
-
'/v1/document/columns': {
|
|
748
|
-
parameters: {
|
|
749
|
-
query?: never;
|
|
750
|
-
header?: never;
|
|
751
|
-
path?: never;
|
|
752
|
-
cookie?: never;
|
|
753
|
-
};
|
|
754
|
-
get?: never;
|
|
755
|
-
put?: never;
|
|
756
|
-
/**
|
|
757
|
-
* Fetch Document Columns Endpoint
|
|
758
|
-
* @description Fetch specific encrypted column groups for a batch of documents.
|
|
759
|
-
*
|
|
760
|
-
* Companion to ``GET /v1/document/list?fields=lite``: the list endpoint
|
|
761
|
-
* returns all rows fast with plain DB columns + decrypted ``file_name``,
|
|
762
|
-
* and this endpoint fills in the heavy encrypted fields (``doc_metadata``
|
|
763
|
-
* and ``doctags``) on demand when the frontend reveals the columns that
|
|
764
|
-
* need them.
|
|
765
|
-
*
|
|
766
|
-
* Only the column groups listed in ``fields`` trigger DB work and
|
|
767
|
-
* decryption, so the cost scales with what's actually asked for.
|
|
768
|
-
*/
|
|
769
|
-
post: operations['fetch_document_columns'];
|
|
770
|
-
delete?: never;
|
|
771
|
-
options?: never;
|
|
772
|
-
head?: never;
|
|
773
|
-
patch?: never;
|
|
774
|
-
trace?: never;
|
|
775
|
-
};
|
|
776
747
|
'/v1/document/similar': {
|
|
777
748
|
parameters: {
|
|
778
749
|
query?: never;
|
|
@@ -2379,7 +2350,7 @@ interface components {
|
|
|
2379
2350
|
* @default {
|
|
2380
2351
|
* "API_TYPE": "remote",
|
|
2381
2352
|
* "ENABLE_THINKING": true,
|
|
2382
|
-
* "MODEL_NAME": "
|
|
2353
|
+
* "MODEL_NAME": "GLM5@Fireworks",
|
|
2383
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.",
|
|
2384
2355
|
* "TEMPERATURE": 0.2,
|
|
2385
2356
|
* "MAX_TOKENS": 8000,
|
|
@@ -2415,7 +2386,7 @@ interface components {
|
|
|
2415
2386
|
* "MAX_NUMB_OF_CHUNKS": 30,
|
|
2416
2387
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
2417
2388
|
* "MODEL_NAME": "Qwen/Qwen3-Reranker-0.6B",
|
|
2418
|
-
* "API_TYPE": "
|
|
2389
|
+
* "API_TYPE": "remote",
|
|
2419
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"
|
|
2420
2391
|
* }
|
|
2421
2392
|
*/
|
|
@@ -2437,7 +2408,7 @@ interface components {
|
|
|
2437
2408
|
/**
|
|
2438
2409
|
* @default {
|
|
2439
2410
|
* "MODEL_NAME": "Qwen/Qwen3-Embedding-0.6B",
|
|
2440
|
-
* "API_TYPE": "
|
|
2411
|
+
* "API_TYPE": "remote",
|
|
2441
2412
|
* "BATCH_SIZE": 128,
|
|
2442
2413
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
2443
2414
|
* "DOCUMENT_PREFIX": "",
|
|
@@ -2849,7 +2820,7 @@ interface components {
|
|
|
2849
2820
|
/**
|
|
2850
2821
|
* Model Name
|
|
2851
2822
|
* @description Model for code generation. Should be a strong coding model.
|
|
2852
|
-
* @default
|
|
2823
|
+
* @default GLM5@Fireworks
|
|
2853
2824
|
*/
|
|
2854
2825
|
MODEL_NAME: string;
|
|
2855
2826
|
/**
|
|
@@ -3357,45 +3328,6 @@ interface components {
|
|
|
3357
3328
|
/** External Ids */
|
|
3358
3329
|
external_ids: string[];
|
|
3359
3330
|
};
|
|
3360
|
-
/**
|
|
3361
|
-
* DocColumnData
|
|
3362
|
-
* @description Per-document column data returned by POST /v1/document/columns.
|
|
3363
|
-
*
|
|
3364
|
-
* Fields are populated only when requested in the ``fields`` list. Unrequested
|
|
3365
|
-
* fields are omitted from the response. Used by the frontend's on-demand
|
|
3366
|
-
* column loader to fill in encrypted/joined fields after the skeleton load.
|
|
3367
|
-
*/
|
|
3368
|
-
DocColumnData: {
|
|
3369
|
-
/** External Id */
|
|
3370
|
-
external_id: string;
|
|
3371
|
-
doc_metadata?: components['schemas']['DocMetadata'] | null;
|
|
3372
|
-
/** Doctags */
|
|
3373
|
-
doctags?: components['schemas']['DocTagResponse'][] | null;
|
|
3374
|
-
};
|
|
3375
|
-
/**
|
|
3376
|
-
* DocColumnsRequest
|
|
3377
|
-
* @description Request body for POST /v1/document/columns.
|
|
3378
|
-
*/
|
|
3379
|
-
DocColumnsRequest: {
|
|
3380
|
-
/**
|
|
3381
|
-
* External Ids
|
|
3382
|
-
* @description Document external IDs to fetch columns for (max 10k per request).
|
|
3383
|
-
*/
|
|
3384
|
-
external_ids: string[];
|
|
3385
|
-
/**
|
|
3386
|
-
* Fields
|
|
3387
|
-
* @description Column groups to decrypt and return for each document.
|
|
3388
|
-
*/
|
|
3389
|
-
fields: ('doc_metadata' | 'doctags')[];
|
|
3390
|
-
};
|
|
3391
|
-
/**
|
|
3392
|
-
* DocColumnsResponse
|
|
3393
|
-
* @description Response for POST /v1/document/columns — batch column data for many docs.
|
|
3394
|
-
*/
|
|
3395
|
-
DocColumnsResponse: {
|
|
3396
|
-
/** Docs */
|
|
3397
|
-
docs: components['schemas']['DocColumnData'][];
|
|
3398
|
-
};
|
|
3399
3331
|
/**
|
|
3400
3332
|
* DocMetadata
|
|
3401
3333
|
* @description Structured model for document metadata stored in JSONB column.
|
|
@@ -3478,8 +3410,8 @@ interface components {
|
|
|
3478
3410
|
* @description A pair of documents identified as near-duplicates by centroid similarity.
|
|
3479
3411
|
*/
|
|
3480
3412
|
DocSimPair: {
|
|
3481
|
-
doc_a: components['schemas']['
|
|
3482
|
-
doc_b: components['schemas']['
|
|
3413
|
+
doc_a: components['schemas']['DocResponse'];
|
|
3414
|
+
doc_b: components['schemas']['DocResponse'];
|
|
3483
3415
|
/** Similarity */
|
|
3484
3416
|
similarity: number;
|
|
3485
3417
|
};
|
|
@@ -3493,16 +3425,6 @@ interface components {
|
|
|
3493
3425
|
/** Pairs */
|
|
3494
3426
|
pairs: components['schemas']['DocSimPair'][];
|
|
3495
3427
|
};
|
|
3496
|
-
/**
|
|
3497
|
-
* DocSimSummary
|
|
3498
|
-
* @description Lightweight document summary for the similar-documents endpoint.
|
|
3499
|
-
*/
|
|
3500
|
-
DocSimSummary: {
|
|
3501
|
-
/** External Id */
|
|
3502
|
-
external_id: string;
|
|
3503
|
-
/** File Name */
|
|
3504
|
-
file_name?: string | null;
|
|
3505
|
-
};
|
|
3506
3428
|
/**
|
|
3507
3429
|
* DocTagResponse
|
|
3508
3430
|
* @description Response for doctag operations - the link between a document and a tag.
|
|
@@ -3667,7 +3589,7 @@ interface components {
|
|
|
3667
3589
|
/**
|
|
3668
3590
|
* Api Type
|
|
3669
3591
|
* @description The inference type (local or remote).
|
|
3670
|
-
* @default
|
|
3592
|
+
* @default remote
|
|
3671
3593
|
* @enum {string}
|
|
3672
3594
|
*/
|
|
3673
3595
|
API_TYPE: 'local' | 'remote';
|
|
@@ -5356,7 +5278,7 @@ interface components {
|
|
|
5356
5278
|
/**
|
|
5357
5279
|
* Api Type
|
|
5358
5280
|
* @description The inference type (local or remote).
|
|
5359
|
-
* @default
|
|
5281
|
+
* @default remote
|
|
5360
5282
|
* @enum {string}
|
|
5361
5283
|
*/
|
|
5362
5284
|
API_TYPE: 'local' | 'remote';
|
|
@@ -8751,43 +8673,10 @@ interface operations {
|
|
|
8751
8673
|
};
|
|
8752
8674
|
};
|
|
8753
8675
|
};
|
|
8754
|
-
fetch_document_columns: {
|
|
8755
|
-
parameters: {
|
|
8756
|
-
query?: never;
|
|
8757
|
-
header?: never;
|
|
8758
|
-
path?: never;
|
|
8759
|
-
cookie?: never;
|
|
8760
|
-
};
|
|
8761
|
-
requestBody: {
|
|
8762
|
-
content: {
|
|
8763
|
-
'application/json': components['schemas']['DocColumnsRequest'];
|
|
8764
|
-
};
|
|
8765
|
-
};
|
|
8766
|
-
responses: {
|
|
8767
|
-
/** @description Successful Response */
|
|
8768
|
-
200: {
|
|
8769
|
-
headers: {
|
|
8770
|
-
[name: string]: unknown;
|
|
8771
|
-
};
|
|
8772
|
-
content: {
|
|
8773
|
-
'application/json': components['schemas']['DocColumnsResponse'];
|
|
8774
|
-
};
|
|
8775
|
-
};
|
|
8776
|
-
/** @description Validation Error */
|
|
8777
|
-
422: {
|
|
8778
|
-
headers: {
|
|
8779
|
-
[name: string]: unknown;
|
|
8780
|
-
};
|
|
8781
|
-
content: {
|
|
8782
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
8783
|
-
};
|
|
8784
|
-
};
|
|
8785
|
-
};
|
|
8786
|
-
};
|
|
8787
8676
|
get_similar_documents: {
|
|
8788
8677
|
parameters: {
|
|
8789
8678
|
query?: {
|
|
8790
|
-
/** @description Minimum similarity score (default 0.
|
|
8679
|
+
/** @description Minimum similarity score (default 0.92 for near-duplicates) */
|
|
8791
8680
|
threshold?: number;
|
|
8792
8681
|
/** @description Filter pairs involving a specific document */
|
|
8793
8682
|
doc_ext_id?: string | null;
|
package/dist/index.d.ts
CHANGED
|
@@ -744,35 +744,6 @@ interface paths {
|
|
|
744
744
|
patch?: never;
|
|
745
745
|
trace?: never;
|
|
746
746
|
};
|
|
747
|
-
'/v1/document/columns': {
|
|
748
|
-
parameters: {
|
|
749
|
-
query?: never;
|
|
750
|
-
header?: never;
|
|
751
|
-
path?: never;
|
|
752
|
-
cookie?: never;
|
|
753
|
-
};
|
|
754
|
-
get?: never;
|
|
755
|
-
put?: never;
|
|
756
|
-
/**
|
|
757
|
-
* Fetch Document Columns Endpoint
|
|
758
|
-
* @description Fetch specific encrypted column groups for a batch of documents.
|
|
759
|
-
*
|
|
760
|
-
* Companion to ``GET /v1/document/list?fields=lite``: the list endpoint
|
|
761
|
-
* returns all rows fast with plain DB columns + decrypted ``file_name``,
|
|
762
|
-
* and this endpoint fills in the heavy encrypted fields (``doc_metadata``
|
|
763
|
-
* and ``doctags``) on demand when the frontend reveals the columns that
|
|
764
|
-
* need them.
|
|
765
|
-
*
|
|
766
|
-
* Only the column groups listed in ``fields`` trigger DB work and
|
|
767
|
-
* decryption, so the cost scales with what's actually asked for.
|
|
768
|
-
*/
|
|
769
|
-
post: operations['fetch_document_columns'];
|
|
770
|
-
delete?: never;
|
|
771
|
-
options?: never;
|
|
772
|
-
head?: never;
|
|
773
|
-
patch?: never;
|
|
774
|
-
trace?: never;
|
|
775
|
-
};
|
|
776
747
|
'/v1/document/similar': {
|
|
777
748
|
parameters: {
|
|
778
749
|
query?: never;
|
|
@@ -2379,7 +2350,7 @@ interface components {
|
|
|
2379
2350
|
* @default {
|
|
2380
2351
|
* "API_TYPE": "remote",
|
|
2381
2352
|
* "ENABLE_THINKING": true,
|
|
2382
|
-
* "MODEL_NAME": "
|
|
2353
|
+
* "MODEL_NAME": "GLM5@Fireworks",
|
|
2383
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.",
|
|
2384
2355
|
* "TEMPERATURE": 0.2,
|
|
2385
2356
|
* "MAX_TOKENS": 8000,
|
|
@@ -2415,7 +2386,7 @@ interface components {
|
|
|
2415
2386
|
* "MAX_NUMB_OF_CHUNKS": 30,
|
|
2416
2387
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
2417
2388
|
* "MODEL_NAME": "Qwen/Qwen3-Reranker-0.6B",
|
|
2418
|
-
* "API_TYPE": "
|
|
2389
|
+
* "API_TYPE": "remote",
|
|
2419
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"
|
|
2420
2391
|
* }
|
|
2421
2392
|
*/
|
|
@@ -2437,7 +2408,7 @@ interface components {
|
|
|
2437
2408
|
/**
|
|
2438
2409
|
* @default {
|
|
2439
2410
|
* "MODEL_NAME": "Qwen/Qwen3-Embedding-0.6B",
|
|
2440
|
-
* "API_TYPE": "
|
|
2411
|
+
* "API_TYPE": "remote",
|
|
2441
2412
|
* "BATCH_SIZE": 128,
|
|
2442
2413
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
2443
2414
|
* "DOCUMENT_PREFIX": "",
|
|
@@ -2849,7 +2820,7 @@ interface components {
|
|
|
2849
2820
|
/**
|
|
2850
2821
|
* Model Name
|
|
2851
2822
|
* @description Model for code generation. Should be a strong coding model.
|
|
2852
|
-
* @default
|
|
2823
|
+
* @default GLM5@Fireworks
|
|
2853
2824
|
*/
|
|
2854
2825
|
MODEL_NAME: string;
|
|
2855
2826
|
/**
|
|
@@ -3357,45 +3328,6 @@ interface components {
|
|
|
3357
3328
|
/** External Ids */
|
|
3358
3329
|
external_ids: string[];
|
|
3359
3330
|
};
|
|
3360
|
-
/**
|
|
3361
|
-
* DocColumnData
|
|
3362
|
-
* @description Per-document column data returned by POST /v1/document/columns.
|
|
3363
|
-
*
|
|
3364
|
-
* Fields are populated only when requested in the ``fields`` list. Unrequested
|
|
3365
|
-
* fields are omitted from the response. Used by the frontend's on-demand
|
|
3366
|
-
* column loader to fill in encrypted/joined fields after the skeleton load.
|
|
3367
|
-
*/
|
|
3368
|
-
DocColumnData: {
|
|
3369
|
-
/** External Id */
|
|
3370
|
-
external_id: string;
|
|
3371
|
-
doc_metadata?: components['schemas']['DocMetadata'] | null;
|
|
3372
|
-
/** Doctags */
|
|
3373
|
-
doctags?: components['schemas']['DocTagResponse'][] | null;
|
|
3374
|
-
};
|
|
3375
|
-
/**
|
|
3376
|
-
* DocColumnsRequest
|
|
3377
|
-
* @description Request body for POST /v1/document/columns.
|
|
3378
|
-
*/
|
|
3379
|
-
DocColumnsRequest: {
|
|
3380
|
-
/**
|
|
3381
|
-
* External Ids
|
|
3382
|
-
* @description Document external IDs to fetch columns for (max 10k per request).
|
|
3383
|
-
*/
|
|
3384
|
-
external_ids: string[];
|
|
3385
|
-
/**
|
|
3386
|
-
* Fields
|
|
3387
|
-
* @description Column groups to decrypt and return for each document.
|
|
3388
|
-
*/
|
|
3389
|
-
fields: ('doc_metadata' | 'doctags')[];
|
|
3390
|
-
};
|
|
3391
|
-
/**
|
|
3392
|
-
* DocColumnsResponse
|
|
3393
|
-
* @description Response for POST /v1/document/columns — batch column data for many docs.
|
|
3394
|
-
*/
|
|
3395
|
-
DocColumnsResponse: {
|
|
3396
|
-
/** Docs */
|
|
3397
|
-
docs: components['schemas']['DocColumnData'][];
|
|
3398
|
-
};
|
|
3399
3331
|
/**
|
|
3400
3332
|
* DocMetadata
|
|
3401
3333
|
* @description Structured model for document metadata stored in JSONB column.
|
|
@@ -3478,8 +3410,8 @@ interface components {
|
|
|
3478
3410
|
* @description A pair of documents identified as near-duplicates by centroid similarity.
|
|
3479
3411
|
*/
|
|
3480
3412
|
DocSimPair: {
|
|
3481
|
-
doc_a: components['schemas']['
|
|
3482
|
-
doc_b: components['schemas']['
|
|
3413
|
+
doc_a: components['schemas']['DocResponse'];
|
|
3414
|
+
doc_b: components['schemas']['DocResponse'];
|
|
3483
3415
|
/** Similarity */
|
|
3484
3416
|
similarity: number;
|
|
3485
3417
|
};
|
|
@@ -3493,16 +3425,6 @@ interface components {
|
|
|
3493
3425
|
/** Pairs */
|
|
3494
3426
|
pairs: components['schemas']['DocSimPair'][];
|
|
3495
3427
|
};
|
|
3496
|
-
/**
|
|
3497
|
-
* DocSimSummary
|
|
3498
|
-
* @description Lightweight document summary for the similar-documents endpoint.
|
|
3499
|
-
*/
|
|
3500
|
-
DocSimSummary: {
|
|
3501
|
-
/** External Id */
|
|
3502
|
-
external_id: string;
|
|
3503
|
-
/** File Name */
|
|
3504
|
-
file_name?: string | null;
|
|
3505
|
-
};
|
|
3506
3428
|
/**
|
|
3507
3429
|
* DocTagResponse
|
|
3508
3430
|
* @description Response for doctag operations - the link between a document and a tag.
|
|
@@ -3667,7 +3589,7 @@ interface components {
|
|
|
3667
3589
|
/**
|
|
3668
3590
|
* Api Type
|
|
3669
3591
|
* @description The inference type (local or remote).
|
|
3670
|
-
* @default
|
|
3592
|
+
* @default remote
|
|
3671
3593
|
* @enum {string}
|
|
3672
3594
|
*/
|
|
3673
3595
|
API_TYPE: 'local' | 'remote';
|
|
@@ -5356,7 +5278,7 @@ interface components {
|
|
|
5356
5278
|
/**
|
|
5357
5279
|
* Api Type
|
|
5358
5280
|
* @description The inference type (local or remote).
|
|
5359
|
-
* @default
|
|
5281
|
+
* @default remote
|
|
5360
5282
|
* @enum {string}
|
|
5361
5283
|
*/
|
|
5362
5284
|
API_TYPE: 'local' | 'remote';
|
|
@@ -8751,43 +8673,10 @@ interface operations {
|
|
|
8751
8673
|
};
|
|
8752
8674
|
};
|
|
8753
8675
|
};
|
|
8754
|
-
fetch_document_columns: {
|
|
8755
|
-
parameters: {
|
|
8756
|
-
query?: never;
|
|
8757
|
-
header?: never;
|
|
8758
|
-
path?: never;
|
|
8759
|
-
cookie?: never;
|
|
8760
|
-
};
|
|
8761
|
-
requestBody: {
|
|
8762
|
-
content: {
|
|
8763
|
-
'application/json': components['schemas']['DocColumnsRequest'];
|
|
8764
|
-
};
|
|
8765
|
-
};
|
|
8766
|
-
responses: {
|
|
8767
|
-
/** @description Successful Response */
|
|
8768
|
-
200: {
|
|
8769
|
-
headers: {
|
|
8770
|
-
[name: string]: unknown;
|
|
8771
|
-
};
|
|
8772
|
-
content: {
|
|
8773
|
-
'application/json': components['schemas']['DocColumnsResponse'];
|
|
8774
|
-
};
|
|
8775
|
-
};
|
|
8776
|
-
/** @description Validation Error */
|
|
8777
|
-
422: {
|
|
8778
|
-
headers: {
|
|
8779
|
-
[name: string]: unknown;
|
|
8780
|
-
};
|
|
8781
|
-
content: {
|
|
8782
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
8783
|
-
};
|
|
8784
|
-
};
|
|
8785
|
-
};
|
|
8786
|
-
};
|
|
8787
8676
|
get_similar_documents: {
|
|
8788
8677
|
parameters: {
|
|
8789
8678
|
query?: {
|
|
8790
|
-
/** @description Minimum similarity score (default 0.
|
|
8679
|
+
/** @description Minimum similarity score (default 0.92 for near-duplicates) */
|
|
8791
8680
|
threshold?: number;
|
|
8792
8681
|
/** @description Filter pairs involving a specific document */
|
|
8793
8682
|
doc_ext_id?: string | null;
|
package/package.json
CHANGED