@felspar/sdk 0.3.0 → 0.4.1

package/dist/types/draft-hosted-client.d.ts

@@ -147,6 +147,7 @@ declare const refusalSchema: z.ZodPipe<z.ZodObject<{
         code: string;
         path: string[];
     }[] | undefined;
+    recovery?: "escalate" | "fix_input" | "retry";
     fix?: string;
     escalation?: {
         id: string;
@@ -191,6 +192,544 @@ export declare function createHostedFelsparClient(configuration: {
             id: string;
         }[];
     }>;
+    describeCurrentJob: (job: string) => Promise<{
+        schema: "felspar.hosted-job-description.draft/v0";
+        job: string;
+        trustDomain: string;
+        release: {
+            releaseId: string;
+            releaseDigest: string;
+            materialDigest: string;
+            expectedAuthorityDigest: string;
+        };
+        resolutionPolicy: "relative-date-required-types/direct-overrides/v5" | "relational-required-types/direct-overrides/v4" | "scored-required-types/mandatory-gates/v6" | "windowed-required-types/mandatory-gates/v7" | "conditional-required-types/direct-overrides/v3" | "strict-required-types/direct-overrides/v2" | "strict-required-values/direct-overrides/v1";
+        questions: {
+            definition: {
+                key: string;
+                contentDigest: string;
+                sourceLocator: string;
+                allowedValues: string[];
+            } | {
+                key: string;
+                contentDigest: string;
+                sourceLocator: string;
+                valueRule: {
+                    type: "boolean";
+                };
+            } | {
+                key: string;
+                contentDigest: string;
+                sourceLocator: string;
+                valueRule: {
+                    type: "number";
+                    integer: boolean;
+                    minimum: number;
+                    maximum: number;
+                };
+                unit: string;
+            } | {
+                key: string;
+                contentDigest: string;
+                sourceLocator: string;
+                valueRule: {
+                    type: "date";
+                };
+            };
+            evidencePolicy: {
+                maxAgeMs: number;
+                allowedSourceClasses: string[];
+                trustDomain: string;
+            };
+            key: string;
+            type: "number" | "boolean" | "date" | "enum";
+            meaning: {
+                text: string;
+                source: {
+                    sourceId: string;
+                    revision: string;
+                    locator: string;
+                    contentDigest: string;
+                };
+                parts: {
+                    locator: string;
+                    text: string;
+                }[];
+            };
+            answer: {
+                send: "text" | "text_or_value";
+                valueFormat: "number" | "calendar-date" | null;
+                interpretation: "unsupported" | "classified" | "exact_read";
+                threshold: number | null;
+                applies: "always" | "conditional";
+                dependsOn: string[];
+                appliesWhen: string | null;
+                reading?: {
+                    version: "felspar.exact-number/v2";
+                    unit: {
+                        kind: "currency";
+                        code: string;
+                    } | {
+                        kind: "percent";
+                    } | {
+                        kind: "count";
+                        words: string[];
+                    };
+                    numberStyle: "1,234.56" | "1.234,56" | "1 234,56" | "1'234.56";
+                } | {
+                    version: "felspar.exact-date/v2";
+                    dateOrder: "unstated" | "month-first" | "day-first";
+                } | undefined;
+            };
+            requiredWhen?: ({
+                key: string;
+                relativeDate: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    anchorKey: string;
+                    offsetDays: number;
+                    calendar: {
+                        kind: "business_days";
+                        id: string;
+                        version: string;
+                        validFrom: string;
+                        validThrough: string;
+                        workingWeekdays: number[];
+                        holidays: string[];
+                    } | {
+                        kind: "calendar_days";
+                    };
+                };
+            } | {
+                key: string;
+                relativeToDecision: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    offsetDays: number;
+                    timeZone: string;
+                };
+            } | {
+                key: string;
+                equals: string | boolean;
+            } | {
+                key: string;
+                oneOf: string[];
+            } | {
+                key: string;
+                compare: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    value: number;
+                };
+            } | {
+                key: string;
+                compareFact: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    key: string;
+                };
+            } | {
+                key: string;
+                compareDate: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    value: string;
+                };
+            })[] | undefined;
+            answers?: {
+                value: string;
+                meaning: string | null;
+                inclusions: string[];
+                exclusions: string[];
+                examples: string[];
+                edgeCases: string[];
+            }[] | undefined;
+            whereToLook?: {
+                text: string;
+                source: {
+                    sourceId: string;
+                    revision: string;
+                    locator: string;
+                    contentDigest: string;
+                };
+                parts: {
+                    locator: string;
+                    text: string;
+                }[];
+            }[] | undefined;
+            about?: {
+                relationship: string;
+                subject: string;
+            } | undefined;
+        }[];
+        rules: {
+            id: string;
+            sourceLocator: string;
+            contentDigest: string;
+            when: ({
+                key: string;
+                relativeDate: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    anchorKey: string;
+                    offsetDays: number;
+                    calendar: {
+                        kind: "business_days";
+                        id: string;
+                        version: string;
+                        validFrom: string;
+                        validThrough: string;
+                        workingWeekdays: number[];
+                        holidays: string[];
+                    } | {
+                        kind: "calendar_days";
+                    };
+                };
+            } | {
+                key: string;
+                relativeToDecision: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    offsetDays: number;
+                    timeZone: string;
+                };
+            } | {
+                key: string;
+                equals: string | boolean;
+            } | {
+                key: string;
+                oneOf: string[];
+            } | {
+                key: string;
+                compare: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    value: number;
+                };
+            } | {
+                key: string;
+                compareFact: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    key: string;
+                };
+            } | {
+                key: string;
+                compareDate: {
+                    operator: "eq" | "lt" | "lte" | "gt" | "gte";
+                    value: string;
+                };
+            })[];
+            outcome: string;
+            overrides: string[];
+            text: {
+                text: string;
+                source: {
+                    sourceId: string;
+                    revision: string;
+                    locator: string;
+                    contentDigest: string;
+                };
+                parts: {
+                    locator: string;
+                    text: string;
+                }[];
+            };
+            scoreRange?: {
+                minimumUnits: number;
+                maximumUnits: number;
+            } | undefined;
+            priority?: number | undefined;
+        }[];
+        outcomes: {
+            id: string;
+            meaning: {
+                text: string;
+                source: {
+                    sourceId: string;
+                    revision: string;
+                    locator: string;
+                    contentDigest: string;
+                };
+                parts: {
+                    locator: string;
+                    text: string;
+                }[];
+            } | null;
+            nextStep?: {
+                text: string;
+                source: {
+                    sourceId: string;
+                    revision: string;
+                    locator: string;
+                    contentDigest: string;
+                };
+                parts: {
+                    locator: string;
+                    text: string;
+                }[];
+            } | null | undefined;
+            outputs?: {
+                id: string;
+                what: {
+                    text: string;
+                    locator: string;
+                };
+                maxCharacters: number;
+                checks: {
+                    check: string;
+                    rule: string | null;
+                    must: string;
+                }[];
+                context?: {
+                    text: string;
+                    locator: string;
+                    id: string;
+                }[] | undefined;
+            }[] | undefined;
+            escalate?: string | undefined;
+        }[];
+        guidance: {
+            gather: string;
+        };
+        input: {
+            jsonSchema: Record<string, unknown>;
+            example: {
+                mode: "facts";
+                executionId: string;
+                expectedReleaseDigest: string;
+                jobId: string;
+                entityId: string;
+                facts: Record<string, {
+                    text: string;
+                    source: {
+                        class: string;
+                        observedAt: string;
+                        id?: string | undefined;
+                        manual?: true | undefined;
+                        suppliedBy?: string | undefined;
+                        by?: string | undefined;
+                        stamped?: true | undefined;
+                        revision?: string | undefined;
+                        locator?: string | undefined;
+                        sensitivity?: string | undefined;
+                    };
+                    about?: string | undefined;
+                } | {
+                    value: string | number | boolean;
+                    source: {
+                        class: string;
+                        observedAt: string;
+                        excerpt?: string | undefined;
+                        id?: string | undefined;
+                        manual?: true | undefined;
+                        suppliedBy?: string | undefined;
+                        by?: string | undefined;
+                        stamped?: true | undefined;
+                        revision?: string | undefined;
+                        locator?: string | undefined;
+                        sensitivity?: string | undefined;
+                    };
+                    about?: string | undefined;
+                } | ({
+                    text: string;
+                    source: {
+                        class: string;
+                        observedAt: string;
+                        id?: string | undefined;
+                        manual?: true | undefined;
+                        suppliedBy?: string | undefined;
+                        by?: string | undefined;
+                        stamped?: true | undefined;
+                        revision?: string | undefined;
+                        locator?: string | undefined;
+                        sensitivity?: string | undefined;
+                    };
+                    about?: string | undefined;
+                } | {
+                    value: string | number | boolean;
+                    source: {
+                        class: string;
+                        observedAt: string;
+                        excerpt?: string | undefined;
+                        id?: string | undefined;
+                        manual?: true | undefined;
+                        suppliedBy?: string | undefined;
+                        by?: string | undefined;
+                        stamped?: true | undefined;
+                        revision?: string | undefined;
+                        locator?: string | undefined;
+                        sensitivity?: string | undefined;
+                    };
+                    about?: string | undefined;
+                })[]>;
+                related?: Record<string, string | string[]> | undefined;
+                identity?: Record<string, string> | undefined;
+            } | null;
+            exampleNote: string;
+        };
+        limits: {
+            maxEvidenceItems: number;
+            maxPassages: number;
+            facts: {
+                maxExcerptCharacters: 2000;
+                maxExcerptsPerQuestion: 3;
+                maxFactsBytes: 524288;
+                maxQuestions: 64;
+            };
+        };
+        purpose?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        } | undefined;
+        useWhen?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        }[] | undefined;
+        notFor?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        }[] | undefined;
+        owner?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        } | undefined;
+        subject?: {
+            type: string;
+            definition: {
+                text: string;
+                source: {
+                    sourceId: string;
+                    revision: string;
+                    locator: string;
+                    contentDigest: string;
+                };
+                parts: {
+                    locator: string;
+                    text: string;
+                }[];
+            };
+            match: "exact" | "case-insensitive";
+            related: {
+                identifier: string;
+                example: string;
+                match: "exact" | "case-insensitive";
+                relationship: string;
+                meaning: {
+                    text: string;
+                    source: {
+                        sourceId: string;
+                        revision: string;
+                        locator: string;
+                        contentDigest: string;
+                    };
+                    parts: {
+                        locator: string;
+                        text: string;
+                    }[];
+                };
+                cardinality: "one" | "many";
+                required: boolean;
+                subject: string;
+                definition: {
+                    text: string;
+                    source: {
+                        sourceId: string;
+                        revision: string;
+                        locator: string;
+                        contentDigest: string;
+                    };
+                    parts: {
+                        locator: string;
+                        text: string;
+                    }[];
+                };
+            }[];
+            send: string;
+            identifier?: string | undefined;
+            example?: string | undefined;
+        } | undefined;
+        identity?: {
+            mode: "provided" | "fields" | "content" | "issued";
+            send: string;
+            fields?: {
+                identifier: string;
+                example: string;
+                match: "exact" | "case-insensitive";
+                name: string;
+            }[] | undefined;
+            question?: string | undefined;
+        } | undefined;
+        manualFacts?: {
+            allowed: false;
+            quote: string;
+        } | undefined;
+        escalations?: {
+            routes: {
+                id: string;
+                quote: {
+                    text: string;
+                    source: {
+                        sourceId: string;
+                        revision: string;
+                        locator: string;
+                        contentDigest: string;
+                    };
+                    parts: {
+                        locator: string;
+                        text: string;
+                    }[];
+                };
+            }[];
+            unresolved: string | null;
+            attemptLimit: string | null;
+            rule: string;
+        } | undefined;
+        whenUnresolved?: {
+            text: string;
+            source: {
+                sourceId: string;
+                revision: string;
+                locator: string;
+                contentDigest: string;
+            };
+            parts: {
+                locator: string;
+                text: string;
+            }[];
+        } | null | undefined;
+        attempts?: {
+            max: number;
+            withProgress: number;
+            rule: string;
+        } | undefined;
+    }>;
     resolveJob: (id: string, value: unknown) => Promise<FelsparJobResult>;
     executeJob: (id: string, value: unknown) => Promise<{
         status: string;
@@ -1126,6 +1665,7 @@ export declare function createHostedFelsparClient(configuration: {
                         scope: {
                             entityId: string;
                             evaluationTime: string;
+                            valueAgreement?: "outcome-regions" | undefined;
                         };
                         expected: {
                             status: "review_required" | "blocked" | "ready" | "gap" | "conflict" | "stale";
@@ -1148,11 +1688,14 @@ export declare function createHostedFelsparClient(configuration: {
                         facts: {
                             key: string;
                             value: string | number | boolean;
+                            held?: "stale" | "review" | undefined;
+                            conflictsWith?: string | number | boolean | undefined;
                         }[];
                         id: string;
                         scope: {
                             entityId: string;
                             evaluationTime: string;
+                            valueAgreement?: "outcome-regions" | undefined;
                         };
                         expected: {
                             status: "review_required" | "blocked" | "ready" | "gap" | "conflict" | "stale";
@@ -1500,6 +2043,7 @@ export declare function createHostedFelsparClient(configuration: {
                         scope: {
                             entityId: string;
                             evaluationTime: string;
+                            valueAgreement?: "outcome-regions" | undefined;
                         };
                         trustDomain: string;
                         expectedArtifactDigest: string;
@@ -1604,6 +2148,7 @@ export declare function createHostedFelsparClient(configuration: {
                             scope: {
                                 entityId: string;
                                 evaluationTime: string;
+                                valueAgreement?: "outcome-regions" | undefined;
                             };
                             expected: {
                                 status: "review_required" | "blocked" | "ready" | "gap" | "conflict" | "stale";
@@ -1626,11 +2171,14 @@ export declare function createHostedFelsparClient(configuration: {
                             facts: {
                                 key: string;
                                 value: string | number | boolean;
+                                held?: "stale" | "review" | undefined;
+                                conflictsWith?: string | number | boolean | undefined;
                             }[];
                             id: string;
                             scope: {
                                 entityId: string;
                                 evaluationTime: string;
+                                valueAgreement?: "outcome-regions" | undefined;
                             };
                             expected: {
                                 status: "review_required" | "blocked" | "ready" | "gap" | "conflict" | "stale";
@@ -2533,6 +3081,7 @@ export declare function createHostedFelsparClient(configuration: {
                         scope: {
                             entityId: string;
                             evaluationTime: string;
+                            valueAgreement?: "outcome-regions" | undefined;
                         };
                         trustDomain: string;
                         expectedArtifactDigest: string;
@@ -2637,6 +3186,7 @@ export declare function createHostedFelsparClient(configuration: {
                             scope: {
                                 entityId: string;
                                 evaluationTime: string;
+                                valueAgreement?: "outcome-regions" | undefined;
                             };
                             expected: {
                                 status: "review_required" | "blocked" | "ready" | "gap" | "conflict" | "stale";
@@ -2659,11 +3209,14 @@ export declare function createHostedFelsparClient(configuration: {
                             facts: {
                                 key: string;
                                 value: string | number | boolean;
+                                held?: "stale" | "review" | undefined;
+                                conflictsWith?: string | number | boolean | undefined;
                             }[];
                             id: string;
                             scope: {
                                 entityId: string;
                                 evaluationTime: string;
+                                valueAgreement?: "outcome-regions" | undefined;
                             };
                             expected: {
                                 status: "review_required" | "blocked" | "ready" | "gap" | "conflict" | "stale";
@@ -3242,6 +3795,18 @@ export declare function createHostedFelsparClient(configuration: {
             policyDigest: string;
             fixtureSuiteDigest: string;
         } | undefined;
+        calibration?: {
+            savedResultId: string;
+            calibrationDigest: string;
+            questions: string[];
+            acceptedBy: string;
+            approvedMaterialDigest: string;
+            bars: {
+                question: string;
+                bar: number;
+                calibrationDigest: string;
+            }[];
+        } | undefined;
     }>;
     describeJob: (id: string, job: string) => Promise<{
         schema: "felspar.hosted-job-description.draft/v0";
@@ -3309,7 +3874,7 @@ export declare function createHostedFelsparClient(configuration: {
             answer: {
                 send: "text" | "text_or_value";
                 valueFormat: "number" | "calendar-date" | null;
-                interpretation: "classified" | "exact_read" | "unsupported";
+                interpretation: "unsupported" | "classified" | "exact_read";
                 threshold: number | null;
                 applies: "always" | "conditional";
                 dependsOn: string[];
@@ -3545,37 +4110,65 @@ export declare function createHostedFelsparClient(configuration: {
                     text: string;
                     source: {
                         class: string;
-                        id: string;
                         observedAt: string;
+                        id?: string | undefined;
+                        manual?: true | undefined;
+                        suppliedBy?: string | undefined;
+                        by?: string | undefined;
+                        stamped?: true | undefined;
                         revision?: string | undefined;
                         locator?: string | undefined;
                         sensitivity?: string | undefined;
                     };
                     about?: string | undefined;
                 } | {
+                    value: string | number | boolean;
+                    source: {
+                        class: string;
+                        observedAt: string;
+                        excerpt?: string | undefined;
+                        id?: string | undefined;
+                        manual?: true | undefined;
+                        suppliedBy?: string | undefined;
+                        by?: string | undefined;
+                        stamped?: true | undefined;
+                        revision?: string | undefined;
+                        locator?: string | undefined;
+                        sensitivity?: string | undefined;
+                    };
+                    about?: string | undefined;
+                } | ({
                     text: string;
                     source: {
                         class: string;
-                        id: string;
                         observedAt: string;
+                        id?: string | undefined;
+                        manual?: true | undefined;
+                        suppliedBy?: string | undefined;
+                        by?: string | undefined;
+                        stamped?: true | undefined;
                         revision?: string | undefined;
                         locator?: string | undefined;
                         sensitivity?: string | undefined;
                     };
                     about?: string | undefined;
-                }[] | {
+                } | {
                     value: string | number | boolean;
                     source: {
                         class: string;
-                        id: string;
                         observedAt: string;
+                        excerpt?: string | undefined;
+                        id?: string | undefined;
+                        manual?: true | undefined;
+                        suppliedBy?: string | undefined;
+                        by?: string | undefined;
+                        stamped?: true | undefined;
                         revision?: string | undefined;
                         locator?: string | undefined;
                         sensitivity?: string | undefined;
-                        excerpt?: string | undefined;
                     };
                     about?: string | undefined;
-                }>;
+                })[]>;
                 related?: Record<string, string | string[]> | undefined;
                 identity?: Record<string, string> | undefined;
             } | null;
@@ -3709,6 +4302,10 @@ export declare function createHostedFelsparClient(configuration: {
             }[] | undefined;
             question?: string | undefined;
         } | undefined;
+        manualFacts?: {
+            allowed: false;
+            quote: string;
+        } | undefined;
         escalations?: {
             routes: {
                 id: string;
@@ -3775,6 +4372,32 @@ export declare function createHostedFelsparClient(configuration: {
                 id: string;
                 trigger: "outcome" | "unresolved" | "attempt_limit";
             } | undefined;
+            manualFacts?: {
+                question: string;
+                excerpt: number;
+                via: {
+                    principal: string;
+                    agent: {
+                        name: string;
+                        accountable: string;
+                    } | null;
+                };
+                observedAt: string;
+                stampedByFelspar: boolean;
+                suppliedBy?: {
+                    text: string;
+                    verified: false;
+                } | undefined;
+            }[] | undefined;
+            caseRecord?: {
+                rule: "whole-case";
+                attempt: number;
+                attempts: {
+                    executionId: string;
+                    added: string[];
+                    considered: boolean;
+                }[];
+            } | undefined;
         } | undefined;
     }>;
 };