vellum-ai 0.0.2

package/api/types/NormalizedLogProbs.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/NormalizedTokenLogProbs.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface NormalizedTokenLogProbs {
+    token: string;
+    logprob: number;
+    topLogprobs: Record<string, number>;
+    textOffset: number;
+}

package/api/types/NormalizedTokenLogProbs.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PaginatedSlimDocumentList.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface PaginatedSlimDocumentList {
+    count?: number;
+    next?: string;
+    previous?: string;
+    results?: Vellum.SlimDocument[];
+}

package/api/types/PaginatedSlimDocumentList.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProcessingStateEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ProcessingStateEnum = "QUEUED" | "PROCESSING" | "PROCESSED" | "FAILED";
+export declare const ProcessingStateEnum: {
+    readonly Queued: "QUEUED";
+    readonly Processing: "PROCESSING";
+    readonly Processed: "PROCESSED";
+    readonly Failed: "FAILED";
+};

package/api/types/ProcessingStateEnum.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessingStateEnum = void 0;
+exports.ProcessingStateEnum = {
+    Queued: "QUEUED",
+    Processing: "PROCESSING",
+    Processed: "PROCESSED",
+    Failed: "FAILED",
+};

package/api/types/PromptTemplateBlock.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface PromptTemplateBlock {
+    blockType: Vellum.BlockTypeEnum;
+    properties: Vellum.PromptTemplateBlockProperties;
+}

package/api/types/PromptTemplateBlock.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PromptTemplateBlockData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface PromptTemplateBlockData {
+    version: number;
+    blocks: Vellum.PromptTemplateBlock[];
+}

package/api/types/PromptTemplateBlockData.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PromptTemplateBlockProperties.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface PromptTemplateBlockProperties {
+    chatRole?: Vellum.ChatRoleEnum;
+    text?: string;
+    variableName?: string;
+    blocks?: Record<string, unknown>[];
+}

package/api/types/PromptTemplateBlockProperties.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ProviderEnum.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ProviderEnum = "ANTHROPIC" | "COHERE" | "GOOGLE" | "HOSTED" | "OPENAI" | "PYQ";
+export declare const ProviderEnum: {
+    readonly Anthropic: "ANTHROPIC";
+    readonly Cohere: "COHERE";
+    readonly Google: "GOOGLE";
+    readonly Hosted: "HOSTED";
+    readonly Openai: "OPENAI";
+    readonly Pyq: "PYQ";
+};

package/api/types/ProviderEnum.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProviderEnum = void 0;
+exports.ProviderEnum = {
+    Anthropic: "ANTHROPIC",
+    Cohere: "COHERE",
+    Google: "GOOGLE",
+    Hosted: "HOSTED",
+    Openai: "OPENAI",
+    Pyq: "PYQ",
+};

package/api/types/SearchErrorResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SearchErrorResponse {
+    /** Details about why the request failed. */
+    detail: string;
+}

package/api/types/SearchErrorResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SearchFiltersRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SearchFiltersRequest {
+    /** The document external IDs to filter by */
+    externalIds?: string[];
+}

package/api/types/SearchFiltersRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SearchRequestOptionsRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface SearchRequestOptionsRequest {
+    /** The maximum number of results to return. */
+    limit?: number;
+    /** The weights to use for the search. Must add up to 1.0. */
+    weights?: Vellum.SearchWeightsRequest;
+    /** The configuration for merging results. */
+    resultMerging?: Vellum.SearchResultMergingRequest;
+    /** The filters to apply to the search. */
+    filters?: Vellum.SearchFiltersRequest;
+}

package/api/types/SearchRequestOptionsRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SearchResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface SearchResponse {
+    /** The results of the search. Each result represents a chunk that matches the search query. */
+    results: Vellum.SearchResult[];
+}

package/api/types/SearchResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SearchResult.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface SearchResult {
+    /** The document that contains the chunk that matched the search query. */
+    document: Vellum.Document;
+    /** The text of the chunk that matched the search query. */
+    text: string;
+    keywords: string[];
+    /** A score representing how well the chunk matches the search query. */
+    score: number;
+}

package/api/types/SearchResult.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SearchResultMergingRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SearchResultMergingRequest {
+    /** Whether to enable merging results */
+    enabled: boolean;
+}

package/api/types/SearchResultMergingRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SearchWeightsRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SearchWeightsRequest {
+    /** The relative weight to give to semantic similarity */
+    semanticSimilarity: number;
+    /** The relative weight to give to keyword matches */
+    keywords: number;
+}

package/api/types/SearchWeightsRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SlimDocument.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface SlimDocument {
+    /** Vellum-generated ID that uniquely identifies this document. */
+    id: string;
+    /** The external ID that was originally provided when uploading the document. */
+    externalId?: string;
+    /** A timestamp representing when this document was most recently uploaded. */
+    lastUploadedAt: string;
+    /** Human-friendly name for this document. */
+    label: string;
+    /** The current processing state of the document */
+    processingState?: Vellum.ProcessingStateEnum;
+    /** The document's current status. */
+    status?: Vellum.SlimDocumentStatusEnum;
+    /** A list of keywords associated with this document. Originally provided when uploading the document. */
+    keywords?: string[];
+    documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
+}

package/api/types/SlimDocument.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SlimDocumentStatusEnum.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type SlimDocumentStatusEnum = "ACTIVE";
+export declare const SlimDocumentStatusEnum: {
+    readonly Active: "ACTIVE";
+};

package/api/types/SlimDocumentStatusEnum.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SlimDocumentStatusEnum = void 0;
+exports.SlimDocumentStatusEnum = {
+    Active: "ACTIVE",
+};

package/api/types/SubmitCompletionActualRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SubmitCompletionActualRequest {
+    /** The Vellum-generated ID of a previously generated completion. Must provide either this or external_id. */
+    id?: string;
+    /** The external ID that was originally provided when generating the completion that you'd now like to submit actuals for. Must provide either this or id. */
+    externalId?: string;
+    /** Text representing what the completion _should_ have been. */
+    text?: string;
+    /** A number between 0 and 1 representing the quality of the completion. 0 is the worst, 1 is the best. */
+    quality?: number;
+    /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
+    timestamp?: string;
+}

package/api/types/SubmitCompletionActualRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SubmitCompletionActualsErrorResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SubmitCompletionActualsErrorResponse {
+    detail: string;
+}

package/api/types/SubmitCompletionActualsErrorResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/UploadDocumentErrorResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UploadDocumentErrorResponse {
+    detail: string;
+}

package/api/types/UploadDocumentErrorResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/UploadDocumentResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UploadDocumentResponse {
+    /** The ID of the newly created document. */
+    documentId: string;
+}

package/api/types/UploadDocumentResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/index.d.ts

@@ -0,0 +1,43 @@
+export * from "./BlockTypeEnum";
+export * from "./ChatRoleEnum";
+export * from "./Document";
+export * from "./DocumentDocumentToDocumentIndex";
+export * from "./EnrichedNormalizedCompletion";
+export * from "./FinishReasonEnum";
+export * from "./GenerateErrorResponse";
+export * from "./GenerateOptionsRequest";
+export * from "./GenerateRequestRequest";
+export * from "./GenerateResponse";
+export * from "./GenerateResult";
+export * from "./GenerateResultData";
+export * from "./GenerateResultError";
+export * from "./IndexingStateEnum";
+export * from "./LogprobsEnum";
+export * from "./ModelTypeEnum";
+export * from "./ModelVersionBuildConfig";
+export * from "./ModelVersionExecConfigParameters";
+export * from "./ModelVersionExecConfigRead";
+export * from "./ModelVersionRead";
+export * from "./ModelVersionReadStatusEnum";
+export * from "./ModelVersionSandboxSnapshot";
+export * from "./NormalizedLogProbs";
+export * from "./NormalizedTokenLogProbs";
+export * from "./PaginatedSlimDocumentList";
+export * from "./ProcessingStateEnum";
+export * from "./PromptTemplateBlock";
+export * from "./PromptTemplateBlockData";
+export * from "./PromptTemplateBlockProperties";
+export * from "./ProviderEnum";
+export * from "./SearchErrorResponse";
+export * from "./SearchFiltersRequest";
+export * from "./SearchRequestOptionsRequest";
+export * from "./SearchResponse";
+export * from "./SearchResult";
+export * from "./SearchResultMergingRequest";
+export * from "./SearchWeightsRequest";
+export * from "./SlimDocument";
+export * from "./SlimDocumentStatusEnum";
+export * from "./SubmitCompletionActualRequest";
+export * from "./SubmitCompletionActualsErrorResponse";
+export * from "./UploadDocumentErrorResponse";
+export * from "./UploadDocumentResponse";

package/api/types/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BlockTypeEnum"), exports);
+__exportStar(require("./ChatRoleEnum"), exports);
+__exportStar(require("./Document"), exports);
+__exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
+__exportStar(require("./EnrichedNormalizedCompletion"), exports);
+__exportStar(require("./FinishReasonEnum"), exports);
+__exportStar(require("./GenerateErrorResponse"), exports);
+__exportStar(require("./GenerateOptionsRequest"), exports);
+__exportStar(require("./GenerateRequestRequest"), exports);
+__exportStar(require("./GenerateResponse"), exports);
+__exportStar(require("./GenerateResult"), exports);
+__exportStar(require("./GenerateResultData"), exports);
+__exportStar(require("./GenerateResultError"), exports);
+__exportStar(require("./IndexingStateEnum"), exports);
+__exportStar(require("./LogprobsEnum"), exports);
+__exportStar(require("./ModelTypeEnum"), exports);
+__exportStar(require("./ModelVersionBuildConfig"), exports);
+__exportStar(require("./ModelVersionExecConfigParameters"), exports);
+__exportStar(require("./ModelVersionExecConfigRead"), exports);
+__exportStar(require("./ModelVersionRead"), exports);
+__exportStar(require("./ModelVersionReadStatusEnum"), exports);
+__exportStar(require("./ModelVersionSandboxSnapshot"), exports);
+__exportStar(require("./NormalizedLogProbs"), exports);
+__exportStar(require("./NormalizedTokenLogProbs"), exports);
+__exportStar(require("./PaginatedSlimDocumentList"), exports);
+__exportStar(require("./ProcessingStateEnum"), exports);
+__exportStar(require("./PromptTemplateBlock"), exports);
+__exportStar(require("./PromptTemplateBlockData"), exports);
+__exportStar(require("./PromptTemplateBlockProperties"), exports);
+__exportStar(require("./ProviderEnum"), exports);
+__exportStar(require("./SearchErrorResponse"), exports);
+__exportStar(require("./SearchFiltersRequest"), exports);
+__exportStar(require("./SearchRequestOptionsRequest"), exports);
+__exportStar(require("./SearchResponse"), exports);
+__exportStar(require("./SearchResult"), exports);
+__exportStar(require("./SearchResultMergingRequest"), exports);
+__exportStar(require("./SearchWeightsRequest"), exports);
+__exportStar(require("./SlimDocument"), exports);
+__exportStar(require("./SlimDocumentStatusEnum"), exports);
+__exportStar(require("./SubmitCompletionActualRequest"), exports);
+__exportStar(require("./SubmitCompletionActualsErrorResponse"), exports);
+__exportStar(require("./UploadDocumentErrorResponse"), exports);
+__exportStar(require("./UploadDocumentResponse"), exports);

package/core/fetcher/APIResponse.d.ts

@@ -0,0 +1,9 @@
+export declare type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+}

package/core/fetcher/APIResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/core/fetcher/Fetcher.d.ts

@@ -0,0 +1,36 @@
+import URLSearchParams from "@ungap/url-search-params";
+import { AxiosAdapter } from "axios";
+import { APIResponse } from "./APIResponse";
+export declare type FetchFunction = (args: Fetcher.Args) => Promise<APIResponse<unknown, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | undefined>;
+        queryParameters?: URLSearchParams;
+        body?: unknown;
+        timeoutMs?: number;
+        withCredentials?: boolean;
+        adapter?: AxiosAdapter;
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare const fetcher: FetchFunction;

package/core/fetcher/Fetcher.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetcher = void 0;
+const axios_1 = __importDefault(require("axios"));
+const fetcher = async (args) => {
+    const headers = {};
+    if (args.body !== undefined && args.contentType != null) {
+        headers["Content-Type"] = args.contentType;
+    }
+    if (args.headers != null) {
+        for (const [key, value] of Object.entries(args.headers)) {
+            if (value != null) {
+                headers[key] = value;
+            }
+        }
+    }
+    try {
+        const response = await (0, axios_1.default)({
+            url: args.url,
+            params: args.queryParameters,
+            method: args.method,
+            headers,
+            data: args.body,
+            validateStatus: () => true,
+            transformResponse: (response) => response,
+            timeout: args.timeoutMs ?? 60_000,
+            transitional: {
+                clarifyTimeoutError: true,
+            },
+            withCredentials: args.withCredentials,
+            adapter: args.adapter,
+        });
+        let body;
+        if (response.data != null && response.data.length > 0) {
+            try {
+                body = JSON.parse(response.data) ?? undefined;
+            }
+            catch {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "non-json",
+                        statusCode: response.status,
+                        rawBody: response.data,
+                    },
+                };
+            }
+        }
+        if (response.status >= 200 && response.status < 300) {
+            return {
+                ok: true,
+                body,
+            };
+        }
+        else {
+            return {
+                ok: false,
+                error: {
+                    reason: "status-code",
+                    statusCode: response.status,
+                    body,
+                },
+            };
+        }
+    }
+    catch (error) {
+        if (error.code === "ETIMEDOUT") {
+            return {
+                ok: false,
+                error: {
+                    reason: "timeout",
+                },
+            };
+        }
+        return {
+            ok: false,
+            error: {
+                reason: "unknown",
+                errorMessage: error.message,
+            },
+        };
+    }
+};
+exports.fetcher = fetcher;

package/core/fetcher/Supplier.d.ts

@@ -0,0 +1,4 @@
+export declare type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);
+export declare const Supplier: {
+    get: <T>(supplier: Supplier<T>) => Promise<T>;
+};