bem-ai-sdk 0.27.0 → 0.29.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 +27 -0
- package/client.d.mts +10 -10
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -10
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/buckets.d.mts +9 -113
- package/resources/buckets.d.mts.map +1 -1
- package/resources/buckets.d.ts +9 -113
- package/resources/buckets.d.ts.map +1 -1
- package/resources/buckets.js +3 -3
- package/resources/buckets.js.map +1 -1
- package/resources/buckets.mjs +3 -3
- package/resources/buckets.mjs.map +1 -1
- package/resources/entities/entities.d.mts +52 -93
- package/resources/entities/entities.d.mts.map +1 -1
- package/resources/entities/entities.d.ts +52 -93
- package/resources/entities/entities.d.ts.map +1 -1
- package/resources/entities/entities.js.map +1 -1
- package/resources/entities/entities.mjs.map +1 -1
- package/resources/entities/index.d.mts +1 -1
- package/resources/entities/index.d.mts.map +1 -1
- package/resources/entities/index.d.ts +1 -1
- package/resources/entities/index.d.ts.map +1 -1
- package/resources/entities/index.js.map +1 -1
- package/resources/entities/index.mjs.map +1 -1
- package/resources/entity-types/entity-types.d.mts +8 -124
- package/resources/entity-types/entity-types.d.mts.map +1 -1
- package/resources/entity-types/entity-types.d.ts +8 -124
- package/resources/entity-types/entity-types.d.ts.map +1 -1
- package/resources/entity-types/entity-types.js.map +1 -1
- package/resources/entity-types/entity-types.mjs.map +1 -1
- package/resources/entity-types/index.d.mts +2 -2
- package/resources/entity-types/index.d.mts.map +1 -1
- package/resources/entity-types/index.d.ts +2 -2
- package/resources/entity-types/index.d.ts.map +1 -1
- package/resources/entity-types/index.js.map +1 -1
- package/resources/entity-types/index.mjs.map +1 -1
- package/resources/entity-types/reviewers.d.mts +10 -39
- package/resources/entity-types/reviewers.d.mts.map +1 -1
- package/resources/entity-types/reviewers.d.ts +10 -39
- package/resources/entity-types/reviewers.d.ts.map +1 -1
- package/resources/entity-types/reviewers.js +1 -1
- package/resources/entity-types/reviewers.js.map +1 -1
- package/resources/entity-types/reviewers.mjs +1 -1
- package/resources/entity-types/reviewers.mjs.map +1 -1
- package/resources/errors.d.mts +9 -0
- package/resources/errors.d.mts.map +1 -1
- package/resources/errors.d.ts +9 -0
- package/resources/errors.d.ts.map +1 -1
- package/resources/eval/eval.d.mts +2 -2
- package/resources/eval/eval.d.mts.map +1 -1
- package/resources/eval/eval.d.ts +2 -2
- package/resources/eval/eval.d.ts.map +1 -1
- package/resources/eval/eval.js.map +1 -1
- package/resources/eval/eval.mjs.map +1 -1
- package/resources/eval/index.d.mts +1 -1
- package/resources/eval/index.d.mts.map +1 -1
- package/resources/eval/index.d.ts +1 -1
- package/resources/eval/index.d.ts.map +1 -1
- package/resources/eval/index.js.map +1 -1
- package/resources/eval/index.mjs.map +1 -1
- package/resources/eval/score.d.mts +60 -219
- package/resources/eval/score.d.mts.map +1 -1
- package/resources/eval/score.d.ts +60 -219
- package/resources/eval/score.d.ts.map +1 -1
- package/resources/eval/score.js +2 -2
- package/resources/eval/score.js.map +1 -1
- package/resources/eval/score.mjs +2 -2
- package/resources/eval/score.mjs.map +1 -1
- package/resources/functions/functions.d.mts +495 -896
- package/resources/functions/functions.d.mts.map +1 -1
- package/resources/functions/functions.d.ts +495 -896
- package/resources/functions/functions.d.ts.map +1 -1
- package/resources/functions/functions.js +2 -2
- package/resources/functions/functions.js.map +1 -1
- package/resources/functions/functions.mjs +2 -2
- package/resources/functions/functions.mjs.map +1 -1
- package/resources/functions/index.d.mts +1 -1
- package/resources/functions/index.d.mts.map +1 -1
- package/resources/functions/index.d.ts +1 -1
- package/resources/functions/index.d.ts.map +1 -1
- package/resources/functions/index.js.map +1 -1
- package/resources/functions/index.mjs.map +1 -1
- package/resources/functions/versions.d.mts +44 -18
- package/resources/functions/versions.d.mts.map +1 -1
- package/resources/functions/versions.d.ts +44 -18
- package/resources/functions/versions.d.ts.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/knowledge-graph.d.mts +18 -0
- package/resources/knowledge-graph.d.mts.map +1 -1
- package/resources/knowledge-graph.d.ts +18 -0
- package/resources/knowledge-graph.d.ts.map +1 -1
- package/resources/outputs.d.mts +80 -2
- package/resources/outputs.d.mts.map +1 -1
- package/resources/outputs.d.ts +80 -2
- package/resources/outputs.d.ts.map +1 -1
- package/resources/views.d.mts +97 -745
- package/resources/views.d.mts.map +1 -1
- package/resources/views.d.ts +97 -745
- package/resources/views.d.ts.map +1 -1
- package/resources/workflows/workflows.d.mts +10 -19
- package/resources/workflows/workflows.d.mts.map +1 -1
- package/resources/workflows/workflows.d.ts +10 -19
- package/resources/workflows/workflows.d.ts.map +1 -1
- package/resources/workflows/workflows.js.map +1 -1
- package/resources/workflows/workflows.mjs.map +1 -1
- package/src/client.ts +38 -18
- package/src/resources/buckets.ts +9 -137
- package/src/resources/entities/entities.ts +61 -106
- package/src/resources/entities/index.ts +2 -0
- package/src/resources/entity-types/entity-types.ts +8 -151
- package/src/resources/entity-types/index.ts +2 -4
- package/src/resources/entity-types/reviewers.ts +11 -49
- package/src/resources/errors.ts +10 -0
- package/src/resources/eval/eval.ts +8 -4
- package/src/resources/eval/index.ts +4 -2
- package/src/resources/eval/score.ts +66 -263
- package/src/resources/functions/functions.ts +536 -987
- package/src/resources/functions/index.ts +8 -0
- package/src/resources/functions/versions.ts +54 -18
- package/src/resources/index.ts +19 -9
- package/src/resources/knowledge-graph.ts +21 -0
- package/src/resources/outputs.ts +102 -1
- package/src/resources/views.ts +118 -936
- package/src/resources/workflows/workflows.ts +11 -21
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -16,8 +16,8 @@ export declare class Functions extends APIResource {
|
|
|
16
16
|
/**
|
|
17
17
|
* **Create a function.**
|
|
18
18
|
*
|
|
19
|
-
* The function type
|
|
20
|
-
* `
|
|
19
|
+
* The function `type` determines which configuration fields are required — see the
|
|
20
|
+
* `CreateFunctionV3` discriminated union and
|
|
21
21
|
* [Function types overview](/guide/function-types/overview) for the per-type
|
|
22
22
|
* contract.
|
|
23
23
|
*
|
|
@@ -261,7 +261,7 @@ export declare namespace ClassificationListItem {
|
|
|
261
261
|
/**
|
|
262
262
|
* V3 wire form of the classify function create payload.
|
|
263
263
|
*/
|
|
264
|
-
export type CreateFunction = CreateFunction.ExtractFunction | CreateFunction.ClassifyFunction | CreateFunction.SendFunction | CreateFunction.SplitFunction | CreateFunction.JoinFunction | CreateFunction.PayloadShapingFunction | CreateFunction.EnrichFunction | CreateFunction.ParseFunction;
|
|
264
|
+
export type CreateFunction = CreateFunction.ExtractFunction | CreateFunction.ClassifyFunction | CreateFunction.SendFunction | CreateFunction.SplitFunction | CreateFunction.JoinFunction | CreateFunction.PayloadShapingFunction | CreateFunction.EnrichFunction | CreateFunction.ParseFunction | CreateFunction.RenderFunction;
|
|
265
265
|
export declare namespace CreateFunction {
|
|
266
266
|
interface ExtractFunction {
|
|
267
267
|
/**
|
|
@@ -520,7 +520,7 @@ export declare namespace CreateFunction {
|
|
|
520
520
|
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
521
521
|
* stays distinct from operator-level execution flags.
|
|
522
522
|
*/
|
|
523
|
-
extraConfig?:
|
|
523
|
+
extraConfig?: FunctionsAPI.ParseExtraFunctionConfig;
|
|
524
524
|
/**
|
|
525
525
|
* Per-version configuration for a Parse function.
|
|
526
526
|
*
|
|
@@ -534,24 +534,28 @@ export declare namespace CreateFunction {
|
|
|
534
534
|
*/
|
|
535
535
|
tags?: Array<string>;
|
|
536
536
|
}
|
|
537
|
-
|
|
537
|
+
interface RenderFunction {
|
|
538
538
|
/**
|
|
539
|
-
*
|
|
540
|
-
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
541
|
-
* stays distinct from operator-level execution flags.
|
|
539
|
+
* Name of function. Must be UNIQUE on a per-environment basis.
|
|
542
540
|
*/
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
541
|
+
functionName: string;
|
|
542
|
+
/**
|
|
543
|
+
* Request-side render configuration. Carries the template document as
|
|
544
|
+
* base64-encoded `.docx` bytes: the server validates them, stores the template,
|
|
545
|
+
* and derives the placeholder/style-id contract at create/update time, so clients
|
|
546
|
+
* never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
|
|
547
|
+
* returns the derived contract.
|
|
548
|
+
*/
|
|
549
|
+
renderConfig: FunctionsAPI.RenderConfigInput;
|
|
550
|
+
type: 'render';
|
|
551
|
+
/**
|
|
552
|
+
* Display name of function. Human-readable name to help you identify the function.
|
|
553
|
+
*/
|
|
554
|
+
displayName?: string;
|
|
555
|
+
/**
|
|
556
|
+
* Array of tags to categorize and organize functions.
|
|
557
|
+
*/
|
|
558
|
+
tags?: Array<string>;
|
|
555
559
|
}
|
|
556
560
|
}
|
|
557
561
|
/**
|
|
@@ -645,9 +649,9 @@ export declare namespace EnrichConfig {
|
|
|
645
649
|
* Natural-language instructions for LLM agent reasoning.
|
|
646
650
|
*
|
|
647
651
|
* When set, the candidates fetched from the endpoint are passed to an LLM with
|
|
648
|
-
* these instructions, which selects the best match(es) and returns them
|
|
649
|
-
*
|
|
650
|
-
* `{ data, confidence, reasoning? }
|
|
652
|
+
* these instructions, which selects the best match(es) and returns them ranked
|
|
653
|
+
* best-first. Each injected result has the shape
|
|
654
|
+
* `{ data, rank, confidence, reasoning? }` (rank is 1-based, 1 = best).
|
|
651
655
|
*
|
|
652
656
|
* When omitted, the raw fetched value is injected without any LLM involvement.
|
|
653
657
|
*/
|
|
@@ -760,10 +764,30 @@ export declare namespace EnrichConfig {
|
|
|
760
764
|
* - `exact`: Exact keyword matching — best for SKU numbers, IDs, routing numbers
|
|
761
765
|
* - `hybrid`: Combined semantic + keyword search — best for tags and categories
|
|
762
766
|
*
|
|
763
|
-
* **Result Format (collection source):**
|
|
767
|
+
* **Result Format (collection source, exact mode — no re-ranking):**
|
|
764
768
|
*
|
|
765
769
|
* - Always an array sorted by relevance (best match first)
|
|
766
|
-
* - Each element: `{ data,
|
|
770
|
+
* - Each element: `{ data, cosine_distance? }` or `{ data, hybrid_score? }`
|
|
771
|
+
*
|
|
772
|
+
* **Result Format (collection source, semantic/hybrid — re-ranking always on):**
|
|
773
|
+
*
|
|
774
|
+
* - Re-ranking uses a fixed, built-in instruction to the LLM (rank the candidates
|
|
775
|
+
* by how well each matches the source value); it is not configurable per step
|
|
776
|
+
* - Array of matches, best first:
|
|
777
|
+
* `[{ data, rank, confidence?, reasoning?, score?, scoreType?, cosine_distance?, hybrid_score? }, ...]`
|
|
778
|
+
* - `rank` is 1-based (1 = best)
|
|
779
|
+
* - `confidence` is the LLM's 0–1 score. It is present only for entries the LLM
|
|
780
|
+
* ranked and **omitted** for backfilled entries (see below) — a missing
|
|
781
|
+
* `confidence` means "not ranked by the LLM", not a score of 0
|
|
782
|
+
* - `score` is the original retrieval score and `scoreType` says which metric it
|
|
783
|
+
* is (`"cosineDistance"` for semantic search, `"hybridScore"` for hybrid); both
|
|
784
|
+
* included only when `includeScore` is set
|
|
785
|
+
* - `cosine_distance` (semantic) and `hybrid_score` (hybrid) are **deprecated**
|
|
786
|
+
* (use `score` + `scoreType`): each mirrors `score` under the pre-rerank field
|
|
787
|
+
* name for backward compatibility; exactly one is present, matching `scoreType`
|
|
788
|
+
* - Length is `min(candidates surviving the scoreThreshold filter, topK)`. The LLM
|
|
789
|
+
* re-orders the survivors; if it ranks fewer than that length, the remaining
|
|
790
|
+
* survivors are backfilled in retrieval (score) order with `confidence` omitted
|
|
767
791
|
*
|
|
768
792
|
* **Result Format (endpoint source, no matchInstructions):**
|
|
769
793
|
*
|
|
@@ -771,7 +795,9 @@ export declare namespace EnrichConfig {
|
|
|
771
795
|
*
|
|
772
796
|
* **Result Format (endpoint source, with matchInstructions):**
|
|
773
797
|
*
|
|
774
|
-
* - Array of LLM-ranked matches
|
|
798
|
+
* - Array of LLM-ranked matches, best first:
|
|
799
|
+
* `[{ data, rank, confidence, reasoning? }, ...]`
|
|
800
|
+
* - `rank` is 1-based (1 = best); `confidence` is the LLM's 0–1 score
|
|
775
801
|
* - Length capped by `enrichEndpoint.matchTopK` (default 1)
|
|
776
802
|
*/
|
|
777
803
|
export interface EnrichStep {
|
|
@@ -867,6 +893,11 @@ export interface EnrichStep {
|
|
|
867
893
|
*
|
|
868
894
|
* - 1: Returns array with single best match: `[{...}]`
|
|
869
895
|
* - > 1: Returns array with multiple matches: `[{...}, {...}, ...]`
|
|
896
|
+
*
|
|
897
|
+
* When re-ranking is on (the default for `semantic`/`hybrid`), `topK` is still the
|
|
898
|
+
* number of results returned — re-ranking changes their order, not the count. The
|
|
899
|
+
* candidate pool the LLM chooses from is widened internally to at least 5, so even
|
|
900
|
+
* `topK: 1` re-ranks a real pool and returns the single best match.
|
|
870
901
|
*/
|
|
871
902
|
topK?: number;
|
|
872
903
|
}
|
|
@@ -875,7 +906,7 @@ export interface EnrichStep {
|
|
|
875
906
|
* `classify` in place of `route`. Legacy `transform` and `analyze` functions
|
|
876
907
|
* remain readable via V3.
|
|
877
908
|
*/
|
|
878
|
-
export type Function = Function.TransformFunction | Function.ExtractFunction | Function.AnalyzeFunction | Function.ClassifyFunction | Function.SendFunction | Function.SplitFunction | Function.JoinFunction | Function.PayloadShapingFunction | Function.EnrichFunction | Function.ParseFunction;
|
|
909
|
+
export type Function = Function.TransformFunction | Function.ExtractFunction | Function.AnalyzeFunction | Function.ClassifyFunction | Function.SendFunction | Function.SplitFunction | Function.JoinFunction | Function.PayloadShapingFunction | Function.EnrichFunction | Function.ParseFunction | Function.RenderFunction;
|
|
879
910
|
export declare namespace Function {
|
|
880
911
|
interface TransformFunction {
|
|
881
912
|
/**
|
|
@@ -1381,7 +1412,7 @@ export declare namespace Function {
|
|
|
1381
1412
|
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
1382
1413
|
* stays distinct from operator-level execution flags.
|
|
1383
1414
|
*/
|
|
1384
|
-
extraConfig?:
|
|
1415
|
+
extraConfig?: FunctionsAPI.ParseExtraFunctionConfig;
|
|
1385
1416
|
/**
|
|
1386
1417
|
* Per-version configuration for a Parse function.
|
|
1387
1418
|
*
|
|
@@ -1399,24 +1430,46 @@ export declare namespace Function {
|
|
|
1399
1430
|
*/
|
|
1400
1431
|
usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
|
|
1401
1432
|
}
|
|
1402
|
-
|
|
1433
|
+
interface RenderFunction {
|
|
1403
1434
|
/**
|
|
1404
|
-
*
|
|
1405
|
-
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
1406
|
-
* stays distinct from operator-level execution flags.
|
|
1435
|
+
* Unique identifier of function.
|
|
1407
1436
|
*/
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1437
|
+
functionID: string;
|
|
1438
|
+
/**
|
|
1439
|
+
* Name of function. Must be UNIQUE on a per-environment basis.
|
|
1440
|
+
*/
|
|
1441
|
+
functionName: string;
|
|
1442
|
+
type: 'render';
|
|
1443
|
+
/**
|
|
1444
|
+
* Version number of function.
|
|
1445
|
+
*/
|
|
1446
|
+
versionNum: number;
|
|
1447
|
+
/**
|
|
1448
|
+
* Audit trail information for the function.
|
|
1449
|
+
*/
|
|
1450
|
+
audit?: FunctionsAPI.FunctionAudit;
|
|
1451
|
+
/**
|
|
1452
|
+
* Display name of function. Human-readable name to help you identify the function.
|
|
1453
|
+
*/
|
|
1454
|
+
displayName?: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* Per-version configuration for a Render function.
|
|
1457
|
+
*
|
|
1458
|
+
* Render emits a `.docx` from schema-typed JSON by composing the JSON into a
|
|
1459
|
+
* `.docx` template. The template document is stored server-side; this response
|
|
1460
|
+
* exposes only the contract derived from it. Schema validation runs internally in
|
|
1461
|
+
* the ML service against the bundled core schema; no customer-supplied schema
|
|
1462
|
+
* rides this surface.
|
|
1463
|
+
*/
|
|
1464
|
+
renderConfig?: FunctionsAPI.RenderConfig;
|
|
1465
|
+
/**
|
|
1466
|
+
* Array of tags to categorize and organize functions.
|
|
1467
|
+
*/
|
|
1468
|
+
tags?: Array<string>;
|
|
1469
|
+
/**
|
|
1470
|
+
* List of workflows that use this function.
|
|
1471
|
+
*/
|
|
1472
|
+
usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
|
|
1420
1473
|
}
|
|
1421
1474
|
}
|
|
1422
1475
|
export interface FunctionAudit {
|
|
@@ -1449,7 +1502,7 @@ export interface FunctionResponse {
|
|
|
1449
1502
|
/**
|
|
1450
1503
|
* The type of the function.
|
|
1451
1504
|
*/
|
|
1452
|
-
export type FunctionType = 'transform' | 'extract' | 'route' | 'classify' | 'send' | 'split' | 'join' | 'analyze' | 'payload_shaping' | 'enrich' | 'parse';
|
|
1505
|
+
export type FunctionType = 'transform' | 'extract' | 'route' | 'classify' | 'send' | 'split' | 'join' | 'analyze' | 'payload_shaping' | 'enrich' | 'parse' | 'render';
|
|
1453
1506
|
export interface ListFunctionsResponse {
|
|
1454
1507
|
functions?: Array<Function>;
|
|
1455
1508
|
/**
|
|
@@ -1457,6 +1510,122 @@ export interface ListFunctionsResponse {
|
|
|
1457
1510
|
*/
|
|
1458
1511
|
totalCount?: number;
|
|
1459
1512
|
}
|
|
1513
|
+
/**
|
|
1514
|
+
* Comparison of a single metric between two versions
|
|
1515
|
+
*/
|
|
1516
|
+
export interface MetricComparison {
|
|
1517
|
+
/**
|
|
1518
|
+
* Value in baseline version (null if not available)
|
|
1519
|
+
*/
|
|
1520
|
+
baselineValue?: number | null;
|
|
1521
|
+
/**
|
|
1522
|
+
* Value in comparison version (null if not available)
|
|
1523
|
+
*/
|
|
1524
|
+
comparisonValue?: number | null;
|
|
1525
|
+
/**
|
|
1526
|
+
* Absolute difference (comparisonValue - baselineValue)
|
|
1527
|
+
*/
|
|
1528
|
+
difference?: number | null;
|
|
1529
|
+
/**
|
|
1530
|
+
* **Percentage change from baseline to comparison**
|
|
1531
|
+
*
|
|
1532
|
+
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
1533
|
+
*
|
|
1534
|
+
* - Positive values indicate improvement
|
|
1535
|
+
* - Negative values indicate regression
|
|
1536
|
+
*/
|
|
1537
|
+
liftPercent?: number | null;
|
|
1538
|
+
}
|
|
1539
|
+
/**
|
|
1540
|
+
* Comprehensive performance metrics
|
|
1541
|
+
*/
|
|
1542
|
+
export interface Metrics {
|
|
1543
|
+
/**
|
|
1544
|
+
* Overall accuracy
|
|
1545
|
+
*/
|
|
1546
|
+
accuracy?: number | null;
|
|
1547
|
+
/**
|
|
1548
|
+
* F1 Score (harmonic mean of precision and recall)
|
|
1549
|
+
*/
|
|
1550
|
+
f1Score?: number | null;
|
|
1551
|
+
/**
|
|
1552
|
+
* False Negatives
|
|
1553
|
+
*/
|
|
1554
|
+
fn?: number;
|
|
1555
|
+
/**
|
|
1556
|
+
* False Positives
|
|
1557
|
+
*/
|
|
1558
|
+
fp?: number;
|
|
1559
|
+
/**
|
|
1560
|
+
* Precision (TP / (TP + FP))
|
|
1561
|
+
*/
|
|
1562
|
+
precision?: number | null;
|
|
1563
|
+
/**
|
|
1564
|
+
* Recall (TP / (TP + FN))
|
|
1565
|
+
*/
|
|
1566
|
+
recall?: number | null;
|
|
1567
|
+
/**
|
|
1568
|
+
* True Negatives
|
|
1569
|
+
*/
|
|
1570
|
+
tn?: number;
|
|
1571
|
+
/**
|
|
1572
|
+
* True Positives
|
|
1573
|
+
*/
|
|
1574
|
+
tp?: number;
|
|
1575
|
+
}
|
|
1576
|
+
/**
|
|
1577
|
+
* Comparison of metrics between two versions
|
|
1578
|
+
*/
|
|
1579
|
+
export interface MetricsComparison {
|
|
1580
|
+
/**
|
|
1581
|
+
* Comparison of a single metric between two versions
|
|
1582
|
+
*/
|
|
1583
|
+
accuracy?: MetricComparison;
|
|
1584
|
+
/**
|
|
1585
|
+
* Comparison of a single metric between two versions
|
|
1586
|
+
*/
|
|
1587
|
+
f1Score?: MetricComparison;
|
|
1588
|
+
/**
|
|
1589
|
+
* Comparison of a single metric between two versions
|
|
1590
|
+
*/
|
|
1591
|
+
precision?: MetricComparison;
|
|
1592
|
+
/**
|
|
1593
|
+
* Comparison of a single metric between two versions
|
|
1594
|
+
*/
|
|
1595
|
+
recall?: MetricComparison;
|
|
1596
|
+
}
|
|
1597
|
+
/**
|
|
1598
|
+
* Detailed performance metrics and analysis
|
|
1599
|
+
*/
|
|
1600
|
+
export interface MetricsDetails {
|
|
1601
|
+
/**
|
|
1602
|
+
* Comprehensive performance metrics
|
|
1603
|
+
*/
|
|
1604
|
+
aggregateMetrics?: Metrics;
|
|
1605
|
+
/**
|
|
1606
|
+
* Enhanced field metrics with comprehensive analytics
|
|
1607
|
+
*/
|
|
1608
|
+
fieldMetrics?: Array<MetricsDetails.FieldMetric>;
|
|
1609
|
+
/**
|
|
1610
|
+
* Area Under the Precision-Recall Curve
|
|
1611
|
+
*/
|
|
1612
|
+
precisionRecallAuc?: number;
|
|
1613
|
+
}
|
|
1614
|
+
export declare namespace MetricsDetails {
|
|
1615
|
+
/**
|
|
1616
|
+
* Enhanced field metrics with comprehensive analytics
|
|
1617
|
+
*/
|
|
1618
|
+
interface FieldMetric {
|
|
1619
|
+
/**
|
|
1620
|
+
* JSON path to the field
|
|
1621
|
+
*/
|
|
1622
|
+
fieldPath: string;
|
|
1623
|
+
/**
|
|
1624
|
+
* Comprehensive performance metrics
|
|
1625
|
+
*/
|
|
1626
|
+
metrics?: FunctionsAPI.Metrics;
|
|
1627
|
+
}
|
|
1628
|
+
}
|
|
1460
1629
|
/**
|
|
1461
1630
|
* Per-version configuration for a Parse function.
|
|
1462
1631
|
*
|
|
@@ -1465,6 +1634,12 @@ export interface ListFunctionsResponse {
|
|
|
1465
1634
|
* output concern) and cross-document memory linking (an environment-wide concern).
|
|
1466
1635
|
*/
|
|
1467
1636
|
export interface ParseConfig {
|
|
1637
|
+
/**
|
|
1638
|
+
* Optional bucket NAME that parse-extracted entities land in when no call-level
|
|
1639
|
+
* bucket is supplied. Lower precedence than a call-level bucket, higher than the
|
|
1640
|
+
* account+environment default.
|
|
1641
|
+
*/
|
|
1642
|
+
defaultBucket?: string;
|
|
1468
1643
|
/**
|
|
1469
1644
|
* When true, extract named entities (people, organizations, products, studies,
|
|
1470
1645
|
* identifiers, etc.) and the relationships between them, and dedupe by canonical
|
|
@@ -1488,6 +1663,163 @@ export interface ParseConfig {
|
|
|
1488
1663
|
*/
|
|
1489
1664
|
schema?: unknown;
|
|
1490
1665
|
}
|
|
1666
|
+
/**
|
|
1667
|
+
* Cross-cutting toggles for Parse functions. Mirrors the `extraConfig` surface on
|
|
1668
|
+
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
1669
|
+
* stays distinct from operator-level execution flags.
|
|
1670
|
+
*/
|
|
1671
|
+
export interface ParseExtraFunctionConfig {
|
|
1672
|
+
/**
|
|
1673
|
+
* When true, return per-section and per-entity-mention coordinates in the parse
|
|
1674
|
+
* event's `fieldBoundingBoxes` map (same shape as Extract: JSON Pointer key →
|
|
1675
|
+
* array of `{page, left, top, width, height}` with coordinates normalized to [0,
|
|
1676
|
+
* 1]). Keys are `/sections/{N}` and `/entities/{N}/occurrences/{M}` into the parse
|
|
1677
|
+
* output. Only applies to the open-ended discovery path (no `schema`) and to
|
|
1678
|
+
* vision input types. Bedrock-backed parse functions silently return an empty map
|
|
1679
|
+
* (no native bbox support). Defaults to false.
|
|
1680
|
+
*/
|
|
1681
|
+
enableBoundingBoxes?: boolean;
|
|
1682
|
+
}
|
|
1683
|
+
/**
|
|
1684
|
+
* Confidence interval for a rate/proportion using Wald (normal approximation)
|
|
1685
|
+
* method by default.
|
|
1686
|
+
*
|
|
1687
|
+
* Wald confidence intervals use the normal approximation to the binomial
|
|
1688
|
+
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
1689
|
+
* intervals may be more appropriate.
|
|
1690
|
+
*/
|
|
1691
|
+
export interface RateConfidenceInterval {
|
|
1692
|
+
/**
|
|
1693
|
+
* Current number of samples/observations available
|
|
1694
|
+
*/
|
|
1695
|
+
currentSample: number;
|
|
1696
|
+
/**
|
|
1697
|
+
* Minimum number of samples needed for reliable confidence interval calculation
|
|
1698
|
+
*/
|
|
1699
|
+
sampleNeeded: number;
|
|
1700
|
+
/**
|
|
1701
|
+
* Lower bound of the confidence interval (null if insufficient sample size)
|
|
1702
|
+
*/
|
|
1703
|
+
ciLower?: number | null;
|
|
1704
|
+
/**
|
|
1705
|
+
* Upper bound of the confidence interval (null if insufficient sample size)
|
|
1706
|
+
*/
|
|
1707
|
+
ciUpper?: number | null;
|
|
1708
|
+
/**
|
|
1709
|
+
* Point estimate (observed rate) at the center of the interval (null if
|
|
1710
|
+
* insufficient sample size)
|
|
1711
|
+
*/
|
|
1712
|
+
mid?: number | null;
|
|
1713
|
+
}
|
|
1714
|
+
/**
|
|
1715
|
+
* Per-version configuration for a Render function.
|
|
1716
|
+
*
|
|
1717
|
+
* Render emits a `.docx` from schema-typed JSON by composing the JSON into a
|
|
1718
|
+
* `.docx` template. The template document is stored server-side; this response
|
|
1719
|
+
* exposes only the contract derived from it. Schema validation runs internally in
|
|
1720
|
+
* the ML service against the bundled core schema; no customer-supplied schema
|
|
1721
|
+
* rides this surface.
|
|
1722
|
+
*/
|
|
1723
|
+
export interface RenderConfig {
|
|
1724
|
+
/**
|
|
1725
|
+
* The uploaded template: its filename, a short-lived presigned download URL, and
|
|
1726
|
+
* the placeholder/style contract derived from it. Absent on configs created before
|
|
1727
|
+
* template capture existed.
|
|
1728
|
+
*/
|
|
1729
|
+
template?: RenderConfig.Template;
|
|
1730
|
+
}
|
|
1731
|
+
export declare namespace RenderConfig {
|
|
1732
|
+
/**
|
|
1733
|
+
* The uploaded template: its filename, a short-lived presigned download URL, and
|
|
1734
|
+
* the placeholder/style contract derived from it. Absent on configs created before
|
|
1735
|
+
* template capture existed.
|
|
1736
|
+
*/
|
|
1737
|
+
interface Template {
|
|
1738
|
+
/**
|
|
1739
|
+
* Short-lived presigned URL to download the stored `.docx`. The private storage
|
|
1740
|
+
* location is never exposed.
|
|
1741
|
+
*/
|
|
1742
|
+
downloadURL?: string;
|
|
1743
|
+
/**
|
|
1744
|
+
* Supported list kinds (`decimal`, `bullet`) the template's `numbering.xml`
|
|
1745
|
+
* defines an `abstractNum` for. Empty means the template can hold no list, so any
|
|
1746
|
+
* list primitive will fail at render.
|
|
1747
|
+
*/
|
|
1748
|
+
listKinds?: Array<'decimal' | 'bullet'>;
|
|
1749
|
+
/**
|
|
1750
|
+
* Original filename of the uploaded template (e.g. `contract.docx`), echoed back
|
|
1751
|
+
* for display. Absent on templates uploaded before the filename was captured.
|
|
1752
|
+
*/
|
|
1753
|
+
name?: string;
|
|
1754
|
+
/**
|
|
1755
|
+
* The placeholder contract a Render template declares, grouped by how each
|
|
1756
|
+
* placeholder is filled. Derived from the template at create/update time by
|
|
1757
|
+
* scanning its `docxtpl` tags; not user-supplied.
|
|
1758
|
+
*
|
|
1759
|
+
* - `stringKeys`: bare string placeholders (`{{ key }}`) filled with a single
|
|
1760
|
+
* value.
|
|
1761
|
+
* - `blockKeys`: wrapped-primitive placeholders (`{{p key }}`) — bind one core
|
|
1762
|
+
* primitive (paragraph, table, image, or list). The placeholder's own paragraph
|
|
1763
|
+
* dissolves and is replaced by the rendered subdocument's blocks, rather than
|
|
1764
|
+
* substituting text inline.
|
|
1765
|
+
*/
|
|
1766
|
+
placeholders?: Template.Placeholders;
|
|
1767
|
+
/**
|
|
1768
|
+
* Paragraph/character style IDs the uploaded template defines and the rendered
|
|
1769
|
+
* output can reference. Derived from the template's `styles.xml` at create/update
|
|
1770
|
+
* time.
|
|
1771
|
+
*/
|
|
1772
|
+
styleIds?: Array<string>;
|
|
1773
|
+
/**
|
|
1774
|
+
* Style IDs whose type is table — the styles a `table` primitive's required
|
|
1775
|
+
* `styleId` can name. Empty means the template defines no table style, so any
|
|
1776
|
+
* table primitive will fail at render.
|
|
1777
|
+
*/
|
|
1778
|
+
tableStyleIds?: Array<string>;
|
|
1779
|
+
}
|
|
1780
|
+
namespace Template {
|
|
1781
|
+
/**
|
|
1782
|
+
* The placeholder contract a Render template declares, grouped by how each
|
|
1783
|
+
* placeholder is filled. Derived from the template at create/update time by
|
|
1784
|
+
* scanning its `docxtpl` tags; not user-supplied.
|
|
1785
|
+
*
|
|
1786
|
+
* - `stringKeys`: bare string placeholders (`{{ key }}`) filled with a single
|
|
1787
|
+
* value.
|
|
1788
|
+
* - `blockKeys`: wrapped-primitive placeholders (`{{p key }}`) — bind one core
|
|
1789
|
+
* primitive (paragraph, table, image, or list). The placeholder's own paragraph
|
|
1790
|
+
* dissolves and is replaced by the rendered subdocument's blocks, rather than
|
|
1791
|
+
* substituting text inline.
|
|
1792
|
+
*/
|
|
1793
|
+
interface Placeholders {
|
|
1794
|
+
blockKeys: Array<string>;
|
|
1795
|
+
stringKeys: Array<string>;
|
|
1796
|
+
}
|
|
1797
|
+
}
|
|
1798
|
+
}
|
|
1799
|
+
/**
|
|
1800
|
+
* Request-side render configuration. Carries the template document as
|
|
1801
|
+
* base64-encoded `.docx` bytes: the server validates them, stores the template,
|
|
1802
|
+
* and derives the placeholder/style-id contract at create/update time, so clients
|
|
1803
|
+
* never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
|
|
1804
|
+
* returns the derived contract.
|
|
1805
|
+
*/
|
|
1806
|
+
export interface RenderConfigInput {
|
|
1807
|
+
template: RenderConfigInput.Template;
|
|
1808
|
+
}
|
|
1809
|
+
export declare namespace RenderConfigInput {
|
|
1810
|
+
interface Template {
|
|
1811
|
+
/**
|
|
1812
|
+
* Base64-encoded `.docx` bytes. In the Bem CLI, use `@path/to/file` to embed it
|
|
1813
|
+
* automatically.
|
|
1814
|
+
*/
|
|
1815
|
+
base64: string;
|
|
1816
|
+
/**
|
|
1817
|
+
* Original upload filename (e.g. `contract.docx`), stored for display only. Does
|
|
1818
|
+
* not affect where the template is stored.
|
|
1819
|
+
*/
|
|
1820
|
+
name?: string;
|
|
1821
|
+
}
|
|
1822
|
+
}
|
|
1491
1823
|
/**
|
|
1492
1824
|
* Destination type for a Send function.
|
|
1493
1825
|
*/
|
|
@@ -1520,7 +1852,7 @@ export interface SplitFunctionSemanticPageItemClass {
|
|
|
1520
1852
|
* unions (existing classify functions are returned from V2 GET endpoints
|
|
1521
1853
|
* verbatim).V3 wire form of the classify function upsert payload.
|
|
1522
1854
|
*/
|
|
1523
|
-
export type UpdateFunction = UpdateFunction.ExtractFunction | UpdateFunction.ClassifyFunction | UpdateFunction.SendFunction | UpdateFunction.SplitFunction | UpdateFunction.JoinFunction | UpdateFunction.PayloadShapingFunction | UpdateFunction.UpsertEnrichFunction | UpdateFunction.ParseFunction;
|
|
1855
|
+
export type UpdateFunction = UpdateFunction.ExtractFunction | UpdateFunction.ClassifyFunction | UpdateFunction.SendFunction | UpdateFunction.SplitFunction | UpdateFunction.JoinFunction | UpdateFunction.PayloadShapingFunction | UpdateFunction.UpsertEnrichFunction | UpdateFunction.ParseFunction | UpdateFunction.RenderFunction;
|
|
1524
1856
|
export declare namespace UpdateFunction {
|
|
1525
1857
|
interface ExtractFunction {
|
|
1526
1858
|
type: 'extract';
|
|
@@ -1782,7 +2114,7 @@ export declare namespace UpdateFunction {
|
|
|
1782
2114
|
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
1783
2115
|
* stays distinct from operator-level execution flags.
|
|
1784
2116
|
*/
|
|
1785
|
-
extraConfig?:
|
|
2117
|
+
extraConfig?: FunctionsAPI.ParseExtraFunctionConfig;
|
|
1786
2118
|
/**
|
|
1787
2119
|
* Name of function. Must be UNIQUE on a per-environment basis.
|
|
1788
2120
|
*/
|
|
@@ -1800,24 +2132,28 @@ export declare namespace UpdateFunction {
|
|
|
1800
2132
|
*/
|
|
1801
2133
|
tags?: Array<string>;
|
|
1802
2134
|
}
|
|
1803
|
-
|
|
2135
|
+
interface RenderFunction {
|
|
2136
|
+
type: 'render';
|
|
1804
2137
|
/**
|
|
1805
|
-
*
|
|
1806
|
-
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
1807
|
-
* stays distinct from operator-level execution flags.
|
|
2138
|
+
* Display name of function. Human-readable name to help you identify the function.
|
|
1808
2139
|
*/
|
|
1809
|
-
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
|
|
2140
|
+
displayName?: string;
|
|
2141
|
+
/**
|
|
2142
|
+
* Name of function. Must be UNIQUE on a per-environment basis.
|
|
2143
|
+
*/
|
|
2144
|
+
functionName?: string;
|
|
2145
|
+
/**
|
|
2146
|
+
* Request-side render configuration. Carries the template document as
|
|
2147
|
+
* base64-encoded `.docx` bytes: the server validates them, stores the template,
|
|
2148
|
+
* and derives the placeholder/style-id contract at create/update time, so clients
|
|
2149
|
+
* never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
|
|
2150
|
+
* returns the derived contract.
|
|
2151
|
+
*/
|
|
2152
|
+
renderConfig?: FunctionsAPI.RenderConfigInput;
|
|
2153
|
+
/**
|
|
2154
|
+
* Array of tags to categorize and organize functions.
|
|
2155
|
+
*/
|
|
2156
|
+
tags?: Array<string>;
|
|
1821
2157
|
}
|
|
1822
2158
|
}
|
|
1823
2159
|
export interface UserActionSummary {
|
|
@@ -1887,11 +2223,11 @@ export interface FunctionCompareMetricsResponse {
|
|
|
1887
2223
|
/**
|
|
1888
2224
|
* Comparison of metrics between two versions
|
|
1889
2225
|
*/
|
|
1890
|
-
aggregateComparison?:
|
|
2226
|
+
aggregateComparison?: MetricsComparison;
|
|
1891
2227
|
/**
|
|
1892
2228
|
* Detailed performance metrics and analysis
|
|
1893
2229
|
*/
|
|
1894
|
-
baselineMetrics?:
|
|
2230
|
+
baselineMetrics?: MetricsDetails;
|
|
1895
2231
|
/**
|
|
1896
2232
|
* Number of transformations used to calculate baseline metrics
|
|
1897
2233
|
*/
|
|
@@ -1899,7 +2235,7 @@ export interface FunctionCompareMetricsResponse {
|
|
|
1899
2235
|
/**
|
|
1900
2236
|
* Detailed performance metrics and analysis
|
|
1901
2237
|
*/
|
|
1902
|
-
comparisonMetrics?:
|
|
2238
|
+
comparisonMetrics?: MetricsDetails;
|
|
1903
2239
|
/**
|
|
1904
2240
|
* Number of transformations used to calculate comparison metrics
|
|
1905
2241
|
*/
|
|
@@ -1917,535 +2253,63 @@ export interface FunctionCompareMetricsResponse {
|
|
|
1917
2253
|
}
|
|
1918
2254
|
export declare namespace FunctionCompareMetricsResponse {
|
|
1919
2255
|
/**
|
|
1920
|
-
* Comparison of metrics
|
|
2256
|
+
* Comparison of field-level metrics
|
|
1921
2257
|
*/
|
|
1922
|
-
interface
|
|
2258
|
+
interface FieldMetricsChange {
|
|
1923
2259
|
/**
|
|
1924
|
-
* Comparison of
|
|
2260
|
+
* Comparison of metrics between two versions
|
|
1925
2261
|
*/
|
|
1926
|
-
|
|
2262
|
+
comparison: FunctionsAPI.MetricsComparison;
|
|
1927
2263
|
/**
|
|
1928
|
-
*
|
|
2264
|
+
* JSON pointer path to the field
|
|
1929
2265
|
*/
|
|
1930
|
-
|
|
2266
|
+
fieldPath: string;
|
|
2267
|
+
}
|
|
2268
|
+
}
|
|
2269
|
+
/**
|
|
2270
|
+
* Response containing review requirements estimate
|
|
2271
|
+
*/
|
|
2272
|
+
export interface FunctionEstimateReviewRequirementsResponse {
|
|
2273
|
+
/**
|
|
2274
|
+
* Detailed review requirements estimate
|
|
2275
|
+
*/
|
|
2276
|
+
estimate: FunctionEstimateReviewRequirementsResponse.Estimate;
|
|
2277
|
+
/**
|
|
2278
|
+
* Name of the analyzed function
|
|
2279
|
+
*/
|
|
2280
|
+
functionName: string;
|
|
2281
|
+
/**
|
|
2282
|
+
* Version number of the function that was analyzed
|
|
2283
|
+
*/
|
|
2284
|
+
functionVersionNum: number;
|
|
2285
|
+
/**
|
|
2286
|
+
* Detailed performance metrics and analysis
|
|
2287
|
+
*/
|
|
2288
|
+
metrics?: MetricsDetails;
|
|
2289
|
+
}
|
|
2290
|
+
export declare namespace FunctionEstimateReviewRequirementsResponse {
|
|
2291
|
+
/**
|
|
2292
|
+
* Detailed review requirements estimate
|
|
2293
|
+
*/
|
|
2294
|
+
interface Estimate {
|
|
1931
2295
|
/**
|
|
1932
|
-
*
|
|
2296
|
+
* Distribution of confidence levels
|
|
1933
2297
|
*/
|
|
1934
|
-
|
|
2298
|
+
confidenceDistribution: Estimate.ConfidenceDistribution;
|
|
1935
2299
|
/**
|
|
1936
|
-
*
|
|
2300
|
+
* Number of transformations already labeled
|
|
1937
2301
|
*/
|
|
1938
|
-
|
|
1939
|
-
}
|
|
1940
|
-
namespace AggregateComparison {
|
|
2302
|
+
labeledTransformations: number;
|
|
1941
2303
|
/**
|
|
1942
|
-
*
|
|
2304
|
+
* Number of transformations without evaluation data
|
|
1943
2305
|
*/
|
|
1944
|
-
|
|
1945
|
-
/**
|
|
1946
|
-
* Value in baseline version (null if not available)
|
|
1947
|
-
*/
|
|
1948
|
-
baselineValue?: number | null;
|
|
1949
|
-
/**
|
|
1950
|
-
* Value in comparison version (null if not available)
|
|
1951
|
-
*/
|
|
1952
|
-
comparisonValue?: number | null;
|
|
1953
|
-
/**
|
|
1954
|
-
* Absolute difference (comparisonValue - baselineValue)
|
|
1955
|
-
*/
|
|
1956
|
-
difference?: number | null;
|
|
1957
|
-
/**
|
|
1958
|
-
* **Percentage change from baseline to comparison**
|
|
1959
|
-
*
|
|
1960
|
-
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
1961
|
-
*
|
|
1962
|
-
* - Positive values indicate improvement
|
|
1963
|
-
* - Negative values indicate regression
|
|
1964
|
-
*/
|
|
1965
|
-
liftPercent?: number | null;
|
|
1966
|
-
}
|
|
2306
|
+
missingEvaluations: number;
|
|
1967
2307
|
/**
|
|
1968
|
-
*
|
|
2308
|
+
* Statistical analysis across confidence thresholds
|
|
1969
2309
|
*/
|
|
1970
|
-
|
|
1971
|
-
/**
|
|
1972
|
-
* Value in baseline version (null if not available)
|
|
1973
|
-
*/
|
|
1974
|
-
baselineValue?: number | null;
|
|
1975
|
-
/**
|
|
1976
|
-
* Value in comparison version (null if not available)
|
|
1977
|
-
*/
|
|
1978
|
-
comparisonValue?: number | null;
|
|
1979
|
-
/**
|
|
1980
|
-
* Absolute difference (comparisonValue - baselineValue)
|
|
1981
|
-
*/
|
|
1982
|
-
difference?: number | null;
|
|
1983
|
-
/**
|
|
1984
|
-
* **Percentage change from baseline to comparison**
|
|
1985
|
-
*
|
|
1986
|
-
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
1987
|
-
*
|
|
1988
|
-
* - Positive values indicate improvement
|
|
1989
|
-
* - Negative values indicate regression
|
|
1990
|
-
*/
|
|
1991
|
-
liftPercent?: number | null;
|
|
1992
|
-
}
|
|
2310
|
+
thresholdMatrix: Array<Estimate.ThresholdMatrix>;
|
|
1993
2311
|
/**
|
|
1994
|
-
*
|
|
1995
|
-
*/
|
|
1996
|
-
interface Precision {
|
|
1997
|
-
/**
|
|
1998
|
-
* Value in baseline version (null if not available)
|
|
1999
|
-
*/
|
|
2000
|
-
baselineValue?: number | null;
|
|
2001
|
-
/**
|
|
2002
|
-
* Value in comparison version (null if not available)
|
|
2003
|
-
*/
|
|
2004
|
-
comparisonValue?: number | null;
|
|
2005
|
-
/**
|
|
2006
|
-
* Absolute difference (comparisonValue - baselineValue)
|
|
2007
|
-
*/
|
|
2008
|
-
difference?: number | null;
|
|
2009
|
-
/**
|
|
2010
|
-
* **Percentage change from baseline to comparison**
|
|
2011
|
-
*
|
|
2012
|
-
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
2013
|
-
*
|
|
2014
|
-
* - Positive values indicate improvement
|
|
2015
|
-
* - Negative values indicate regression
|
|
2016
|
-
*/
|
|
2017
|
-
liftPercent?: number | null;
|
|
2018
|
-
}
|
|
2019
|
-
/**
|
|
2020
|
-
* Comparison of a single metric between two versions
|
|
2021
|
-
*/
|
|
2022
|
-
interface Recall {
|
|
2023
|
-
/**
|
|
2024
|
-
* Value in baseline version (null if not available)
|
|
2025
|
-
*/
|
|
2026
|
-
baselineValue?: number | null;
|
|
2027
|
-
/**
|
|
2028
|
-
* Value in comparison version (null if not available)
|
|
2029
|
-
*/
|
|
2030
|
-
comparisonValue?: number | null;
|
|
2031
|
-
/**
|
|
2032
|
-
* Absolute difference (comparisonValue - baselineValue)
|
|
2033
|
-
*/
|
|
2034
|
-
difference?: number | null;
|
|
2035
|
-
/**
|
|
2036
|
-
* **Percentage change from baseline to comparison**
|
|
2037
|
-
*
|
|
2038
|
-
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
2039
|
-
*
|
|
2040
|
-
* - Positive values indicate improvement
|
|
2041
|
-
* - Negative values indicate regression
|
|
2042
|
-
*/
|
|
2043
|
-
liftPercent?: number | null;
|
|
2044
|
-
}
|
|
2045
|
-
}
|
|
2046
|
-
/**
|
|
2047
|
-
* Detailed performance metrics and analysis
|
|
2048
|
-
*/
|
|
2049
|
-
interface BaselineMetrics {
|
|
2050
|
-
/**
|
|
2051
|
-
* Comprehensive performance metrics
|
|
2052
|
-
*/
|
|
2053
|
-
aggregateMetrics?: BaselineMetrics.AggregateMetrics;
|
|
2054
|
-
/**
|
|
2055
|
-
* Enhanced field metrics with comprehensive analytics
|
|
2056
|
-
*/
|
|
2057
|
-
fieldMetrics?: Array<BaselineMetrics.FieldMetric>;
|
|
2058
|
-
/**
|
|
2059
|
-
* Area Under the Precision-Recall Curve
|
|
2060
|
-
*/
|
|
2061
|
-
precisionRecallAuc?: number;
|
|
2062
|
-
}
|
|
2063
|
-
namespace BaselineMetrics {
|
|
2064
|
-
/**
|
|
2065
|
-
* Comprehensive performance metrics
|
|
2066
|
-
*/
|
|
2067
|
-
interface AggregateMetrics {
|
|
2068
|
-
/**
|
|
2069
|
-
* Overall accuracy
|
|
2070
|
-
*/
|
|
2071
|
-
accuracy?: number | null;
|
|
2072
|
-
/**
|
|
2073
|
-
* F1 Score (harmonic mean of precision and recall)
|
|
2074
|
-
*/
|
|
2075
|
-
f1Score?: number | null;
|
|
2076
|
-
/**
|
|
2077
|
-
* False Negatives
|
|
2078
|
-
*/
|
|
2079
|
-
fn?: number;
|
|
2080
|
-
/**
|
|
2081
|
-
* False Positives
|
|
2082
|
-
*/
|
|
2083
|
-
fp?: number;
|
|
2084
|
-
/**
|
|
2085
|
-
* Precision (TP / (TP + FP))
|
|
2086
|
-
*/
|
|
2087
|
-
precision?: number | null;
|
|
2088
|
-
/**
|
|
2089
|
-
* Recall (TP / (TP + FN))
|
|
2090
|
-
*/
|
|
2091
|
-
recall?: number | null;
|
|
2092
|
-
/**
|
|
2093
|
-
* True Negatives
|
|
2094
|
-
*/
|
|
2095
|
-
tn?: number;
|
|
2096
|
-
/**
|
|
2097
|
-
* True Positives
|
|
2098
|
-
*/
|
|
2099
|
-
tp?: number;
|
|
2100
|
-
}
|
|
2101
|
-
/**
|
|
2102
|
-
* Enhanced field metrics with comprehensive analytics
|
|
2103
|
-
*/
|
|
2104
|
-
interface FieldMetric {
|
|
2105
|
-
/**
|
|
2106
|
-
* JSON path to the field
|
|
2107
|
-
*/
|
|
2108
|
-
fieldPath: string;
|
|
2109
|
-
/**
|
|
2110
|
-
* Comprehensive performance metrics
|
|
2111
|
-
*/
|
|
2112
|
-
metrics?: FieldMetric.Metrics;
|
|
2113
|
-
}
|
|
2114
|
-
namespace FieldMetric {
|
|
2115
|
-
/**
|
|
2116
|
-
* Comprehensive performance metrics
|
|
2117
|
-
*/
|
|
2118
|
-
interface Metrics {
|
|
2119
|
-
/**
|
|
2120
|
-
* Overall accuracy
|
|
2121
|
-
*/
|
|
2122
|
-
accuracy?: number | null;
|
|
2123
|
-
/**
|
|
2124
|
-
* F1 Score (harmonic mean of precision and recall)
|
|
2125
|
-
*/
|
|
2126
|
-
f1Score?: number | null;
|
|
2127
|
-
/**
|
|
2128
|
-
* False Negatives
|
|
2129
|
-
*/
|
|
2130
|
-
fn?: number;
|
|
2131
|
-
/**
|
|
2132
|
-
* False Positives
|
|
2133
|
-
*/
|
|
2134
|
-
fp?: number;
|
|
2135
|
-
/**
|
|
2136
|
-
* Precision (TP / (TP + FP))
|
|
2137
|
-
*/
|
|
2138
|
-
precision?: number | null;
|
|
2139
|
-
/**
|
|
2140
|
-
* Recall (TP / (TP + FN))
|
|
2141
|
-
*/
|
|
2142
|
-
recall?: number | null;
|
|
2143
|
-
/**
|
|
2144
|
-
* True Negatives
|
|
2145
|
-
*/
|
|
2146
|
-
tn?: number;
|
|
2147
|
-
/**
|
|
2148
|
-
* True Positives
|
|
2149
|
-
*/
|
|
2150
|
-
tp?: number;
|
|
2151
|
-
}
|
|
2152
|
-
}
|
|
2153
|
-
}
|
|
2154
|
-
/**
|
|
2155
|
-
* Detailed performance metrics and analysis
|
|
2156
|
-
*/
|
|
2157
|
-
interface ComparisonMetrics {
|
|
2158
|
-
/**
|
|
2159
|
-
* Comprehensive performance metrics
|
|
2160
|
-
*/
|
|
2161
|
-
aggregateMetrics?: ComparisonMetrics.AggregateMetrics;
|
|
2162
|
-
/**
|
|
2163
|
-
* Enhanced field metrics with comprehensive analytics
|
|
2164
|
-
*/
|
|
2165
|
-
fieldMetrics?: Array<ComparisonMetrics.FieldMetric>;
|
|
2166
|
-
/**
|
|
2167
|
-
* Area Under the Precision-Recall Curve
|
|
2168
|
-
*/
|
|
2169
|
-
precisionRecallAuc?: number;
|
|
2170
|
-
}
|
|
2171
|
-
namespace ComparisonMetrics {
|
|
2172
|
-
/**
|
|
2173
|
-
* Comprehensive performance metrics
|
|
2174
|
-
*/
|
|
2175
|
-
interface AggregateMetrics {
|
|
2176
|
-
/**
|
|
2177
|
-
* Overall accuracy
|
|
2178
|
-
*/
|
|
2179
|
-
accuracy?: number | null;
|
|
2180
|
-
/**
|
|
2181
|
-
* F1 Score (harmonic mean of precision and recall)
|
|
2182
|
-
*/
|
|
2183
|
-
f1Score?: number | null;
|
|
2184
|
-
/**
|
|
2185
|
-
* False Negatives
|
|
2186
|
-
*/
|
|
2187
|
-
fn?: number;
|
|
2188
|
-
/**
|
|
2189
|
-
* False Positives
|
|
2190
|
-
*/
|
|
2191
|
-
fp?: number;
|
|
2192
|
-
/**
|
|
2193
|
-
* Precision (TP / (TP + FP))
|
|
2194
|
-
*/
|
|
2195
|
-
precision?: number | null;
|
|
2196
|
-
/**
|
|
2197
|
-
* Recall (TP / (TP + FN))
|
|
2198
|
-
*/
|
|
2199
|
-
recall?: number | null;
|
|
2200
|
-
/**
|
|
2201
|
-
* True Negatives
|
|
2202
|
-
*/
|
|
2203
|
-
tn?: number;
|
|
2204
|
-
/**
|
|
2205
|
-
* True Positives
|
|
2206
|
-
*/
|
|
2207
|
-
tp?: number;
|
|
2208
|
-
}
|
|
2209
|
-
/**
|
|
2210
|
-
* Enhanced field metrics with comprehensive analytics
|
|
2211
|
-
*/
|
|
2212
|
-
interface FieldMetric {
|
|
2213
|
-
/**
|
|
2214
|
-
* JSON path to the field
|
|
2215
|
-
*/
|
|
2216
|
-
fieldPath: string;
|
|
2217
|
-
/**
|
|
2218
|
-
* Comprehensive performance metrics
|
|
2219
|
-
*/
|
|
2220
|
-
metrics?: FieldMetric.Metrics;
|
|
2221
|
-
}
|
|
2222
|
-
namespace FieldMetric {
|
|
2223
|
-
/**
|
|
2224
|
-
* Comprehensive performance metrics
|
|
2225
|
-
*/
|
|
2226
|
-
interface Metrics {
|
|
2227
|
-
/**
|
|
2228
|
-
* Overall accuracy
|
|
2229
|
-
*/
|
|
2230
|
-
accuracy?: number | null;
|
|
2231
|
-
/**
|
|
2232
|
-
* F1 Score (harmonic mean of precision and recall)
|
|
2233
|
-
*/
|
|
2234
|
-
f1Score?: number | null;
|
|
2235
|
-
/**
|
|
2236
|
-
* False Negatives
|
|
2237
|
-
*/
|
|
2238
|
-
fn?: number;
|
|
2239
|
-
/**
|
|
2240
|
-
* False Positives
|
|
2241
|
-
*/
|
|
2242
|
-
fp?: number;
|
|
2243
|
-
/**
|
|
2244
|
-
* Precision (TP / (TP + FP))
|
|
2245
|
-
*/
|
|
2246
|
-
precision?: number | null;
|
|
2247
|
-
/**
|
|
2248
|
-
* Recall (TP / (TP + FN))
|
|
2249
|
-
*/
|
|
2250
|
-
recall?: number | null;
|
|
2251
|
-
/**
|
|
2252
|
-
* True Negatives
|
|
2253
|
-
*/
|
|
2254
|
-
tn?: number;
|
|
2255
|
-
/**
|
|
2256
|
-
* True Positives
|
|
2257
|
-
*/
|
|
2258
|
-
tp?: number;
|
|
2259
|
-
}
|
|
2260
|
-
}
|
|
2261
|
-
}
|
|
2262
|
-
/**
|
|
2263
|
-
* Comparison of field-level metrics
|
|
2264
|
-
*/
|
|
2265
|
-
interface FieldMetricsChange {
|
|
2266
|
-
/**
|
|
2267
|
-
* Comparison of metrics between two versions
|
|
2268
|
-
*/
|
|
2269
|
-
comparison: FieldMetricsChange.Comparison;
|
|
2270
|
-
/**
|
|
2271
|
-
* JSON pointer path to the field
|
|
2272
|
-
*/
|
|
2273
|
-
fieldPath: string;
|
|
2274
|
-
}
|
|
2275
|
-
namespace FieldMetricsChange {
|
|
2276
|
-
/**
|
|
2277
|
-
* Comparison of metrics between two versions
|
|
2278
|
-
*/
|
|
2279
|
-
interface Comparison {
|
|
2280
|
-
/**
|
|
2281
|
-
* Comparison of a single metric between two versions
|
|
2282
|
-
*/
|
|
2283
|
-
accuracy?: Comparison.Accuracy;
|
|
2284
|
-
/**
|
|
2285
|
-
* Comparison of a single metric between two versions
|
|
2286
|
-
*/
|
|
2287
|
-
f1Score?: Comparison.F1Score;
|
|
2288
|
-
/**
|
|
2289
|
-
* Comparison of a single metric between two versions
|
|
2290
|
-
*/
|
|
2291
|
-
precision?: Comparison.Precision;
|
|
2292
|
-
/**
|
|
2293
|
-
* Comparison of a single metric between two versions
|
|
2294
|
-
*/
|
|
2295
|
-
recall?: Comparison.Recall;
|
|
2296
|
-
}
|
|
2297
|
-
namespace Comparison {
|
|
2298
|
-
/**
|
|
2299
|
-
* Comparison of a single metric between two versions
|
|
2300
|
-
*/
|
|
2301
|
-
interface Accuracy {
|
|
2302
|
-
/**
|
|
2303
|
-
* Value in baseline version (null if not available)
|
|
2304
|
-
*/
|
|
2305
|
-
baselineValue?: number | null;
|
|
2306
|
-
/**
|
|
2307
|
-
* Value in comparison version (null if not available)
|
|
2308
|
-
*/
|
|
2309
|
-
comparisonValue?: number | null;
|
|
2310
|
-
/**
|
|
2311
|
-
* Absolute difference (comparisonValue - baselineValue)
|
|
2312
|
-
*/
|
|
2313
|
-
difference?: number | null;
|
|
2314
|
-
/**
|
|
2315
|
-
* **Percentage change from baseline to comparison**
|
|
2316
|
-
*
|
|
2317
|
-
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
2318
|
-
*
|
|
2319
|
-
* - Positive values indicate improvement
|
|
2320
|
-
* - Negative values indicate regression
|
|
2321
|
-
*/
|
|
2322
|
-
liftPercent?: number | null;
|
|
2323
|
-
}
|
|
2324
|
-
/**
|
|
2325
|
-
* Comparison of a single metric between two versions
|
|
2326
|
-
*/
|
|
2327
|
-
interface F1Score {
|
|
2328
|
-
/**
|
|
2329
|
-
* Value in baseline version (null if not available)
|
|
2330
|
-
*/
|
|
2331
|
-
baselineValue?: number | null;
|
|
2332
|
-
/**
|
|
2333
|
-
* Value in comparison version (null if not available)
|
|
2334
|
-
*/
|
|
2335
|
-
comparisonValue?: number | null;
|
|
2336
|
-
/**
|
|
2337
|
-
* Absolute difference (comparisonValue - baselineValue)
|
|
2338
|
-
*/
|
|
2339
|
-
difference?: number | null;
|
|
2340
|
-
/**
|
|
2341
|
-
* **Percentage change from baseline to comparison**
|
|
2342
|
-
*
|
|
2343
|
-
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
2344
|
-
*
|
|
2345
|
-
* - Positive values indicate improvement
|
|
2346
|
-
* - Negative values indicate regression
|
|
2347
|
-
*/
|
|
2348
|
-
liftPercent?: number | null;
|
|
2349
|
-
}
|
|
2350
|
-
/**
|
|
2351
|
-
* Comparison of a single metric between two versions
|
|
2352
|
-
*/
|
|
2353
|
-
interface Precision {
|
|
2354
|
-
/**
|
|
2355
|
-
* Value in baseline version (null if not available)
|
|
2356
|
-
*/
|
|
2357
|
-
baselineValue?: number | null;
|
|
2358
|
-
/**
|
|
2359
|
-
* Value in comparison version (null if not available)
|
|
2360
|
-
*/
|
|
2361
|
-
comparisonValue?: number | null;
|
|
2362
|
-
/**
|
|
2363
|
-
* Absolute difference (comparisonValue - baselineValue)
|
|
2364
|
-
*/
|
|
2365
|
-
difference?: number | null;
|
|
2366
|
-
/**
|
|
2367
|
-
* **Percentage change from baseline to comparison**
|
|
2368
|
-
*
|
|
2369
|
-
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
2370
|
-
*
|
|
2371
|
-
* - Positive values indicate improvement
|
|
2372
|
-
* - Negative values indicate regression
|
|
2373
|
-
*/
|
|
2374
|
-
liftPercent?: number | null;
|
|
2375
|
-
}
|
|
2376
|
-
/**
|
|
2377
|
-
* Comparison of a single metric between two versions
|
|
2378
|
-
*/
|
|
2379
|
-
interface Recall {
|
|
2380
|
-
/**
|
|
2381
|
-
* Value in baseline version (null if not available)
|
|
2382
|
-
*/
|
|
2383
|
-
baselineValue?: number | null;
|
|
2384
|
-
/**
|
|
2385
|
-
* Value in comparison version (null if not available)
|
|
2386
|
-
*/
|
|
2387
|
-
comparisonValue?: number | null;
|
|
2388
|
-
/**
|
|
2389
|
-
* Absolute difference (comparisonValue - baselineValue)
|
|
2390
|
-
*/
|
|
2391
|
-
difference?: number | null;
|
|
2392
|
-
/**
|
|
2393
|
-
* **Percentage change from baseline to comparison**
|
|
2394
|
-
*
|
|
2395
|
-
* Formula: ((comparisonValue - baselineValue) / baselineValue) \* 100
|
|
2396
|
-
*
|
|
2397
|
-
* - Positive values indicate improvement
|
|
2398
|
-
* - Negative values indicate regression
|
|
2399
|
-
*/
|
|
2400
|
-
liftPercent?: number | null;
|
|
2401
|
-
}
|
|
2402
|
-
}
|
|
2403
|
-
}
|
|
2404
|
-
}
|
|
2405
|
-
/**
|
|
2406
|
-
* Response containing review requirements estimate
|
|
2407
|
-
*/
|
|
2408
|
-
export interface FunctionEstimateReviewRequirementsResponse {
|
|
2409
|
-
/**
|
|
2410
|
-
* Detailed review requirements estimate
|
|
2411
|
-
*/
|
|
2412
|
-
estimate: FunctionEstimateReviewRequirementsResponse.Estimate;
|
|
2413
|
-
/**
|
|
2414
|
-
* Name of the analyzed function
|
|
2415
|
-
*/
|
|
2416
|
-
functionName: string;
|
|
2417
|
-
/**
|
|
2418
|
-
* Version number of the function that was analyzed
|
|
2419
|
-
*/
|
|
2420
|
-
functionVersionNum: number;
|
|
2421
|
-
/**
|
|
2422
|
-
* Detailed performance metrics and analysis
|
|
2423
|
-
*/
|
|
2424
|
-
metrics?: FunctionEstimateReviewRequirementsResponse.Metrics;
|
|
2425
|
-
}
|
|
2426
|
-
export declare namespace FunctionEstimateReviewRequirementsResponse {
|
|
2427
|
-
/**
|
|
2428
|
-
* Detailed review requirements estimate
|
|
2429
|
-
*/
|
|
2430
|
-
interface Estimate {
|
|
2431
|
-
/**
|
|
2432
|
-
* Distribution of confidence levels
|
|
2433
|
-
*/
|
|
2434
|
-
confidenceDistribution: Estimate.ConfidenceDistribution;
|
|
2435
|
-
/**
|
|
2436
|
-
* Number of transformations already labeled
|
|
2437
|
-
*/
|
|
2438
|
-
labeledTransformations: number;
|
|
2439
|
-
/**
|
|
2440
|
-
* Number of transformations without evaluation data
|
|
2441
|
-
*/
|
|
2442
|
-
missingEvaluations: number;
|
|
2443
|
-
/**
|
|
2444
|
-
* Statistical analysis across confidence thresholds
|
|
2445
|
-
*/
|
|
2446
|
-
thresholdMatrix: Array<Estimate.ThresholdMatrix>;
|
|
2447
|
-
/**
|
|
2448
|
-
* Total number of transformations analyzed
|
|
2312
|
+
* Total number of transformations analyzed
|
|
2449
2313
|
*/
|
|
2450
2314
|
totalTransformations: number;
|
|
2451
2315
|
/**
|
|
@@ -2530,40 +2394,7 @@ export declare namespace FunctionEstimateReviewRequirementsResponse {
|
|
|
2530
2394
|
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2531
2395
|
* intervals may be more appropriate.
|
|
2532
2396
|
*/
|
|
2533
|
-
'95'?:
|
|
2534
|
-
}
|
|
2535
|
-
namespace AccuracyAboveThreshold {
|
|
2536
|
-
/**
|
|
2537
|
-
* Confidence interval for a rate/proportion using Wald (normal approximation)
|
|
2538
|
-
* method by default.
|
|
2539
|
-
*
|
|
2540
|
-
* Wald confidence intervals use the normal approximation to the binomial
|
|
2541
|
-
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2542
|
-
* intervals may be more appropriate.
|
|
2543
|
-
*/
|
|
2544
|
-
interface _95 {
|
|
2545
|
-
/**
|
|
2546
|
-
* Current number of samples/observations available
|
|
2547
|
-
*/
|
|
2548
|
-
currentSample: number;
|
|
2549
|
-
/**
|
|
2550
|
-
* Minimum number of samples needed for reliable confidence interval calculation
|
|
2551
|
-
*/
|
|
2552
|
-
sampleNeeded: number;
|
|
2553
|
-
/**
|
|
2554
|
-
* Lower bound of the confidence interval (null if insufficient sample size)
|
|
2555
|
-
*/
|
|
2556
|
-
ciLower?: number | null;
|
|
2557
|
-
/**
|
|
2558
|
-
* Upper bound of the confidence interval (null if insufficient sample size)
|
|
2559
|
-
*/
|
|
2560
|
-
ciUpper?: number | null;
|
|
2561
|
-
/**
|
|
2562
|
-
* Point estimate (observed rate) at the center of the interval (null if
|
|
2563
|
-
* insufficient sample size)
|
|
2564
|
-
*/
|
|
2565
|
-
mid?: number | null;
|
|
2566
|
-
}
|
|
2397
|
+
'95'?: FunctionsAPI.RateConfidenceInterval;
|
|
2567
2398
|
}
|
|
2568
2399
|
/**
|
|
2569
2400
|
* False Discovery Rate confidence intervals by confidence level. Keys are
|
|
@@ -2579,40 +2410,7 @@ export declare namespace FunctionEstimateReviewRequirementsResponse {
|
|
|
2579
2410
|
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2580
2411
|
* intervals may be more appropriate.
|
|
2581
2412
|
*/
|
|
2582
|
-
'95'?:
|
|
2583
|
-
}
|
|
2584
|
-
namespace FalseDiscoveryRate {
|
|
2585
|
-
/**
|
|
2586
|
-
* Confidence interval for a rate/proportion using Wald (normal approximation)
|
|
2587
|
-
* method by default.
|
|
2588
|
-
*
|
|
2589
|
-
* Wald confidence intervals use the normal approximation to the binomial
|
|
2590
|
-
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2591
|
-
* intervals may be more appropriate.
|
|
2592
|
-
*/
|
|
2593
|
-
interface _95 {
|
|
2594
|
-
/**
|
|
2595
|
-
* Current number of samples/observations available
|
|
2596
|
-
*/
|
|
2597
|
-
currentSample: number;
|
|
2598
|
-
/**
|
|
2599
|
-
* Minimum number of samples needed for reliable confidence interval calculation
|
|
2600
|
-
*/
|
|
2601
|
-
sampleNeeded: number;
|
|
2602
|
-
/**
|
|
2603
|
-
* Lower bound of the confidence interval (null if insufficient sample size)
|
|
2604
|
-
*/
|
|
2605
|
-
ciLower?: number | null;
|
|
2606
|
-
/**
|
|
2607
|
-
* Upper bound of the confidence interval (null if insufficient sample size)
|
|
2608
|
-
*/
|
|
2609
|
-
ciUpper?: number | null;
|
|
2610
|
-
/**
|
|
2611
|
-
* Point estimate (observed rate) at the center of the interval (null if
|
|
2612
|
-
* insufficient sample size)
|
|
2613
|
-
*/
|
|
2614
|
-
mid?: number | null;
|
|
2615
|
-
}
|
|
2413
|
+
'95'?: FunctionsAPI.RateConfidenceInterval;
|
|
2616
2414
|
}
|
|
2617
2415
|
/**
|
|
2618
2416
|
* False Positive Rate confidence intervals by confidence level. Keys are
|
|
@@ -2628,40 +2426,7 @@ export declare namespace FunctionEstimateReviewRequirementsResponse {
|
|
|
2628
2426
|
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2629
2427
|
* intervals may be more appropriate.
|
|
2630
2428
|
*/
|
|
2631
|
-
'95'?:
|
|
2632
|
-
}
|
|
2633
|
-
namespace FalsePositiveRate {
|
|
2634
|
-
/**
|
|
2635
|
-
* Confidence interval for a rate/proportion using Wald (normal approximation)
|
|
2636
|
-
* method by default.
|
|
2637
|
-
*
|
|
2638
|
-
* Wald confidence intervals use the normal approximation to the binomial
|
|
2639
|
-
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2640
|
-
* intervals may be more appropriate.
|
|
2641
|
-
*/
|
|
2642
|
-
interface _95 {
|
|
2643
|
-
/**
|
|
2644
|
-
* Current number of samples/observations available
|
|
2645
|
-
*/
|
|
2646
|
-
currentSample: number;
|
|
2647
|
-
/**
|
|
2648
|
-
* Minimum number of samples needed for reliable confidence interval calculation
|
|
2649
|
-
*/
|
|
2650
|
-
sampleNeeded: number;
|
|
2651
|
-
/**
|
|
2652
|
-
* Lower bound of the confidence interval (null if insufficient sample size)
|
|
2653
|
-
*/
|
|
2654
|
-
ciLower?: number | null;
|
|
2655
|
-
/**
|
|
2656
|
-
* Upper bound of the confidence interval (null if insufficient sample size)
|
|
2657
|
-
*/
|
|
2658
|
-
ciUpper?: number | null;
|
|
2659
|
-
/**
|
|
2660
|
-
* Point estimate (observed rate) at the center of the interval (null if
|
|
2661
|
-
* insufficient sample size)
|
|
2662
|
-
*/
|
|
2663
|
-
mid?: number | null;
|
|
2664
|
-
}
|
|
2429
|
+
'95'?: FunctionsAPI.RateConfidenceInterval;
|
|
2665
2430
|
}
|
|
2666
2431
|
/**
|
|
2667
2432
|
* Precision confidence intervals by confidence level. Keys are confidence levels
|
|
@@ -2676,40 +2441,7 @@ export declare namespace FunctionEstimateReviewRequirementsResponse {
|
|
|
2676
2441
|
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2677
2442
|
* intervals may be more appropriate.
|
|
2678
2443
|
*/
|
|
2679
|
-
'95'?:
|
|
2680
|
-
}
|
|
2681
|
-
namespace Precision {
|
|
2682
|
-
/**
|
|
2683
|
-
* Confidence interval for a rate/proportion using Wald (normal approximation)
|
|
2684
|
-
* method by default.
|
|
2685
|
-
*
|
|
2686
|
-
* Wald confidence intervals use the normal approximation to the binomial
|
|
2687
|
-
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2688
|
-
* intervals may be more appropriate.
|
|
2689
|
-
*/
|
|
2690
|
-
interface _95 {
|
|
2691
|
-
/**
|
|
2692
|
-
* Current number of samples/observations available
|
|
2693
|
-
*/
|
|
2694
|
-
currentSample: number;
|
|
2695
|
-
/**
|
|
2696
|
-
* Minimum number of samples needed for reliable confidence interval calculation
|
|
2697
|
-
*/
|
|
2698
|
-
sampleNeeded: number;
|
|
2699
|
-
/**
|
|
2700
|
-
* Lower bound of the confidence interval (null if insufficient sample size)
|
|
2701
|
-
*/
|
|
2702
|
-
ciLower?: number | null;
|
|
2703
|
-
/**
|
|
2704
|
-
* Upper bound of the confidence interval (null if insufficient sample size)
|
|
2705
|
-
*/
|
|
2706
|
-
ciUpper?: number | null;
|
|
2707
|
-
/**
|
|
2708
|
-
* Point estimate (observed rate) at the center of the interval (null if
|
|
2709
|
-
* insufficient sample size)
|
|
2710
|
-
*/
|
|
2711
|
-
mid?: number | null;
|
|
2712
|
-
}
|
|
2444
|
+
'95'?: FunctionsAPI.RateConfidenceInterval;
|
|
2713
2445
|
}
|
|
2714
2446
|
/**
|
|
2715
2447
|
* Recall confidence intervals by confidence level. Keys are confidence levels as
|
|
@@ -2724,148 +2456,7 @@ export declare namespace FunctionEstimateReviewRequirementsResponse {
|
|
|
2724
2456
|
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2725
2457
|
* intervals may be more appropriate.
|
|
2726
2458
|
*/
|
|
2727
|
-
'95'?:
|
|
2728
|
-
}
|
|
2729
|
-
namespace Recall {
|
|
2730
|
-
/**
|
|
2731
|
-
* Confidence interval for a rate/proportion using Wald (normal approximation)
|
|
2732
|
-
* method by default.
|
|
2733
|
-
*
|
|
2734
|
-
* Wald confidence intervals use the normal approximation to the binomial
|
|
2735
|
-
* distribution. For extreme rates or small sample sizes, Wilson confidence
|
|
2736
|
-
* intervals may be more appropriate.
|
|
2737
|
-
*/
|
|
2738
|
-
interface _95 {
|
|
2739
|
-
/**
|
|
2740
|
-
* Current number of samples/observations available
|
|
2741
|
-
*/
|
|
2742
|
-
currentSample: number;
|
|
2743
|
-
/**
|
|
2744
|
-
* Minimum number of samples needed for reliable confidence interval calculation
|
|
2745
|
-
*/
|
|
2746
|
-
sampleNeeded: number;
|
|
2747
|
-
/**
|
|
2748
|
-
* Lower bound of the confidence interval (null if insufficient sample size)
|
|
2749
|
-
*/
|
|
2750
|
-
ciLower?: number | null;
|
|
2751
|
-
/**
|
|
2752
|
-
* Upper bound of the confidence interval (null if insufficient sample size)
|
|
2753
|
-
*/
|
|
2754
|
-
ciUpper?: number | null;
|
|
2755
|
-
/**
|
|
2756
|
-
* Point estimate (observed rate) at the center of the interval (null if
|
|
2757
|
-
* insufficient sample size)
|
|
2758
|
-
*/
|
|
2759
|
-
mid?: number | null;
|
|
2760
|
-
}
|
|
2761
|
-
}
|
|
2762
|
-
}
|
|
2763
|
-
}
|
|
2764
|
-
/**
|
|
2765
|
-
* Detailed performance metrics and analysis
|
|
2766
|
-
*/
|
|
2767
|
-
interface Metrics {
|
|
2768
|
-
/**
|
|
2769
|
-
* Comprehensive performance metrics
|
|
2770
|
-
*/
|
|
2771
|
-
aggregateMetrics?: Metrics.AggregateMetrics;
|
|
2772
|
-
/**
|
|
2773
|
-
* Enhanced field metrics with comprehensive analytics
|
|
2774
|
-
*/
|
|
2775
|
-
fieldMetrics?: Array<Metrics.FieldMetric>;
|
|
2776
|
-
/**
|
|
2777
|
-
* Area Under the Precision-Recall Curve
|
|
2778
|
-
*/
|
|
2779
|
-
precisionRecallAuc?: number;
|
|
2780
|
-
}
|
|
2781
|
-
namespace Metrics {
|
|
2782
|
-
/**
|
|
2783
|
-
* Comprehensive performance metrics
|
|
2784
|
-
*/
|
|
2785
|
-
interface AggregateMetrics {
|
|
2786
|
-
/**
|
|
2787
|
-
* Overall accuracy
|
|
2788
|
-
*/
|
|
2789
|
-
accuracy?: number | null;
|
|
2790
|
-
/**
|
|
2791
|
-
* F1 Score (harmonic mean of precision and recall)
|
|
2792
|
-
*/
|
|
2793
|
-
f1Score?: number | null;
|
|
2794
|
-
/**
|
|
2795
|
-
* False Negatives
|
|
2796
|
-
*/
|
|
2797
|
-
fn?: number;
|
|
2798
|
-
/**
|
|
2799
|
-
* False Positives
|
|
2800
|
-
*/
|
|
2801
|
-
fp?: number;
|
|
2802
|
-
/**
|
|
2803
|
-
* Precision (TP / (TP + FP))
|
|
2804
|
-
*/
|
|
2805
|
-
precision?: number | null;
|
|
2806
|
-
/**
|
|
2807
|
-
* Recall (TP / (TP + FN))
|
|
2808
|
-
*/
|
|
2809
|
-
recall?: number | null;
|
|
2810
|
-
/**
|
|
2811
|
-
* True Negatives
|
|
2812
|
-
*/
|
|
2813
|
-
tn?: number;
|
|
2814
|
-
/**
|
|
2815
|
-
* True Positives
|
|
2816
|
-
*/
|
|
2817
|
-
tp?: number;
|
|
2818
|
-
}
|
|
2819
|
-
/**
|
|
2820
|
-
* Enhanced field metrics with comprehensive analytics
|
|
2821
|
-
*/
|
|
2822
|
-
interface FieldMetric {
|
|
2823
|
-
/**
|
|
2824
|
-
* JSON path to the field
|
|
2825
|
-
*/
|
|
2826
|
-
fieldPath: string;
|
|
2827
|
-
/**
|
|
2828
|
-
* Comprehensive performance metrics
|
|
2829
|
-
*/
|
|
2830
|
-
metrics?: FieldMetric.Metrics;
|
|
2831
|
-
}
|
|
2832
|
-
namespace FieldMetric {
|
|
2833
|
-
/**
|
|
2834
|
-
* Comprehensive performance metrics
|
|
2835
|
-
*/
|
|
2836
|
-
interface Metrics {
|
|
2837
|
-
/**
|
|
2838
|
-
* Overall accuracy
|
|
2839
|
-
*/
|
|
2840
|
-
accuracy?: number | null;
|
|
2841
|
-
/**
|
|
2842
|
-
* F1 Score (harmonic mean of precision and recall)
|
|
2843
|
-
*/
|
|
2844
|
-
f1Score?: number | null;
|
|
2845
|
-
/**
|
|
2846
|
-
* False Negatives
|
|
2847
|
-
*/
|
|
2848
|
-
fn?: number;
|
|
2849
|
-
/**
|
|
2850
|
-
* False Positives
|
|
2851
|
-
*/
|
|
2852
|
-
fp?: number;
|
|
2853
|
-
/**
|
|
2854
|
-
* Precision (TP / (TP + FP))
|
|
2855
|
-
*/
|
|
2856
|
-
precision?: number | null;
|
|
2857
|
-
/**
|
|
2858
|
-
* Recall (TP / (TP + FN))
|
|
2859
|
-
*/
|
|
2860
|
-
recall?: number | null;
|
|
2861
|
-
/**
|
|
2862
|
-
* True Negatives
|
|
2863
|
-
*/
|
|
2864
|
-
tn?: number;
|
|
2865
|
-
/**
|
|
2866
|
-
* True Positives
|
|
2867
|
-
*/
|
|
2868
|
-
tp?: number;
|
|
2459
|
+
'95'?: FunctionsAPI.RateConfidenceInterval;
|
|
2869
2460
|
}
|
|
2870
2461
|
}
|
|
2871
2462
|
}
|
|
@@ -2907,7 +2498,7 @@ export declare namespace FunctionGetMetricsResponse {
|
|
|
2907
2498
|
}
|
|
2908
2499
|
}
|
|
2909
2500
|
}
|
|
2910
|
-
export type FunctionCreateParams = FunctionCreateParams.CreateExtractFunction | FunctionCreateParams.CreateClassifyFunction | FunctionCreateParams.CreateSendFunction | FunctionCreateParams.CreateSplitFunction | FunctionCreateParams.CreateJoinFunction | FunctionCreateParams.CreatePayloadShapingFunction | FunctionCreateParams.CreateEnrichFunction | FunctionCreateParams.CreateParseFunction;
|
|
2501
|
+
export type FunctionCreateParams = FunctionCreateParams.CreateExtractFunction | FunctionCreateParams.CreateClassifyFunction | FunctionCreateParams.CreateSendFunction | FunctionCreateParams.CreateSplitFunction | FunctionCreateParams.CreateJoinFunction | FunctionCreateParams.CreatePayloadShapingFunction | FunctionCreateParams.CreateEnrichFunction | FunctionCreateParams.CreateParseFunction | FunctionCreateParams.CreateRenderFunction;
|
|
2911
2502
|
export declare namespace FunctionCreateParams {
|
|
2912
2503
|
interface CreateExtractFunction {
|
|
2913
2504
|
/**
|
|
@@ -3163,7 +2754,7 @@ export declare namespace FunctionCreateParams {
|
|
|
3163
2754
|
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
3164
2755
|
* stays distinct from operator-level execution flags.
|
|
3165
2756
|
*/
|
|
3166
|
-
extraConfig?:
|
|
2757
|
+
extraConfig?: ParseExtraFunctionConfig;
|
|
3167
2758
|
/**
|
|
3168
2759
|
* Per-version configuration for a Parse function.
|
|
3169
2760
|
*
|
|
@@ -3177,27 +2768,31 @@ export declare namespace FunctionCreateParams {
|
|
|
3177
2768
|
*/
|
|
3178
2769
|
tags?: Array<string>;
|
|
3179
2770
|
}
|
|
3180
|
-
|
|
2771
|
+
interface CreateRenderFunction {
|
|
3181
2772
|
/**
|
|
3182
|
-
*
|
|
3183
|
-
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
3184
|
-
* stays distinct from operator-level execution flags.
|
|
2773
|
+
* Name of function. Must be UNIQUE on a per-environment basis.
|
|
3185
2774
|
*/
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
|
|
3194
|
-
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
2775
|
+
functionName: string;
|
|
2776
|
+
/**
|
|
2777
|
+
* Request-side render configuration. Carries the template document as
|
|
2778
|
+
* base64-encoded `.docx` bytes: the server validates them, stores the template,
|
|
2779
|
+
* and derives the placeholder/style-id contract at create/update time, so clients
|
|
2780
|
+
* never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
|
|
2781
|
+
* returns the derived contract.
|
|
2782
|
+
*/
|
|
2783
|
+
renderConfig: RenderConfigInput;
|
|
2784
|
+
type: 'render';
|
|
2785
|
+
/**
|
|
2786
|
+
* Display name of function. Human-readable name to help you identify the function.
|
|
2787
|
+
*/
|
|
2788
|
+
displayName?: string;
|
|
2789
|
+
/**
|
|
2790
|
+
* Array of tags to categorize and organize functions.
|
|
2791
|
+
*/
|
|
2792
|
+
tags?: Array<string>;
|
|
3198
2793
|
}
|
|
3199
2794
|
}
|
|
3200
|
-
export type FunctionUpdateParams = FunctionUpdateParams.UpsertExtractFunction | FunctionUpdateParams.UpsertClassifyFunction | FunctionUpdateParams.UpsertSendFunction | FunctionUpdateParams.UpsertSplitFunction | FunctionUpdateParams.UpsertJoinFunction | FunctionUpdateParams.UpsertPayloadShapingFunction | FunctionUpdateParams.UpsertEnrichFunction | FunctionUpdateParams.UpsertParseFunction;
|
|
2795
|
+
export type FunctionUpdateParams = FunctionUpdateParams.UpsertExtractFunction | FunctionUpdateParams.UpsertClassifyFunction | FunctionUpdateParams.UpsertSendFunction | FunctionUpdateParams.UpsertSplitFunction | FunctionUpdateParams.UpsertJoinFunction | FunctionUpdateParams.UpsertPayloadShapingFunction | FunctionUpdateParams.UpsertEnrichFunction | FunctionUpdateParams.UpsertParseFunction | FunctionUpdateParams.UpsertRenderFunction;
|
|
3201
2796
|
export declare namespace FunctionUpdateParams {
|
|
3202
2797
|
interface UpsertExtractFunction {
|
|
3203
2798
|
type: 'extract';
|
|
@@ -3437,7 +3032,7 @@ export declare namespace FunctionUpdateParams {
|
|
|
3437
3032
|
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
3438
3033
|
* stays distinct from operator-level execution flags.
|
|
3439
3034
|
*/
|
|
3440
|
-
extraConfig?:
|
|
3035
|
+
extraConfig?: ParseExtraFunctionConfig;
|
|
3441
3036
|
/**
|
|
3442
3037
|
* Name of function. Must be UNIQUE on a per-environment basis.
|
|
3443
3038
|
*/
|
|
@@ -3455,24 +3050,28 @@ export declare namespace FunctionUpdateParams {
|
|
|
3455
3050
|
*/
|
|
3456
3051
|
tags?: Array<string>;
|
|
3457
3052
|
}
|
|
3458
|
-
|
|
3053
|
+
interface UpsertRenderFunction {
|
|
3054
|
+
type: 'render';
|
|
3459
3055
|
/**
|
|
3460
|
-
*
|
|
3461
|
-
* Extract / Join — separated from `parseConfig` so the per-call Parse output shape
|
|
3462
|
-
* stays distinct from operator-level execution flags.
|
|
3056
|
+
* Display name of function. Human-readable name to help you identify the function.
|
|
3463
3057
|
*/
|
|
3464
|
-
|
|
3465
|
-
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
|
|
3470
|
-
|
|
3471
|
-
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
|
|
3475
|
-
|
|
3058
|
+
displayName?: string;
|
|
3059
|
+
/**
|
|
3060
|
+
* Name of function. Must be UNIQUE on a per-environment basis.
|
|
3061
|
+
*/
|
|
3062
|
+
functionName?: string;
|
|
3063
|
+
/**
|
|
3064
|
+
* Request-side render configuration. Carries the template document as
|
|
3065
|
+
* base64-encoded `.docx` bytes: the server validates them, stores the template,
|
|
3066
|
+
* and derives the placeholder/style-id contract at create/update time, so clients
|
|
3067
|
+
* never submit `placeholders` or `styleIds`. The response shape (`RenderConfig`)
|
|
3068
|
+
* returns the derived contract.
|
|
3069
|
+
*/
|
|
3070
|
+
renderConfig?: RenderConfigInput;
|
|
3071
|
+
/**
|
|
3072
|
+
* Array of tags to categorize and organize functions.
|
|
3073
|
+
*/
|
|
3074
|
+
tags?: Array<string>;
|
|
3476
3075
|
}
|
|
3477
3076
|
}
|
|
3478
3077
|
export interface FunctionListParams extends FunctionsPageParams {
|
|
@@ -3578,7 +3177,7 @@ export interface FunctionGetMetricsParams {
|
|
|
3578
3177
|
types?: Array<FunctionType>;
|
|
3579
3178
|
}
|
|
3580
3179
|
export declare namespace Functions {
|
|
3581
|
-
export { type ClassificationListItem as ClassificationListItem, type CreateFunction as CreateFunction, type EnrichConfig as EnrichConfig, type EnrichStep as EnrichStep, type Function as Function, type FunctionAudit as FunctionAudit, type FunctionResponse as FunctionResponse, type FunctionType as FunctionType, type ListFunctionsResponse as ListFunctionsResponse, type ParseConfig as ParseConfig, type SendDestinationType as SendDestinationType, type SplitFunctionSemanticPageItemClass as SplitFunctionSemanticPageItemClass, type UpdateFunction as UpdateFunction, type UserActionSummary as UserActionSummary, type WorkflowUsageInfo as WorkflowUsageInfo, type FunctionCompareMetricsResponse as FunctionCompareMetricsResponse, type FunctionEstimateReviewRequirementsResponse as FunctionEstimateReviewRequirementsResponse, type FunctionGetMetricsResponse as FunctionGetMetricsResponse, type FunctionsFunctionsPage as FunctionsFunctionsPage, type FunctionCreateParams as FunctionCreateParams, type FunctionUpdateParams as FunctionUpdateParams, type FunctionListParams as FunctionListParams, type FunctionCompareMetricsParams as FunctionCompareMetricsParams, type FunctionEstimateReviewRequirementsParams as FunctionEstimateReviewRequirementsParams, type FunctionGetMetricsParams as FunctionGetMetricsParams, };
|
|
3180
|
+
export { type ClassificationListItem as ClassificationListItem, type CreateFunction as CreateFunction, type EnrichConfig as EnrichConfig, type EnrichStep as EnrichStep, type Function as Function, type FunctionAudit as FunctionAudit, type FunctionResponse as FunctionResponse, type FunctionType as FunctionType, type ListFunctionsResponse as ListFunctionsResponse, type MetricComparison as MetricComparison, type Metrics as Metrics, type MetricsComparison as MetricsComparison, type MetricsDetails as MetricsDetails, type ParseConfig as ParseConfig, type ParseExtraFunctionConfig as ParseExtraFunctionConfig, type RateConfidenceInterval as RateConfidenceInterval, type RenderConfig as RenderConfig, type RenderConfigInput as RenderConfigInput, type SendDestinationType as SendDestinationType, type SplitFunctionSemanticPageItemClass as SplitFunctionSemanticPageItemClass, type UpdateFunction as UpdateFunction, type UserActionSummary as UserActionSummary, type WorkflowUsageInfo as WorkflowUsageInfo, type FunctionCompareMetricsResponse as FunctionCompareMetricsResponse, type FunctionEstimateReviewRequirementsResponse as FunctionEstimateReviewRequirementsResponse, type FunctionGetMetricsResponse as FunctionGetMetricsResponse, type FunctionsFunctionsPage as FunctionsFunctionsPage, type FunctionCreateParams as FunctionCreateParams, type FunctionUpdateParams as FunctionUpdateParams, type FunctionListParams as FunctionListParams, type FunctionCompareMetricsParams as FunctionCompareMetricsParams, type FunctionEstimateReviewRequirementsParams as FunctionEstimateReviewRequirementsParams, type FunctionGetMetricsParams as FunctionGetMetricsParams, };
|
|
3582
3181
|
export { Copy as Copy, type FunctionCopyRequest as FunctionCopyRequest, type CopyCreateParams as CopyCreateParams, };
|
|
3583
3182
|
export { Versions as Versions, type FunctionVersion as FunctionVersion, type ListFunctionVersionsResponse as ListFunctionVersionsResponse, type VersionRetrieveResponse as VersionRetrieveResponse, type VersionRetrieveParams as VersionRetrieveParams, };
|
|
3584
3183
|
export { Regression as Regression, type RegressionApplyCorrectionsResponse as RegressionApplyCorrectionsResponse, type RegressionRunResponse as RegressionRunResponse, type RegressionApplyCorrectionsParams as RegressionApplyCorrectionsParams, type RegressionRunParams as RegressionRunParams, };
|