vellum-ai 0.5.2 → 0.6.1

package/Client.js

@@ -71,7 +71,7 @@ class VellumClient {
                 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: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 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,
@@ -127,7 +127,7 @@ class VellumClient {
                 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: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.ExecutePromptStreamRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -195,7 +195,7 @@ class VellumClient {
                 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"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.ExecuteWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -249,7 +249,7 @@ class VellumClient {
                 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",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -325,7 +325,7 @@ class VellumClient {
                 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"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -383,7 +383,7 @@ class VellumClient {
                 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",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 responseType: "streaming",
@@ -456,7 +456,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/search"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -520,7 +520,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/submit-completion-actuals"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -578,7 +578,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/submit-workflow-execution-actuals"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",

package/README.md

@@ -1,7 +1,7 @@
 # Vellum Node Library
 
 [![npm shield](https://img.shields.io/npm/v/vellum-ai)](https://www.npmjs.com/package/vellum-ai)
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=vellum-ai/vellum-client-node/readme)
 
 The Vellum Node.js library provides access to the Vellum API from JavaScript/TypeScript.
 

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

@@ -70,7 +70,7 @@ 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.5.2", "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.1", "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,
@@ -118,7 +118,7 @@ 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/${id}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "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,
@@ -170,7 +170,7 @@ 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.5.2", "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.1", "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",

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

@@ -26,85 +26,14 @@ export declare class DocumentIndexes {
     list(request?: Vellum.DocumentIndexesListRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.PaginatedDocumentIndexReadList>;
     /**
      * Creates a new document index.
-     *
-     * @example
-     *     await vellum.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
-     *         indexingConfig: {
-     *             "chunking": {
-     *                 "chunker_name": "sentence-chunker",
-     *                 "chunker_config": {
-     *                     "character_limit": 1000,
-     *                     "min_overlap_ratio": 0.5
-     *                 }
-     *             },
-     *             "vectorizer": {
-     *                 "model_name": "hkunlp/instructor-xl",
-     *                 "config": {
-     *                     "instruction_domain": "",
-     *                     "instruction_document_text_type": "plain_text",
-     *                     "instruction_query_text_type": "plain_text"
-     *                 }
-     *             }
-     *         }
-     *     })
-     *
-     * @example
-     *     await vellum.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
-     *         indexingConfig: {
-     *             "chunking": {
-     *                 "chunker_name": "sentence-chunker",
-     *                 "chunker_config": {
-     *                     "character_limit": 1000,
-     *                     "min_overlap_ratio": 0.5
-     *                 }
-     *             },
-     *             "vectorizer": {
-     *                 "model_name": "sentence-transformers/multi-qa-mpnet-base-dot-v1",
-     *                 "config": {}
-     *             }
-     *         }
-     *     })
-     *
-     * @example
-     *     await vellum.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
-     *         indexingConfig: {
-     *             "chunking": {
-     *                 "chunker_name": "sentence-chunker",
-     *                 "chunker_config": {
-     *                     "character_limit": 1000,
-     *                     "min_overlap_ratio": 0.5
-     *                 }
-     *             },
-     *             "vectorizer": {
-     *                 "model_name": "text-embedding-ada-002",
-     *                 "config": {
-     *                     "add_openai_api_key": true
-     *                 }
-     *             }
-     *         }
-     *     })
      */
     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("id")
      */
     retrieve(id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     /**
      * Used to fully update a Document Index given its ID.
-     *
-     * @example
-     *     await vellum.documentIndexes.update("id", {
-     *         label: "label"
-     *     })
      */
     update(id: string, request: Vellum.DocumentIndexUpdateRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     /**
@@ -116,9 +45,6 @@ export declare class DocumentIndexes {
     destroy(id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<void>;
     /**
      * Used to partial update a Document Index given its ID.
-     *
-     * @example
-     *     await vellum.documentIndexes.partialUpdate("id")
      */
     partialUpdate(id: string, request?: Vellum.PatchedDocumentIndexUpdateRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     protected _getCustomAuthorizationHeaders(): Promise<{

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

@@ -57,7 +57,7 @@ class DocumentIndexes {
     list(request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const { limit, offset, ordering, status } = request;
+            const { limit, offset, ordering, search, status } = request;
             const _queryParams = {};
             if (limit != null) {
                 _queryParams["limit"] = limit.toString();
@@ -68,6 +68,9 @@ class DocumentIndexes {
             if (ordering != null) {
                 _queryParams["ordering"] = ordering;
             }
+            if (search != null) {
+                _queryParams["search"] = search;
+            }
             if (status != null) {
                 _queryParams["status"] = status;
             }
@@ -75,7 +78,7 @@ class DocumentIndexes {
                 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: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "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,
@@ -112,69 +115,6 @@ class DocumentIndexes {
     }
     /**
      * Creates a new document index.
-     *
-     * @example
-     *     await vellum.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
-     *         indexingConfig: {
-     *             "chunking": {
-     *                 "chunker_name": "sentence-chunker",
-     *                 "chunker_config": {
-     *                     "character_limit": 1000,
-     *                     "min_overlap_ratio": 0.5
-     *                 }
-     *             },
-     *             "vectorizer": {
-     *                 "model_name": "hkunlp/instructor-xl",
-     *                 "config": {
-     *                     "instruction_domain": "",
-     *                     "instruction_document_text_type": "plain_text",
-     *                     "instruction_query_text_type": "plain_text"
-     *                 }
-     *             }
-     *         }
-     *     })
-     *
-     * @example
-     *     await vellum.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
-     *         indexingConfig: {
-     *             "chunking": {
-     *                 "chunker_name": "sentence-chunker",
-     *                 "chunker_config": {
-     *                     "character_limit": 1000,
-     *                     "min_overlap_ratio": 0.5
-     *                 }
-     *             },
-     *             "vectorizer": {
-     *                 "model_name": "sentence-transformers/multi-qa-mpnet-base-dot-v1",
-     *                 "config": {}
-     *             }
-     *         }
-     *     })
-     *
-     * @example
-     *     await vellum.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
-     *         indexingConfig: {
-     *             "chunking": {
-     *                 "chunker_name": "sentence-chunker",
-     *                 "chunker_config": {
-     *                     "character_limit": 1000,
-     *                     "min_overlap_ratio": 0.5
-     *                 }
-     *             },
-     *             "vectorizer": {
-     *                 "model_name": "text-embedding-ada-002",
-     *                 "config": {
-     *                     "add_openai_api_key": true
-     *                 }
-     *             }
-     *         }
-     *     })
      */
     create(request, requestOptions) {
         var _a;
@@ -183,7 +123,7 @@ class DocumentIndexes {
                 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: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.DocumentIndexCreateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -222,9 +162,6 @@ class DocumentIndexes {
     }
     /**
      * Used to retrieve a Document Index given its ID or name.
-     *
-     * @example
-     *     await vellum.documentIndexes.retrieve("id")
      */
     retrieve(id, requestOptions) {
         var _a;
@@ -233,7 +170,7 @@ class DocumentIndexes {
                 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: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "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,
@@ -269,11 +206,6 @@ class DocumentIndexes {
     }
     /**
      * Used to fully update a Document Index given its ID.
-     *
-     * @example
-     *     await vellum.documentIndexes.update("id", {
-     *         label: "label"
-     *     })
      */
     update(id, request, requestOptions) {
         var _a;
@@ -282,7 +214,7 @@ class DocumentIndexes {
                 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: "PUT",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.DocumentIndexUpdateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -332,7 +264,7 @@ class DocumentIndexes {
                 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: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "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,
@@ -363,9 +295,6 @@ class DocumentIndexes {
     }
     /**
      * Used to partial update a Document Index given its ID.
-     *
-     * @example
-     *     await vellum.documentIndexes.partialUpdate("id")
      */
     partialUpdate(id, request = {}, requestOptions) {
         var _a;
@@ -374,7 +303,7 @@ class DocumentIndexes {
                 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: "PATCH",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.PatchedDocumentIndexUpdateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",

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

@@ -2,70 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../../../..";
-/**
- * @example
- *     {
- *         label: "My Document Index",
- *         name: "my-document-index",
- *         indexingConfig: {
- *             "chunking": {
- *                 "chunker_name": "sentence-chunker",
- *                 "chunker_config": {
- *                     "character_limit": 1000,
- *                     "min_overlap_ratio": 0.5
- *                 }
- *             },
- *             "vectorizer": {
- *                 "model_name": "hkunlp/instructor-xl",
- *                 "config": {
- *                     "instruction_domain": "",
- *                     "instruction_document_text_type": "plain_text",
- *                     "instruction_query_text_type": "plain_text"
- *                 }
- *             }
- *         }
- *     }
- *
- * @example
- *     {
- *         label: "My Document Index",
- *         name: "my-document-index",
- *         indexingConfig: {
- *             "chunking": {
- *                 "chunker_name": "sentence-chunker",
- *                 "chunker_config": {
- *                     "character_limit": 1000,
- *                     "min_overlap_ratio": 0.5
- *                 }
- *             },
- *             "vectorizer": {
- *                 "model_name": "sentence-transformers/multi-qa-mpnet-base-dot-v1",
- *                 "config": {}
- *             }
- *         }
- *     }
- *
- * @example
- *     {
- *         label: "My Document Index",
- *         name: "my-document-index",
- *         indexingConfig: {
- *             "chunking": {
- *                 "chunker_name": "sentence-chunker",
- *                 "chunker_config": {
- *                     "character_limit": 1000,
- *                     "min_overlap_ratio": 0.5
- *                 }
- *             },
- *             "vectorizer": {
- *                 "model_name": "text-embedding-ada-002",
- *                 "config": {
- *                     "add_openai_api_key": true
- *                 }
- *             }
- *         }
- *     }
- */
 export interface DocumentIndexCreateRequest {
     /** A human-readable label for the document index */
     label: string;
@@ -86,8 +22,7 @@ export interface DocumentIndexCreateRequest {
      * * `PRODUCTION` - Production
      */
     environment?: Vellum.EnvironmentEnum;
-    /** Configuration representing how documents should be indexed */
-    indexingConfig: Record<string, unknown>;
+    indexingConfig: Vellum.DocumentIndexIndexingConfigRequest;
     /** Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index */
     copyDocumentsFromIndexId?: string;
 }

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

@@ -2,12 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../../../..";
-/**
- * @example
- *     {
- *         label: "label"
- *     }
- */
 export interface DocumentIndexUpdateRequest {
     /** A human-readable label for the document index */
     label: string;

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

@@ -20,7 +20,11 @@ export interface DocumentIndexesListRequest {
      */
     ordering?: string;
     /**
-     * The current status of the document index
+     * Search for document indices by name or label
+     */
+    search?: string;
+    /**
+     * Filter down to only document indices that have a status matching the status specified
      *
      * - `ACTIVE` - Active
      * - `ARCHIVED` - Archived

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

@@ -2,10 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../../../..";
-/**
- * @example
- *     {}
- */
 export interface PatchedDocumentIndexUpdateRequest {
     /** A human-readable label for the document index */
     label?: string;

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

@@ -27,15 +27,21 @@ export declare class Documents {
      */
     list(request?: Vellum.DocumentsListRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.PaginatedSlimDocumentList>;
     /**
-     * Retrieve a Document via its Vellum-generated ID.
+     * Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.
      *
      * @example
      *     await vellum.documents.retrieve("id")
      */
     retrieve(id: string, requestOptions?: Documents.RequestOptions): Promise<Vellum.DocumentRead>;
+    /**
+     * Delete a Document, keying off of either its Vellum-generated ID or its external ID.
+     *
+     * @example
+     *     await vellum.documents.destroy("id")
+     */
     destroy(id: string, requestOptions?: Documents.RequestOptions): Promise<void>;
     /**
-     * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
+     * Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.
      *
      * @example
      *     await vellum.documents.partialUpdate("id")

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

@@ -77,7 +77,7 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/documents"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "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,
@@ -113,7 +113,7 @@ class Documents {
         });
     }
     /**
-     * Retrieve a Document via its Vellum-generated ID.
+     * Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.
      *
      * @example
      *     await vellum.documents.retrieve("id")
@@ -125,7 +125,7 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/documents/${id}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "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,
@@ -159,6 +159,12 @@ class Documents {
             }
         });
     }
+    /**
+     * Delete a Document, keying off of either its Vellum-generated ID or its external ID.
+     *
+     * @example
+     *     await vellum.documents.destroy("id")
+     */
     destroy(id, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -166,7 +172,7 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/documents/${id}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "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,
@@ -196,7 +202,7 @@ class Documents {
         });
     }
     /**
-     * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
+     * Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.
      *
      * @example
      *     await vellum.documents.partialUpdate("id")
@@ -208,7 +214,7 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/documents/${id}`),
                 method: "PATCH",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.PatchedDocumentUpdateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -287,7 +293,7 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .documents, "v1/upload-document"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "multipart/form-data; boundary=" + _request.getBoundary(),
                 body: _request,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,

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

@@ -65,7 +65,7 @@ class FolderEntities {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/folders/${folderId}/add-entity`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.5.2", "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.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.AddEntityToFolderRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,