vellum-ai 0.0.2

package/dist/api/resources/modelVersions/client/Client.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelVersions = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const url_join_1 = __importDefault(require("url-join"));
+const serializers = __importStar(require("../../../../serialization"));
+const errors = __importStar(require("../../../../errors"));
+class ModelVersions {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    async retrieve(id) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/model-versions/${id}`),
+            method: "GET",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+        });
+        if (_response.ok) {
+            return await serializers.ModelVersionRead.parseOrThrow(_response.body, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            });
+        }
+        if (_response.error.reason === "status-code") {
+            throw new errors.VellumError({
+                statusCode: _response.error.statusCode,
+                body: _response.error.body,
+            });
+        }
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.VellumError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                });
+            case "timeout":
+                throw new errors.VellumTimeoutError();
+            case "unknown":
+                throw new errors.VellumError({
+                    message: _response.error.errorMessage,
+                });
+        }
+    }
+}
+exports.ModelVersions = ModelVersions;

package/dist/api/resources/modelVersions/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api/resources/modelVersions/client/index.js

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

package/dist/api/resources/modelVersions/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/dist/api/resources/modelVersions/index.js

@@ -0,0 +1,17 @@
+"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("./client"), exports);

package/dist/api/types/BlockTypeEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type BlockTypeEnum = "CHAT_MESSAGE" | "CHAT_HISTORY" | "TEXT" | "VARIABLE";
+export declare const BlockTypeEnum: {
+    readonly ChatMessage: "CHAT_MESSAGE";
+    readonly ChatHistory: "CHAT_HISTORY";
+    readonly Text: "TEXT";
+    readonly Variable: "VARIABLE";
+};

package/dist/api/types/BlockTypeEnum.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.BlockTypeEnum = void 0;
+exports.BlockTypeEnum = {
+    ChatMessage: "CHAT_MESSAGE",
+    ChatHistory: "CHAT_HISTORY",
+    Text: "TEXT",
+    Variable: "VARIABLE",
+};

package/dist/api/types/ChatRoleEnum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ChatRoleEnum = "SYSTEM" | "ASSISTANT" | "USER";
+export declare const ChatRoleEnum: {
+    readonly System: "SYSTEM";
+    readonly Assistant: "ASSISTANT";
+    readonly User: "USER";
+};

package/dist/api/types/ChatRoleEnum.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatRoleEnum = void 0;
+exports.ChatRoleEnum = {
+    System: "SYSTEM",
+    Assistant: "ASSISTANT",
+    User: "USER",
+};

package/dist/api/types/Document.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Document {
+    /** The ID of the document. */
+    id: string;
+    /** The human-readable name for the document. */
+    label: string;
+    /** The unique ID of the document as represented in an external system and specified when it was originally uploaded. */
+    externalId?: string;
+}

package/dist/api/types/Document.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/dist/api/types/DocumentDocumentToDocumentIndex.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface DocumentDocumentToDocumentIndex {
+    /** Vellum-generated ID that uniquely identifies this link. */
+    id: string;
+    /** Vellum-generated ID that uniquely identifies the index this document is included in. */
+    documentIndexId: string;
+    /** An enum value representing where this document is along its indexing lifecycle for this index. */
+    indexingState?: Vellum.IndexingStateEnum;
+}

package/dist/api/types/DocumentDocumentToDocumentIndex.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/dist/api/types/EnrichedNormalizedCompletion.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface EnrichedNormalizedCompletion {
+    /** The Vellum-generated ID of the completion. */
+    id: string;
+    /** The external ID that was originally provided along with the generation request, which uniquely identifies this generation in an external system. */
+    externalId?: string;
+    /** The text generated by the LLM. */
+    text: string;
+    /** The reason the generation finished. */
+    finishReason: Vellum.FinishReasonEnum;
+    /** The logprobs of the completion. Only present if specified in the original request options. */
+    logprobs?: Vellum.NormalizedLogProbs;
+    /** The ID of the model version used to generate this completion. */
+    modelVersionId: string;
+}

package/dist/api/types/EnrichedNormalizedCompletion.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/dist/api/types/FinishReasonEnum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type FinishReasonEnum = "LENGTH" | "STOP" | "UNKNOWN";
+export declare const FinishReasonEnum: {
+    readonly Length: "LENGTH";
+    readonly Stop: "STOP";
+    readonly Unknown: "UNKNOWN";
+};

package/dist/api/types/FinishReasonEnum.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FinishReasonEnum = void 0;
+exports.FinishReasonEnum = {
+    Length: "LENGTH",
+    Stop: "STOP",
+    Unknown: "UNKNOWN",
+};

package/dist/api/types/GenerateErrorResponse.d.ts

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

package/dist/api/types/GenerateErrorResponse.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/dist/api/types/GenerateOptionsRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface GenerateOptionsRequest {
+    /** Which logprobs to include, if any. Defaults to NONE. */
+    logprobs?: Vellum.LogprobsEnum;
+}

package/dist/api/types/GenerateOptionsRequest.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/dist/api/types/GenerateRequestRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface GenerateRequestRequest {
+    /** Key/value pairs for each template variable defined in the deployment's prompt. */
+    inputValues: Record<string, unknown>;
+    /** Optionally include a unique identifier for each generation, as represented outside of Vellum. Note that this should generally be a list of length one. */
+    externalIds?: string[];
+}

package/dist/api/types/GenerateRequestRequest.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/dist/api/types/GenerateResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface GenerateResponse {
+    /** The results of each generation request. */
+    results: Vellum.GenerateResult[];
+}

package/dist/api/types/GenerateResponse.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/dist/api/types/GenerateResult.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface GenerateResult {
+    /** An object containing the resulting generation. This key will be absent if the LLM provider experienced an error. */
+    data?: Vellum.GenerateResultData;
+    /** An object containing details about the error that occurred. This key will be absent if the LLM provider did not experience an error. */
+    error?: Vellum.GenerateResultError;
+}

package/dist/api/types/GenerateResult.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/dist/api/types/GenerateResultData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface GenerateResultData {
+    /** The generated completions. This will generally be a list of length one. */
+    completions: Vellum.EnrichedNormalizedCompletion[];
+}

package/dist/api/types/GenerateResultData.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/dist/api/types/GenerateResultError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface GenerateResultError {
+    /** The error message returned by the LLM provider. */
+    message: string;
+}

package/dist/api/types/GenerateResultError.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/dist/api/types/IndexingStateEnum.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type IndexingStateEnum = "AWAITING_PROCESSING" | "QUEUED" | "INDEXING" | "INDEXED" | "FAILED";
+export declare const IndexingStateEnum: {
+    readonly AwaitingProcessing: "AWAITING_PROCESSING";
+    readonly Queued: "QUEUED";
+    readonly Indexing: "INDEXING";
+    readonly Indexed: "INDEXED";
+    readonly Failed: "FAILED";
+};

package/dist/api/types/IndexingStateEnum.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IndexingStateEnum = void 0;
+exports.IndexingStateEnum = {
+    AwaitingProcessing: "AWAITING_PROCESSING",
+    Queued: "QUEUED",
+    Indexing: "INDEXING",
+    Indexed: "INDEXED",
+    Failed: "FAILED",
+};

package/dist/api/types/LogprobsEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type LogprobsEnum = "ALL" | "NONE";
+export declare const LogprobsEnum: {
+    readonly All: "ALL";
+    readonly None: "NONE";
+};

package/dist/api/types/LogprobsEnum.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogprobsEnum = void 0;
+exports.LogprobsEnum = {
+    All: "ALL",
+    None: "NONE",
+};

package/dist/api/types/ModelTypeEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ModelTypeEnum = "GENERATE" | "CLASSIFY";
+export declare const ModelTypeEnum: {
+    readonly Generate: "GENERATE";
+    readonly Classify: "CLASSIFY";
+};

package/dist/api/types/ModelTypeEnum.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelTypeEnum = void 0;
+exports.ModelTypeEnum = {
+    Generate: "GENERATE",
+    Classify: "CLASSIFY",
+};

package/dist/api/types/ModelVersionBuildConfig.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface ModelVersionBuildConfig {
+    /** The name of the base model used to create this model version, as identified by the LLM provider. */
+    baseModel: string;
+    /** Information about the sandbox snapshot that was used to create this model version, if applicable. */
+    sandboxSnapshot?: Vellum.ModelVersionSandboxSnapshot;
+}

package/dist/api/types/ModelVersionBuildConfig.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/dist/api/types/ModelVersionExecConfigParameters.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ModelVersionExecConfigParameters {
+    temperature: number;
+    maxTokens: number;
+    stop: string[];
+    topP: number;
+    topK?: number;
+    frequencyPenalty: number;
+    presencePenalty: number;
+    logitBias?: Record<string, number | undefined>;
+}

package/dist/api/types/ModelVersionExecConfigParameters.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/dist/api/types/ModelVersionExecConfigRead.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface ModelVersionExecConfigRead {
+    /** The generation parameters that are passed to the LLM provider at runtime. */
+    parameters: Vellum.ModelVersionExecConfigParameters;
+    /** Names of the template variables specified in the prompt template. */
+    inputVariables: string[];
+    /** The template used to generate prompts for this model version. */
+    promptTemplate: string;
+    promptBlockData?: Vellum.PromptTemplateBlockData;
+}

package/dist/api/types/ModelVersionExecConfigRead.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/dist/api/types/ModelVersionRead.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Vellum } from "../..";
+export interface ModelVersionRead {
+    /** Vellum-generated ID that uniquely identifies this model version. */
+    id: string;
+    /** Timestamp of when this model version was created. */
+    created: string;
+    /** Human-friendly name for this model version. */
+    label: string;
+    /** The type of task this model is used for. */
+    modelType: Vellum.ModelTypeEnum;
+    /** Which LLM provider this model version is associated with. */
+    provider: Vellum.ProviderEnum;
+    /** The unique id of this model version as it exists in the above provider's system. */
+    externalId: string;
+    /** Configuration used to build this model version. */
+    buildConfig: Vellum.ModelVersionBuildConfig;
+    /** Configuration used to execute this model version. */
+    execConfig: Vellum.ModelVersionExecConfigRead;
+    status?: Vellum.ModelVersionReadStatusEnum;
+}

package/dist/api/types/ModelVersionRead.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/dist/api/types/ModelVersionReadStatusEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ModelVersionReadStatusEnum = "CREATING" | "READY" | "CREATION_FAILED" | "DISABLED";
+export declare const ModelVersionReadStatusEnum: {
+    readonly Creating: "CREATING";
+    readonly Ready: "READY";
+    readonly CreationFailed: "CREATION_FAILED";
+    readonly Disabled: "DISABLED";
+};

package/dist/api/types/ModelVersionReadStatusEnum.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.ModelVersionReadStatusEnum = void 0;
+exports.ModelVersionReadStatusEnum = {
+    Creating: "CREATING",
+    Ready: "READY",
+    CreationFailed: "CREATION_FAILED",
+    Disabled: "DISABLED",
+};

package/dist/api/types/ModelVersionSandboxSnapshot.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ModelVersionSandboxSnapshot {
+    /** The ID of the sandbox snapshot. */
+    id: string;
+    /** The index of the prompt in the sandbox snapshot. */
+    promptIndex: number;
+}

package/dist/api/types/ModelVersionSandboxSnapshot.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/dist/api/types/NormalizedLogProbs.d.ts

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

package/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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";
+};