vellum-ai 0.1.14 → 0.2.0

package/Client.d.ts

@@ -11,6 +11,7 @@ import { ModelVersions } from "./api/resources/modelVersions/client/Client";
 import { RegisteredPrompts } from "./api/resources/registeredPrompts/client/Client";
 import { Sandboxes } from "./api/resources/sandboxes/client/Client";
 import { TestSuites } from "./api/resources/testSuites/client/Client";
+import { WorkflowDeployments } from "./api/resources/workflowDeployments/client/Client";
 export declare namespace VellumClient {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
@@ -58,7 +59,12 @@ export declare class VellumClient {
      * @example
      *     await vellum.generate({
      *         requests: [{
-     *                 inputValues: {}
+     *                 inputValues: {
+     *                     "string": "string"
+     *                 },
+     *                 chatHistory: [{
+     *                         role: Vellum.ChatMessageRole.System
+     *                     }]
      *             }],
      *         options: {
      *             logprobs: Vellum.LogprobsEnum.All
@@ -79,6 +85,25 @@ export declare class VellumClient {
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.search({
+     *         query: "string",
+     *         options: {
+     *             weights: {},
+     *             resultMerging: {},
+     *             filters: {
+     *                 metadata: {
+     *                     combinator: Vellum.MetadataFilterRuleCombinator.And,
+     *                     rules: [{
+     *                             combinator: Vellum.MetadataFilterRuleCombinator.And,
+     *                             operator: Vellum.LogicalOperator.Equals
+     *                         }],
+     *                     operator: Vellum.LogicalOperator.Equals
+     *                 }
+     *             }
+     *         }
+     *     })
      */
     search(request: Vellum.SearchRequestBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.SearchResponse>;
     /**
@@ -91,7 +116,7 @@ export declare class VellumClient {
      *
      * @example
      *     await vellum.submitCompletionActuals({
-     *         actuals: []
+     *         actuals: [{}]
      *     })
      */
     submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest, requestOptions?: VellumClient.RequestOptions): Promise<void>;
@@ -120,4 +145,6 @@ export declare class VellumClient {
     get sandboxes(): Sandboxes;
     protected _testSuites: TestSuites | undefined;
     get testSuites(): TestSuites;
+    protected _workflowDeployments: WorkflowDeployments | undefined;
+    get workflowDeployments(): WorkflowDeployments;
 }

package/Client.js

@@ -52,6 +52,7 @@ const Client_4 = require("./api/resources/modelVersions/client/Client");
 const Client_5 = require("./api/resources/registeredPrompts/client/Client");
 const Client_6 = require("./api/resources/sandboxes/client/Client");
 const Client_7 = require("./api/resources/testSuites/client/Client");
+const Client_8 = require("./api/resources/workflowDeployments/client/Client");
 class VellumClient {
     constructor(_options) {
         this._options = _options;
@@ -77,7 +78,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -141,7 +142,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.ExecutePromptStreamRequest.jsonOrThrow(request, {
@@ -211,7 +212,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, {
@@ -277,7 +278,12 @@ class VellumClient {
      * @example
      *     await vellum.generate({
      *         requests: [{
-     *                 inputValues: {}
+     *                 inputValues: {
+     *                     "string": "string"
+     *                 },
+     *                 chatHistory: [{
+     *                         role: Vellum.ChatMessageRole.System
+     *                     }]
      *             }],
      *         options: {
      *             logprobs: Vellum.LogprobsEnum.All
@@ -295,7 +301,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -358,7 +364,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -419,6 +425,25 @@ class VellumClient {
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.search({
+     *         query: "string",
+     *         options: {
+     *             weights: {},
+     *             resultMerging: {},
+     *             filters: {
+     *                 metadata: {
+     *                     combinator: Vellum.MetadataFilterRuleCombinator.And,
+     *                     rules: [{
+     *                             combinator: Vellum.MetadataFilterRuleCombinator.And,
+     *                             operator: Vellum.LogicalOperator.Equals
+     *                         }],
+     *                     operator: Vellum.LogicalOperator.Equals
+     *                 }
+     *             }
+     *         }
+     *     })
      */
     search(request, requestOptions) {
         var _a;
@@ -431,7 +456,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -486,7 +511,7 @@ class VellumClient {
      *
      * @example
      *     await vellum.submitCompletionActuals({
-     *         actuals: []
+     *         actuals: [{}]
      *     })
      */
     submitCompletionActuals(request, requestOptions) {
@@ -500,7 +525,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, {
@@ -563,7 +588,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
@@ -624,5 +649,9 @@ class VellumClient {
         var _a;
         return ((_a = this._testSuites) !== null && _a !== void 0 ? _a : (this._testSuites = new Client_7.TestSuites(this._options)));
     }
+    get workflowDeployments() {
+        var _a;
+        return ((_a = this._workflowDeployments) !== null && _a !== void 0 ? _a : (this._workflowDeployments = new Client_8.WorkflowDeployments(this._options)));
+    }
 }
 exports.VellumClient = VellumClient;

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

@@ -3,6 +3,7 @@
  */
 import * as Vellum from "../..";
 export interface ExecutePromptRequest {
+    /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
     inputs: Vellum.PromptDeploymentInputRequest[];
     /** The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name. */
     promptDeploymentId?: string;

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

@@ -3,6 +3,7 @@
  */
 import * as Vellum from "../..";
 export interface ExecutePromptStreamRequest {
+    /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
     inputs: Vellum.PromptDeploymentInputRequest[];
     /** The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name. */
     promptDeploymentId?: string;

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

@@ -6,7 +6,12 @@ import * as Vellum from "../..";
  * @example
  *     {
  *         requests: [{
- *                 inputValues: {}
+ *                 inputValues: {
+ *                     "string": "string"
+ *                 },
+ *                 chatHistory: [{
+ *                         role: Vellum.ChatMessageRole.System
+ *                     }]
  *             }],
  *         options: {
  *             logprobs: Vellum.LogprobsEnum.All

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

@@ -2,6 +2,26 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../..";
+/**
+ * @example
+ *     {
+ *         query: "string",
+ *         options: {
+ *             weights: {},
+ *             resultMerging: {},
+ *             filters: {
+ *                 metadata: {
+ *                     combinator: Vellum.MetadataFilterRuleCombinator.And,
+ *                     rules: [{
+ *                             combinator: Vellum.MetadataFilterRuleCombinator.And,
+ *                             operator: Vellum.LogicalOperator.Equals
+ *                         }],
+ *                     operator: Vellum.LogicalOperator.Equals
+ *                 }
+ *             }
+ *         }
+ *     }
+ */
 export interface SearchRequestBodyRequest {
     /** The ID of the index to search against. Must provide either this or index_name. */
     indexId?: string;

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

@@ -5,7 +5,7 @@ import * as Vellum from "../..";
 /**
  * @example
  *     {
- *         actuals: []
+ *         actuals: [{}]
  *     }
  */
 export interface SubmitCompletionActualsRequest {

package/api/index.d.ts

@@ -1,4 +1,4 @@
+export * from "./resources";
 export * from "./types";
 export * from "./errors";
-export * from "./resources";
 export * from "./client";

package/api/index.js

@@ -14,7 +14,7 @@ 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("./resources"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./errors"), exports);
-__exportStar(require("./resources"), exports);
 __exportStar(require("./client"), exports);

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

@@ -17,8 +17,12 @@ export declare namespace Deployments {
 export declare class Deployments {
     protected readonly _options: Deployments.Options;
     constructor(_options: Deployments.Options);
+    list(request?: Vellum.DeploymentsListRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.PaginatedSlimDeploymentReadList>;
     /**
      * Used to retrieve a deployment given its ID or name.
+     *
+     * @example
+     *     await vellum.deployments.retrieve("string")
      */
     retrieve(id: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentRead>;
     retrieveProviderPayload(request: Vellum.DeploymentProviderPayloadRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentProviderPayloadResponse>;

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

@@ -48,8 +48,72 @@ class Deployments {
     constructor(_options) {
         this._options = _options;
     }
+    list(request = {}, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { limit, offset, ordering, status } = request;
+            const _queryParams = {};
+            if (limit != null) {
+                _queryParams["limit"] = limit.toString();
+            }
+            if (offset != null) {
+                _queryParams["offset"] = offset.toString();
+            }
+            if (ordering != null) {
+                _queryParams["ordering"] = ordering;
+            }
+            if (status != null) {
+                _queryParams["status"] = status;
+            }
+            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"),
+                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.2.0",
+                },
+                contentType: "application/json",
+                queryParameters: _queryParams,
+                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.PaginatedSlimDeploymentReadList.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            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,
+                    });
+            }
+        });
+    }
     /**
      * Used to retrieve a deployment given its ID or name.
+     *
+     * @example
+     *     await vellum.deployments.retrieve("string")
      */
     retrieve(id, requestOptions) {
         var _a;
@@ -62,7 +126,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -108,7 +172,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.DeploymentProviderPayloadRequest.jsonOrThrow(request, {

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

@@ -13,5 +13,6 @@ export interface DeploymentProviderPayloadRequest {
     deploymentId?: string;
     /** The name of the deployment. Must provide either this or deployment_id. */
     deploymentName?: string;
+    /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
     inputs: Vellum.PromptDeploymentInputRequest[];
 }

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

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../../../..";
+/**
+ * @example
+ *     {
+ *         status: Vellum.DeploymentsListRequestStatus.Active
+ *     }
+ */
+export interface DeploymentsListRequest {
+    /**
+     * Number of results to return per page.
+     */
+    limit?: number;
+    /**
+     * The initial index from which to return the results.
+     */
+    offset?: number;
+    /**
+     * Which field to use when ordering the results.
+     */
+    ordering?: string;
+    /**
+     * The current status of the deployment
+     *
+     * - `ACTIVE` - Active
+     * - `ARCHIVED` - Archived
+     */
+    status?: Vellum.DeploymentsListRequestStatus;
+}

package/api/resources/deployments/client/requests/DeploymentsListRequest.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/resources/deployments/client/requests/index.d.ts

@@ -1 +1,2 @@
+export { DeploymentsListRequest } from "./DeploymentsListRequest";
 export { DeploymentProviderPayloadRequest } from "./DeploymentProviderPayloadRequest";

package/api/resources/deployments/index.d.ts

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

package/api/resources/deployments/index.js

@@ -14,4 +14,5 @@ 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("./types"), exports);
 __exportStar(require("./client"), exports);

package/api/resources/deployments/types/DeploymentsListRequestStatus.d.ts

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

package/{dist/api/types/DeploymentStatus.js → api/resources/deployments/types/DeploymentsListRequestStatus.js}

@@ -3,9 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeploymentStatus = void 0;
-exports.DeploymentStatus = {
+exports.DeploymentsListRequestStatus = void 0;
+exports.DeploymentsListRequestStatus = {
     Active: "ACTIVE",
-    Inactive: "INACTIVE",
     Archived: "ARCHIVED",
 };

package/api/resources/deployments/types/index.d.ts

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

package/api/resources/deployments/types/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("./DeploymentsListRequestStatus"), exports);

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

@@ -19,10 +19,24 @@ export declare class DocumentIndexes {
     constructor(_options: DocumentIndexes.Options);
     /**
      * Creates a new document index.
+     *
+     * @example
+     *     await vellum.documentIndexes.create({
+     *         label: "string",
+     *         name: "string",
+     *         status: Vellum.EntityStatus.Active,
+     *         environment: Vellum.EnvironmentEnum.Development,
+     *         indexingConfig: {
+     *             "string": "string"
+     *         }
+     *     })
      */
     create(request: Vellum.DocumentIndexCreateRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     /**
      * Used to retrieve a Document Index given its ID or name.
+     *
+     * @example
+     *     await vellum.documentIndexes.retrieve("string")
      */
     retrieve(id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
 }

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

@@ -50,6 +50,17 @@ class DocumentIndexes {
     }
     /**
      * Creates a new document index.
+     *
+     * @example
+     *     await vellum.documentIndexes.create({
+     *         label: "string",
+     *         name: "string",
+     *         status: Vellum.EntityStatus.Active,
+     *         environment: Vellum.EnvironmentEnum.Development,
+     *         indexingConfig: {
+     *             "string": "string"
+     *         }
+     *     })
      */
     create(request, requestOptions) {
         var _a;
@@ -62,7 +73,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 body: yield serializers.DocumentIndexCreateRequest.jsonOrThrow(request, {
@@ -102,6 +113,9 @@ class DocumentIndexes {
     }
     /**
      * Used to retrieve a Document Index given its ID or name.
+     *
+     * @example
+     *     await vellum.documentIndexes.retrieve("string")
      */
     retrieve(id, requestOptions) {
         var _a;
@@ -114,7 +128,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": "v0.1.13",
+                    "X-Fern-SDK-Version": "v0.2.0",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,

package/api/resources/documentIndexes/client/requests/DocumentIndexCreateRequest.d.ts

@@ -2,6 +2,18 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../../../..";
+/**
+ * @example
+ *     {
+ *         label: "string",
+ *         name: "string",
+ *         status: Vellum.EntityStatus.Active,
+ *         environment: Vellum.EnvironmentEnum.Development,
+ *         indexingConfig: {
+ *             "string": "string"
+ *         }
+ *     }
+ */
 export interface DocumentIndexCreateRequest {
     /** A human-readable label for the document index */
     label: string;
@@ -13,7 +25,7 @@ export interface DocumentIndexCreateRequest {
      * * `ACTIVE` - Active
      * * `ARCHIVED` - Archived
      */
-    status?: Vellum.DocumentIndexStatus;
+    status?: Vellum.EntityStatus;
     /**
      * The environment this document index is used in
      *

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

@@ -29,6 +29,11 @@ export declare class Documents {
     destroy(id: string, requestOptions?: Documents.RequestOptions): Promise<void>;
     /**
      * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
+     *
+     * @example
+     *     await vellum.documents.partialUpdate("string", {
+     *         status: "ACTIVE"
+     *     })
      */
     partialUpdate(id: string, request?: Vellum.PatchedDocumentUpdateRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.DocumentRead>;
     /**