@arbidocs/client 0.4.82 → 0.4.84
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 +180 -8
- package/dist/index.d.ts +180 -8
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2233,7 +2233,9 @@ interface paths {
|
|
|
2233
2233
|
* Prepare Document Signature
|
|
2234
2234
|
* @description Return the exact statement the signer's key must sign, and the hash of the PDF they are shown.
|
|
2235
2235
|
*
|
|
2236
|
-
*
|
|
2236
|
+
* The PDF is the one ``GET /view?version=`` serves for ``version`` (a PDF rendition for a Word or Markdown
|
|
2237
|
+
* document): a client hashes those bytes, never the original's download. ``appearance`` and ``include_date`` are
|
|
2238
|
+
* part of the statement: send the same ones (and the same ``version``) to ``/sign``.
|
|
2237
2239
|
*/
|
|
2238
2240
|
post: operations['prepare_document_signature'];
|
|
2239
2241
|
delete?: never;
|
|
@@ -2255,7 +2257,8 @@ interface paths {
|
|
|
2255
2257
|
* Sign Document
|
|
2256
2258
|
* @description Sign a document: verify the signer's statement, seal a signed copy, save it as the document's next
|
|
2257
2259
|
* version (reason ``signed``; the document keeps its id) and record the evidence under the signing's
|
|
2258
|
-
* reference, whose public certificate the signature links to.
|
|
2260
|
+
* reference, whose public certificate the signature links to. A Word or Markdown document is signed as the PDF
|
|
2261
|
+
* rendition of that version, so its signed version is a PDF.
|
|
2259
2262
|
*/
|
|
2260
2263
|
post: operations['sign_document'];
|
|
2261
2264
|
delete?: never;
|
|
@@ -3133,8 +3136,9 @@ interface paths {
|
|
|
3133
3136
|
* @description A set of tags with their fields and values, plus the documents and facts linked to each.
|
|
3134
3137
|
*
|
|
3135
3138
|
* Select the rows with ``parent_ext_id`` (its children; the parent comes back too, its fields being the
|
|
3136
|
-
* shared columns) or with ``tag_ext_id``. Each row lists up
|
|
3137
|
-
* note and how many passages it cites) and facts, newest
|
|
3139
|
+
* shared columns), with ``kind`` (e.g. every person, or every issue) or with ``tag_ext_id``. Each row lists up
|
|
3140
|
+
* to ``links_limit`` documents (with the doctag's note and how many passages it cites) and facts, newest
|
|
3141
|
+
* first; ``doc_count``/``fact_count`` are the totals.
|
|
3138
3142
|
*/
|
|
3139
3143
|
get: operations['get_tag_matrix'];
|
|
3140
3144
|
put?: never;
|
|
@@ -3145,6 +3149,29 @@ interface paths {
|
|
|
3145
3149
|
patch?: never;
|
|
3146
3150
|
trace?: never;
|
|
3147
3151
|
};
|
|
3152
|
+
'/v1/tag/entities/extract': {
|
|
3153
|
+
parameters: {
|
|
3154
|
+
query?: never;
|
|
3155
|
+
header?: never;
|
|
3156
|
+
path?: never;
|
|
3157
|
+
cookie?: never;
|
|
3158
|
+
};
|
|
3159
|
+
get?: never;
|
|
3160
|
+
put?: never;
|
|
3161
|
+
/**
|
|
3162
|
+
* Extract Entities
|
|
3163
|
+
* @description Find the people and organisations these documents name, and link each to its entity tag (on demand).
|
|
3164
|
+
*
|
|
3165
|
+
* Returns 202 at once; a ``batch_complete`` (``entity_extract``) WebSocket message follows when every document
|
|
3166
|
+
* is done. Reuses entities already in the workspace by name or "Also known as"; only ever adds links.
|
|
3167
|
+
*/
|
|
3168
|
+
post: operations['extract_entities'];
|
|
3169
|
+
delete?: never;
|
|
3170
|
+
options?: never;
|
|
3171
|
+
head?: never;
|
|
3172
|
+
patch?: never;
|
|
3173
|
+
trace?: never;
|
|
3174
|
+
};
|
|
3148
3175
|
'/v1/tag/': {
|
|
3149
3176
|
parameters: {
|
|
3150
3177
|
query?: never;
|
|
@@ -3159,7 +3186,8 @@ interface paths {
|
|
|
3159
3186
|
* @description Create a new tag for a given workspace.
|
|
3160
3187
|
*
|
|
3161
3188
|
* If 'shared' is provided, the tag will be set to shared or private accordingly.
|
|
3162
|
-
* If 'shared' is not provided, it defaults to True (shared).
|
|
3189
|
+
* If 'shared' is not provided, it defaults to True (shared). ``kind`` defaults from the format; a person or
|
|
3190
|
+
* organisation gets that kind's default fields unless ``fields`` are given.
|
|
3163
3191
|
*/
|
|
3164
3192
|
post: operations['create_tag'];
|
|
3165
3193
|
delete?: never;
|
|
@@ -6997,6 +7025,18 @@ interface components {
|
|
|
6997
7025
|
* @default 0
|
|
6998
7026
|
*/
|
|
6999
7027
|
AGENT_MAX_TOKENS: number;
|
|
7028
|
+
/**
|
|
7029
|
+
* Agent Stream Output Ceiling Tokens
|
|
7030
|
+
* @description Absolute cap on one streamed agent call's output (estimated at ~4 chars/token, at least one token per chunk), checked while it streams. The run budget's remaining allowance applies when lower. Normal outputs peak around 16.5k tokens; this only meets a runaway, which is stopped and fails the turn.
|
|
7031
|
+
* @default 64000
|
|
7032
|
+
*/
|
|
7033
|
+
AGENT_STREAM_OUTPUT_CEILING_TOKENS: number;
|
|
7034
|
+
/**
|
|
7035
|
+
* Agent Stream Degenerate Chars
|
|
7036
|
+
* @description Stop an agent stream that produces this many consecutive chars (or text-less chunks) with no visible content and no tool-call progress: a model stuck emitting empty output. 0 = disabled.
|
|
7037
|
+
* @default 20000
|
|
7038
|
+
*/
|
|
7039
|
+
AGENT_STREAM_DEGENERATE_CHARS: number;
|
|
7000
7040
|
/**
|
|
7001
7041
|
* Enable Thinking
|
|
7002
7042
|
* @description Enable reasoning/thinking mode for the agentic loop LLM.
|
|
@@ -7284,6 +7324,8 @@ interface components {
|
|
|
7284
7324
|
* "AGENT_API_TYPE": "remote",
|
|
7285
7325
|
* "LLM_AGENT_TEMPERATURE": 0.6,
|
|
7286
7326
|
* "AGENT_MAX_TOKENS": 0,
|
|
7327
|
+
* "AGENT_STREAM_OUTPUT_CEILING_TOKENS": 64000,
|
|
7328
|
+
* "AGENT_STREAM_DEGENERATE_CHARS": 20000,
|
|
7287
7329
|
* "ENABLE_THINKING": false,
|
|
7288
7330
|
* "AGENT_STRICT_TOOL_CALLS": true,
|
|
7289
7331
|
* "AGENT_MAX_ITERATIONS": 20,
|
|
@@ -8138,7 +8180,7 @@ interface components {
|
|
|
8138
8180
|
* Batch Type
|
|
8139
8181
|
* @enum {string}
|
|
8140
8182
|
*/
|
|
8141
|
-
batch_type: 'upload' | 'doctag_generate';
|
|
8183
|
+
batch_type: 'upload' | 'doctag_generate' | 'entity_extract';
|
|
8142
8184
|
/** Workspace Ext Id */
|
|
8143
8185
|
workspace_ext_id: string;
|
|
8144
8186
|
/** Doc Ext Ids */
|
|
@@ -10471,6 +10513,10 @@ interface components {
|
|
|
10471
10513
|
/**
|
|
10472
10514
|
* CreateTagRequest
|
|
10473
10515
|
* @description Request to create a new tag in a workspace.
|
|
10516
|
+
*
|
|
10517
|
+
* ``kind`` defaults to the parent's when the parent is an issue, person or organisation (so a matrix's new row
|
|
10518
|
+
* is one too), else from the format (checkbox → label, search → search, any other → annotation). A person or
|
|
10519
|
+
* organisation is created with that kind's default fields unless ``fields`` are given.
|
|
10474
10520
|
*/
|
|
10475
10521
|
CreateTagRequest: {
|
|
10476
10522
|
/** Name */
|
|
@@ -10478,6 +10524,8 @@ interface components {
|
|
|
10478
10524
|
/** Instruction */
|
|
10479
10525
|
instruction?: string | null;
|
|
10480
10526
|
tag_type?: components['schemas']['TagFormat'];
|
|
10527
|
+
/** Kind */
|
|
10528
|
+
kind?: ('label' | 'annotation' | 'search' | 'issue' | 'person' | 'organisation') | null;
|
|
10481
10529
|
/** Shared */
|
|
10482
10530
|
shared?: boolean | null;
|
|
10483
10531
|
/** Parent Ext Id */
|
|
@@ -12059,6 +12107,36 @@ interface components {
|
|
|
12059
12107
|
*/
|
|
12060
12108
|
markup: boolean;
|
|
12061
12109
|
};
|
|
12110
|
+
/**
|
|
12111
|
+
* ExtractEntitiesRequest
|
|
12112
|
+
* @description Find the people and organisations these documents name and link each to its entity tag.
|
|
12113
|
+
*
|
|
12114
|
+
* An entity already in the workspace (same kind, same name or one of its "Also known as" names) is reused;
|
|
12115
|
+
* a new one is created with that kind's default fields. Each document gets a link (a doctag citing the
|
|
12116
|
+
* passages that name the entity), and facts drawn from the document that mention the entity get it too.
|
|
12117
|
+
* Existing links are kept; ``overwrite`` refreshes their citations (e.g. after a new version).
|
|
12118
|
+
*/
|
|
12119
|
+
ExtractEntitiesRequest: {
|
|
12120
|
+
/** Doc Ext Ids */
|
|
12121
|
+
doc_ext_ids: string[];
|
|
12122
|
+
/** Kinds */
|
|
12123
|
+
kinds?: ('person' | 'organisation')[];
|
|
12124
|
+
/**
|
|
12125
|
+
* Overwrite
|
|
12126
|
+
* @default false
|
|
12127
|
+
*/
|
|
12128
|
+
overwrite: boolean;
|
|
12129
|
+
};
|
|
12130
|
+
/**
|
|
12131
|
+
* ExtractEntitiesResponse
|
|
12132
|
+
* @description Accepted: extraction runs in the background; a ``batch_complete`` (``entity_extract``) says when done.
|
|
12133
|
+
*/
|
|
12134
|
+
ExtractEntitiesResponse: {
|
|
12135
|
+
/** Doc Ext Ids */
|
|
12136
|
+
doc_ext_ids: string[];
|
|
12137
|
+
/** Kinds */
|
|
12138
|
+
kinds: string[];
|
|
12139
|
+
};
|
|
12062
12140
|
/** FactDeleteResponse */
|
|
12063
12141
|
FactDeleteResponse: {
|
|
12064
12142
|
/**
|
|
@@ -14720,6 +14798,11 @@ interface components {
|
|
|
14720
14798
|
* @default false
|
|
14721
14799
|
*/
|
|
14722
14800
|
include_date: boolean;
|
|
14801
|
+
/**
|
|
14802
|
+
* Version
|
|
14803
|
+
* @description The version the signer was shown (the PDF from GET /view?version=). It must be the current version: the signed copy becomes the next one. Omit for the current version.
|
|
14804
|
+
*/
|
|
14805
|
+
version?: number | null;
|
|
14723
14806
|
};
|
|
14724
14807
|
/** PrepareSignatureResponse */
|
|
14725
14808
|
PrepareSignatureResponse: {
|
|
@@ -14735,7 +14818,7 @@ interface components {
|
|
|
14735
14818
|
intent: string;
|
|
14736
14819
|
/**
|
|
14737
14820
|
* Source Sha256
|
|
14738
|
-
* @description SHA-256 of the PDF the signer is shown (the /view rendition)
|
|
14821
|
+
* @description SHA-256 of the PDF the signer is shown (the /view rendition of that version)
|
|
14739
14822
|
*/
|
|
14740
14823
|
source_sha256: string;
|
|
14741
14824
|
/** Timestamp */
|
|
@@ -17286,6 +17369,11 @@ interface components {
|
|
|
17286
17369
|
* @default false
|
|
17287
17370
|
*/
|
|
17288
17371
|
include_date: boolean;
|
|
17372
|
+
/**
|
|
17373
|
+
* Version
|
|
17374
|
+
* @description The version the signer was shown (the PDF from GET /view?version=). It must be the current version: the signed copy becomes the next one. Omit for the current version.
|
|
17375
|
+
*/
|
|
17376
|
+
version?: number | null;
|
|
17289
17377
|
/** Timestamp */
|
|
17290
17378
|
timestamp: number;
|
|
17291
17379
|
/**
|
|
@@ -18113,7 +18201,8 @@ interface components {
|
|
|
18113
18201
|
};
|
|
18114
18202
|
/**
|
|
18115
18203
|
* TagMatrixRow
|
|
18116
|
-
* @description One tag of the matrix with its evidence. ``docs``/``facts`` are capped; the counts are the
|
|
18204
|
+
* @description One tag of the matrix with its evidence. ``docs``/``facts``/``threads`` are capped; the counts are the
|
|
18205
|
+
* totals.
|
|
18117
18206
|
*/
|
|
18118
18207
|
TagMatrixRow: {
|
|
18119
18208
|
tag: components['schemas']['TagResponse'];
|
|
@@ -18121,6 +18210,8 @@ interface components {
|
|
|
18121
18210
|
docs?: components['schemas']['TagMatrixDocLink'][];
|
|
18122
18211
|
/** Facts */
|
|
18123
18212
|
facts?: components['schemas']['TagMatrixFactLink'][];
|
|
18213
|
+
/** Threads */
|
|
18214
|
+
threads?: components['schemas']['TagMatrixThreadLink'][];
|
|
18124
18215
|
/**
|
|
18125
18216
|
* Doc Count
|
|
18126
18217
|
* @default 0
|
|
@@ -18131,6 +18222,26 @@ interface components {
|
|
|
18131
18222
|
* @default 0
|
|
18132
18223
|
*/
|
|
18133
18224
|
fact_count: number;
|
|
18225
|
+
/**
|
|
18226
|
+
* Thread Count
|
|
18227
|
+
* @default 0
|
|
18228
|
+
*/
|
|
18229
|
+
thread_count: number;
|
|
18230
|
+
};
|
|
18231
|
+
/**
|
|
18232
|
+
* TagMatrixThreadLink
|
|
18233
|
+
* @description A thread (conversation) carrying a matrix tag.
|
|
18234
|
+
*/
|
|
18235
|
+
TagMatrixThreadLink: {
|
|
18236
|
+
/** Conversation Ext Id */
|
|
18237
|
+
conversation_ext_id: string;
|
|
18238
|
+
/** Title */
|
|
18239
|
+
title?: string | null;
|
|
18240
|
+
/**
|
|
18241
|
+
* Updated At
|
|
18242
|
+
* Format: date-time
|
|
18243
|
+
*/
|
|
18244
|
+
updated_at: string;
|
|
18134
18245
|
};
|
|
18135
18246
|
/** TagResponse */
|
|
18136
18247
|
TagResponse: {
|
|
@@ -18143,6 +18254,12 @@ interface components {
|
|
|
18143
18254
|
/** Instruction */
|
|
18144
18255
|
instruction?: string | null;
|
|
18145
18256
|
tag_type: components['schemas']['TagFormat'];
|
|
18257
|
+
/**
|
|
18258
|
+
* Kind
|
|
18259
|
+
* @default label
|
|
18260
|
+
* @enum {string}
|
|
18261
|
+
*/
|
|
18262
|
+
kind: 'label' | 'annotation' | 'search' | 'issue' | 'person' | 'organisation';
|
|
18146
18263
|
/** Shared */
|
|
18147
18264
|
shared: boolean;
|
|
18148
18265
|
/** Parent Ext Id */
|
|
@@ -18154,6 +18271,11 @@ interface components {
|
|
|
18154
18271
|
* @default 0
|
|
18155
18272
|
*/
|
|
18156
18273
|
facttag_count: number;
|
|
18274
|
+
/**
|
|
18275
|
+
* Convotag Count
|
|
18276
|
+
* @default 0
|
|
18277
|
+
*/
|
|
18278
|
+
convotag_count: number;
|
|
18157
18279
|
/** Fields */
|
|
18158
18280
|
fields?: components['schemas']['TagField'][];
|
|
18159
18281
|
/** Field Values */
|
|
@@ -18953,7 +19075,19 @@ interface components {
|
|
|
18953
19075
|
name?: string | null;
|
|
18954
19076
|
/** Instruction */
|
|
18955
19077
|
instruction?: string | null;
|
|
19078
|
+
/** @description New format. Refused (409) when a value already on a document would not fit it — a format change never drops values; clear or edit those first. */
|
|
18956
19079
|
tag_type?: components['schemas']['TagFormat'] | null;
|
|
19080
|
+
/**
|
|
19081
|
+
* Kind
|
|
19082
|
+
* @description New kind. A label can become an issue, person or organisation and back (all presence tags); a format change alone re-derives label/annotation/search.
|
|
19083
|
+
*/
|
|
19084
|
+
kind?: ('label' | 'annotation' | 'search' | 'issue' | 'person' | 'organisation') | null;
|
|
19085
|
+
/**
|
|
19086
|
+
* Kind To Children
|
|
19087
|
+
* @description With kind: also give it to this tag's children whose format allows it (e.g. mark an existing issue list and its issues in one call).
|
|
19088
|
+
* @default false
|
|
19089
|
+
*/
|
|
19090
|
+
kind_to_children: boolean;
|
|
18957
19091
|
/** Shared */
|
|
18958
19092
|
shared?: boolean | null;
|
|
18959
19093
|
/**
|
|
@@ -24758,6 +24892,8 @@ interface operations {
|
|
|
24758
24892
|
parent_ext_id?: string | null;
|
|
24759
24893
|
/** @description Rows are these tags, in this order (repeatable) */
|
|
24760
24894
|
tag_ext_id?: string[] | null;
|
|
24895
|
+
/** @description Rows are every tag of this kind, oldest first */
|
|
24896
|
+
kind?: ('label' | 'annotation' | 'search' | 'issue' | 'person' | 'organisation') | null;
|
|
24761
24897
|
/** @description Most documents and facts per row */
|
|
24762
24898
|
links_limit?: number;
|
|
24763
24899
|
};
|
|
@@ -24787,6 +24923,42 @@ interface operations {
|
|
|
24787
24923
|
};
|
|
24788
24924
|
};
|
|
24789
24925
|
};
|
|
24926
|
+
extract_entities: {
|
|
24927
|
+
parameters: {
|
|
24928
|
+
query?: {
|
|
24929
|
+
/** @description Configuration to use for the LLM */
|
|
24930
|
+
config_ext_id?: string | null;
|
|
24931
|
+
};
|
|
24932
|
+
header?: never;
|
|
24933
|
+
path?: never;
|
|
24934
|
+
cookie?: never;
|
|
24935
|
+
};
|
|
24936
|
+
requestBody: {
|
|
24937
|
+
content: {
|
|
24938
|
+
'application/json': components['schemas']['ExtractEntitiesRequest'];
|
|
24939
|
+
};
|
|
24940
|
+
};
|
|
24941
|
+
responses: {
|
|
24942
|
+
/** @description Successful Response */
|
|
24943
|
+
202: {
|
|
24944
|
+
headers: {
|
|
24945
|
+
[name: string]: unknown;
|
|
24946
|
+
};
|
|
24947
|
+
content: {
|
|
24948
|
+
'application/json': components['schemas']['ExtractEntitiesResponse'];
|
|
24949
|
+
};
|
|
24950
|
+
};
|
|
24951
|
+
/** @description Validation Error */
|
|
24952
|
+
422: {
|
|
24953
|
+
headers: {
|
|
24954
|
+
[name: string]: unknown;
|
|
24955
|
+
};
|
|
24956
|
+
content: {
|
|
24957
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24958
|
+
};
|
|
24959
|
+
};
|
|
24960
|
+
};
|
|
24961
|
+
};
|
|
24790
24962
|
create_tag: {
|
|
24791
24963
|
parameters: {
|
|
24792
24964
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -2233,7 +2233,9 @@ interface paths {
|
|
|
2233
2233
|
* Prepare Document Signature
|
|
2234
2234
|
* @description Return the exact statement the signer's key must sign, and the hash of the PDF they are shown.
|
|
2235
2235
|
*
|
|
2236
|
-
*
|
|
2236
|
+
* The PDF is the one ``GET /view?version=`` serves for ``version`` (a PDF rendition for a Word or Markdown
|
|
2237
|
+
* document): a client hashes those bytes, never the original's download. ``appearance`` and ``include_date`` are
|
|
2238
|
+
* part of the statement: send the same ones (and the same ``version``) to ``/sign``.
|
|
2237
2239
|
*/
|
|
2238
2240
|
post: operations['prepare_document_signature'];
|
|
2239
2241
|
delete?: never;
|
|
@@ -2255,7 +2257,8 @@ interface paths {
|
|
|
2255
2257
|
* Sign Document
|
|
2256
2258
|
* @description Sign a document: verify the signer's statement, seal a signed copy, save it as the document's next
|
|
2257
2259
|
* version (reason ``signed``; the document keeps its id) and record the evidence under the signing's
|
|
2258
|
-
* reference, whose public certificate the signature links to.
|
|
2260
|
+
* reference, whose public certificate the signature links to. A Word or Markdown document is signed as the PDF
|
|
2261
|
+
* rendition of that version, so its signed version is a PDF.
|
|
2259
2262
|
*/
|
|
2260
2263
|
post: operations['sign_document'];
|
|
2261
2264
|
delete?: never;
|
|
@@ -3133,8 +3136,9 @@ interface paths {
|
|
|
3133
3136
|
* @description A set of tags with their fields and values, plus the documents and facts linked to each.
|
|
3134
3137
|
*
|
|
3135
3138
|
* Select the rows with ``parent_ext_id`` (its children; the parent comes back too, its fields being the
|
|
3136
|
-
* shared columns) or with ``tag_ext_id``. Each row lists up
|
|
3137
|
-
* note and how many passages it cites) and facts, newest
|
|
3139
|
+
* shared columns), with ``kind`` (e.g. every person, or every issue) or with ``tag_ext_id``. Each row lists up
|
|
3140
|
+
* to ``links_limit`` documents (with the doctag's note and how many passages it cites) and facts, newest
|
|
3141
|
+
* first; ``doc_count``/``fact_count`` are the totals.
|
|
3138
3142
|
*/
|
|
3139
3143
|
get: operations['get_tag_matrix'];
|
|
3140
3144
|
put?: never;
|
|
@@ -3145,6 +3149,29 @@ interface paths {
|
|
|
3145
3149
|
patch?: never;
|
|
3146
3150
|
trace?: never;
|
|
3147
3151
|
};
|
|
3152
|
+
'/v1/tag/entities/extract': {
|
|
3153
|
+
parameters: {
|
|
3154
|
+
query?: never;
|
|
3155
|
+
header?: never;
|
|
3156
|
+
path?: never;
|
|
3157
|
+
cookie?: never;
|
|
3158
|
+
};
|
|
3159
|
+
get?: never;
|
|
3160
|
+
put?: never;
|
|
3161
|
+
/**
|
|
3162
|
+
* Extract Entities
|
|
3163
|
+
* @description Find the people and organisations these documents name, and link each to its entity tag (on demand).
|
|
3164
|
+
*
|
|
3165
|
+
* Returns 202 at once; a ``batch_complete`` (``entity_extract``) WebSocket message follows when every document
|
|
3166
|
+
* is done. Reuses entities already in the workspace by name or "Also known as"; only ever adds links.
|
|
3167
|
+
*/
|
|
3168
|
+
post: operations['extract_entities'];
|
|
3169
|
+
delete?: never;
|
|
3170
|
+
options?: never;
|
|
3171
|
+
head?: never;
|
|
3172
|
+
patch?: never;
|
|
3173
|
+
trace?: never;
|
|
3174
|
+
};
|
|
3148
3175
|
'/v1/tag/': {
|
|
3149
3176
|
parameters: {
|
|
3150
3177
|
query?: never;
|
|
@@ -3159,7 +3186,8 @@ interface paths {
|
|
|
3159
3186
|
* @description Create a new tag for a given workspace.
|
|
3160
3187
|
*
|
|
3161
3188
|
* If 'shared' is provided, the tag will be set to shared or private accordingly.
|
|
3162
|
-
* If 'shared' is not provided, it defaults to True (shared).
|
|
3189
|
+
* If 'shared' is not provided, it defaults to True (shared). ``kind`` defaults from the format; a person or
|
|
3190
|
+
* organisation gets that kind's default fields unless ``fields`` are given.
|
|
3163
3191
|
*/
|
|
3164
3192
|
post: operations['create_tag'];
|
|
3165
3193
|
delete?: never;
|
|
@@ -6997,6 +7025,18 @@ interface components {
|
|
|
6997
7025
|
* @default 0
|
|
6998
7026
|
*/
|
|
6999
7027
|
AGENT_MAX_TOKENS: number;
|
|
7028
|
+
/**
|
|
7029
|
+
* Agent Stream Output Ceiling Tokens
|
|
7030
|
+
* @description Absolute cap on one streamed agent call's output (estimated at ~4 chars/token, at least one token per chunk), checked while it streams. The run budget's remaining allowance applies when lower. Normal outputs peak around 16.5k tokens; this only meets a runaway, which is stopped and fails the turn.
|
|
7031
|
+
* @default 64000
|
|
7032
|
+
*/
|
|
7033
|
+
AGENT_STREAM_OUTPUT_CEILING_TOKENS: number;
|
|
7034
|
+
/**
|
|
7035
|
+
* Agent Stream Degenerate Chars
|
|
7036
|
+
* @description Stop an agent stream that produces this many consecutive chars (or text-less chunks) with no visible content and no tool-call progress: a model stuck emitting empty output. 0 = disabled.
|
|
7037
|
+
* @default 20000
|
|
7038
|
+
*/
|
|
7039
|
+
AGENT_STREAM_DEGENERATE_CHARS: number;
|
|
7000
7040
|
/**
|
|
7001
7041
|
* Enable Thinking
|
|
7002
7042
|
* @description Enable reasoning/thinking mode for the agentic loop LLM.
|
|
@@ -7284,6 +7324,8 @@ interface components {
|
|
|
7284
7324
|
* "AGENT_API_TYPE": "remote",
|
|
7285
7325
|
* "LLM_AGENT_TEMPERATURE": 0.6,
|
|
7286
7326
|
* "AGENT_MAX_TOKENS": 0,
|
|
7327
|
+
* "AGENT_STREAM_OUTPUT_CEILING_TOKENS": 64000,
|
|
7328
|
+
* "AGENT_STREAM_DEGENERATE_CHARS": 20000,
|
|
7287
7329
|
* "ENABLE_THINKING": false,
|
|
7288
7330
|
* "AGENT_STRICT_TOOL_CALLS": true,
|
|
7289
7331
|
* "AGENT_MAX_ITERATIONS": 20,
|
|
@@ -8138,7 +8180,7 @@ interface components {
|
|
|
8138
8180
|
* Batch Type
|
|
8139
8181
|
* @enum {string}
|
|
8140
8182
|
*/
|
|
8141
|
-
batch_type: 'upload' | 'doctag_generate';
|
|
8183
|
+
batch_type: 'upload' | 'doctag_generate' | 'entity_extract';
|
|
8142
8184
|
/** Workspace Ext Id */
|
|
8143
8185
|
workspace_ext_id: string;
|
|
8144
8186
|
/** Doc Ext Ids */
|
|
@@ -10471,6 +10513,10 @@ interface components {
|
|
|
10471
10513
|
/**
|
|
10472
10514
|
* CreateTagRequest
|
|
10473
10515
|
* @description Request to create a new tag in a workspace.
|
|
10516
|
+
*
|
|
10517
|
+
* ``kind`` defaults to the parent's when the parent is an issue, person or organisation (so a matrix's new row
|
|
10518
|
+
* is one too), else from the format (checkbox → label, search → search, any other → annotation). A person or
|
|
10519
|
+
* organisation is created with that kind's default fields unless ``fields`` are given.
|
|
10474
10520
|
*/
|
|
10475
10521
|
CreateTagRequest: {
|
|
10476
10522
|
/** Name */
|
|
@@ -10478,6 +10524,8 @@ interface components {
|
|
|
10478
10524
|
/** Instruction */
|
|
10479
10525
|
instruction?: string | null;
|
|
10480
10526
|
tag_type?: components['schemas']['TagFormat'];
|
|
10527
|
+
/** Kind */
|
|
10528
|
+
kind?: ('label' | 'annotation' | 'search' | 'issue' | 'person' | 'organisation') | null;
|
|
10481
10529
|
/** Shared */
|
|
10482
10530
|
shared?: boolean | null;
|
|
10483
10531
|
/** Parent Ext Id */
|
|
@@ -12059,6 +12107,36 @@ interface components {
|
|
|
12059
12107
|
*/
|
|
12060
12108
|
markup: boolean;
|
|
12061
12109
|
};
|
|
12110
|
+
/**
|
|
12111
|
+
* ExtractEntitiesRequest
|
|
12112
|
+
* @description Find the people and organisations these documents name and link each to its entity tag.
|
|
12113
|
+
*
|
|
12114
|
+
* An entity already in the workspace (same kind, same name or one of its "Also known as" names) is reused;
|
|
12115
|
+
* a new one is created with that kind's default fields. Each document gets a link (a doctag citing the
|
|
12116
|
+
* passages that name the entity), and facts drawn from the document that mention the entity get it too.
|
|
12117
|
+
* Existing links are kept; ``overwrite`` refreshes their citations (e.g. after a new version).
|
|
12118
|
+
*/
|
|
12119
|
+
ExtractEntitiesRequest: {
|
|
12120
|
+
/** Doc Ext Ids */
|
|
12121
|
+
doc_ext_ids: string[];
|
|
12122
|
+
/** Kinds */
|
|
12123
|
+
kinds?: ('person' | 'organisation')[];
|
|
12124
|
+
/**
|
|
12125
|
+
* Overwrite
|
|
12126
|
+
* @default false
|
|
12127
|
+
*/
|
|
12128
|
+
overwrite: boolean;
|
|
12129
|
+
};
|
|
12130
|
+
/**
|
|
12131
|
+
* ExtractEntitiesResponse
|
|
12132
|
+
* @description Accepted: extraction runs in the background; a ``batch_complete`` (``entity_extract``) says when done.
|
|
12133
|
+
*/
|
|
12134
|
+
ExtractEntitiesResponse: {
|
|
12135
|
+
/** Doc Ext Ids */
|
|
12136
|
+
doc_ext_ids: string[];
|
|
12137
|
+
/** Kinds */
|
|
12138
|
+
kinds: string[];
|
|
12139
|
+
};
|
|
12062
12140
|
/** FactDeleteResponse */
|
|
12063
12141
|
FactDeleteResponse: {
|
|
12064
12142
|
/**
|
|
@@ -14720,6 +14798,11 @@ interface components {
|
|
|
14720
14798
|
* @default false
|
|
14721
14799
|
*/
|
|
14722
14800
|
include_date: boolean;
|
|
14801
|
+
/**
|
|
14802
|
+
* Version
|
|
14803
|
+
* @description The version the signer was shown (the PDF from GET /view?version=). It must be the current version: the signed copy becomes the next one. Omit for the current version.
|
|
14804
|
+
*/
|
|
14805
|
+
version?: number | null;
|
|
14723
14806
|
};
|
|
14724
14807
|
/** PrepareSignatureResponse */
|
|
14725
14808
|
PrepareSignatureResponse: {
|
|
@@ -14735,7 +14818,7 @@ interface components {
|
|
|
14735
14818
|
intent: string;
|
|
14736
14819
|
/**
|
|
14737
14820
|
* Source Sha256
|
|
14738
|
-
* @description SHA-256 of the PDF the signer is shown (the /view rendition)
|
|
14821
|
+
* @description SHA-256 of the PDF the signer is shown (the /view rendition of that version)
|
|
14739
14822
|
*/
|
|
14740
14823
|
source_sha256: string;
|
|
14741
14824
|
/** Timestamp */
|
|
@@ -17286,6 +17369,11 @@ interface components {
|
|
|
17286
17369
|
* @default false
|
|
17287
17370
|
*/
|
|
17288
17371
|
include_date: boolean;
|
|
17372
|
+
/**
|
|
17373
|
+
* Version
|
|
17374
|
+
* @description The version the signer was shown (the PDF from GET /view?version=). It must be the current version: the signed copy becomes the next one. Omit for the current version.
|
|
17375
|
+
*/
|
|
17376
|
+
version?: number | null;
|
|
17289
17377
|
/** Timestamp */
|
|
17290
17378
|
timestamp: number;
|
|
17291
17379
|
/**
|
|
@@ -18113,7 +18201,8 @@ interface components {
|
|
|
18113
18201
|
};
|
|
18114
18202
|
/**
|
|
18115
18203
|
* TagMatrixRow
|
|
18116
|
-
* @description One tag of the matrix with its evidence. ``docs``/``facts`` are capped; the counts are the
|
|
18204
|
+
* @description One tag of the matrix with its evidence. ``docs``/``facts``/``threads`` are capped; the counts are the
|
|
18205
|
+
* totals.
|
|
18117
18206
|
*/
|
|
18118
18207
|
TagMatrixRow: {
|
|
18119
18208
|
tag: components['schemas']['TagResponse'];
|
|
@@ -18121,6 +18210,8 @@ interface components {
|
|
|
18121
18210
|
docs?: components['schemas']['TagMatrixDocLink'][];
|
|
18122
18211
|
/** Facts */
|
|
18123
18212
|
facts?: components['schemas']['TagMatrixFactLink'][];
|
|
18213
|
+
/** Threads */
|
|
18214
|
+
threads?: components['schemas']['TagMatrixThreadLink'][];
|
|
18124
18215
|
/**
|
|
18125
18216
|
* Doc Count
|
|
18126
18217
|
* @default 0
|
|
@@ -18131,6 +18222,26 @@ interface components {
|
|
|
18131
18222
|
* @default 0
|
|
18132
18223
|
*/
|
|
18133
18224
|
fact_count: number;
|
|
18225
|
+
/**
|
|
18226
|
+
* Thread Count
|
|
18227
|
+
* @default 0
|
|
18228
|
+
*/
|
|
18229
|
+
thread_count: number;
|
|
18230
|
+
};
|
|
18231
|
+
/**
|
|
18232
|
+
* TagMatrixThreadLink
|
|
18233
|
+
* @description A thread (conversation) carrying a matrix tag.
|
|
18234
|
+
*/
|
|
18235
|
+
TagMatrixThreadLink: {
|
|
18236
|
+
/** Conversation Ext Id */
|
|
18237
|
+
conversation_ext_id: string;
|
|
18238
|
+
/** Title */
|
|
18239
|
+
title?: string | null;
|
|
18240
|
+
/**
|
|
18241
|
+
* Updated At
|
|
18242
|
+
* Format: date-time
|
|
18243
|
+
*/
|
|
18244
|
+
updated_at: string;
|
|
18134
18245
|
};
|
|
18135
18246
|
/** TagResponse */
|
|
18136
18247
|
TagResponse: {
|
|
@@ -18143,6 +18254,12 @@ interface components {
|
|
|
18143
18254
|
/** Instruction */
|
|
18144
18255
|
instruction?: string | null;
|
|
18145
18256
|
tag_type: components['schemas']['TagFormat'];
|
|
18257
|
+
/**
|
|
18258
|
+
* Kind
|
|
18259
|
+
* @default label
|
|
18260
|
+
* @enum {string}
|
|
18261
|
+
*/
|
|
18262
|
+
kind: 'label' | 'annotation' | 'search' | 'issue' | 'person' | 'organisation';
|
|
18146
18263
|
/** Shared */
|
|
18147
18264
|
shared: boolean;
|
|
18148
18265
|
/** Parent Ext Id */
|
|
@@ -18154,6 +18271,11 @@ interface components {
|
|
|
18154
18271
|
* @default 0
|
|
18155
18272
|
*/
|
|
18156
18273
|
facttag_count: number;
|
|
18274
|
+
/**
|
|
18275
|
+
* Convotag Count
|
|
18276
|
+
* @default 0
|
|
18277
|
+
*/
|
|
18278
|
+
convotag_count: number;
|
|
18157
18279
|
/** Fields */
|
|
18158
18280
|
fields?: components['schemas']['TagField'][];
|
|
18159
18281
|
/** Field Values */
|
|
@@ -18953,7 +19075,19 @@ interface components {
|
|
|
18953
19075
|
name?: string | null;
|
|
18954
19076
|
/** Instruction */
|
|
18955
19077
|
instruction?: string | null;
|
|
19078
|
+
/** @description New format. Refused (409) when a value already on a document would not fit it — a format change never drops values; clear or edit those first. */
|
|
18956
19079
|
tag_type?: components['schemas']['TagFormat'] | null;
|
|
19080
|
+
/**
|
|
19081
|
+
* Kind
|
|
19082
|
+
* @description New kind. A label can become an issue, person or organisation and back (all presence tags); a format change alone re-derives label/annotation/search.
|
|
19083
|
+
*/
|
|
19084
|
+
kind?: ('label' | 'annotation' | 'search' | 'issue' | 'person' | 'organisation') | null;
|
|
19085
|
+
/**
|
|
19086
|
+
* Kind To Children
|
|
19087
|
+
* @description With kind: also give it to this tag's children whose format allows it (e.g. mark an existing issue list and its issues in one call).
|
|
19088
|
+
* @default false
|
|
19089
|
+
*/
|
|
19090
|
+
kind_to_children: boolean;
|
|
18957
19091
|
/** Shared */
|
|
18958
19092
|
shared?: boolean | null;
|
|
18959
19093
|
/**
|
|
@@ -24758,6 +24892,8 @@ interface operations {
|
|
|
24758
24892
|
parent_ext_id?: string | null;
|
|
24759
24893
|
/** @description Rows are these tags, in this order (repeatable) */
|
|
24760
24894
|
tag_ext_id?: string[] | null;
|
|
24895
|
+
/** @description Rows are every tag of this kind, oldest first */
|
|
24896
|
+
kind?: ('label' | 'annotation' | 'search' | 'issue' | 'person' | 'organisation') | null;
|
|
24761
24897
|
/** @description Most documents and facts per row */
|
|
24762
24898
|
links_limit?: number;
|
|
24763
24899
|
};
|
|
@@ -24787,6 +24923,42 @@ interface operations {
|
|
|
24787
24923
|
};
|
|
24788
24924
|
};
|
|
24789
24925
|
};
|
|
24926
|
+
extract_entities: {
|
|
24927
|
+
parameters: {
|
|
24928
|
+
query?: {
|
|
24929
|
+
/** @description Configuration to use for the LLM */
|
|
24930
|
+
config_ext_id?: string | null;
|
|
24931
|
+
};
|
|
24932
|
+
header?: never;
|
|
24933
|
+
path?: never;
|
|
24934
|
+
cookie?: never;
|
|
24935
|
+
};
|
|
24936
|
+
requestBody: {
|
|
24937
|
+
content: {
|
|
24938
|
+
'application/json': components['schemas']['ExtractEntitiesRequest'];
|
|
24939
|
+
};
|
|
24940
|
+
};
|
|
24941
|
+
responses: {
|
|
24942
|
+
/** @description Successful Response */
|
|
24943
|
+
202: {
|
|
24944
|
+
headers: {
|
|
24945
|
+
[name: string]: unknown;
|
|
24946
|
+
};
|
|
24947
|
+
content: {
|
|
24948
|
+
'application/json': components['schemas']['ExtractEntitiesResponse'];
|
|
24949
|
+
};
|
|
24950
|
+
};
|
|
24951
|
+
/** @description Validation Error */
|
|
24952
|
+
422: {
|
|
24953
|
+
headers: {
|
|
24954
|
+
[name: string]: unknown;
|
|
24955
|
+
};
|
|
24956
|
+
content: {
|
|
24957
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24958
|
+
};
|
|
24959
|
+
};
|
|
24960
|
+
};
|
|
24961
|
+
};
|
|
24790
24962
|
create_tag: {
|
|
24791
24963
|
parameters: {
|
|
24792
24964
|
query?: never;
|