vellum-ai 0.0.45 → 0.1.0

package/api/resources/deployments/client/Client.d.ts

@@ -6,15 +6,19 @@ import * as core from "../../../../core";
 import * as Vellum from "../../..";
 export declare namespace Deployments {
     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 Deployments {
-    protected readonly options: Deployments.Options;
-    constructor(options: Deployments.Options);
+    protected readonly _options: Deployments.Options;
+    constructor(_options: Deployments.Options);
     /**
      * Used to retrieve a deployment given its ID or name.
      */
-    retrieve(id: string): Promise<Vellum.DeploymentRead>;
+    retrieve(id: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentRead>;
 }

package/api/resources/deployments/client/Client.js

@@ -25,6 +25,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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 };
 };
@@ -36,48 +45,57 @@ const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization"));
 const errors = __importStar(require("../../../../errors"));
 class Deployments {
-    options;
-    constructor(options) {
-        this.options = options;
+    constructor(_options) {
+        this._options = _options;
     }
     /**
      * Used to retrieve a deployment given its ID or name.
      */
-    async retrieve(id) {
-        const _response = await core.fetcher({
-            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/deployments/${id}`),
-            method: "GET",
-            headers: {
-                X_API_KEY: await core.Supplier.get(this.options.apiKey),
-            },
-            contentType: "application/json",
-        });
-        if (_response.ok) {
-            return await serializers.DeploymentRead.parseOrThrow(_response.body, {
-                unrecognizedObjectKeys: "passthrough",
-                allowUnrecognizedUnionMembers: true,
-                allowUnrecognizedEnumValues: true,
+    retrieve(id, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
+                    .default, `v1/deployments/${id}`),
+                method: "GET",
+                headers: {
+                    X_API_KEY: yield core.Supplier.get(this._options.apiKey),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "vellum-ai",
+                    "X-Fern-SDK-Version": "v0.1.0",
+                },
+                contentType: "application/json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
             });
-        }
-        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,
+            if (_response.ok) {
+                return yield serializers.DeploymentRead.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
                 });
-            case "timeout":
-                throw new errors.VellumTimeoutError();
-            case "unknown":
+            }
+            if (_response.error.reason === "status-code") {
                 throw new errors.VellumError({
-                    message: _response.error.errorMessage,
+                    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.Deployments = Deployments;

package/api/resources/documentIndexes/client/Client.d.ts

@@ -6,19 +6,23 @@ import * as core from "../../../../core";
 import * as Vellum from "../../..";
 export declare namespace DocumentIndexes {
     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 DocumentIndexes {
-    protected readonly options: DocumentIndexes.Options;
-    constructor(options: DocumentIndexes.Options);
+    protected readonly _options: DocumentIndexes.Options;
+    constructor(_options: DocumentIndexes.Options);
     /**
      * Creates a new document index.
      */
-    create(request: Vellum.DocumentIndexCreateRequest): Promise<Vellum.DocumentIndexRead>;
+    create(request: Vellum.DocumentIndexCreateRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     /**
      * Used to retrieve a Document Index given its ID or name.
      */
-    retrieve(id: string): Promise<Vellum.DocumentIndexRead>;
+    retrieve(id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
 }

package/api/resources/documentIndexes/client/Client.js

@@ -25,6 +25,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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 };
 };
@@ -32,94 +41,113 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentIndexes = 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 url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors"));
 class DocumentIndexes {
-    options;
-    constructor(options) {
-        this.options = options;
+    constructor(_options) {
+        this._options = _options;
     }
     /**
      * Creates a new document index.
      */
-    async create(request) {
-        const _response = await core.fetcher({
-            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, "v1/document-indexes"),
-            method: "POST",
-            headers: {
-                X_API_KEY: await core.Supplier.get(this.options.apiKey),
-            },
-            contentType: "application/json",
-            body: await serializers.DocumentIndexCreateRequest.jsonOrThrow(request, {
-                unrecognizedObjectKeys: "strip",
-            }),
-        });
-        if (_response.ok) {
-            return await serializers.DocumentIndexRead.parseOrThrow(_response.body, {
-                unrecognizedObjectKeys: "passthrough",
-                allowUnrecognizedUnionMembers: true,
-                allowUnrecognizedEnumValues: true,
+    create(request, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
+                    .default, "v1/document-indexes"),
+                method: "POST",
+                headers: {
+                    X_API_KEY: yield core.Supplier.get(this._options.apiKey),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "vellum-ai",
+                    "X-Fern-SDK-Version": "v0.1.0",
+                },
+                contentType: "application/json",
+                body: yield serializers.DocumentIndexCreateRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
             });
-        }
-        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,
+            if (_response.ok) {
+                return yield serializers.DocumentIndexRead.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
                 });
-            case "timeout":
-                throw new errors.VellumTimeoutError();
-            case "unknown":
+            }
+            if (_response.error.reason === "status-code") {
                 throw new errors.VellumError({
-                    message: _response.error.errorMessage,
+                    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,
+                    });
+            }
+        });
     }
     /**
      * Used to retrieve a Document Index given its ID or name.
      */
-    async retrieve(id) {
-        const _response = await core.fetcher({
-            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/document-indexes/${id}`),
-            method: "GET",
-            headers: {
-                X_API_KEY: await core.Supplier.get(this.options.apiKey),
-            },
-            contentType: "application/json",
-        });
-        if (_response.ok) {
-            return await serializers.DocumentIndexRead.parseOrThrow(_response.body, {
-                unrecognizedObjectKeys: "passthrough",
-                allowUnrecognizedUnionMembers: true,
-                allowUnrecognizedEnumValues: true,
+    retrieve(id, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
+                    .default, `v1/document-indexes/${id}`),
+                method: "GET",
+                headers: {
+                    X_API_KEY: yield core.Supplier.get(this._options.apiKey),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "vellum-ai",
+                    "X-Fern-SDK-Version": "v0.1.0",
+                },
+                contentType: "application/json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
             });
-        }
-        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,
+            if (_response.ok) {
+                return yield serializers.DocumentIndexRead.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
                 });
-            case "timeout":
-                throw new errors.VellumTimeoutError();
-            case "unknown":
+            }
+            if (_response.error.reason === "status-code") {
                 throw new errors.VellumError({
-                    message: _response.error.errorMessage,
+                    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.DocumentIndexes = DocumentIndexes;

package/api/resources/documents/client/Client.d.ts

@@ -8,29 +8,33 @@ import * as Vellum from "../../..";
 import * as fs from "fs";
 export declare namespace Documents {
     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 Documents {
-    protected readonly options: Documents.Options;
-    constructor(options: Documents.Options);
+    protected readonly _options: Documents.Options;
+    constructor(_options: Documents.Options);
     /**
      * Used to list documents. Optionally filter on supported fields.
      */
-    list(request?: Vellum.DocumentsListRequest): Promise<Vellum.PaginatedSlimDocumentList>;
+    list(request?: Vellum.DocumentsListRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.PaginatedSlimDocumentList>;
+    destroy(id: string, requestOptions?: Documents.RequestOptions): Promise<void>;
     /**
      * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
      */
-    partialUpdate(id: string, request?: Vellum.PatchedDocumentUpdateRequest): Promise<Vellum.DocumentRead>;
-    destroy(id: string): Promise<void>;
+    partialUpdate(id: string, request?: Vellum.PatchedDocumentUpdateRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.DocumentRead>;
     /**
      * Upload a document to be indexed and used for search.
      *
      * **Note:** Uses a base url of `https://documents.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
      */
-    upload(contents: File | fs.ReadStream, request: Vellum.UploadDocumentBodyRequest): Promise<Vellum.UploadDocumentResponse>;
+    upload(contents: File | fs.ReadStream, request: Vellum.UploadDocumentBodyRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.UploadDocumentResponse>;
 }