vellum-ai 0.0.37 → 0.0.38

package/api/types/DocumentRead.d.ts

@@ -27,6 +27,6 @@ export interface DocumentRead {
     originalFileUrl?: string;
     processedFileUrl?: string;
     documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
-    /** A previously supplied JSON object containing metadata that can filtered on when searching. */
+    /** A previously supplied JSON object containing metadata that can be filtered on when searching. */
     metadata?: Record<string, unknown>;
 }

package/api/types/SearchResult.d.ts

@@ -9,5 +9,5 @@ export interface SearchResult {
     score: number;
     keywords: string[];
     /** The document that contains the chunk that matched the search query. */
-    document: Vellum.Document;
+    document: Vellum.SearchResultDocument;
 }

package/api/types/{Document.d.ts → SearchResultDocument.d.ts}

@@ -1,11 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface Document {
+export interface SearchResultDocument {
     /** The ID of the document. */
     id: string;
     /** The human-readable name for the document. <span style="white-space: nowrap">`<= 1000 characters`</span> */
     label: string;
     /** The unique ID of the document as represented in an external system and specified when it was originally uploaded. */
     externalId?: string;
+    /** A previously supplied JSON object containing metadata that can be filtered on when searching. */
+    metadata?: Record<string, unknown>;
 }

package/api/types/SlimDocument.d.ts

@@ -35,5 +35,7 @@ export interface SlimDocument {
     status?: Vellum.DocumentStatus;
     /** A list of keywords associated with this document. Originally provided when uploading the document. */
     keywords?: string[];
+    /** A previously supplied JSON object containing metadata that can be filtered on when searching. */
+    metadata?: Record<string, unknown>;
     documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
 }

package/api/types/index.d.ts

@@ -7,7 +7,6 @@ export * from "./ConditionalNodeResultData";
 export * from "./ContentType";
 export * from "./DeploymentRead";
 export * from "./DeploymentStatus";
-export * from "./Document";
 export * from "./DocumentDocumentToDocumentIndex";
 export * from "./DocumentIndexRead";
 export * from "./DocumentIndexStatus";
@@ -85,6 +84,7 @@ export * from "./SearchNodeResultData";
 export * from "./SearchRequestOptionsRequest";
 export * from "./SearchResponse";
 export * from "./SearchResult";
+export * from "./SearchResultDocument";
 export * from "./SearchResultMergingRequest";
 export * from "./SearchWeightsRequest";
 export * from "./SlimDocument";

package/api/types/index.js

@@ -23,7 +23,6 @@ __exportStar(require("./ConditionalNodeResultData"), exports);
 __exportStar(require("./ContentType"), exports);
 __exportStar(require("./DeploymentRead"), exports);
 __exportStar(require("./DeploymentStatus"), exports);
-__exportStar(require("./Document"), exports);
 __exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
 __exportStar(require("./DocumentIndexRead"), exports);
 __exportStar(require("./DocumentIndexStatus"), exports);
@@ -101,6 +100,7 @@ __exportStar(require("./SearchNodeResultData"), exports);
 __exportStar(require("./SearchRequestOptionsRequest"), exports);
 __exportStar(require("./SearchResponse"), exports);
 __exportStar(require("./SearchResult"), exports);
+__exportStar(require("./SearchResultDocument"), exports);
 __exportStar(require("./SearchResultMergingRequest"), exports);
 __exportStar(require("./SearchWeightsRequest"), exports);
 __exportStar(require("./SlimDocument"), exports);

package/dist/api/types/DocumentRead.d.ts

@@ -27,6 +27,6 @@ export interface DocumentRead {
     originalFileUrl?: string;
     processedFileUrl?: string;
     documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
-    /** A previously supplied JSON object containing metadata that can filtered on when searching. */
+    /** A previously supplied JSON object containing metadata that can be filtered on when searching. */
     metadata?: Record<string, unknown>;
 }

package/dist/api/types/SearchResult.d.ts

@@ -9,5 +9,5 @@ export interface SearchResult {
     score: number;
     keywords: string[];
     /** The document that contains the chunk that matched the search query. */
-    document: Vellum.Document;
+    document: Vellum.SearchResultDocument;
 }

package/dist/api/types/{Document.d.ts → SearchResultDocument.d.ts}

@@ -1,11 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface Document {
+export interface SearchResultDocument {
     /** The ID of the document. */
     id: string;
     /** The human-readable name for the document. <span style="white-space: nowrap">`<= 1000 characters`</span> */
     label: string;
     /** The unique ID of the document as represented in an external system and specified when it was originally uploaded. */
     externalId?: string;
+    /** A previously supplied JSON object containing metadata that can be filtered on when searching. */
+    metadata?: Record<string, unknown>;
 }

package/dist/api/types/SlimDocument.d.ts

@@ -35,5 +35,7 @@ export interface SlimDocument {
     status?: Vellum.DocumentStatus;
     /** A list of keywords associated with this document. Originally provided when uploading the document. */
     keywords?: string[];
+    /** A previously supplied JSON object containing metadata that can be filtered on when searching. */
+    metadata?: Record<string, unknown>;
     documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
 }

package/dist/api/types/index.d.ts

@@ -7,7 +7,6 @@ export * from "./ConditionalNodeResultData";
 export * from "./ContentType";
 export * from "./DeploymentRead";
 export * from "./DeploymentStatus";
-export * from "./Document";
 export * from "./DocumentDocumentToDocumentIndex";
 export * from "./DocumentIndexRead";
 export * from "./DocumentIndexStatus";
@@ -85,6 +84,7 @@ export * from "./SearchNodeResultData";
 export * from "./SearchRequestOptionsRequest";
 export * from "./SearchResponse";
 export * from "./SearchResult";
+export * from "./SearchResultDocument";
 export * from "./SearchResultMergingRequest";
 export * from "./SearchWeightsRequest";
 export * from "./SlimDocument";

package/dist/api/types/index.js

@@ -23,7 +23,6 @@ __exportStar(require("./ConditionalNodeResultData"), exports);
 __exportStar(require("./ContentType"), exports);
 __exportStar(require("./DeploymentRead"), exports);
 __exportStar(require("./DeploymentStatus"), exports);
-__exportStar(require("./Document"), exports);
 __exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
 __exportStar(require("./DocumentIndexRead"), exports);
 __exportStar(require("./DocumentIndexStatus"), exports);
@@ -101,6 +100,7 @@ __exportStar(require("./SearchNodeResultData"), exports);
 __exportStar(require("./SearchRequestOptionsRequest"), exports);
 __exportStar(require("./SearchResponse"), exports);
 __exportStar(require("./SearchResult"), exports);
+__exportStar(require("./SearchResultDocument"), exports);
 __exportStar(require("./SearchResultMergingRequest"), exports);
 __exportStar(require("./SearchWeightsRequest"), exports);
 __exportStar(require("./SlimDocument"), exports);

package/dist/serialization/types/SearchResult.d.ts

@@ -10,6 +10,6 @@ export declare namespace SearchResult {
         text: string;
         score: number;
         keywords: string[];
-        document: serializers.Document.Raw;
+        document: serializers.SearchResultDocument.Raw;
     }
 }

package/dist/serialization/types/SearchResult.js

@@ -32,5 +32,5 @@ exports.SearchResult = core.serialization.object({
     text: core.serialization.string(),
     score: core.serialization.number(),
     keywords: core.serialization.list(core.serialization.string()),
-    document: core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).Document),
+    document: core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).SearchResultDocument),
 });

package/dist/serialization/types/{Document.d.ts → SearchResultDocument.d.ts}

@@ -4,11 +4,12 @@
 import * as serializers from "..";
 import * as Vellum from "../../api";
 import * as core from "../../core";
-export declare const Document: core.serialization.ObjectSchema<serializers.Document.Raw, Vellum.Document>;
-export declare namespace Document {
+export declare const SearchResultDocument: core.serialization.ObjectSchema<serializers.SearchResultDocument.Raw, Vellum.SearchResultDocument>;
+export declare namespace SearchResultDocument {
     interface Raw {
         id: string;
         label: string;
         external_id?: string | null;
+        metadata?: Record<string, unknown> | null;
     }
 }

package/dist/serialization/types/{Document.js → SearchResultDocument.js}

@@ -26,10 +26,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Document = void 0;
+exports.SearchResultDocument = void 0;
 const core = __importStar(require("../../core"));
-exports.Document = core.serialization.object({
+exports.SearchResultDocument = core.serialization.object({
     id: core.serialization.string(),
     label: core.serialization.string(),
     externalId: core.serialization.property("external_id", core.serialization.string().optional()),
+    metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
 });

package/dist/serialization/types/SlimDocument.d.ts

@@ -15,6 +15,7 @@ export declare namespace SlimDocument {
         processing_failure_reason?: serializers.ProcessingFailureReasonEnum.Raw | null;
         status?: serializers.DocumentStatus.Raw | null;
         keywords?: string[] | null;
+        metadata?: Record<string, unknown> | null;
         document_to_document_indexes: serializers.DocumentDocumentToDocumentIndex.Raw[];
     }
 }

package/dist/serialization/types/SlimDocument.js

@@ -37,5 +37,6 @@ exports.SlimDocument = core.serialization.object({
     processingFailureReason: core.serialization.property("processing_failure_reason", core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("..")))).ProcessingFailureReasonEnum).optional()),
     status: core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("..")))).DocumentStatus).optional(),
     keywords: core.serialization.list(core.serialization.string()).optional(),
+    metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
     documentToDocumentIndexes: core.serialization.property("document_to_document_indexes", core.serialization.list(core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).DocumentDocumentToDocumentIndex))),
 });

package/dist/serialization/types/index.d.ts

@@ -7,7 +7,6 @@ export * from "./ConditionalNodeResultData";
 export * from "./ContentType";
 export * from "./DeploymentRead";
 export * from "./DeploymentStatus";
-export * from "./Document";
 export * from "./DocumentDocumentToDocumentIndex";
 export * from "./DocumentIndexRead";
 export * from "./DocumentIndexStatus";
@@ -85,6 +84,7 @@ export * from "./SearchNodeResultData";
 export * from "./SearchRequestOptionsRequest";
 export * from "./SearchResponse";
 export * from "./SearchResult";
+export * from "./SearchResultDocument";
 export * from "./SearchResultMergingRequest";
 export * from "./SearchWeightsRequest";
 export * from "./SlimDocument";

package/dist/serialization/types/index.js

@@ -23,7 +23,6 @@ __exportStar(require("./ConditionalNodeResultData"), exports);
 __exportStar(require("./ContentType"), exports);
 __exportStar(require("./DeploymentRead"), exports);
 __exportStar(require("./DeploymentStatus"), exports);
-__exportStar(require("./Document"), exports);
 __exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
 __exportStar(require("./DocumentIndexRead"), exports);
 __exportStar(require("./DocumentIndexStatus"), exports);
@@ -101,6 +100,7 @@ __exportStar(require("./SearchNodeResultData"), exports);
 __exportStar(require("./SearchRequestOptionsRequest"), exports);
 __exportStar(require("./SearchResponse"), exports);
 __exportStar(require("./SearchResult"), exports);
+__exportStar(require("./SearchResultDocument"), exports);
 __exportStar(require("./SearchResultMergingRequest"), exports);
 __exportStar(require("./SearchWeightsRequest"), exports);
 __exportStar(require("./SlimDocument"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vellum-ai",
-    "version": "v0.0.37",
+    "version": "v0.0.38",
     "private": false,
     "repository": "https://github.com/vellum-ai/vellum-client-node",
     "main": "./index.js",

package/serialization/types/SearchResult.d.ts

@@ -10,6 +10,6 @@ export declare namespace SearchResult {
         text: string;
         score: number;
         keywords: string[];
-        document: serializers.Document.Raw;
+        document: serializers.SearchResultDocument.Raw;
     }
 }

package/serialization/types/SearchResult.js

@@ -32,5 +32,5 @@ exports.SearchResult = core.serialization.object({
     text: core.serialization.string(),
     score: core.serialization.number(),
     keywords: core.serialization.list(core.serialization.string()),
-    document: core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).Document),
+    document: core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).SearchResultDocument),
 });

package/serialization/types/{Document.d.ts → SearchResultDocument.d.ts}

@@ -4,11 +4,12 @@
 import * as serializers from "..";
 import * as Vellum from "../../api";
 import * as core from "../../core";
-export declare const Document: core.serialization.ObjectSchema<serializers.Document.Raw, Vellum.Document>;
-export declare namespace Document {
+export declare const SearchResultDocument: core.serialization.ObjectSchema<serializers.SearchResultDocument.Raw, Vellum.SearchResultDocument>;
+export declare namespace SearchResultDocument {
     interface Raw {
         id: string;
         label: string;
         external_id?: string | null;
+        metadata?: Record<string, unknown> | null;
     }
 }

package/serialization/types/{Document.js → SearchResultDocument.js}

@@ -26,10 +26,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Document = void 0;
+exports.SearchResultDocument = void 0;
 const core = __importStar(require("../../core"));
-exports.Document = core.serialization.object({
+exports.SearchResultDocument = core.serialization.object({
     id: core.serialization.string(),
     label: core.serialization.string(),
     externalId: core.serialization.property("external_id", core.serialization.string().optional()),
+    metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
 });

package/serialization/types/SlimDocument.d.ts

@@ -15,6 +15,7 @@ export declare namespace SlimDocument {
         processing_failure_reason?: serializers.ProcessingFailureReasonEnum.Raw | null;
         status?: serializers.DocumentStatus.Raw | null;
         keywords?: string[] | null;
+        metadata?: Record<string, unknown> | null;
         document_to_document_indexes: serializers.DocumentDocumentToDocumentIndex.Raw[];
     }
 }

package/serialization/types/SlimDocument.js

@@ -37,5 +37,6 @@ exports.SlimDocument = core.serialization.object({
     processingFailureReason: core.serialization.property("processing_failure_reason", core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("..")))).ProcessingFailureReasonEnum).optional()),
     status: core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("..")))).DocumentStatus).optional(),
     keywords: core.serialization.list(core.serialization.string()).optional(),
+    metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
     documentToDocumentIndexes: core.serialization.property("document_to_document_indexes", core.serialization.list(core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).DocumentDocumentToDocumentIndex))),
 });

package/serialization/types/index.d.ts

@@ -7,7 +7,6 @@ export * from "./ConditionalNodeResultData";
 export * from "./ContentType";
 export * from "./DeploymentRead";
 export * from "./DeploymentStatus";
-export * from "./Document";
 export * from "./DocumentDocumentToDocumentIndex";
 export * from "./DocumentIndexRead";
 export * from "./DocumentIndexStatus";
@@ -85,6 +84,7 @@ export * from "./SearchNodeResultData";
 export * from "./SearchRequestOptionsRequest";
 export * from "./SearchResponse";
 export * from "./SearchResult";
+export * from "./SearchResultDocument";
 export * from "./SearchResultMergingRequest";
 export * from "./SearchWeightsRequest";
 export * from "./SlimDocument";

package/serialization/types/index.js

@@ -23,7 +23,6 @@ __exportStar(require("./ConditionalNodeResultData"), exports);
 __exportStar(require("./ContentType"), exports);
 __exportStar(require("./DeploymentRead"), exports);
 __exportStar(require("./DeploymentStatus"), exports);
-__exportStar(require("./Document"), exports);
 __exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
 __exportStar(require("./DocumentIndexRead"), exports);
 __exportStar(require("./DocumentIndexStatus"), exports);
@@ -101,6 +100,7 @@ __exportStar(require("./SearchNodeResultData"), exports);
 __exportStar(require("./SearchRequestOptionsRequest"), exports);
 __exportStar(require("./SearchResponse"), exports);
 __exportStar(require("./SearchResult"), exports);
+__exportStar(require("./SearchResultDocument"), exports);
 __exportStar(require("./SearchResultMergingRequest"), exports);
 __exportStar(require("./SearchWeightsRequest"), exports);
 __exportStar(require("./SlimDocument"), exports);