@arbidocs/client 0.3.54 → 0.3.56
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 +265 -8
- package/dist/index.d.ts +265 -8
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -510,6 +510,30 @@ interface paths {
|
|
|
510
510
|
patch?: never;
|
|
511
511
|
trace?: never;
|
|
512
512
|
};
|
|
513
|
+
'/v1/user/me/usage/today': {
|
|
514
|
+
parameters: {
|
|
515
|
+
query?: never;
|
|
516
|
+
header?: never;
|
|
517
|
+
path?: never;
|
|
518
|
+
cookie?: never;
|
|
519
|
+
};
|
|
520
|
+
/**
|
|
521
|
+
* Get User Usage Today
|
|
522
|
+
* @description Return today's deployment-wide credit spend for the current user.
|
|
523
|
+
*
|
|
524
|
+
* The same number that the per-user daily cap is enforced against in
|
|
525
|
+
* ``check_ai_access``. Frontend pairs this with the project's
|
|
526
|
+
* ``daily_cap_per_user`` to render a "credits today" indicator for non-owners.
|
|
527
|
+
*/
|
|
528
|
+
get: operations['get_user_usage_today'];
|
|
529
|
+
put?: never;
|
|
530
|
+
post?: never;
|
|
531
|
+
delete?: never;
|
|
532
|
+
options?: never;
|
|
533
|
+
head?: never;
|
|
534
|
+
patch?: never;
|
|
535
|
+
trace?: never;
|
|
536
|
+
};
|
|
513
537
|
'/v1/user/settings': {
|
|
514
538
|
parameters: {
|
|
515
539
|
query?: never;
|
|
@@ -538,6 +562,63 @@ interface paths {
|
|
|
538
562
|
patch: operations['update_user_settings'];
|
|
539
563
|
trace?: never;
|
|
540
564
|
};
|
|
565
|
+
'/v1/user/me': {
|
|
566
|
+
parameters: {
|
|
567
|
+
query?: never;
|
|
568
|
+
header?: never;
|
|
569
|
+
path?: never;
|
|
570
|
+
cookie?: never;
|
|
571
|
+
};
|
|
572
|
+
get?: never;
|
|
573
|
+
put?: never;
|
|
574
|
+
post?: never;
|
|
575
|
+
/**
|
|
576
|
+
* Delete My Account
|
|
577
|
+
* @description Permanently delete the calling user and all their data.
|
|
578
|
+
*
|
|
579
|
+
* **Test-account-only:** restricted to `test+NNN@arbi.city` accounts that have
|
|
580
|
+
* `settings.developer == true`. All other callers receive 403. This restriction
|
|
581
|
+
* exists because production-grade account deletion (soft-delete, PII scrubbing,
|
|
582
|
+
* content reassignment) is not yet designed.
|
|
583
|
+
*
|
|
584
|
+
* Body must include `confirm_email` matching the authenticated user's email.
|
|
585
|
+
*/
|
|
586
|
+
delete: operations['delete_my_account'];
|
|
587
|
+
options?: never;
|
|
588
|
+
head?: never;
|
|
589
|
+
patch?: never;
|
|
590
|
+
trace?: never;
|
|
591
|
+
};
|
|
592
|
+
'/v1/user/test-accounts': {
|
|
593
|
+
parameters: {
|
|
594
|
+
query?: never;
|
|
595
|
+
header?: never;
|
|
596
|
+
path?: never;
|
|
597
|
+
cookie?: never;
|
|
598
|
+
};
|
|
599
|
+
/**
|
|
600
|
+
* List Test Accounts
|
|
601
|
+
* @description List emails of users matching the `<prefix>+<NNN>@<domain>` test convention.
|
|
602
|
+
*
|
|
603
|
+
* Authenticated via the support API key (header `X-API-Key`). Intended for
|
|
604
|
+
* test-account tooling only. Returns ``{"emails": [...]}``.
|
|
605
|
+
*/
|
|
606
|
+
get: operations['list_test_accounts'];
|
|
607
|
+
put?: never;
|
|
608
|
+
post?: never;
|
|
609
|
+
/**
|
|
610
|
+
* Delete Test Accounts
|
|
611
|
+
* @description Bulk-wipe users matching the test-account regex AND the given email suffix.
|
|
612
|
+
*
|
|
613
|
+
* Authenticated via the support API key (header `X-API-Key`). Returns
|
|
614
|
+
* ``{"deleted": [...]}`` with the emails that were wiped.
|
|
615
|
+
*/
|
|
616
|
+
delete: operations['delete_test_accounts'];
|
|
617
|
+
options?: never;
|
|
618
|
+
head?: never;
|
|
619
|
+
patch?: never;
|
|
620
|
+
trace?: never;
|
|
621
|
+
};
|
|
541
622
|
'/v1/user/products': {
|
|
542
623
|
parameters: {
|
|
543
624
|
query?: never;
|
|
@@ -2215,7 +2296,7 @@ interface components {
|
|
|
2215
2296
|
* "API_TYPE": "remote",
|
|
2216
2297
|
* "ENABLE_THINKING": false,
|
|
2217
2298
|
* "MODEL_NAME": "Fast",
|
|
2218
|
-
* "SYSTEM_INSTRUCTION": "You are a title generator that creates concise, descriptive titles.",
|
|
2299
|
+
* "SYSTEM_INSTRUCTION": "You are a title generator that creates concise, descriptive titles.\n\nOutput the title as plain text only. Do not use Markdown or any other formatting. Specifically:\n- Do not bold, italicize, or otherwise emphasize any part of the title.\n- Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.\n- Do not prefix the title with bullets, dashes (-), or numbered/lettered enumeration (e.g. \"1.\", \"a)\").\n- Do not wrap the title in quotes or brackets.",
|
|
2219
2300
|
* "MAX_CHAR_SIZE_TO_ANSWER": 50,
|
|
2220
2301
|
* "TEMPERATURE": 0.3,
|
|
2221
2302
|
* "MAX_TOKENS": 20
|
|
@@ -2241,7 +2322,7 @@ interface components {
|
|
|
2241
2322
|
* "API_TYPE": "remote",
|
|
2242
2323
|
* "ENABLE_THINKING": false,
|
|
2243
2324
|
* "MODEL_NAME": "Fast",
|
|
2244
|
-
* "SYSTEM_INSTRUCTION": "You are a document analysis assistant. Answer questions based strictly on document content.\n\nGuidelines:\n- Only use information explicitly stated in the document\n- Do not infer or assume information not present\n- If information is not found, respond with \"Information not found in document.\"\n- Follow format instructions exactly for each answer\n- Be concise and precise",
|
|
2325
|
+
* "SYSTEM_INSTRUCTION": "You are a document analysis assistant. Answer questions based strictly on document content.\n\nGuidelines:\n- Only use information explicitly stated in the document\n- Do not infer or assume information not present\n- If information is not found, respond with \"Information not found in document.\"\n- Follow format instructions exactly for each answer\n- Be concise and precise\n- Output answers as plain text only. Do not use Markdown or any other formatting:\n - Do not bold, italicize, or otherwise emphasize any part of the answer.\n - Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.\n - Do not prefix answers with bullets, dashes (-), or numbered/lettered enumeration (e.g. \"1.\", \"a)\").\n - Write multi-point answers as flowing sentences, not as a list.",
|
|
2245
2326
|
* "MAX_CHAR_CONTEXT_TO_ANSWER": 100000,
|
|
2246
2327
|
* "TEMPERATURE": 0.1,
|
|
2247
2328
|
* "MAX_TOKENS": 2000,
|
|
@@ -2380,12 +2461,12 @@ interface components {
|
|
|
2380
2461
|
* "SEARCH_MODE": "semantic"
|
|
2381
2462
|
* },
|
|
2382
2463
|
* "smart_search": {
|
|
2383
|
-
* "GROUP_SIZE":
|
|
2464
|
+
* "GROUP_SIZE": 50,
|
|
2384
2465
|
* "HYBRID_DENSE_WEIGHT": 0.7,
|
|
2385
2466
|
* "HYBRID_PREFETCH_LIMIT": 10000,
|
|
2386
2467
|
* "HYBRID_SPARSE_WEIGHT": 0.3,
|
|
2387
2468
|
* "MAX_DISTINCT_DOCUMENTS": 100000,
|
|
2388
|
-
* "MAX_TOTAL_CHUNKS_TO_RETRIEVE":
|
|
2469
|
+
* "MAX_TOTAL_CHUNKS_TO_RETRIEVE": 100000,
|
|
2389
2470
|
* "MIN_RETRIEVAL_SIM_SCORE": 0.1,
|
|
2390
2471
|
* "SEARCH_MODE": "hybrid"
|
|
2391
2472
|
* }
|
|
@@ -2399,7 +2480,7 @@ interface components {
|
|
|
2399
2480
|
* "MIN_SCORE": 0.01
|
|
2400
2481
|
* },
|
|
2401
2482
|
* "smart_search": {
|
|
2402
|
-
* "MAX_NUMB_OF_CHUNKS":
|
|
2483
|
+
* "MAX_NUMB_OF_CHUNKS": 100000,
|
|
2403
2484
|
* "MIN_SCORE": 0
|
|
2404
2485
|
* },
|
|
2405
2486
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
@@ -2439,7 +2520,9 @@ interface components {
|
|
|
2439
2520
|
* "FILTER_STOPWORDS": true,
|
|
2440
2521
|
* "BM25_K1": 1.5,
|
|
2441
2522
|
* "BM25_B": 0.75,
|
|
2442
|
-
* "BM25_AVGDL": 100
|
|
2523
|
+
* "BM25_AVGDL": 100,
|
|
2524
|
+
* "CJK_NGRAM_SIZE": 2,
|
|
2525
|
+
* "NORMALIZE_TRADITIONAL_TO_SIMPLIFIED": true
|
|
2443
2526
|
* }
|
|
2444
2527
|
*/
|
|
2445
2528
|
KeywordEmbedder: components['schemas']['KeywordEmbedderConfig'];
|
|
@@ -2968,6 +3051,14 @@ interface components {
|
|
|
2968
3051
|
/** Versions */
|
|
2969
3052
|
versions: components['schemas']['ConfigVersionInfo'][];
|
|
2970
3053
|
};
|
|
3054
|
+
/**
|
|
3055
|
+
* ConfirmDeleteRequest
|
|
3056
|
+
* @description Body for DELETE /users/me. confirm_email must match the authenticated user's email.
|
|
3057
|
+
*/
|
|
3058
|
+
ConfirmDeleteRequest: {
|
|
3059
|
+
/** Confirm Email */
|
|
3060
|
+
confirm_email: string;
|
|
3061
|
+
};
|
|
2971
3062
|
/**
|
|
2972
3063
|
* ConnectionClosedMessage
|
|
2973
3064
|
* @description Sent when connection is closed (e.g., another tab opened).
|
|
@@ -3534,6 +3625,11 @@ interface components {
|
|
|
3534
3625
|
* - If information is not found, respond with "Information not found in document."
|
|
3535
3626
|
* - Follow format instructions exactly for each answer
|
|
3536
3627
|
* - Be concise and precise
|
|
3628
|
+
* - Output answers as plain text only. Do not use Markdown or any other formatting:
|
|
3629
|
+
* - Do not bold, italicize, or otherwise emphasize any part of the answer.
|
|
3630
|
+
* - Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.
|
|
3631
|
+
* - Do not prefix answers with bullets, dashes (-), or numbered/lettered enumeration (e.g. "1.", "a)").
|
|
3632
|
+
* - Write multi-point answers as flowing sentences, not as a list.
|
|
3537
3633
|
*/
|
|
3538
3634
|
SYSTEM_INSTRUCTION: string;
|
|
3539
3635
|
/**
|
|
@@ -3999,6 +4095,18 @@ interface components {
|
|
|
3999
4095
|
* @default 100
|
|
4000
4096
|
*/
|
|
4001
4097
|
BM25_AVGDL: number;
|
|
4098
|
+
/**
|
|
4099
|
+
* Cjk Ngram Size
|
|
4100
|
+
* @description N-gram size for CJK character runs (Chinese/Japanese/Korean). 2 = bi-grams (recommended for e-discovery recall). 1 = uni-grams (very noisy).
|
|
4101
|
+
* @default 2
|
|
4102
|
+
*/
|
|
4103
|
+
CJK_NGRAM_SIZE: number;
|
|
4104
|
+
/**
|
|
4105
|
+
* Normalize Traditional To Simplified
|
|
4106
|
+
* @description Normalize Traditional Chinese to Simplified before tokenization, so a query in one script finds documents in the other. Required for cross-border discovery.
|
|
4107
|
+
* @default true
|
|
4108
|
+
*/
|
|
4109
|
+
NORMALIZE_TRADITIONAL_TO_SIMPLIFIED: boolean;
|
|
4002
4110
|
};
|
|
4003
4111
|
/**
|
|
4004
4112
|
* LoginRequest
|
|
@@ -4570,7 +4678,7 @@ interface components {
|
|
|
4570
4678
|
* Type is self-descriptive, no need to parse content field.
|
|
4571
4679
|
* @enum {string}
|
|
4572
4680
|
*/
|
|
4573
|
-
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'email_reply';
|
|
4681
|
+
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100';
|
|
4574
4682
|
/**
|
|
4575
4683
|
* NotificationUpdate
|
|
4576
4684
|
* @description Single notification update for bulk PATCH.
|
|
@@ -4939,6 +5047,8 @@ interface components {
|
|
|
4939
5047
|
ProjectCreateRequest: {
|
|
4940
5048
|
/** Name */
|
|
4941
5049
|
name: string;
|
|
5050
|
+
/** Daily Cap Per User */
|
|
5051
|
+
daily_cap_per_user?: number | null;
|
|
4942
5052
|
};
|
|
4943
5053
|
/**
|
|
4944
5054
|
* ProjectInvoice
|
|
@@ -4985,12 +5095,21 @@ interface components {
|
|
|
4985
5095
|
/**
|
|
4986
5096
|
* ProjectResponse
|
|
4987
5097
|
* @description Project summary returned in list and detail views.
|
|
5098
|
+
*
|
|
5099
|
+
* Listed for both project owners and workspace members of the project. For
|
|
5100
|
+
* non-owner viewers, ``packs``, ``subscription``, ``quotas``, and the
|
|
5101
|
+
* Stripe billing fields are blanked out (zeros / "none" / null) — only
|
|
5102
|
+
* ``name``, ``external_id``, ``created_by``, and ``daily_cap_per_user`` are
|
|
5103
|
+
* meaningful. Frontend distinguishes the two modes by comparing
|
|
5104
|
+
* ``created_by`` against the current user's external_id.
|
|
4988
5105
|
*/
|
|
4989
5106
|
ProjectResponse: {
|
|
4990
5107
|
/** External Id */
|
|
4991
5108
|
external_id: string;
|
|
4992
5109
|
/** Name */
|
|
4993
5110
|
name: string;
|
|
5111
|
+
/** Created By */
|
|
5112
|
+
created_by: string;
|
|
4994
5113
|
/** Packs */
|
|
4995
5114
|
packs: number;
|
|
4996
5115
|
/** Subscription */
|
|
@@ -5001,6 +5120,8 @@ interface components {
|
|
|
5001
5120
|
*/
|
|
5002
5121
|
created_at: string;
|
|
5003
5122
|
quotas: components['schemas']['ProjectQuotas'];
|
|
5123
|
+
/** Daily Cap Per User */
|
|
5124
|
+
daily_cap_per_user?: number | null;
|
|
5004
5125
|
/** Price Id */
|
|
5005
5126
|
price_id?: string | null;
|
|
5006
5127
|
/** Plan */
|
|
@@ -5018,11 +5139,13 @@ interface components {
|
|
|
5018
5139
|
};
|
|
5019
5140
|
/**
|
|
5020
5141
|
* ProjectUpdateRequest
|
|
5021
|
-
* @description Update project name.
|
|
5142
|
+
* @description Update project name and/or daily per-user cap.
|
|
5022
5143
|
*/
|
|
5023
5144
|
ProjectUpdateRequest: {
|
|
5024
5145
|
/** Name */
|
|
5025
5146
|
name?: string | null;
|
|
5147
|
+
/** Daily Cap Per User */
|
|
5148
|
+
daily_cap_per_user?: number | null;
|
|
5026
5149
|
};
|
|
5027
5150
|
/**
|
|
5028
5151
|
* ProjectUpgradeRequest
|
|
@@ -6669,6 +6792,12 @@ interface components {
|
|
|
6669
6792
|
/**
|
|
6670
6793
|
* System Instruction
|
|
6671
6794
|
* @default You are a title generator that creates concise, descriptive titles.
|
|
6795
|
+
*
|
|
6796
|
+
* Output the title as plain text only. Do not use Markdown or any other formatting. Specifically:
|
|
6797
|
+
* - Do not bold, italicize, or otherwise emphasize any part of the title.
|
|
6798
|
+
* - Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.
|
|
6799
|
+
* - Do not prefix the title with bullets, dashes (-), or numbered/lettered enumeration (e.g. "1.", "a)").
|
|
6800
|
+
* - Do not wrap the title in quotes or brackets.
|
|
6672
6801
|
*/
|
|
6673
6802
|
SYSTEM_INSTRUCTION: string;
|
|
6674
6803
|
/**
|
|
@@ -6975,6 +7104,14 @@ interface components {
|
|
|
6975
7104
|
/** Items */
|
|
6976
7105
|
items?: components['schemas']['InitedUploadItem'][];
|
|
6977
7106
|
};
|
|
7107
|
+
/**
|
|
7108
|
+
* UserDailyUsageResponse
|
|
7109
|
+
* @description Today's deployment-wide credit spend tagged with the current user.
|
|
7110
|
+
*/
|
|
7111
|
+
UserDailyUsageResponse: {
|
|
7112
|
+
/** Credits Used */
|
|
7113
|
+
credits_used: number;
|
|
7114
|
+
};
|
|
6978
7115
|
/**
|
|
6979
7116
|
* UserInputBody
|
|
6980
7117
|
* @description Request body for POST /assistant/respond.
|
|
@@ -8341,6 +8478,26 @@ interface operations {
|
|
|
8341
8478
|
};
|
|
8342
8479
|
};
|
|
8343
8480
|
};
|
|
8481
|
+
get_user_usage_today: {
|
|
8482
|
+
parameters: {
|
|
8483
|
+
query?: never;
|
|
8484
|
+
header?: never;
|
|
8485
|
+
path?: never;
|
|
8486
|
+
cookie?: never;
|
|
8487
|
+
};
|
|
8488
|
+
requestBody?: never;
|
|
8489
|
+
responses: {
|
|
8490
|
+
/** @description Successful Response */
|
|
8491
|
+
200: {
|
|
8492
|
+
headers: {
|
|
8493
|
+
[name: string]: unknown;
|
|
8494
|
+
};
|
|
8495
|
+
content: {
|
|
8496
|
+
'application/json': components['schemas']['UserDailyUsageResponse'];
|
|
8497
|
+
};
|
|
8498
|
+
};
|
|
8499
|
+
};
|
|
8500
|
+
};
|
|
8344
8501
|
get_user_settings: {
|
|
8345
8502
|
parameters: {
|
|
8346
8503
|
query?: never;
|
|
@@ -8392,6 +8549,106 @@ interface operations {
|
|
|
8392
8549
|
};
|
|
8393
8550
|
};
|
|
8394
8551
|
};
|
|
8552
|
+
delete_my_account: {
|
|
8553
|
+
parameters: {
|
|
8554
|
+
query?: never;
|
|
8555
|
+
header?: never;
|
|
8556
|
+
path?: never;
|
|
8557
|
+
cookie?: never;
|
|
8558
|
+
};
|
|
8559
|
+
requestBody: {
|
|
8560
|
+
content: {
|
|
8561
|
+
'application/json': components['schemas']['ConfirmDeleteRequest'];
|
|
8562
|
+
};
|
|
8563
|
+
};
|
|
8564
|
+
responses: {
|
|
8565
|
+
/** @description Successful Response */
|
|
8566
|
+
204: {
|
|
8567
|
+
headers: {
|
|
8568
|
+
[name: string]: unknown;
|
|
8569
|
+
};
|
|
8570
|
+
content?: never;
|
|
8571
|
+
};
|
|
8572
|
+
/** @description Validation Error */
|
|
8573
|
+
422: {
|
|
8574
|
+
headers: {
|
|
8575
|
+
[name: string]: unknown;
|
|
8576
|
+
};
|
|
8577
|
+
content: {
|
|
8578
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
8579
|
+
};
|
|
8580
|
+
};
|
|
8581
|
+
};
|
|
8582
|
+
};
|
|
8583
|
+
list_test_accounts: {
|
|
8584
|
+
parameters: {
|
|
8585
|
+
query?: never;
|
|
8586
|
+
header?: {
|
|
8587
|
+
'x-api-key'?: string;
|
|
8588
|
+
};
|
|
8589
|
+
path?: never;
|
|
8590
|
+
cookie?: never;
|
|
8591
|
+
};
|
|
8592
|
+
requestBody?: never;
|
|
8593
|
+
responses: {
|
|
8594
|
+
/** @description Successful Response */
|
|
8595
|
+
200: {
|
|
8596
|
+
headers: {
|
|
8597
|
+
[name: string]: unknown;
|
|
8598
|
+
};
|
|
8599
|
+
content: {
|
|
8600
|
+
'application/json': {
|
|
8601
|
+
[key: string]: unknown;
|
|
8602
|
+
};
|
|
8603
|
+
};
|
|
8604
|
+
};
|
|
8605
|
+
/** @description Validation Error */
|
|
8606
|
+
422: {
|
|
8607
|
+
headers: {
|
|
8608
|
+
[name: string]: unknown;
|
|
8609
|
+
};
|
|
8610
|
+
content: {
|
|
8611
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
8612
|
+
};
|
|
8613
|
+
};
|
|
8614
|
+
};
|
|
8615
|
+
};
|
|
8616
|
+
delete_test_accounts: {
|
|
8617
|
+
parameters: {
|
|
8618
|
+
query: {
|
|
8619
|
+
/** @description Match users whose email ends with this suffix, e.g. '@dev.arbidocs.com' */
|
|
8620
|
+
email_suffix: string;
|
|
8621
|
+
};
|
|
8622
|
+
header?: {
|
|
8623
|
+
'x-api-key'?: string;
|
|
8624
|
+
};
|
|
8625
|
+
path?: never;
|
|
8626
|
+
cookie?: never;
|
|
8627
|
+
};
|
|
8628
|
+
requestBody?: never;
|
|
8629
|
+
responses: {
|
|
8630
|
+
/** @description Successful Response */
|
|
8631
|
+
200: {
|
|
8632
|
+
headers: {
|
|
8633
|
+
[name: string]: unknown;
|
|
8634
|
+
};
|
|
8635
|
+
content: {
|
|
8636
|
+
'application/json': {
|
|
8637
|
+
[key: string]: unknown;
|
|
8638
|
+
};
|
|
8639
|
+
};
|
|
8640
|
+
};
|
|
8641
|
+
/** @description Validation Error */
|
|
8642
|
+
422: {
|
|
8643
|
+
headers: {
|
|
8644
|
+
[name: string]: unknown;
|
|
8645
|
+
};
|
|
8646
|
+
content: {
|
|
8647
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
8648
|
+
};
|
|
8649
|
+
};
|
|
8650
|
+
};
|
|
8651
|
+
};
|
|
8395
8652
|
get_products: {
|
|
8396
8653
|
parameters: {
|
|
8397
8654
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -510,6 +510,30 @@ interface paths {
|
|
|
510
510
|
patch?: never;
|
|
511
511
|
trace?: never;
|
|
512
512
|
};
|
|
513
|
+
'/v1/user/me/usage/today': {
|
|
514
|
+
parameters: {
|
|
515
|
+
query?: never;
|
|
516
|
+
header?: never;
|
|
517
|
+
path?: never;
|
|
518
|
+
cookie?: never;
|
|
519
|
+
};
|
|
520
|
+
/**
|
|
521
|
+
* Get User Usage Today
|
|
522
|
+
* @description Return today's deployment-wide credit spend for the current user.
|
|
523
|
+
*
|
|
524
|
+
* The same number that the per-user daily cap is enforced against in
|
|
525
|
+
* ``check_ai_access``. Frontend pairs this with the project's
|
|
526
|
+
* ``daily_cap_per_user`` to render a "credits today" indicator for non-owners.
|
|
527
|
+
*/
|
|
528
|
+
get: operations['get_user_usage_today'];
|
|
529
|
+
put?: never;
|
|
530
|
+
post?: never;
|
|
531
|
+
delete?: never;
|
|
532
|
+
options?: never;
|
|
533
|
+
head?: never;
|
|
534
|
+
patch?: never;
|
|
535
|
+
trace?: never;
|
|
536
|
+
};
|
|
513
537
|
'/v1/user/settings': {
|
|
514
538
|
parameters: {
|
|
515
539
|
query?: never;
|
|
@@ -538,6 +562,63 @@ interface paths {
|
|
|
538
562
|
patch: operations['update_user_settings'];
|
|
539
563
|
trace?: never;
|
|
540
564
|
};
|
|
565
|
+
'/v1/user/me': {
|
|
566
|
+
parameters: {
|
|
567
|
+
query?: never;
|
|
568
|
+
header?: never;
|
|
569
|
+
path?: never;
|
|
570
|
+
cookie?: never;
|
|
571
|
+
};
|
|
572
|
+
get?: never;
|
|
573
|
+
put?: never;
|
|
574
|
+
post?: never;
|
|
575
|
+
/**
|
|
576
|
+
* Delete My Account
|
|
577
|
+
* @description Permanently delete the calling user and all their data.
|
|
578
|
+
*
|
|
579
|
+
* **Test-account-only:** restricted to `test+NNN@arbi.city` accounts that have
|
|
580
|
+
* `settings.developer == true`. All other callers receive 403. This restriction
|
|
581
|
+
* exists because production-grade account deletion (soft-delete, PII scrubbing,
|
|
582
|
+
* content reassignment) is not yet designed.
|
|
583
|
+
*
|
|
584
|
+
* Body must include `confirm_email` matching the authenticated user's email.
|
|
585
|
+
*/
|
|
586
|
+
delete: operations['delete_my_account'];
|
|
587
|
+
options?: never;
|
|
588
|
+
head?: never;
|
|
589
|
+
patch?: never;
|
|
590
|
+
trace?: never;
|
|
591
|
+
};
|
|
592
|
+
'/v1/user/test-accounts': {
|
|
593
|
+
parameters: {
|
|
594
|
+
query?: never;
|
|
595
|
+
header?: never;
|
|
596
|
+
path?: never;
|
|
597
|
+
cookie?: never;
|
|
598
|
+
};
|
|
599
|
+
/**
|
|
600
|
+
* List Test Accounts
|
|
601
|
+
* @description List emails of users matching the `<prefix>+<NNN>@<domain>` test convention.
|
|
602
|
+
*
|
|
603
|
+
* Authenticated via the support API key (header `X-API-Key`). Intended for
|
|
604
|
+
* test-account tooling only. Returns ``{"emails": [...]}``.
|
|
605
|
+
*/
|
|
606
|
+
get: operations['list_test_accounts'];
|
|
607
|
+
put?: never;
|
|
608
|
+
post?: never;
|
|
609
|
+
/**
|
|
610
|
+
* Delete Test Accounts
|
|
611
|
+
* @description Bulk-wipe users matching the test-account regex AND the given email suffix.
|
|
612
|
+
*
|
|
613
|
+
* Authenticated via the support API key (header `X-API-Key`). Returns
|
|
614
|
+
* ``{"deleted": [...]}`` with the emails that were wiped.
|
|
615
|
+
*/
|
|
616
|
+
delete: operations['delete_test_accounts'];
|
|
617
|
+
options?: never;
|
|
618
|
+
head?: never;
|
|
619
|
+
patch?: never;
|
|
620
|
+
trace?: never;
|
|
621
|
+
};
|
|
541
622
|
'/v1/user/products': {
|
|
542
623
|
parameters: {
|
|
543
624
|
query?: never;
|
|
@@ -2215,7 +2296,7 @@ interface components {
|
|
|
2215
2296
|
* "API_TYPE": "remote",
|
|
2216
2297
|
* "ENABLE_THINKING": false,
|
|
2217
2298
|
* "MODEL_NAME": "Fast",
|
|
2218
|
-
* "SYSTEM_INSTRUCTION": "You are a title generator that creates concise, descriptive titles.",
|
|
2299
|
+
* "SYSTEM_INSTRUCTION": "You are a title generator that creates concise, descriptive titles.\n\nOutput the title as plain text only. Do not use Markdown or any other formatting. Specifically:\n- Do not bold, italicize, or otherwise emphasize any part of the title.\n- Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.\n- Do not prefix the title with bullets, dashes (-), or numbered/lettered enumeration (e.g. \"1.\", \"a)\").\n- Do not wrap the title in quotes or brackets.",
|
|
2219
2300
|
* "MAX_CHAR_SIZE_TO_ANSWER": 50,
|
|
2220
2301
|
* "TEMPERATURE": 0.3,
|
|
2221
2302
|
* "MAX_TOKENS": 20
|
|
@@ -2241,7 +2322,7 @@ interface components {
|
|
|
2241
2322
|
* "API_TYPE": "remote",
|
|
2242
2323
|
* "ENABLE_THINKING": false,
|
|
2243
2324
|
* "MODEL_NAME": "Fast",
|
|
2244
|
-
* "SYSTEM_INSTRUCTION": "You are a document analysis assistant. Answer questions based strictly on document content.\n\nGuidelines:\n- Only use information explicitly stated in the document\n- Do not infer or assume information not present\n- If information is not found, respond with \"Information not found in document.\"\n- Follow format instructions exactly for each answer\n- Be concise and precise",
|
|
2325
|
+
* "SYSTEM_INSTRUCTION": "You are a document analysis assistant. Answer questions based strictly on document content.\n\nGuidelines:\n- Only use information explicitly stated in the document\n- Do not infer or assume information not present\n- If information is not found, respond with \"Information not found in document.\"\n- Follow format instructions exactly for each answer\n- Be concise and precise\n- Output answers as plain text only. Do not use Markdown or any other formatting:\n - Do not bold, italicize, or otherwise emphasize any part of the answer.\n - Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.\n - Do not prefix answers with bullets, dashes (-), or numbered/lettered enumeration (e.g. \"1.\", \"a)\").\n - Write multi-point answers as flowing sentences, not as a list.",
|
|
2245
2326
|
* "MAX_CHAR_CONTEXT_TO_ANSWER": 100000,
|
|
2246
2327
|
* "TEMPERATURE": 0.1,
|
|
2247
2328
|
* "MAX_TOKENS": 2000,
|
|
@@ -2380,12 +2461,12 @@ interface components {
|
|
|
2380
2461
|
* "SEARCH_MODE": "semantic"
|
|
2381
2462
|
* },
|
|
2382
2463
|
* "smart_search": {
|
|
2383
|
-
* "GROUP_SIZE":
|
|
2464
|
+
* "GROUP_SIZE": 50,
|
|
2384
2465
|
* "HYBRID_DENSE_WEIGHT": 0.7,
|
|
2385
2466
|
* "HYBRID_PREFETCH_LIMIT": 10000,
|
|
2386
2467
|
* "HYBRID_SPARSE_WEIGHT": 0.3,
|
|
2387
2468
|
* "MAX_DISTINCT_DOCUMENTS": 100000,
|
|
2388
|
-
* "MAX_TOTAL_CHUNKS_TO_RETRIEVE":
|
|
2469
|
+
* "MAX_TOTAL_CHUNKS_TO_RETRIEVE": 100000,
|
|
2389
2470
|
* "MIN_RETRIEVAL_SIM_SCORE": 0.1,
|
|
2390
2471
|
* "SEARCH_MODE": "hybrid"
|
|
2391
2472
|
* }
|
|
@@ -2399,7 +2480,7 @@ interface components {
|
|
|
2399
2480
|
* "MIN_SCORE": 0.01
|
|
2400
2481
|
* },
|
|
2401
2482
|
* "smart_search": {
|
|
2402
|
-
* "MAX_NUMB_OF_CHUNKS":
|
|
2483
|
+
* "MAX_NUMB_OF_CHUNKS": 100000,
|
|
2403
2484
|
* "MIN_SCORE": 0
|
|
2404
2485
|
* },
|
|
2405
2486
|
* "MAX_CONCURRENT_REQUESTS": 256,
|
|
@@ -2439,7 +2520,9 @@ interface components {
|
|
|
2439
2520
|
* "FILTER_STOPWORDS": true,
|
|
2440
2521
|
* "BM25_K1": 1.5,
|
|
2441
2522
|
* "BM25_B": 0.75,
|
|
2442
|
-
* "BM25_AVGDL": 100
|
|
2523
|
+
* "BM25_AVGDL": 100,
|
|
2524
|
+
* "CJK_NGRAM_SIZE": 2,
|
|
2525
|
+
* "NORMALIZE_TRADITIONAL_TO_SIMPLIFIED": true
|
|
2443
2526
|
* }
|
|
2444
2527
|
*/
|
|
2445
2528
|
KeywordEmbedder: components['schemas']['KeywordEmbedderConfig'];
|
|
@@ -2968,6 +3051,14 @@ interface components {
|
|
|
2968
3051
|
/** Versions */
|
|
2969
3052
|
versions: components['schemas']['ConfigVersionInfo'][];
|
|
2970
3053
|
};
|
|
3054
|
+
/**
|
|
3055
|
+
* ConfirmDeleteRequest
|
|
3056
|
+
* @description Body for DELETE /users/me. confirm_email must match the authenticated user's email.
|
|
3057
|
+
*/
|
|
3058
|
+
ConfirmDeleteRequest: {
|
|
3059
|
+
/** Confirm Email */
|
|
3060
|
+
confirm_email: string;
|
|
3061
|
+
};
|
|
2971
3062
|
/**
|
|
2972
3063
|
* ConnectionClosedMessage
|
|
2973
3064
|
* @description Sent when connection is closed (e.g., another tab opened).
|
|
@@ -3534,6 +3625,11 @@ interface components {
|
|
|
3534
3625
|
* - If information is not found, respond with "Information not found in document."
|
|
3535
3626
|
* - Follow format instructions exactly for each answer
|
|
3536
3627
|
* - Be concise and precise
|
|
3628
|
+
* - Output answers as plain text only. Do not use Markdown or any other formatting:
|
|
3629
|
+
* - Do not bold, italicize, or otherwise emphasize any part of the answer.
|
|
3630
|
+
* - Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.
|
|
3631
|
+
* - Do not prefix answers with bullets, dashes (-), or numbered/lettered enumeration (e.g. "1.", "a)").
|
|
3632
|
+
* - Write multi-point answers as flowing sentences, not as a list.
|
|
3537
3633
|
*/
|
|
3538
3634
|
SYSTEM_INSTRUCTION: string;
|
|
3539
3635
|
/**
|
|
@@ -3999,6 +4095,18 @@ interface components {
|
|
|
3999
4095
|
* @default 100
|
|
4000
4096
|
*/
|
|
4001
4097
|
BM25_AVGDL: number;
|
|
4098
|
+
/**
|
|
4099
|
+
* Cjk Ngram Size
|
|
4100
|
+
* @description N-gram size for CJK character runs (Chinese/Japanese/Korean). 2 = bi-grams (recommended for e-discovery recall). 1 = uni-grams (very noisy).
|
|
4101
|
+
* @default 2
|
|
4102
|
+
*/
|
|
4103
|
+
CJK_NGRAM_SIZE: number;
|
|
4104
|
+
/**
|
|
4105
|
+
* Normalize Traditional To Simplified
|
|
4106
|
+
* @description Normalize Traditional Chinese to Simplified before tokenization, so a query in one script finds documents in the other. Required for cross-border discovery.
|
|
4107
|
+
* @default true
|
|
4108
|
+
*/
|
|
4109
|
+
NORMALIZE_TRADITIONAL_TO_SIMPLIFIED: boolean;
|
|
4002
4110
|
};
|
|
4003
4111
|
/**
|
|
4004
4112
|
* LoginRequest
|
|
@@ -4570,7 +4678,7 @@ interface components {
|
|
|
4570
4678
|
* Type is self-descriptive, no need to parse content field.
|
|
4571
4679
|
* @enum {string}
|
|
4572
4680
|
*/
|
|
4573
|
-
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'email_reply';
|
|
4681
|
+
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100';
|
|
4574
4682
|
/**
|
|
4575
4683
|
* NotificationUpdate
|
|
4576
4684
|
* @description Single notification update for bulk PATCH.
|
|
@@ -4939,6 +5047,8 @@ interface components {
|
|
|
4939
5047
|
ProjectCreateRequest: {
|
|
4940
5048
|
/** Name */
|
|
4941
5049
|
name: string;
|
|
5050
|
+
/** Daily Cap Per User */
|
|
5051
|
+
daily_cap_per_user?: number | null;
|
|
4942
5052
|
};
|
|
4943
5053
|
/**
|
|
4944
5054
|
* ProjectInvoice
|
|
@@ -4985,12 +5095,21 @@ interface components {
|
|
|
4985
5095
|
/**
|
|
4986
5096
|
* ProjectResponse
|
|
4987
5097
|
* @description Project summary returned in list and detail views.
|
|
5098
|
+
*
|
|
5099
|
+
* Listed for both project owners and workspace members of the project. For
|
|
5100
|
+
* non-owner viewers, ``packs``, ``subscription``, ``quotas``, and the
|
|
5101
|
+
* Stripe billing fields are blanked out (zeros / "none" / null) — only
|
|
5102
|
+
* ``name``, ``external_id``, ``created_by``, and ``daily_cap_per_user`` are
|
|
5103
|
+
* meaningful. Frontend distinguishes the two modes by comparing
|
|
5104
|
+
* ``created_by`` against the current user's external_id.
|
|
4988
5105
|
*/
|
|
4989
5106
|
ProjectResponse: {
|
|
4990
5107
|
/** External Id */
|
|
4991
5108
|
external_id: string;
|
|
4992
5109
|
/** Name */
|
|
4993
5110
|
name: string;
|
|
5111
|
+
/** Created By */
|
|
5112
|
+
created_by: string;
|
|
4994
5113
|
/** Packs */
|
|
4995
5114
|
packs: number;
|
|
4996
5115
|
/** Subscription */
|
|
@@ -5001,6 +5120,8 @@ interface components {
|
|
|
5001
5120
|
*/
|
|
5002
5121
|
created_at: string;
|
|
5003
5122
|
quotas: components['schemas']['ProjectQuotas'];
|
|
5123
|
+
/** Daily Cap Per User */
|
|
5124
|
+
daily_cap_per_user?: number | null;
|
|
5004
5125
|
/** Price Id */
|
|
5005
5126
|
price_id?: string | null;
|
|
5006
5127
|
/** Plan */
|
|
@@ -5018,11 +5139,13 @@ interface components {
|
|
|
5018
5139
|
};
|
|
5019
5140
|
/**
|
|
5020
5141
|
* ProjectUpdateRequest
|
|
5021
|
-
* @description Update project name.
|
|
5142
|
+
* @description Update project name and/or daily per-user cap.
|
|
5022
5143
|
*/
|
|
5023
5144
|
ProjectUpdateRequest: {
|
|
5024
5145
|
/** Name */
|
|
5025
5146
|
name?: string | null;
|
|
5147
|
+
/** Daily Cap Per User */
|
|
5148
|
+
daily_cap_per_user?: number | null;
|
|
5026
5149
|
};
|
|
5027
5150
|
/**
|
|
5028
5151
|
* ProjectUpgradeRequest
|
|
@@ -6669,6 +6792,12 @@ interface components {
|
|
|
6669
6792
|
/**
|
|
6670
6793
|
* System Instruction
|
|
6671
6794
|
* @default You are a title generator that creates concise, descriptive titles.
|
|
6795
|
+
*
|
|
6796
|
+
* Output the title as plain text only. Do not use Markdown or any other formatting. Specifically:
|
|
6797
|
+
* - Do not bold, italicize, or otherwise emphasize any part of the title.
|
|
6798
|
+
* - Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.
|
|
6799
|
+
* - Do not prefix the title with bullets, dashes (-), or numbered/lettered enumeration (e.g. "1.", "a)").
|
|
6800
|
+
* - Do not wrap the title in quotes or brackets.
|
|
6672
6801
|
*/
|
|
6673
6802
|
SYSTEM_INSTRUCTION: string;
|
|
6674
6803
|
/**
|
|
@@ -6975,6 +7104,14 @@ interface components {
|
|
|
6975
7104
|
/** Items */
|
|
6976
7105
|
items?: components['schemas']['InitedUploadItem'][];
|
|
6977
7106
|
};
|
|
7107
|
+
/**
|
|
7108
|
+
* UserDailyUsageResponse
|
|
7109
|
+
* @description Today's deployment-wide credit spend tagged with the current user.
|
|
7110
|
+
*/
|
|
7111
|
+
UserDailyUsageResponse: {
|
|
7112
|
+
/** Credits Used */
|
|
7113
|
+
credits_used: number;
|
|
7114
|
+
};
|
|
6978
7115
|
/**
|
|
6979
7116
|
* UserInputBody
|
|
6980
7117
|
* @description Request body for POST /assistant/respond.
|
|
@@ -8341,6 +8478,26 @@ interface operations {
|
|
|
8341
8478
|
};
|
|
8342
8479
|
};
|
|
8343
8480
|
};
|
|
8481
|
+
get_user_usage_today: {
|
|
8482
|
+
parameters: {
|
|
8483
|
+
query?: never;
|
|
8484
|
+
header?: never;
|
|
8485
|
+
path?: never;
|
|
8486
|
+
cookie?: never;
|
|
8487
|
+
};
|
|
8488
|
+
requestBody?: never;
|
|
8489
|
+
responses: {
|
|
8490
|
+
/** @description Successful Response */
|
|
8491
|
+
200: {
|
|
8492
|
+
headers: {
|
|
8493
|
+
[name: string]: unknown;
|
|
8494
|
+
};
|
|
8495
|
+
content: {
|
|
8496
|
+
'application/json': components['schemas']['UserDailyUsageResponse'];
|
|
8497
|
+
};
|
|
8498
|
+
};
|
|
8499
|
+
};
|
|
8500
|
+
};
|
|
8344
8501
|
get_user_settings: {
|
|
8345
8502
|
parameters: {
|
|
8346
8503
|
query?: never;
|
|
@@ -8392,6 +8549,106 @@ interface operations {
|
|
|
8392
8549
|
};
|
|
8393
8550
|
};
|
|
8394
8551
|
};
|
|
8552
|
+
delete_my_account: {
|
|
8553
|
+
parameters: {
|
|
8554
|
+
query?: never;
|
|
8555
|
+
header?: never;
|
|
8556
|
+
path?: never;
|
|
8557
|
+
cookie?: never;
|
|
8558
|
+
};
|
|
8559
|
+
requestBody: {
|
|
8560
|
+
content: {
|
|
8561
|
+
'application/json': components['schemas']['ConfirmDeleteRequest'];
|
|
8562
|
+
};
|
|
8563
|
+
};
|
|
8564
|
+
responses: {
|
|
8565
|
+
/** @description Successful Response */
|
|
8566
|
+
204: {
|
|
8567
|
+
headers: {
|
|
8568
|
+
[name: string]: unknown;
|
|
8569
|
+
};
|
|
8570
|
+
content?: never;
|
|
8571
|
+
};
|
|
8572
|
+
/** @description Validation Error */
|
|
8573
|
+
422: {
|
|
8574
|
+
headers: {
|
|
8575
|
+
[name: string]: unknown;
|
|
8576
|
+
};
|
|
8577
|
+
content: {
|
|
8578
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
8579
|
+
};
|
|
8580
|
+
};
|
|
8581
|
+
};
|
|
8582
|
+
};
|
|
8583
|
+
list_test_accounts: {
|
|
8584
|
+
parameters: {
|
|
8585
|
+
query?: never;
|
|
8586
|
+
header?: {
|
|
8587
|
+
'x-api-key'?: string;
|
|
8588
|
+
};
|
|
8589
|
+
path?: never;
|
|
8590
|
+
cookie?: never;
|
|
8591
|
+
};
|
|
8592
|
+
requestBody?: never;
|
|
8593
|
+
responses: {
|
|
8594
|
+
/** @description Successful Response */
|
|
8595
|
+
200: {
|
|
8596
|
+
headers: {
|
|
8597
|
+
[name: string]: unknown;
|
|
8598
|
+
};
|
|
8599
|
+
content: {
|
|
8600
|
+
'application/json': {
|
|
8601
|
+
[key: string]: unknown;
|
|
8602
|
+
};
|
|
8603
|
+
};
|
|
8604
|
+
};
|
|
8605
|
+
/** @description Validation Error */
|
|
8606
|
+
422: {
|
|
8607
|
+
headers: {
|
|
8608
|
+
[name: string]: unknown;
|
|
8609
|
+
};
|
|
8610
|
+
content: {
|
|
8611
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
8612
|
+
};
|
|
8613
|
+
};
|
|
8614
|
+
};
|
|
8615
|
+
};
|
|
8616
|
+
delete_test_accounts: {
|
|
8617
|
+
parameters: {
|
|
8618
|
+
query: {
|
|
8619
|
+
/** @description Match users whose email ends with this suffix, e.g. '@dev.arbidocs.com' */
|
|
8620
|
+
email_suffix: string;
|
|
8621
|
+
};
|
|
8622
|
+
header?: {
|
|
8623
|
+
'x-api-key'?: string;
|
|
8624
|
+
};
|
|
8625
|
+
path?: never;
|
|
8626
|
+
cookie?: never;
|
|
8627
|
+
};
|
|
8628
|
+
requestBody?: never;
|
|
8629
|
+
responses: {
|
|
8630
|
+
/** @description Successful Response */
|
|
8631
|
+
200: {
|
|
8632
|
+
headers: {
|
|
8633
|
+
[name: string]: unknown;
|
|
8634
|
+
};
|
|
8635
|
+
content: {
|
|
8636
|
+
'application/json': {
|
|
8637
|
+
[key: string]: unknown;
|
|
8638
|
+
};
|
|
8639
|
+
};
|
|
8640
|
+
};
|
|
8641
|
+
/** @description Validation Error */
|
|
8642
|
+
422: {
|
|
8643
|
+
headers: {
|
|
8644
|
+
[name: string]: unknown;
|
|
8645
|
+
};
|
|
8646
|
+
content: {
|
|
8647
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
8648
|
+
};
|
|
8649
|
+
};
|
|
8650
|
+
};
|
|
8651
|
+
};
|
|
8395
8652
|
get_products: {
|
|
8396
8653
|
parameters: {
|
|
8397
8654
|
query?: never;
|
package/package.json
CHANGED