@nvisy/sdk 0.17.0 → 0.19.0
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/CHANGELOG.md +34 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/{client-DTDeY65u.d.ts → client-19Pdp3nu.d.ts} +19 -2
- package/dist/{client-DTDeY65u.d.ts.map → client-19Pdp3nu.d.ts.map} +1 -1
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{errors-DvGetnl_.d.ts → errors-DxGrGuHW.d.ts} +2 -2
- package/dist/{errors-DvGetnl_.d.ts.map → errors-DxGrGuHW.d.ts.map} +1 -1
- package/dist/{index-xsIOUQmc.d.ts → index-C22LjJS2.d.ts} +241 -326
- package/dist/index-C22LjJS2.d.ts.map +1 -0
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/services/index.d.ts +1 -1
- package/dist/services/index.js +1 -1
- package/dist/{services-BFK0sD1B.js → services-CPhHUw24.js} +36 -1
- package/dist/{services-BFK0sD1B.js.map → services-CPhHUw24.js.map} +1 -1
- package/dist/webhooks/index.d.ts +2 -2
- package/package.json +1 -1
- package/dist/index-xsIOUQmc.d.ts.map +0 -1
|
@@ -4296,6 +4296,115 @@ interface paths {
|
|
|
4296
4296
|
patch?: never;
|
|
4297
4297
|
trace?: never;
|
|
4298
4298
|
};
|
|
4299
|
+
"/workspaces/{workspaceSlug}/runs/{runId}/redactions/": {
|
|
4300
|
+
parameters: {
|
|
4301
|
+
query?: never;
|
|
4302
|
+
header?: never;
|
|
4303
|
+
path?: never;
|
|
4304
|
+
cookie?: never;
|
|
4305
|
+
};
|
|
4306
|
+
get?: never;
|
|
4307
|
+
put?: never;
|
|
4308
|
+
/**
|
|
4309
|
+
* Redact a run
|
|
4310
|
+
* @description Applies the pipeline's policies to the run's stored analysis, stores the redacted file, and completes the run.
|
|
4311
|
+
*/
|
|
4312
|
+
post: {
|
|
4313
|
+
parameters: {
|
|
4314
|
+
query?: never;
|
|
4315
|
+
header?: never;
|
|
4316
|
+
path: {
|
|
4317
|
+
/** @description URL-safe workspace identifier. */
|
|
4318
|
+
workspaceSlug: string;
|
|
4319
|
+
/** @description Opaque identifier of the run. */
|
|
4320
|
+
runId: components["schemas"]["RunId"];
|
|
4321
|
+
};
|
|
4322
|
+
cookie?: never;
|
|
4323
|
+
};
|
|
4324
|
+
requestBody?: never;
|
|
4325
|
+
responses: {
|
|
4326
|
+
/**
|
|
4327
|
+
* @description Response type for a pipeline run.
|
|
4328
|
+
*
|
|
4329
|
+
* A run is addressed by its own opaque id; the owning pipeline and workspace
|
|
4330
|
+
* slugs are carried for context.
|
|
4331
|
+
*/
|
|
4332
|
+
200: {
|
|
4333
|
+
headers: {
|
|
4334
|
+
[name: string]: unknown;
|
|
4335
|
+
};
|
|
4336
|
+
content: {
|
|
4337
|
+
"application/json": components["schemas"]["PipelineRun"];
|
|
4338
|
+
};
|
|
4339
|
+
};
|
|
4340
|
+
/**
|
|
4341
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4342
|
+
*
|
|
4343
|
+
* This struct contains all the information needed to serialize an error
|
|
4344
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4345
|
+
* information, and user-friendly messages.
|
|
4346
|
+
*/
|
|
4347
|
+
401: {
|
|
4348
|
+
headers: {
|
|
4349
|
+
[name: string]: unknown;
|
|
4350
|
+
};
|
|
4351
|
+
content: {
|
|
4352
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4353
|
+
};
|
|
4354
|
+
};
|
|
4355
|
+
/**
|
|
4356
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4357
|
+
*
|
|
4358
|
+
* This struct contains all the information needed to serialize an error
|
|
4359
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4360
|
+
* information, and user-friendly messages.
|
|
4361
|
+
*/
|
|
4362
|
+
403: {
|
|
4363
|
+
headers: {
|
|
4364
|
+
[name: string]: unknown;
|
|
4365
|
+
};
|
|
4366
|
+
content: {
|
|
4367
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4368
|
+
};
|
|
4369
|
+
};
|
|
4370
|
+
/**
|
|
4371
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4372
|
+
*
|
|
4373
|
+
* This struct contains all the information needed to serialize an error
|
|
4374
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4375
|
+
* information, and user-friendly messages.
|
|
4376
|
+
*/
|
|
4377
|
+
404: {
|
|
4378
|
+
headers: {
|
|
4379
|
+
[name: string]: unknown;
|
|
4380
|
+
};
|
|
4381
|
+
content: {
|
|
4382
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4383
|
+
};
|
|
4384
|
+
};
|
|
4385
|
+
/**
|
|
4386
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4387
|
+
*
|
|
4388
|
+
* This struct contains all the information needed to serialize an error
|
|
4389
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4390
|
+
* information, and user-friendly messages.
|
|
4391
|
+
*/
|
|
4392
|
+
409: {
|
|
4393
|
+
headers: {
|
|
4394
|
+
[name: string]: unknown;
|
|
4395
|
+
};
|
|
4396
|
+
content: {
|
|
4397
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4398
|
+
};
|
|
4399
|
+
};
|
|
4400
|
+
};
|
|
4401
|
+
};
|
|
4402
|
+
delete?: never;
|
|
4403
|
+
options?: never;
|
|
4404
|
+
head?: never;
|
|
4405
|
+
patch?: never;
|
|
4406
|
+
trace?: never;
|
|
4407
|
+
};
|
|
4299
4408
|
"/workspaces/{workspaceSlug}/runs/{runId}/detections/": {
|
|
4300
4409
|
parameters: {
|
|
4301
4410
|
query?: never;
|
|
@@ -4417,20 +4526,18 @@ interface paths {
|
|
|
4417
4526
|
patch?: never;
|
|
4418
4527
|
trace?: never;
|
|
4419
4528
|
};
|
|
4420
|
-
"/workspaces/{workspaceSlug}/runs/{runId}/
|
|
4529
|
+
"/workspaces/{workspaceSlug}/runs/{runId}/audit/json": {
|
|
4421
4530
|
parameters: {
|
|
4422
4531
|
query?: never;
|
|
4423
4532
|
header?: never;
|
|
4424
4533
|
path?: never;
|
|
4425
4534
|
cookie?: never;
|
|
4426
4535
|
};
|
|
4427
|
-
get?: never;
|
|
4428
|
-
put?: never;
|
|
4429
4536
|
/**
|
|
4430
|
-
*
|
|
4431
|
-
* @description
|
|
4537
|
+
* Download run audit (JSON)
|
|
4538
|
+
* @description Downloads the run's audit as a pretty-printed JSON file.
|
|
4432
4539
|
*/
|
|
4433
|
-
|
|
4540
|
+
get: {
|
|
4434
4541
|
parameters: {
|
|
4435
4542
|
query?: never;
|
|
4436
4543
|
header?: never;
|
|
@@ -4444,20 +4551,115 @@ interface paths {
|
|
|
4444
4551
|
};
|
|
4445
4552
|
requestBody?: never;
|
|
4446
4553
|
responses: {
|
|
4554
|
+
/** @description no content */
|
|
4555
|
+
200: {
|
|
4556
|
+
headers: {
|
|
4557
|
+
[name: string]: unknown;
|
|
4558
|
+
};
|
|
4559
|
+
content?: never;
|
|
4560
|
+
};
|
|
4447
4561
|
/**
|
|
4448
|
-
* @description
|
|
4562
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4449
4563
|
*
|
|
4450
|
-
*
|
|
4451
|
-
*
|
|
4564
|
+
* This struct contains all the information needed to serialize an error
|
|
4565
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4566
|
+
* information, and user-friendly messages.
|
|
4452
4567
|
*/
|
|
4453
|
-
|
|
4568
|
+
401: {
|
|
4454
4569
|
headers: {
|
|
4455
4570
|
[name: string]: unknown;
|
|
4456
4571
|
};
|
|
4457
4572
|
content: {
|
|
4458
|
-
"application/json": components["schemas"]["
|
|
4573
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4574
|
+
};
|
|
4575
|
+
};
|
|
4576
|
+
/**
|
|
4577
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4578
|
+
*
|
|
4579
|
+
* This struct contains all the information needed to serialize an error
|
|
4580
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4581
|
+
* information, and user-friendly messages.
|
|
4582
|
+
*/
|
|
4583
|
+
403: {
|
|
4584
|
+
headers: {
|
|
4585
|
+
[name: string]: unknown;
|
|
4586
|
+
};
|
|
4587
|
+
content: {
|
|
4588
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4589
|
+
};
|
|
4590
|
+
};
|
|
4591
|
+
/**
|
|
4592
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4593
|
+
*
|
|
4594
|
+
* This struct contains all the information needed to serialize an error
|
|
4595
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4596
|
+
* information, and user-friendly messages.
|
|
4597
|
+
*/
|
|
4598
|
+
404: {
|
|
4599
|
+
headers: {
|
|
4600
|
+
[name: string]: unknown;
|
|
4601
|
+
};
|
|
4602
|
+
content: {
|
|
4603
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4604
|
+
};
|
|
4605
|
+
};
|
|
4606
|
+
/**
|
|
4607
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4608
|
+
*
|
|
4609
|
+
* This struct contains all the information needed to serialize an error
|
|
4610
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4611
|
+
* information, and user-friendly messages.
|
|
4612
|
+
*/
|
|
4613
|
+
409: {
|
|
4614
|
+
headers: {
|
|
4615
|
+
[name: string]: unknown;
|
|
4616
|
+
};
|
|
4617
|
+
content: {
|
|
4618
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4459
4619
|
};
|
|
4460
4620
|
};
|
|
4621
|
+
};
|
|
4622
|
+
};
|
|
4623
|
+
put?: never;
|
|
4624
|
+
post?: never;
|
|
4625
|
+
delete?: never;
|
|
4626
|
+
options?: never;
|
|
4627
|
+
head?: never;
|
|
4628
|
+
patch?: never;
|
|
4629
|
+
trace?: never;
|
|
4630
|
+
};
|
|
4631
|
+
"/workspaces/{workspaceSlug}/runs/{runId}/audit/csv": {
|
|
4632
|
+
parameters: {
|
|
4633
|
+
query?: never;
|
|
4634
|
+
header?: never;
|
|
4635
|
+
path?: never;
|
|
4636
|
+
cookie?: never;
|
|
4637
|
+
};
|
|
4638
|
+
/**
|
|
4639
|
+
* Download run audit (CSV)
|
|
4640
|
+
* @description Downloads the run's audit as a zip of entities.csv, provenance.csv, and reviews.csv.
|
|
4641
|
+
*/
|
|
4642
|
+
get: {
|
|
4643
|
+
parameters: {
|
|
4644
|
+
query?: never;
|
|
4645
|
+
header?: never;
|
|
4646
|
+
path: {
|
|
4647
|
+
/** @description URL-safe workspace identifier. */
|
|
4648
|
+
workspaceSlug: string;
|
|
4649
|
+
/** @description Opaque identifier of the run. */
|
|
4650
|
+
runId: components["schemas"]["RunId"];
|
|
4651
|
+
};
|
|
4652
|
+
cookie?: never;
|
|
4653
|
+
};
|
|
4654
|
+
requestBody?: never;
|
|
4655
|
+
responses: {
|
|
4656
|
+
/** @description no content */
|
|
4657
|
+
200: {
|
|
4658
|
+
headers: {
|
|
4659
|
+
[name: string]: unknown;
|
|
4660
|
+
};
|
|
4661
|
+
content?: never;
|
|
4662
|
+
};
|
|
4461
4663
|
/**
|
|
4462
4664
|
* @description HTTP error response representation with security-conscious design.
|
|
4463
4665
|
*
|
|
@@ -4520,6 +4722,8 @@ interface paths {
|
|
|
4520
4722
|
};
|
|
4521
4723
|
};
|
|
4522
4724
|
};
|
|
4725
|
+
put?: never;
|
|
4726
|
+
post?: never;
|
|
4523
4727
|
delete?: never;
|
|
4524
4728
|
options?: never;
|
|
4525
4729
|
head?: never;
|
|
@@ -8510,156 +8714,6 @@ interface components {
|
|
|
8510
8714
|
*/
|
|
8511
8715
|
limit?: number;
|
|
8512
8716
|
};
|
|
8513
|
-
/**
|
|
8514
|
-
* @description One caller-supplied dictionary for the pattern recognizer.
|
|
8515
|
-
*
|
|
8516
|
-
* Mirrors `elide_pattern::Dictionary`. Literal-term matching via
|
|
8517
|
-
* Aho-Corasick; faster and safer than regex for closed sets.
|
|
8518
|
-
*/
|
|
8519
|
-
CustomDictionary: {
|
|
8520
|
-
/**
|
|
8521
|
-
* @description Context keywords lifting confidence near matches.
|
|
8522
|
-
*
|
|
8523
|
-
* Consumed only when the analyzer's
|
|
8524
|
-
* [`PatternRecognizerParams`]`.context_enhanced` is `true`.
|
|
8525
|
-
*
|
|
8526
|
-
* [`PatternRecognizerParams`]: super::PatternRecognizerParams
|
|
8527
|
-
*/
|
|
8528
|
-
context?: components["schemas"]["CustomPatternContext"];
|
|
8529
|
-
/**
|
|
8530
|
-
* @description ISO 3166-1 alpha-2 country codes scoping the dictionary.
|
|
8531
|
-
*
|
|
8532
|
-
* Empty means "any country"; otherwise the recognizer skips
|
|
8533
|
-
* the dictionary when the per-call jurisdiction hint is not
|
|
8534
|
-
* in the list.
|
|
8535
|
-
*/
|
|
8536
|
-
countries?: components["schemas"]["CountryCode"][];
|
|
8537
|
-
/** @description Entity label every match emits. */
|
|
8538
|
-
label: components["schemas"]["LabelRef"];
|
|
8539
|
-
/**
|
|
8540
|
-
* @description BCP-47 language tags scoping the dictionary.
|
|
8541
|
-
*
|
|
8542
|
-
* Empty means "any language"; otherwise the recognizer skips
|
|
8543
|
-
* the dictionary when the per-call language hint is not in
|
|
8544
|
-
* the list.
|
|
8545
|
-
*/
|
|
8546
|
-
languages?: components["schemas"]["LanguageTag"][];
|
|
8547
|
-
/** @description Human-readable identifier surfaced in provenance. */
|
|
8548
|
-
name: string;
|
|
8549
|
-
/**
|
|
8550
|
-
* @description Default confidence stamped on matches when a term has no
|
|
8551
|
-
* per-term override.
|
|
8552
|
-
*
|
|
8553
|
-
* Defaults to [`Confidence::MAX`].
|
|
8554
|
-
* @default 1
|
|
8555
|
-
*/
|
|
8556
|
-
score: components["schemas"]["Confidence"];
|
|
8557
|
-
/**
|
|
8558
|
-
* @description Literal terms + per-term confidence overrides.
|
|
8559
|
-
*
|
|
8560
|
-
* At least one required; the recognizer skips dictionaries
|
|
8561
|
-
* with an empty term list at compile time.
|
|
8562
|
-
*/
|
|
8563
|
-
terms: components["schemas"]["CustomDictionaryTerm"][];
|
|
8564
|
-
};
|
|
8565
|
-
/** @description One term inside a [`CustomDictionary`]. */
|
|
8566
|
-
CustomDictionaryTerm: {
|
|
8567
|
-
/**
|
|
8568
|
-
* @description Per-term score override.
|
|
8569
|
-
*
|
|
8570
|
-
* `None` falls back to the parent dictionary's `score`.
|
|
8571
|
-
*/
|
|
8572
|
-
score?: components["schemas"]["Confidence"];
|
|
8573
|
-
/** @description The literal scanned for. */
|
|
8574
|
-
term: string;
|
|
8575
|
-
};
|
|
8576
|
-
/**
|
|
8577
|
-
* @description Context keywords for a custom rule.
|
|
8578
|
-
*
|
|
8579
|
-
* Either a flat list applied regardless of language, or a
|
|
8580
|
-
* per-language map. Matches the shape of `elide_pattern`'s
|
|
8581
|
-
* `Context` — untagged so the wire looks like either
|
|
8582
|
-
* `["kw1", "kw2"]` or `{ "en": ["kw1"], "es": ["kw2"] }`.
|
|
8583
|
-
*/
|
|
8584
|
-
CustomPatternContext: string[] | {
|
|
8585
|
-
[key: string]: string[];
|
|
8586
|
-
};
|
|
8587
|
-
/**
|
|
8588
|
-
* @description One caller-supplied regex rule for the pattern recognizer.
|
|
8589
|
-
*
|
|
8590
|
-
* Mirrors `elide_pattern::Regex`. Serialize + Deserialize +
|
|
8591
|
-
* JsonSchema end-to-end so SDK callers can inline rules on the
|
|
8592
|
-
* wire; the engine converts each rule to an elide `Regex` at
|
|
8593
|
-
* analyzer-compile time.
|
|
8594
|
-
*/
|
|
8595
|
-
CustomPatternRule: {
|
|
8596
|
-
/**
|
|
8597
|
-
* @description Context keywords lifting confidence when they appear near
|
|
8598
|
-
* a match.
|
|
8599
|
-
*
|
|
8600
|
-
* Either a flat list (any language) or a per-language map.
|
|
8601
|
-
* Consumed only when the analyzer's
|
|
8602
|
-
* [`PatternRecognizerParams`]`.context_enhanced` is `true`.
|
|
8603
|
-
*
|
|
8604
|
-
* [`PatternRecognizerParams`]: super::PatternRecognizerParams
|
|
8605
|
-
*/
|
|
8606
|
-
context?: components["schemas"]["CustomPatternContext"];
|
|
8607
|
-
/**
|
|
8608
|
-
* @description ISO 3166-1 alpha-2 country codes scoping the rule.
|
|
8609
|
-
*
|
|
8610
|
-
* Empty means "any country"; otherwise the recognizer skips
|
|
8611
|
-
* the rule when the per-call jurisdiction hint is not in the
|
|
8612
|
-
* list.
|
|
8613
|
-
*/
|
|
8614
|
-
countries?: components["schemas"]["CountryCode"][];
|
|
8615
|
-
/** @description Entity label every variant emits. */
|
|
8616
|
-
label: components["schemas"]["LabelRef"];
|
|
8617
|
-
/**
|
|
8618
|
-
* @description BCP-47 language tags scoping the rule.
|
|
8619
|
-
*
|
|
8620
|
-
* Empty means "any language"; otherwise the recognizer skips
|
|
8621
|
-
* the rule when the per-call language hint is not in the
|
|
8622
|
-
* list.
|
|
8623
|
-
*/
|
|
8624
|
-
languages?: components["schemas"]["LanguageTag"][];
|
|
8625
|
-
/** @description Human-readable identifier surfaced in provenance. */
|
|
8626
|
-
name: string;
|
|
8627
|
-
/**
|
|
8628
|
-
* @description Regex sources + per-variant confidence + optional
|
|
8629
|
-
* validator.
|
|
8630
|
-
*
|
|
8631
|
-
* At least one required; the recognizer skips rules with an
|
|
8632
|
-
* empty variant list at compile time.
|
|
8633
|
-
*/
|
|
8634
|
-
variants: components["schemas"]["CustomPatternVariant"][];
|
|
8635
|
-
};
|
|
8636
|
-
/** @description One regex variant inside a [`CustomPatternRule`]. */
|
|
8637
|
-
CustomPatternVariant: {
|
|
8638
|
-
/**
|
|
8639
|
-
* @description Regex source.
|
|
8640
|
-
*
|
|
8641
|
-
* Capped at [`MAX_REGEX_SOURCE_LEN`] bytes; longer sources
|
|
8642
|
-
* reject at deserialize. Compiled by the engine at
|
|
8643
|
-
* analyzer-compile time.
|
|
8644
|
-
*/
|
|
8645
|
-
regex: string;
|
|
8646
|
-
/**
|
|
8647
|
-
* @description Confidence stamped on every match, before any
|
|
8648
|
-
* post-recognition keyword boost.
|
|
8649
|
-
*
|
|
8650
|
-
* Defaults to [`Confidence::MAX`].
|
|
8651
|
-
* @default 1
|
|
8652
|
-
*/
|
|
8653
|
-
score: components["schemas"]["Confidence"];
|
|
8654
|
-
/**
|
|
8655
|
-
* @description Optional validator name.
|
|
8656
|
-
*
|
|
8657
|
-
* Resolved against elide's `ValidatorRegistry` at compile
|
|
8658
|
-
* time (e.g. `"ssn"`, `"credit_card"`, `"iban"`). Unknown
|
|
8659
|
-
* names error at compile. `None` means "no validation".
|
|
8660
|
-
*/
|
|
8661
|
-
validator?: string;
|
|
8662
|
-
};
|
|
8663
8717
|
/**
|
|
8664
8718
|
* @description The coarseness a [`GeneralizeDate`] reduces a date/timestamp to.
|
|
8665
8719
|
*
|
|
@@ -9409,8 +9463,6 @@ interface components {
|
|
|
9409
9463
|
expiresAt: string;
|
|
9410
9464
|
/** @description Role the user will have if they join. */
|
|
9411
9465
|
invitedRole: components["schemas"]["WorkspaceRole"];
|
|
9412
|
-
/** @description Tags associated with the workspace. */
|
|
9413
|
-
tags: string[];
|
|
9414
9466
|
/** @description Handle of the workspace. */
|
|
9415
9467
|
workspaceSlug: components["schemas"]["Handle"];
|
|
9416
9468
|
};
|
|
@@ -9837,13 +9889,6 @@ interface components {
|
|
|
9837
9889
|
};
|
|
9838
9890
|
/** @description Fields available for sorting workspace members. */
|
|
9839
9891
|
MemberSortField: "name" | "date";
|
|
9840
|
-
/**
|
|
9841
|
-
* @description How the merging reconciler combines same-label overlaps.
|
|
9842
|
-
*
|
|
9843
|
-
* Picks one entity per overlapping cluster of findings that
|
|
9844
|
-
* share a label.
|
|
9845
|
-
*/
|
|
9846
|
-
MergingStrategyParams: "max" | "noisy_or";
|
|
9847
9892
|
/**
|
|
9848
9893
|
* @description Per-modality operator specs carried by a `redact` rule.
|
|
9849
9894
|
*
|
|
@@ -10022,46 +10067,6 @@ interface components {
|
|
|
10022
10067
|
/** @description Name of the validator that confirmed the match (e.g. `"luhn"`). */
|
|
10023
10068
|
validator?: string;
|
|
10024
10069
|
};
|
|
10025
|
-
/** @description Params for the `elide-pattern` recognizer. */
|
|
10026
|
-
PatternRecognizerParams: {
|
|
10027
|
-
/**
|
|
10028
|
-
* @description Load every pattern + dictionary shipped with `elide-pattern`.
|
|
10029
|
-
*
|
|
10030
|
-
* Implies the country-scoped jurisdictional pattern packs
|
|
10031
|
-
* are active for the scope's jurisdictions.
|
|
10032
|
-
* @default false
|
|
10033
|
-
*/
|
|
10034
|
-
builtins: boolean;
|
|
10035
|
-
/**
|
|
10036
|
-
* @description Enable per-label context-keyword boosting.
|
|
10037
|
-
*
|
|
10038
|
-
* Wraps the bare pattern recognizer in elide's
|
|
10039
|
-
* `Enhanced<PatternRecognizer>` layer so per-label context
|
|
10040
|
-
* keywords boost low-confidence matches before they leave
|
|
10041
|
-
* the recognizer.
|
|
10042
|
-
* @default false
|
|
10043
|
-
*/
|
|
10044
|
-
contextEnhanced: boolean;
|
|
10045
|
-
/**
|
|
10046
|
-
* @description Caller-inlined regex rules.
|
|
10047
|
-
*
|
|
10048
|
-
* Compiled per-request. See [`CustomPatternRule`] for the
|
|
10049
|
-
* shape; the engine bounds request-level cost with a rule-
|
|
10050
|
-
* count cap and a per-regex NFA-size limit at compile time,
|
|
10051
|
-
* on top of the deserialize-time source-length cap in
|
|
10052
|
-
* [`MAX_REGEX_SOURCE_LEN`].
|
|
10053
|
-
*
|
|
10054
|
-
* [`MAX_REGEX_SOURCE_LEN`]: super::MAX_REGEX_SOURCE_LEN
|
|
10055
|
-
*/
|
|
10056
|
-
custom?: components["schemas"]["CustomPatternRule"][];
|
|
10057
|
-
/**
|
|
10058
|
-
* @description Caller-inlined literal-term dictionaries.
|
|
10059
|
-
*
|
|
10060
|
-
* Compiled per-request into a shared Aho-Corasick automaton.
|
|
10061
|
-
* Same rule-count cap as `custom` applies at compile time.
|
|
10062
|
-
*/
|
|
10063
|
-
customDictionaries?: components["schemas"]["CustomDictionary"][];
|
|
10064
|
-
};
|
|
10065
10070
|
/**
|
|
10066
10071
|
* @description Which PCI DSS subsection this template addresses.
|
|
10067
10072
|
*
|
|
@@ -10139,47 +10144,25 @@ interface components {
|
|
|
10139
10144
|
/** @description Handle of the workspace this pipeline belongs to. */
|
|
10140
10145
|
workspaceSlug: components["schemas"]["Handle"];
|
|
10141
10146
|
};
|
|
10142
|
-
/**
|
|
10143
|
-
* @description A pipeline's deduplication intent.
|
|
10144
|
-
*
|
|
10145
|
-
* Each field is optional: when a pipeline omits one, it inherits the
|
|
10146
|
-
* deployment default from the engine config. Per-recognizer calibration is
|
|
10147
|
-
* operator-only and never set here.
|
|
10148
|
-
*/
|
|
10149
|
-
PipelineDeduplication: {
|
|
10150
|
-
/** @description How same-label overlapping findings are merged into one. */
|
|
10151
|
-
merging?: components["schemas"]["MergingStrategyParams"];
|
|
10152
|
-
/** @description Minimum confidence the filter layer admits. */
|
|
10153
|
-
minConfidence?: components["schemas"]["ConfidenceThreshold"];
|
|
10154
|
-
/** @description How cross-label overlaps pick a winner. */
|
|
10155
|
-
tiebreaker?: components["schemas"]["TiebreakerParams"];
|
|
10156
|
-
};
|
|
10157
10147
|
/**
|
|
10158
10148
|
* @description A pipeline's detection + governance intent.
|
|
10159
10149
|
*
|
|
10160
|
-
* Holds what a pipeline author decides —
|
|
10161
|
-
*
|
|
10162
|
-
*
|
|
10163
|
-
* here. Stored as JSON in the pipeline's `definition` column but
|
|
10164
|
-
* against this schema at the API boundary.
|
|
10150
|
+
* Holds what a pipeline author decides — the default scope and the policies to
|
|
10151
|
+
* apply. Recognition is entirely server-wide: the built-in pattern set plus the
|
|
10152
|
+
* deployment's NER/LLM lineups and enrichment backends live in the engine
|
|
10153
|
+
* config, not here. Stored as JSON in the pipeline's `definition` column but
|
|
10154
|
+
* validated against this schema at the API boundary.
|
|
10165
10155
|
*
|
|
10166
10156
|
* The label catalog is not part of this: the policies own the label vocabulary,
|
|
10167
10157
|
* and the engine derives the detection catalog from them at run time.
|
|
10168
10158
|
*
|
|
10169
10159
|
* The split:
|
|
10170
10160
|
*
|
|
10171
|
-
* - `recognizers` / `deduplication` — the detection intent, merged with the
|
|
10172
|
-
* server-wide engine defaults into an `AnalyzerParams`.
|
|
10173
10161
|
* - `default_scope` — optional pipeline-wide scope a document may override.
|
|
10174
10162
|
* - `policy_slugs` — references to the workspace's policies, resolved at run
|
|
10175
10163
|
* time.
|
|
10176
10164
|
*/
|
|
10177
10165
|
PipelineDefinition: {
|
|
10178
|
-
/**
|
|
10179
|
-
* @description Post-recognition deduplication behavior.
|
|
10180
|
-
* @default {}
|
|
10181
|
-
*/
|
|
10182
|
-
deduplication: components["schemas"]["PipelineDeduplication"];
|
|
10183
10166
|
/**
|
|
10184
10167
|
* @description Optional pipeline-wide scope (languages, jurisdictions, document labels).
|
|
10185
10168
|
*
|
|
@@ -10194,12 +10177,6 @@ interface components {
|
|
|
10194
10177
|
* definition; surfaced here so the API exposes one coherent object.
|
|
10195
10178
|
*/
|
|
10196
10179
|
policySlugs?: components["schemas"]["Handle"][];
|
|
10197
|
-
/**
|
|
10198
|
-
* @description Recognizer lineup: pattern (incl. inline custom rules and
|
|
10199
|
-
* dictionaries), plus the NER and LLM toggles.
|
|
10200
|
-
* @default {}
|
|
10201
|
-
*/
|
|
10202
|
-
recognizers: components["schemas"]["RecognizerParams"];
|
|
10203
10180
|
};
|
|
10204
10181
|
/** @description Query parameters for filtering pipelines. */
|
|
10205
10182
|
PipelineFilter: {
|
|
@@ -10304,6 +10281,8 @@ interface components {
|
|
|
10304
10281
|
* @description Timestamp when the pipeline was created.
|
|
10305
10282
|
*/
|
|
10306
10283
|
createdAt: string;
|
|
10284
|
+
/** @description Account that created this pipeline. */
|
|
10285
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
10307
10286
|
/** @description Pipeline description. */
|
|
10308
10287
|
description?: string;
|
|
10309
10288
|
/** @description Pipeline display name. */
|
|
@@ -10317,6 +10296,8 @@ interface components {
|
|
|
10317
10296
|
* @description Timestamp when the pipeline was last updated.
|
|
10318
10297
|
*/
|
|
10319
10298
|
updatedAt: string;
|
|
10299
|
+
/** @description Handle of the workspace this pipeline belongs to. */
|
|
10300
|
+
workspaceSlug: components["schemas"]["Handle"];
|
|
10320
10301
|
};
|
|
10321
10302
|
/**
|
|
10322
10303
|
* @description Generic paginated response wrapper.
|
|
@@ -10653,19 +10634,6 @@ interface components {
|
|
|
10653
10634
|
/** @description Negated predicate. */
|
|
10654
10635
|
not: components["schemas"]["Predicate"];
|
|
10655
10636
|
};
|
|
10656
|
-
/**
|
|
10657
|
-
* @description How to pick recognizers out of a deployment-configured lineup.
|
|
10658
|
-
*
|
|
10659
|
-
* Untagged on the wire: `true` / `false` / a list of names.
|
|
10660
|
-
*
|
|
10661
|
-
* - `All(true)`: explicit opt-in. Attaches every configured
|
|
10662
|
-
* recognizer; fails the analyzer compile if the lineup is
|
|
10663
|
-
* empty.
|
|
10664
|
-
* - `All(false)`: explicit opt-out. Skips the lineup entirely.
|
|
10665
|
-
* - `Only(names)`: attach only the named recognizers. An empty
|
|
10666
|
-
* list and any unknown name fail the analyzer compile.
|
|
10667
|
-
*/
|
|
10668
|
-
ProviderSelection: boolean | string[];
|
|
10669
10637
|
/**
|
|
10670
10638
|
* @description Public view of an account, returned when looking up someone other than the
|
|
10671
10639
|
* authenticated caller. Carries only the fields safe to share with a
|
|
@@ -10698,39 +10666,6 @@ interface components {
|
|
|
10698
10666
|
/** @description NER (named-entity recognition) recognizers. */
|
|
10699
10667
|
ner: components["schemas"]["RegisteredRecognizer"][];
|
|
10700
10668
|
};
|
|
10701
|
-
/**
|
|
10702
|
-
* @description Recognizer slots an analyzer can fill.
|
|
10703
|
-
*
|
|
10704
|
-
* Pattern is at-most-one (per-request); NER and LLM are
|
|
10705
|
-
* deployment-owned lineups each selected by a
|
|
10706
|
-
* [`ProviderSelection`].
|
|
10707
|
-
*/
|
|
10708
|
-
RecognizerParams: {
|
|
10709
|
-
/**
|
|
10710
|
-
* @description Select which of the deployment's LLM recognizers to run.
|
|
10711
|
-
*
|
|
10712
|
-
* Same shape as [`ner`]. The lineup is additionally filtered
|
|
10713
|
-
* by declared modality — only recognizers whose `modalities`
|
|
10714
|
-
* list contains the analyzer's modality attach.
|
|
10715
|
-
*
|
|
10716
|
-
* [`ner`]: RecognizerParams::ner
|
|
10717
|
-
*/
|
|
10718
|
-
llm?: components["schemas"]["ProviderSelection"];
|
|
10719
|
-
/**
|
|
10720
|
-
* @description Select which of the deployment's NER recognizers to run.
|
|
10721
|
-
*
|
|
10722
|
-
* See [`ProviderSelection`] for the shape. `None` is the
|
|
10723
|
-
* softly-on default: attach every configured recognizer if
|
|
10724
|
-
* the deployment has any, skip silently otherwise.
|
|
10725
|
-
*/
|
|
10726
|
-
ner?: components["schemas"]["ProviderSelection"];
|
|
10727
|
-
/**
|
|
10728
|
-
* @description Built-in pattern + dictionary recognizer (`elide-pattern`).
|
|
10729
|
-
*
|
|
10730
|
-
* At most one per analyzer.
|
|
10731
|
-
*/
|
|
10732
|
-
pattern?: components["schemas"]["PatternRecognizerParams"];
|
|
10733
|
-
};
|
|
10734
10669
|
/**
|
|
10735
10670
|
* @description Public view of one recognizer in the engine's NER or LLM
|
|
10736
10671
|
* lineup.
|
|
@@ -12053,13 +11988,6 @@ interface components {
|
|
|
12053
11988
|
*/
|
|
12054
11989
|
style: components["schemas"]["DateStyle"];
|
|
12055
11990
|
};
|
|
12056
|
-
/**
|
|
12057
|
-
* @description How the structural reconciler picks a winner across labels.
|
|
12058
|
-
*
|
|
12059
|
-
* Runs after merging when overlapping entities carry different
|
|
12060
|
-
* labels.
|
|
12061
|
-
*/
|
|
12062
|
-
TiebreakerParams: "highest_confidence" | "longest_span";
|
|
12063
11991
|
/**
|
|
12064
11992
|
* @description Half-open `[start, end)` stream interval, measured in microseconds.
|
|
12065
11993
|
*
|
|
@@ -12448,8 +12376,6 @@ interface components {
|
|
|
12448
12376
|
settings: components["schemas"]["WorkspaceSettings"];
|
|
12449
12377
|
/** @description URL-safe workspace identifier. */
|
|
12450
12378
|
slug: components["schemas"]["Handle"];
|
|
12451
|
-
/** @description Tags associated with the workspace. */
|
|
12452
|
-
tags: string[];
|
|
12453
12379
|
/**
|
|
12454
12380
|
* Format: date-time
|
|
12455
12381
|
* @description Timestamp when the workspace was last updated.
|
|
@@ -12764,35 +12690,24 @@ type LanguageTag = Schemas$4["LanguageTag"];
|
|
|
12764
12690
|
type Sha2Algorithm = Schemas$4["Sha2Algorithm"];
|
|
12765
12691
|
type TerminalFallback = Schemas$4["TerminalFallback"];
|
|
12766
12692
|
//#endregion
|
|
12767
|
-
//#region src/datatypes/
|
|
12693
|
+
//#region src/datatypes/run.d.ts
|
|
12768
12694
|
type Schemas$3 = components["schemas"];
|
|
12769
|
-
type
|
|
12770
|
-
type
|
|
12771
|
-
type
|
|
12772
|
-
type
|
|
12773
|
-
type
|
|
12774
|
-
type CustomPatternContext = Schemas$3["CustomPatternContext"];
|
|
12775
|
-
type CustomDictionary = Schemas$3["CustomDictionary"];
|
|
12776
|
-
type CustomDictionaryTerm = Schemas$3["CustomDictionaryTerm"];
|
|
12777
|
-
type PipelineDeduplication = Schemas$3["PipelineDeduplication"];
|
|
12778
|
-
type MergingStrategyParams = Schemas$3["MergingStrategyParams"];
|
|
12779
|
-
type TiebreakerParams = Schemas$3["TiebreakerParams"];
|
|
12780
|
-
type ScopeParams = Schemas$3["ScopeParams"];
|
|
12781
|
-
type ScopeMetadata = Schemas$3["ScopeMetadata"];
|
|
12782
|
-
type CountryCode = Schemas$3["CountryCode"];
|
|
12783
|
-
type Language = Schemas$3["Language"];
|
|
12784
|
-
type Languages = Schemas$3["Languages"];
|
|
12785
|
-
type LanguageSpan = Schemas$3["LanguageSpan"];
|
|
12786
|
-
type LanguageProvenance = Schemas$3["LanguageProvenance"];
|
|
12787
|
-
type Confidence = Schemas$3["Confidence"];
|
|
12695
|
+
type PipelineRun = Schemas$3["PipelineRun"];
|
|
12696
|
+
type CreatePipelineRun = Schemas$3["CreatePipelineRun"];
|
|
12697
|
+
type PipelineRunStatus = Schemas$3["PipelineRunStatus"];
|
|
12698
|
+
type PipelineRunPage = Schemas$3["PipelineRunPage"];
|
|
12699
|
+
type Audit = Schemas$3["Audit"];
|
|
12788
12700
|
//#endregion
|
|
12789
|
-
//#region src/datatypes/
|
|
12701
|
+
//#region src/datatypes/scope.d.ts
|
|
12790
12702
|
type Schemas$2 = components["schemas"];
|
|
12791
|
-
type
|
|
12792
|
-
type
|
|
12793
|
-
type
|
|
12794
|
-
type
|
|
12795
|
-
type
|
|
12703
|
+
type ScopeParams = Schemas$2["ScopeParams"];
|
|
12704
|
+
type ScopeMetadata = Schemas$2["ScopeMetadata"];
|
|
12705
|
+
type CountryCode = Schemas$2["CountryCode"];
|
|
12706
|
+
type Language = Schemas$2["Language"];
|
|
12707
|
+
type Languages = Schemas$2["Languages"];
|
|
12708
|
+
type LanguageSpan = Schemas$2["LanguageSpan"];
|
|
12709
|
+
type LanguageProvenance = Schemas$2["LanguageProvenance"];
|
|
12710
|
+
type Confidence = Schemas$2["Confidence"];
|
|
12796
12711
|
//#endregion
|
|
12797
12712
|
//#region src/datatypes/webhook.d.ts
|
|
12798
12713
|
type Schemas$1 = components["schemas"];
|
|
@@ -12819,5 +12734,5 @@ type Retention = Schemas["Retention"];
|
|
|
12819
12734
|
type RetentionSettings = Schemas["RetentionSettings"];
|
|
12820
12735
|
type RetentionOverride = Schemas["RetentionOverride"];
|
|
12821
12736
|
//#endregion
|
|
12822
|
-
export {
|
|
12823
|
-
//# sourceMappingURL=index-
|
|
12737
|
+
export { Policy as $, ImageHint as $n, ListFiles as $t, PipelineRun as A, AuthToken as An, ApiTokenType as Ar, MemberPage as At, GdprArticle9Treatment as B, AudioLocation as Bn, PublicAccount as Br, InviteSent as Bt, LanguageProvenance as C, SyncScheduleInput as Cn, TextEventKind as Cr, NotificationEvent as Ct, ScopeParams as D, LabelCatalog as Dn, TimeSpan as Dr, UpdateNotificationSettings as Dt, ScopeMetadata as E, UpdateConnection as En, TextProvenance as Er, UnreadStatus as Et, Color as F, AudioEntity as Fn, Activity as Fr, Invite as Ft, LabelGroup as G, Dpi as Gn, SortOrder as Gt, ImageRedaction as H, AuditContext as Hn, paths as Hr, InviteStatus as Ht, ConfidenceThreshold as I, AudioEntityRecord as In, ActivityPage as Ir, InviteCode as It, LanguageTag as J, ImageData as Jn, HealthStatus as Jt, LabelLocale as K, EntityCoRef as Kn, ComponentHealth as Kt, CreatePolicy as L, AudioEvent as Ln, ActivityType as Lr, InviteExpiration as Lt, PipelineRunStatus as M, Signup as Mn, CreateApiToken as Mr, UpdateMember as Mt, AudioRedaction as N, Attribution as Nn, TokenExpiration as Nr, CreateInvite as Nt, Audit as O, RecognizerCatalog as On, ApiToken as Or, ListMembers as Ot, ClampBucket as P, AudioData as Pn, UpdateApiToken as Pr, GenerateInviteCode as Pt, PciPanRender as Q, ImageEventKind as Qn, FormatToken as Qt, DateGranularity as R, AudioEventKind as Rn, Account as Rr, InvitePage as Rt, Language as S, SyncSchedule as Sn, TextEvent as Sr, Notification as St, Languages as T, SyncTriggerType as Tn, TextLocation as Tr, NotificationSettings as Tt, Label as U, BoundingBox as Un, ListInvites as Ut, HipaaDeidMethod as V, AudioProvenance as Vn, UpdateAccount as Vr, InviteSortField as Vt, LabelEntry as W, Dimensions as Wn, ReplyInvite as Wt, ModalityRedactions as X, ImageEntityRecord as Xn, FileKind as Xt, LocalizedText as Y, ImageEntity as Yn, File as Yt, PciDssPart as Z, ImageEvent as Zn, FilePage as Zt, WebhookPage as _, S3Credentials as _n, TabularLocation as _r, PipelineSummary as _t, RetentionSettings as a, AzureCredentials as an, OperatorId as ar, Predicate as at, Confidence as b, SyncDeletionPolicy as bn, TextEntity as br, UpdatePipeline as bt, WorkspacePage as c, ConnectionPage as cn, Polygon as cr, TerminalFallback as ct, CreateWebhook as d, ConnectionVerification as dn, RuleMatch as dr, Waveform as dt, ModalityToken as en, ImageLocation as er, PolicyDefinition as et, TestWebhook as f, ConnectionsQuery as fn, TabularEntity as fr, CreatePipeline as ft, WebhookEvent as g, OpenAiCredentials as gn, TabularHint as gr, PipelineStatus as gt, WebhookCreated as h, LlmConfig as hn, TabularEventKind as hr, PipelineFilter as ht, RetentionOverride as i, AnthropicCredentials as in, OcrMode as ir, PolicyTemplate as it, PipelineRunPage as j, Login as jn, ApiTokenWithJWT as jr, MemberSortField as jt, CreatePipelineRun as k, RegisteredRecognizer as kn, ApiTokenPage as kr, Member as kt, WorkspaceRole as l, ConnectionSync as ln, RangeOfUint as lr, TextRedaction as lt, Webhook as m, GcsCredentials as mn, TabularEvent as mr, PipelineDefinition as mt, OcrPolicy as n, ErrorResponse as nn, LeakProfile as nr, PolicySummary as nt, UpdateWorkspace as o, Connection as on, PatternEvent as or, Sha2Algorithm as ot, UpdateWebhook as p, CreateConnection as pn, TabularEntityRecord as pr, Pipeline as pt, Labels as q, EntityGroup as qn, Health as qt, Retention as r, ValidationErrorDetail as rn, ModelEvent as rr, PolicySummaryPage as rt, Workspace as s, ConnectionConfig as sn, Point as sr, TabularRedaction as st, CreateWorkspace as t, UpdateFile as tn, ImageProvenance as tr, PolicyRule as tt, WorkspaceSettings as u, ConnectionSyncPage as un, Review as ur, UpdatePolicy as ut, WebhookResult as v, StorageConfig as vn, TabularProvenance as vr, PipelineSummaryPage as vt, LanguageSpan as w, SyncStatus as wn, TextHint as wr, NotificationPage as wt, CountryCode as x, SyncMode as xn, TextEntityRecord as xr, CursorPagination as xt, WebhookStatus as y, SyncConnection as yn, TextData as yr, PipelineTriggerType as yt, DateStyle as z, AudioHint as zn, AccountRef as zr, InvitePreview as zt };
|
|
12738
|
+
//# sourceMappingURL=index-C22LjJS2.d.ts.map
|