vellum-ai 0.0.45 → 0.1.1

package/core/schemas/utils/createIdentitySchemaCreator.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createIdentitySchemaCreator = void 0;
 const schema_utils_1 = require("../builders/schema-utils");
+const maybeSkipValidation_1 = require("./maybeSkipValidation");
 function createIdentitySchemaCreator(schemaType, validate) {
     return () => {
         const baseSchema = {
@@ -9,10 +10,7 @@ function createIdentitySchemaCreator(schemaType, validate) {
             json: validate,
             getType: () => schemaType,
         };
-        return {
-            ...baseSchema,
-            ...(0, schema_utils_1.getSchemaUtils)(baseSchema),
-        };
+        return Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema));
     };
 }
 exports.createIdentitySchemaCreator = createIdentitySchemaCreator;

package/core/schemas/utils/getErrorMessageForIncorrectType.d.ts

@@ -0,0 +1 @@
+export declare function getErrorMessageForIncorrectType(value: unknown, expectedType: string): string;

package/core/schemas/utils/getErrorMessageForIncorrectType.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorMessageForIncorrectType = void 0;
+function getErrorMessageForIncorrectType(value, expectedType) {
+    return `Expected ${expectedType}. Received ${getTypeAsString(value)}.`;
+}
+exports.getErrorMessageForIncorrectType = getErrorMessageForIncorrectType;
+function getTypeAsString(value) {
+    if (Array.isArray(value)) {
+        return "list";
+    }
+    if (value === null) {
+        return "null";
+    }
+    switch (typeof value) {
+        case "string":
+            return `"${value}"`;
+        case "number":
+        case "boolean":
+        case "undefined":
+            return `${value}`;
+    }
+    return typeof value;
+}

package/core/schemas/utils/isPlainObject.d.ts

@@ -1,2 +1 @@
-export declare const NOT_AN_OBJECT_ERROR_MESSAGE = "Not an object";
 export declare function isPlainObject(value: unknown): value is Record<string, unknown>;

package/core/schemas/utils/isPlainObject.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPlainObject = exports.NOT_AN_OBJECT_ERROR_MESSAGE = void 0;
-exports.NOT_AN_OBJECT_ERROR_MESSAGE = "Not an object";
+exports.isPlainObject = void 0;
 // borrowed from https://github.com/lodash/lodash/blob/master/isPlainObject.js
 function isPlainObject(value) {
     if (typeof value !== "object" || value === null) {

package/core/schemas/utils/maybeSkipValidation.d.ts

@@ -0,0 +1,2 @@
+import { BaseSchema } from "../Schema";
+export declare function maybeSkipValidation<S extends BaseSchema<Raw, Parsed>, Raw, Parsed>(schema: S): S;

package/core/schemas/utils/maybeSkipValidation.js

@@ -0,0 +1,37 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maybeSkipValidation = void 0;
+function maybeSkipValidation(schema) {
+    return Object.assign(Object.assign({}, schema), { json: transformAndMaybeSkipValidation(schema.json), parse: transformAndMaybeSkipValidation(schema.parse) });
+}
+exports.maybeSkipValidation = maybeSkipValidation;
+function transformAndMaybeSkipValidation(transform) {
+    return (value, opts) => __awaiter(this, void 0, void 0, function* () {
+        const transformed = yield transform(value, opts);
+        const { skipValidation = false } = opts !== null && opts !== void 0 ? opts : {};
+        if (!transformed.ok && skipValidation) {
+            // eslint-disable-next-line no-console
+            console.warn([
+                "Failed to validate.",
+                ...transformed.errors.map((error) => "  - " +
+                    (error.path.length > 0 ? `${error.path.join(".")}: ${error.message}` : error.message)),
+            ].join("\n"));
+            return {
+                ok: true,
+                value: value,
+            };
+        }
+        else {
+            return transformed;
+        }
+    });
+}

package/core/streaming-fetcher/Stream.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { Readable } from "stream";
+export declare class Stream<T> implements AsyncIterable<T> {
+    private stream;
+    private parse;
+    private terminator;
+    constructor({ stream, parse, terminator, }: {
+        stream: Readable;
+        parse: (val: unknown) => Promise<T>;
+        terminator: string;
+    });
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+}

package/core/streaming-fetcher/Stream.js

@@ -0,0 +1,75 @@
+"use strict";
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Stream = void 0;
+class Stream {
+    constructor({ stream, parse, terminator, }) {
+        this.stream = stream;
+        this.parse = parse;
+        this.terminator = terminator;
+    }
+    iterMessages() {
+        return __asyncGenerator(this, arguments, function* iterMessages_1() {
+            var e_1, _a;
+            let previous = "";
+            try {
+                for (var _b = __asyncValues(this.stream), _c; _c = yield __await(_b.next()), !_c.done;) {
+                    const chunk = _c.value;
+                    const bufferChunk = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
+                    previous += bufferChunk;
+                    let terminatorIndex;
+                    while ((terminatorIndex = previous.indexOf(this.terminator)) >= 0) {
+                        const line = previous.slice(0, terminatorIndex).trimEnd();
+                        const message = yield __await(this.parse(JSON.parse(line)));
+                        yield yield __await(message);
+                        previous = previous.slice(terminatorIndex + 1);
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield __await(_a.call(_b));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var e_2, _b;
+            try {
+                for (var _c = __asyncValues(this.iterMessages()), _d; _d = yield __await(_c.next()), !_d.done;) {
+                    const message = _d.value;
+                    yield yield __await(message);
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_d && !_d.done && (_b = _c.return)) yield __await(_b.call(_c));
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        });
+    }
+}
+exports.Stream = Stream;

package/core/streaming-fetcher/StreamingFetcher.d.ts

@@ -1,22 +1,24 @@
-import URLSearchParams from "@ungap/url-search-params";
+/// <reference types="node" />
 import { AxiosAdapter } from "axios";
-export declare type StreamingFetchFunction = (args: StreamingFetcher.Args) => Promise<void>;
+import { Readable } from "stream";
+export declare type StreamingFetchFunction = (args: StreamingFetcher.Args) => Promise<StreamingFetcher.Response>;
 export declare namespace StreamingFetcher {
     interface Args {
         url: string;
         method: string;
         headers?: Record<string, string | undefined>;
-        queryParameters?: URLSearchParams;
+        queryParameters?: Record<string, string | string[]>;
         body?: unknown;
         timeoutMs?: number;
         withCredentials?: boolean;
         adapter?: AxiosAdapter;
-        onData: (data: unknown) => void;
-        onError?: (err: unknown) => void;
-        onFinish?: () => void;
+        onUploadProgress?: (event: ProgressEvent) => void;
+        onDownloadProgress?: (event: ProgressEvent) => void;
         abortController?: AbortController;
-        responseChunkPrefix?: string;
-        terminator?: string;
+    }
+    interface Response {
+        data: Readable;
+        headers: Record<string, any>;
     }
 }
 export declare const streamingFetcher: StreamingFetchFunction;

package/core/streaming-fetcher/StreamingFetcher.js

@@ -1,11 +1,22 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.streamingFetcher = void 0;
 const axios_1 = __importDefault(require("axios"));
-const streamingFetcher = async (args) => {
+const qs_1 = __importDefault(require("qs"));
+const streamingFetcher = (args) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
     const headers = {};
     if (args.body !== undefined) {
         headers["Content-Type"] = "application/json";
@@ -17,48 +28,31 @@ const streamingFetcher = async (args) => {
             }
         }
     }
-    let response;
-    try {
-        response = await (0, axios_1.default)({
-            url: args.url,
-            params: args.queryParameters,
-            method: args.method,
-            headers,
-            data: args.body,
-            timeout: args.timeoutMs,
-            transitional: {
-                clarifyTimeoutError: true,
-            },
-            withCredentials: args.withCredentials,
-            signal: args.abortController?.signal,
-            responseType: "stream",
-            adapter: args.adapter,
-        });
-    }
-    catch (error) {
-        args.onError?.(error);
-        return;
-    }
-    response.data.on("data", (data) => {
-        for (const line of data.toString().split("\n")) {
-            let data = line;
-            if (args.responseChunkPrefix != null) {
-                if (!data.startsWith(args.responseChunkPrefix)) {
-                    continue;
-                }
-                data = data.substring(args.responseChunkPrefix.length);
-            }
-            try {
-                const parsed = JSON.parse(data);
-                args.onData(parsed);
-            }
-            catch (error) {
-                args.onError?.(error);
-            }
-        }
+    const response = yield (0, axios_1.default)({
+        url: args.url,
+        params: args.queryParameters,
+        paramsSerializer: (params) => {
+            return qs_1.default.stringify(params, { arrayFormat: "repeat" });
+        },
+        method: args.method,
+        headers,
+        data: args.body,
+        timeout: args.timeoutMs,
+        transitional: {
+            clarifyTimeoutError: true,
+        },
+        withCredentials: args.withCredentials,
+        maxBodyLength: Infinity,
+        maxContentLength: Infinity,
+        onUploadProgress: args.onUploadProgress,
+        onDownloadProgress: args.onDownloadProgress,
+        signal: (_a = args.abortController) === null || _a === void 0 ? void 0 : _a.signal,
+        responseType: "stream",
+        adapter: args.adapter,
     });
-    if (args.onFinish != null) {
-        response.data.on("end", args.onFinish);
-    }
-};
+    return {
+        data: response.data,
+        headers: response.headers,
+    };
+});
 exports.streamingFetcher = streamingFetcher;

package/core/streaming-fetcher/getHeader.d.ts

@@ -0,0 +1,2 @@
+import { StreamingFetcher } from "./StreamingFetcher";
+export declare function getHeader(response: StreamingFetcher.Response, header: string): string | undefined;

package/core/streaming-fetcher/getHeader.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHeader = void 0;
+function getHeader(response, header) {
+    for (const [headerKey, headerValue] of Object.entries(response.headers)) {
+        if (headerKey.toLowerCase() === header.toLowerCase()) {
+            return headerValue;
+        }
+    }
+    return undefined;
+}
+exports.getHeader = getHeader;

package/core/streaming-fetcher/index.d.ts

@@ -1 +1,4 @@
-export { streamingFetcher, type StreamingFetcher, type StreamingFetchFunction } from "./StreamingFetcher";
+export { getHeader } from "./getHeader";
+export { Stream } from "./Stream";
+export { streamingFetcher } from "./StreamingFetcher";
+export type { StreamingFetcher, StreamingFetchFunction } from "./StreamingFetcher";

package/core/streaming-fetcher/index.js

@@ -1,5 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.streamingFetcher = void 0;
+exports.streamingFetcher = exports.Stream = exports.getHeader = void 0;
+var getHeader_1 = require("./getHeader");
+Object.defineProperty(exports, "getHeader", { enumerable: true, get: function () { return getHeader_1.getHeader; } });
+var Stream_1 = require("./Stream");
+Object.defineProperty(exports, "Stream", { enumerable: true, get: function () { return Stream_1.Stream; } });
 var StreamingFetcher_1 = require("./StreamingFetcher");
 Object.defineProperty(exports, "streamingFetcher", { enumerable: true, get: function () { return StreamingFetcher_1.streamingFetcher; } });

package/dist/Client.d.ts

@@ -13,64 +13,61 @@ import { Sandboxes } from "./api/resources/sandboxes/client/Client";
 import { TestSuites } from "./api/resources/testSuites/client/Client";
 export declare namespace VellumClient {
     interface Options {
-        environment?: environments.VellumEnvironment | environments.VellumEnvironmentUrls;
+        environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
         apiKey: core.Supplier<string>;
     }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
 }
 export declare class VellumClient {
-    protected readonly options: VellumClient.Options;
-    constructor(options: VellumClient.Options);
+    protected readonly _options: VellumClient.Options;
+    constructor(_options: VellumClient.Options);
     /**
      * Executes a deployed Workflow and streams back its results.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
      */
-    executeWorkflowStream(request: Vellum.ExecuteWorkflowStreamRequest, cb: (data: Vellum.WorkflowStreamEvent) => void, opts?: Pick<core.StreamingFetcher.Args, "onError" | "onFinish" | "abortController" | "timeoutMs">): Promise<void>;
+    executeWorkflowStream(request: Vellum.ExecuteWorkflowStreamRequest, requestOptions?: VellumClient.RequestOptions): Promise<core.Stream<Vellum.WorkflowStreamEvent>>;
     /**
      * Generate a completion using a previously defined deployment.
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.ForbiddenError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.ForbiddenError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
      */
-    generate(request: Vellum.GenerateBodyRequest): Promise<Vellum.GenerateResponse>;
+    generate(request: Vellum.GenerateBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.GenerateResponse>;
     /**
      * Generate a stream of completions using a previously defined deployment.
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.ForbiddenError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
      */
-    generateStream(request: Vellum.GenerateStreamBodyRequest, cb: (data: Vellum.GenerateStreamResponse) => void, opts?: Pick<core.StreamingFetcher.Args, "onError" | "onFinish" | "abortController" | "timeoutMs">): Promise<void>;
+    generateStream(request: Vellum.GenerateStreamBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<core.Stream<Vellum.GenerateStreamResponse>>;
     /**
      * Perform a search against a document index.
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
      */
-    search(request: Vellum.SearchRequestBodyRequest): Promise<Vellum.SearchResponse>;
+    search(request: Vellum.SearchRequestBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.SearchResponse>;
     /**
      * Used to submit feedback regarding the quality of previously generated completions.
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
      */
-    submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
+    submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest, requestOptions?: VellumClient.RequestOptions): Promise<void>;
     /**
      *     Used to submit feedback regarding the quality of previous workflow execution and its outputs.
      *
      *     **Note:** Uses a base url of `https://predict.vellum.ai`.
      */
-    submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest): Promise<void>;
+    submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest, requestOptions?: VellumClient.RequestOptions): Promise<void>;
     protected _deployments: Deployments | undefined;
     get deployments(): Deployments;
     protected _documentIndexes: DocumentIndexes | undefined;