vellum-ai 0.1.8 → 0.1.9

package/Client.d.ts

@@ -24,6 +24,18 @@ export declare namespace VellumClient {
 export declare class VellumClient {
     protected readonly _options: VellumClient.Options;
     constructor(_options: VellumClient.Options);
+    /**
+     * Executes a deployed Prompt and returns the result.
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.ForbiddenError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
+     */
+    executePrompt(request: Vellum.ExecutePromptRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.ExecutePromptResponse>;
+    /**
+     * Executes a deployed Prompt and streams back the results.
+     */
+    executePromptStream(request: Vellum.ExecutePromptStreamRequest, requestOptions?: VellumClient.RequestOptions): Promise<core.Stream<Vellum.ExecutePromptEvent>>;
     /**
      * Executes a deployed Workflow and streams back its results.
      */
@@ -36,6 +48,16 @@ export declare class VellumClient {
      * @throws {@link Vellum.ForbiddenError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.generate({
+     *         requests: [{
+     *                 inputValues: {}
+     *             }],
+     *         options: {
+     *             logprobs: Vellum.LogprobsEnum.All
+     *         }
+     *     })
      */
     generate(request: Vellum.GenerateBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.GenerateResponse>;
     /**
@@ -60,12 +82,22 @@ export declare class VellumClient {
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.submitCompletionActuals({
+     *         actuals: []
+     *     })
      */
     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`.
+     *
+     * @example
+     *     await vellum.submitWorkflowExecutionActuals({
+     *         actuals: []
+     *     })
      */
     submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest, requestOptions?: VellumClient.RequestOptions): Promise<void>;
     protected _deployments: Deployments | undefined;

package/Client.js

@@ -56,13 +56,148 @@ class VellumClient {
     constructor(_options) {
         this._options = _options;
     }
+    /**
+     * Executes a deployed Prompt and returns the result.
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.ForbiddenError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
+     */
+    executePrompt(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)
+                    .predict, "v1/execute-prompt"),
+                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.9",
+                },
+                contentType: "application/json",
+                body: yield serializers.ExecutePromptRequest.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.ok) {
+                return yield serializers.ExecutePromptResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Vellum.BadRequestError(_response.error.body);
+                    case 403:
+                        throw new Vellum.ForbiddenError(_response.error.body);
+                    case 404:
+                        throw new Vellum.NotFoundError(_response.error.body);
+                    case 500:
+                        throw new Vellum.InternalServerError(_response.error.body);
+                    default:
+                        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,
+                    });
+            }
+        });
+    }
+    /**
+     * Executes a deployed Prompt and streams back the results.
+     */
+    executePromptStream(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)
+                    .predict, "v1/execute-prompt-stream"),
+                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.9",
+                },
+                contentType: "application/json",
+                body: yield serializers.ExecutePromptStreamRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
+                responseType: "streaming",
+                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.ok) {
+                return new core.Stream({
+                    stream: _response.body,
+                    terminator: "\n",
+                    parse: (data) => __awaiter(this, void 0, void 0, function* () {
+                        return yield serializers.ExecutePromptEvent.parseOrThrow(data, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        });
+                    }),
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Vellum.BadRequestError(_response.error.body);
+                    case 403:
+                        throw new Vellum.ForbiddenError(_response.error.body);
+                    case 404:
+                        throw new Vellum.NotFoundError(_response.error.body);
+                    case 500:
+                        throw new Vellum.InternalServerError(_response.error.body);
+                    default:
+                        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,
+                    });
+            }
+        });
+    }
     /**
      * Executes a deployed Workflow and streams back its results.
      */
     executeWorkflowStream(request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const _response = yield core.streamingFetcher({
+            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)
                     .predict, "v1/execute-workflow-stream"),
                 method: "POST",
@@ -70,25 +205,58 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
+                contentType: "application/json",
                 body: yield serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
+                responseType: "streaming",
                 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,
             });
-            return new core.Stream({
-                stream: _response.data,
-                terminator: "\n",
-                parse: (data) => __awaiter(this, void 0, void 0, function* () {
-                    return yield serializers.WorkflowStreamEvent.parseOrThrow(data, {
-                        unrecognizedObjectKeys: "passthrough",
-                        allowUnrecognizedUnionMembers: true,
-                        allowUnrecognizedEnumValues: true,
-                        breadcrumbsPrefix: ["response"],
+            if (_response.ok) {
+                return new core.Stream({
+                    stream: _response.body,
+                    terminator: "\n",
+                    parse: (data) => __awaiter(this, void 0, void 0, function* () {
+                        return yield serializers.WorkflowStreamEvent.parseOrThrow(data, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        });
+                    }),
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Vellum.BadRequestError(_response.error.body);
+                    case 404:
+                        throw new Vellum.NotFoundError(_response.error.body);
+                    case 500:
+                        throw new Vellum.InternalServerError(_response.error.body);
+                    default:
+                        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,
+                    });
+            }
         });
     }
     /**
@@ -99,6 +267,16 @@ class VellumClient {
      * @throws {@link Vellum.ForbiddenError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.generate({
+     *         requests: [{
+     *                 inputValues: {}
+     *             }],
+     *         options: {
+     *             logprobs: Vellum.LogprobsEnum.All
+     *         }
+     *     })
      */
     generate(request, requestOptions) {
         var _a;
@@ -111,7 +289,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
                 contentType: "application/json",
                 body: yield serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -131,12 +309,7 @@ class VellumClient {
                     case 400:
                         throw new Vellum.BadRequestError(_response.error.body);
                     case 403:
-                        throw new Vellum.ForbiddenError(yield serializers.GenerateErrorResponse.parseOrThrow(_response.error.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            breadcrumbsPrefix: ["response"],
-                        }));
+                        throw new Vellum.ForbiddenError(_response.error.body);
                     case 404:
                         throw new Vellum.NotFoundError(_response.error.body);
                     case 500:
@@ -171,7 +344,7 @@ class VellumClient {
     generateStream(request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const _response = yield core.streamingFetcher({
+            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)
                     .predict, "v1/generate-stream"),
                 method: "POST",
@@ -179,23 +352,58 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
+                contentType: "application/json",
                 body: yield serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                responseType: "streaming",
                 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,
             });
-            return new core.Stream({
-                stream: _response.data,
-                terminator: "\n",
-                parse: (data) => __awaiter(this, void 0, void 0, function* () {
-                    return yield serializers.GenerateStreamResponse.parseOrThrow(data, {
-                        unrecognizedObjectKeys: "passthrough",
-                        allowUnrecognizedUnionMembers: true,
-                        allowUnrecognizedEnumValues: true,
-                        breadcrumbsPrefix: ["response"],
+            if (_response.ok) {
+                return new core.Stream({
+                    stream: _response.body,
+                    terminator: "\n",
+                    parse: (data) => __awaiter(this, void 0, void 0, function* () {
+                        return yield serializers.GenerateStreamResponse.parseOrThrow(data, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        });
+                    }),
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Vellum.BadRequestError(_response.error.body);
+                    case 403:
+                        throw new Vellum.ForbiddenError(_response.error.body);
+                    case 404:
+                        throw new Vellum.NotFoundError(_response.error.body);
+                    case 500:
+                        throw new Vellum.InternalServerError(_response.error.body);
+                    default:
+                        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,
+                    });
+            }
         });
     }
     /**
@@ -217,7 +425,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
                 contentType: "application/json",
                 body: yield serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -269,6 +477,11 @@ class VellumClient {
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.submitCompletionActuals({
+     *         actuals: []
+     *     })
      */
     submitCompletionActuals(request, requestOptions) {
         var _a;
@@ -281,7 +494,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
                 contentType: "application/json",
                 body: yield serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, {
@@ -327,6 +540,11 @@ class VellumClient {
      *     Used to submit feedback regarding the quality of previous workflow execution and its outputs.
      *
      *     **Note:** Uses a base url of `https://predict.vellum.ai`.
+     *
+     * @example
+     *     await vellum.submitWorkflowExecutionActuals({
+     *         actuals: []
+     *     })
      */
     submitWorkflowExecutionActuals(request, requestOptions) {
         var _a;
@@ -339,7 +557,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
                 contentType: "application/json",
                 body: yield serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {

package/api/client/requests/ExecutePromptRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../..";
+export interface ExecutePromptRequest {
+    inputs: Vellum.PromptDeploymentInputRequest[];
+    /** The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name. */
+    promptDeploymentId?: string;
+    /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
+    promptDeploymentName?: string;
+    /** Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment */
+    releaseTag?: string;
+    externalId?: string;
+    /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
+    expandMeta?: Vellum.PromptDeploymentExpandMetaRequestRequest;
+    rawOverrides?: Vellum.RawPromptExecutionOverridesRequest;
+    /** Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models. */
+    expandRaw?: string[];
+    metadata?: Record<string, unknown>;
+}

package/api/client/requests/ExecutePromptRequest.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/client/requests/ExecutePromptStreamRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../..";
+export interface ExecutePromptStreamRequest {
+    inputs: Vellum.PromptDeploymentInputRequest[];
+    /** The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name. */
+    promptDeploymentId?: string;
+    /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
+    promptDeploymentName?: string;
+    /** Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment */
+    releaseTag?: string;
+    externalId?: string;
+    /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
+    expandMeta?: Vellum.PromptDeploymentExpandMetaRequestRequest;
+    rawOverrides?: Vellum.RawPromptExecutionOverridesRequest;
+    /** Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models. */
+    expandRaw?: string[];
+    metadata?: Record<string, unknown>;
+}

package/api/client/requests/ExecutePromptStreamRequest.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/client/requests/GenerateBodyRequest.d.ts

@@ -2,6 +2,17 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../..";
+/**
+ * @example
+ *     {
+ *         requests: [{
+ *                 inputValues: {}
+ *             }],
+ *         options: {
+ *             logprobs: Vellum.LogprobsEnum.All
+ *         }
+ *     }
+ */
 export interface GenerateBodyRequest {
     /** The ID of the deployment. Must provide either this or deployment_name. */
     deploymentId?: string;

package/api/client/requests/SubmitCompletionActualsRequest.d.ts

@@ -2,6 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../..";
+/**
+ * @example
+ *     {
+ *         actuals: []
+ *     }
+ */
 export interface SubmitCompletionActualsRequest {
     /** The ID of the deployment. Must provide either this or deployment_name. */
     deploymentId?: string;

package/api/client/requests/SubmitWorkflowExecutionActualsRequest.d.ts

@@ -2,6 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../..";
+/**
+ * @example
+ *     {
+ *         actuals: []
+ *     }
+ */
 export interface SubmitWorkflowExecutionActualsRequest {
     /** Feedback regarding the quality of an output on a previously executed workflow. */
     actuals: Vellum.SubmitWorkflowExecutionActualRequest[];

package/api/client/requests/index.d.ts

@@ -1,3 +1,5 @@
+export { ExecutePromptRequest } from "./ExecutePromptRequest";
+export { ExecutePromptStreamRequest } from "./ExecutePromptStreamRequest";
 export { ExecuteWorkflowStreamRequest } from "./ExecuteWorkflowStreamRequest";
 export { GenerateBodyRequest } from "./GenerateBodyRequest";
 export { GenerateStreamBodyRequest } from "./GenerateStreamBodyRequest";

package/api/errors/ForbiddenError.d.ts

@@ -2,7 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors";
-import * as Vellum from "..";
 export declare class ForbiddenError extends errors.VellumError {
-    constructor(body: Vellum.GenerateErrorResponse);
+    constructor(body?: unknown);
 }

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

@@ -62,7 +62,7 @@ class Deployments {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -108,7 +108,7 @@ class Deployments {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
                 contentType: "application/json",
                 body: yield serializers.DeploymentProviderPayloadRequest.jsonOrThrow(request, {

package/api/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts

@@ -2,6 +2,12 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../../../..";
+/**
+ * @example
+ *     {
+ *         inputs: []
+ *     }
+ */
 export interface DeploymentProviderPayloadRequest {
     /** The ID of the deployment. Must provide either this or deployment_name. */
     deploymentId?: string;

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

@@ -62,7 +62,7 @@ class DocumentIndexes {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
                 contentType: "application/json",
                 body: yield serializers.DocumentIndexCreateRequest.jsonOrThrow(request, {
@@ -114,7 +114,7 @@ class DocumentIndexes {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.1.8",
+                    "X-Fern-SDK-Version": "v0.1.9",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,

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

@@ -21,6 +21,9 @@ export declare class Documents {
     constructor(_options: Documents.Options);
     /**
      * Used to list documents. Optionally filter on supported fields.
+     *
+     * @example
+     *     await vellum.documents.list({})
      */
     list(request?: Vellum.DocumentsListRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.PaginatedSlimDocumentList>;
     destroy(id: string, requestOptions?: Documents.RequestOptions): Promise<void>;