vellum-ai 0.6.4 → 0.6.7

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

@@ -1,7 +1,21 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
+/**
+ * @example
+ *     {
+ *         inputs: [{
+ *                 type: "STRING",
+ *                 name: "string",
+ *                 value: "string"
+ *             }],
+ *         workflowDeploymentId: "string",
+ *         workflowDeploymentName: "string",
+ *         releaseTag: "string",
+ *         externalId: "string"
+ *     }
+ */
 export interface ExecuteWorkflowRequest {
     /** The list of inputs defined in the Workflow's Deployment with their corresponding values. */
     inputs: Vellum.WorkflowRequestInputRequest[];

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

@@ -1,7 +1,22 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
+/**
+ * @example
+ *     {
+ *         inputs: [{
+ *                 type: "STRING",
+ *                 name: "string",
+ *                 value: "string"
+ *             }],
+ *         workflowDeploymentId: "string",
+ *         workflowDeploymentName: "string",
+ *         releaseTag: "string",
+ *         externalId: "string",
+ *         eventTypes: [Vellum.WorkflowExecutionEventType.Node]
+ *     }
+ */
 export interface ExecuteWorkflowStreamRequest {
     /** The list of inputs defined in the Workflow's Deployment with their corresponding values. */
     inputs: Vellum.WorkflowRequestInputRequest[];

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
 /**
  * @example
  *     {

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

@@ -1,7 +1,33 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
+/**
+ * @example
+ *     {
+ *         deploymentId: "string",
+ *         deploymentName: "string",
+ *         requests: [{
+ *                 inputValues: {
+ *                     "string": {
+ *                         "key": "value"
+ *                     }
+ *                 },
+ *                 chatHistory: [{
+ *                         text: "string",
+ *                         role: Vellum.ChatMessageRole.System,
+ *                         content: {
+ *                             type: "STRING"
+ *                         },
+ *                         source: "string"
+ *                     }],
+ *                 externalIds: ["string"]
+ *             }],
+ *         options: {
+ *             logprobs: Vellum.LogprobsEnum.All
+ *         }
+ *     }
+ */
 export interface GenerateStreamBodyRequest {
     /** The ID of the deployment. Must provide either this or deployment_name. */
     deploymentId?: string;

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
 /**
  * @example
  *     {

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
 /**
  * @example
  *     {

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
 /**
  * @example
  *     {

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

@@ -1,9 +1,9 @@
-export { ExecutePromptRequest } from "./ExecutePromptRequest";
-export { ExecutePromptStreamRequest } from "./ExecutePromptStreamRequest";
-export { ExecuteWorkflowRequest } from "./ExecuteWorkflowRequest";
-export { ExecuteWorkflowStreamRequest } from "./ExecuteWorkflowStreamRequest";
-export { GenerateBodyRequest } from "./GenerateBodyRequest";
-export { GenerateStreamBodyRequest } from "./GenerateStreamBodyRequest";
-export { SearchRequestBodyRequest } from "./SearchRequestBodyRequest";
-export { SubmitCompletionActualsRequest } from "./SubmitCompletionActualsRequest";
-export { SubmitWorkflowExecutionActualsRequest } from "./SubmitWorkflowExecutionActualsRequest";
+export { type ExecutePromptRequest } from "./ExecutePromptRequest";
+export { type ExecutePromptStreamRequest } from "./ExecutePromptStreamRequest";
+export { type ExecuteWorkflowRequest } from "./ExecuteWorkflowRequest";
+export { type ExecuteWorkflowStreamRequest } from "./ExecuteWorkflowStreamRequest";
+export { type GenerateBodyRequest } from "./GenerateBodyRequest";
+export { type GenerateStreamBodyRequest } from "./GenerateStreamBodyRequest";
+export { type SearchRequestBodyRequest } from "./SearchRequestBodyRequest";
+export { type SubmitCompletionActualsRequest } from "./SubmitCompletionActualsRequest";
+export { type SubmitWorkflowExecutionActualsRequest } from "./SubmitWorkflowExecutionActualsRequest";

package/api/errors/BadRequestError.d.ts

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

package/api/errors/BadRequestError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class BadRequestError extends errors.VellumError {
     constructor(body) {
         super({

package/api/errors/ForbiddenError.d.ts

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

package/api/errors/ForbiddenError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForbiddenError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class ForbiddenError extends errors.VellumError {
     constructor(body) {
         super({

package/api/errors/InternalServerError.d.ts

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

package/api/errors/InternalServerError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalServerError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class InternalServerError extends errors.VellumError {
     constructor(body) {
         super({

package/api/errors/NotFoundError.d.ts

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

package/api/errors/NotFoundError.js

@@ -27,7 +27,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class NotFoundError extends errors.VellumError {
     constructor(body) {
         super({

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vellum from "../../..";
+import * as Vellum from "../../../index";
 export declare namespace Deployments {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
@@ -12,15 +12,26 @@ export declare namespace Deployments {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class Deployments {
     protected readonly _options: Deployments.Options;
     constructor(_options: Deployments.Options);
+    /**
+     * @param {Vellum.DeploymentsListRequest} request
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.deployments.list()
+     */
     list(request?: Vellum.DeploymentsListRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.PaginatedSlimDeploymentReadList>;
     /**
      * Used to retrieve a deployment given its ID or name.
      *
+     * @param {string} id - Either the Deployment's ID or its unique name
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.deployments.retrieve("id")
      */
@@ -28,6 +39,10 @@ export declare class Deployments {
     /**
      * Retrieve a Deployment Release Tag by tag name, associated with a specified Deployment.
      *
+     * @param {string} id - A UUID string identifying this deployment.
+     * @param {string} name - The name of the Release Tag associated with this Deployment that you'd like to retrieve.
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.deployments.retrieveDeploymentReleaseTag("id", "name")
      */
@@ -35,11 +50,19 @@ export declare class Deployments {
     /**
      * Updates an existing Release Tag associated with the specified Deployment.
      *
+     * @param {string} id - A UUID string identifying this deployment.
+     * @param {string} name - The name of the Release Tag associated with this Deployment that you'd like to update.
+     * @param {Vellum.PatchedDeploymentReleaseTagUpdateRequest} request
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.deployments.updateDeploymentReleaseTag("id", "name")
      */
     updateDeploymentReleaseTag(id: string, name: string, request?: Vellum.PatchedDeploymentReleaseTagUpdateRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentReleaseTagRead>;
     /**
+     * @param {Vellum.DeploymentProviderPayloadRequest} request
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.ForbiddenError}
      * @throws {@link Vellum.NotFoundError}

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

@@ -41,14 +41,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Deployments = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const Vellum = __importStar(require("../../.."));
+const Vellum = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization"));
-const errors = __importStar(require("../../../../errors"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
 class Deployments {
     constructor(_options) {
         this._options = _options;
     }
+    /**
+     * @param {Vellum.DeploymentsListRequest} request
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.deployments.list()
+     */
     list(request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -70,11 +77,12 @@ class Deployments {
                 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: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.PaginatedSlimDeploymentReadList.parseOrThrow(_response.body, {
@@ -108,6 +116,9 @@ class Deployments {
     /**
      * Used to retrieve a deployment given its ID or name.
      *
+     * @param {string} id - Either the Deployment's ID or its unique name
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.deployments.retrieve("id")
      */
@@ -116,12 +127,13 @@ class Deployments {
         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}`),
+                    .default, `v1/deployments/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DeploymentRead.parseOrThrow(_response.body, {
@@ -155,6 +167,10 @@ class Deployments {
     /**
      * Retrieve a Deployment Release Tag by tag name, associated with a specified Deployment.
      *
+     * @param {string} id - A UUID string identifying this deployment.
+     * @param {string} name - The name of the Release Tag associated with this Deployment that you'd like to retrieve.
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.deployments.retrieveDeploymentReleaseTag("id", "name")
      */
@@ -163,12 +179,13 @@ class Deployments {
         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}/release-tags/${name}`),
+                    .default, `v1/deployments/${encodeURIComponent(id)}/release-tags/${encodeURIComponent(name)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DeploymentReleaseTagRead.parseOrThrow(_response.body, {
@@ -202,6 +219,11 @@ class Deployments {
     /**
      * Updates an existing Release Tag associated with the specified Deployment.
      *
+     * @param {string} id - A UUID string identifying this deployment.
+     * @param {string} name - The name of the Release Tag associated with this Deployment that you'd like to update.
+     * @param {Vellum.PatchedDeploymentReleaseTagUpdateRequest} request
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.deployments.updateDeploymentReleaseTag("id", "name")
      */
@@ -210,15 +232,16 @@ class Deployments {
         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}/release-tags/${name}`),
+                    .default, `v1/deployments/${encodeURIComponent(id)}/release-tags/${encodeURIComponent(name)}`),
                 method: "PATCH",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.PatchedDeploymentReleaseTagUpdateRequest.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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DeploymentReleaseTagRead.parseOrThrow(_response.body, {
@@ -250,6 +273,9 @@ class Deployments {
         });
     }
     /**
+     * @param {Vellum.DeploymentProviderPayloadRequest} request
+     * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.ForbiddenError}
      * @throws {@link Vellum.NotFoundError}
@@ -267,13 +293,14 @@ class Deployments {
                 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/provider-payload"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.DeploymentProviderPayloadRequest.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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DeploymentProviderPayloadResponse.parseOrThrow(_response.body, {

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
 /**
  * @example
  *     {

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
 /**
  * @example
  *     {}

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

@@ -1,3 +1,3 @@
-export { DeploymentsListRequest } from "./DeploymentsListRequest";
-export { PatchedDeploymentReleaseTagUpdateRequest } from "./PatchedDeploymentReleaseTagUpdateRequest";
-export { DeploymentProviderPayloadRequest } from "./DeploymentProviderPayloadRequest";
+export { type DeploymentsListRequest } from "./DeploymentsListRequest";
+export { type PatchedDeploymentReleaseTagUpdateRequest } from "./PatchedDeploymentReleaseTagUpdateRequest";
+export { type DeploymentProviderPayloadRequest } from "./DeploymentProviderPayloadRequest";

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vellum from "../../..";
+import * as Vellum from "../../../index";
 export declare namespace DocumentIndexes {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
@@ -12,6 +12,7 @@ export declare namespace DocumentIndexes {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class DocumentIndexes {
@@ -20,31 +21,85 @@ export declare class DocumentIndexes {
     /**
      * Used to retrieve a list of Document Indexes.
      *
+     * @param {Vellum.DocumentIndexesListRequest} request
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documentIndexes.list()
      */
     list(request?: Vellum.DocumentIndexesListRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.PaginatedDocumentIndexReadList>;
     /**
      * Creates a new document index.
+     *
+     * @param {Vellum.DocumentIndexCreateRequest} request
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.documentIndexes.create({
+     *         label: "string",
+     *         name: "string",
+     *         status: Vellum.EntityStatus.Active,
+     *         environment: Vellum.EnvironmentEnum.Development,
+     *         indexingConfig: {
+     *             vectorizer: {
+     *                 modelName: "text-embedding-3-small"
+     *             },
+     *             chunking: {
+     *                 chunkerName: "reducto-chunker"
+     *             }
+     *         },
+     *         copyDocumentsFromIndexId: "string"
+     *     })
      */
     create(request: Vellum.DocumentIndexCreateRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     /**
      * Used to retrieve a Document Index given its ID or name.
+     *
+     * @param {string} id - Either the Document Index's ID or its unique name
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.documentIndexes.retrieve("string")
      */
     retrieve(id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     /**
      * Used to fully update a Document Index given its ID.
+     *
+     * @param {string} id - A UUID string identifying this document index.
+     * @param {Vellum.DocumentIndexUpdateRequest} request
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.documentIndexes.update("string", {
+     *         label: "string",
+     *         status: Vellum.EntityStatus.Active,
+     *         environment: Vellum.EnvironmentEnum.Development
+     *     })
      */
     update(id: string, request: Vellum.DocumentIndexUpdateRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     /**
      * Used to delete a Document Index given its ID.
      *
+     * @param {string} id - A UUID string identifying this document index.
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documentIndexes.destroy("id")
      */
     destroy(id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<void>;
     /**
      * Used to partial update a Document Index given its ID.
+     *
+     * @param {string} id - A UUID string identifying this document index.
+     * @param {Vellum.PatchedDocumentIndexUpdateRequest} request
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.documentIndexes.partialUpdate("string", {
+     *         label: "string",
+     *         status: Vellum.EntityStatus.Active,
+     *         environment: Vellum.EnvironmentEnum.Development
+     *     })
      */
     partialUpdate(id: string, request?: Vellum.PatchedDocumentIndexUpdateRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     protected _getCustomAuthorizationHeaders(): Promise<{