vellum-ai 0.0.37 → 0.0.39

package/Client.d.ts

@@ -21,7 +21,7 @@ export declare class VellumClient {
     protected readonly options: VellumClient.Options;
     constructor(options: VellumClient.Options);
     /**
-     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Stable</strong>
      *
      * Executes a deployed Workflow and streams back its results.
      * @throws {Vellum.BadRequestError}
@@ -75,6 +75,14 @@ export declare class VellumClient {
      * @throws {Vellum.InternalServerError}
      */
     submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to submit feedback regarding the quality of previous workflow execution and its outputs.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     */
+    submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest): Promise<void>;
     protected _deployments: Deployments | undefined;
     get deployments(): Deployments;
     protected _documentIndexes: DocumentIndexes | undefined;

package/Client.js

@@ -49,7 +49,7 @@ class VellumClient {
         this.options = options;
     }
     /**
-     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Stable</strong>
      *
      * Executes a deployed Workflow and streams back its results.
      * @throws {Vellum.BadRequestError}
@@ -296,6 +296,48 @@ class VellumClient {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to submit feedback regarding the quality of previous workflow execution and its outputs.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     */
+    async submitWorkflowExecutionActuals(request) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, "v1/submit-workflow-execution-actuals"),
+            method: "POST",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+            body: await serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "strip",
+            }),
+        });
+        if (_response.ok) {
+            return;
+        }
+        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,
+                });
+        }
+    }
     _deployments;
     get deployments() {
         return (this._deployments ??= new Client_1.Deployments(this.options));

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../..";
+export interface SubmitWorkflowExecutionActualsRequest {
+    /** Feedback regarding the quality of an output on a previously executed workflow. */
+    actuals: Vellum.SubmitWorkflowExecutionActualRequest[];
+    /** The Vellum-generated ID of a previously executed workflow. Must provide either this or external_id. */
+    executionId?: string;
+    /** The external ID that was originally provided by when executing the workflow, if applicable, that you'd now like to submit actuals for. Must provide either this or execution_id. */
+    externalId?: string;
+}

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

@@ -3,3 +3,4 @@ export { GenerateBodyRequest } from "./GenerateBodyRequest";
 export { GenerateStreamBodyRequest } from "./GenerateStreamBodyRequest";
 export { SearchRequestBodyRequest } from "./SearchRequestBodyRequest";
 export { SubmitCompletionActualsRequest } from "./SubmitCompletionActualsRequest";
+export { SubmitWorkflowExecutionActualsRequest } from "./SubmitWorkflowExecutionActualsRequest";

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/SubmitWorkflowExecutionActualRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type SubmitWorkflowExecutionActualRequest = Vellum.SubmitWorkflowExecutionActualRequest.String | Vellum.SubmitWorkflowExecutionActualRequest.Json | Vellum.SubmitWorkflowExecutionActualRequest.ChatHistory;
+export declare namespace SubmitWorkflowExecutionActualRequest {
+    interface String extends Vellum.WorkflowExecutionActualStringRequest {
+        outputType: "STRING";
+    }
+    interface Json extends Vellum.WorkflowExecutionActualJsonRequest {
+        outputType: "JSON";
+    }
+    interface ChatHistory extends Vellum.WorkflowExecutionActualChatHistoryRequest {
+        outputType: "CHAT_HISTORY";
+    }
+}

package/api/types/SubmitWorkflowExecutionActualRequest.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/types/WorkflowExecutionActualChatHistoryRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface WorkflowExecutionActualChatHistoryRequest {
+    /** The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred. */
+    outputId?: string;
+    /** The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id. */
+    outputKey?: string;
+    /** Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best. */
+    quality?: number;
+    /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
+    timestamp?: number;
+    /** Optionally provide the value that the output ideally should have been. */
+    desiredOutputValue?: Vellum.ChatMessageRequest[];
+}

package/api/types/WorkflowExecutionActualChatHistoryRequest.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/types/WorkflowExecutionActualJsonRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface WorkflowExecutionActualJsonRequest {
+    /** The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred. */
+    outputId?: string;
+    /** The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id. */
+    outputKey?: string;
+    /** Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best. */
+    quality?: number;
+    /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
+    timestamp?: number;
+    /** Optionally provide the value that the output ideally should have been. */
+    desiredOutputValue?: Record<string, unknown>;
+}

package/api/types/WorkflowExecutionActualJsonRequest.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/types/WorkflowExecutionActualStringRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface WorkflowExecutionActualStringRequest {
+    /** The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred. */
+    outputId?: string;
+    /** The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id. */
+    outputKey?: string;
+    /** Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best. */
+    quality?: number;
+    /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
+    timestamp?: number;
+    /** Optionally provide the value that the output ideally should have been. */
+    desiredOutputValue?: string;
+}

package/api/types/WorkflowExecutionActualStringRequest.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/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,11 +84,13 @@ export * from "./SearchNodeResultData";
 export * from "./SearchRequestOptionsRequest";
 export * from "./SearchResponse";
 export * from "./SearchResult";
+export * from "./SearchResultDocument";
 export * from "./SearchResultMergingRequest";
 export * from "./SearchWeightsRequest";
 export * from "./SlimDocument";
 export * from "./SubmitCompletionActualRequest";
 export * from "./SubmitCompletionActualsErrorResponse";
+export * from "./SubmitWorkflowExecutionActualRequest";
 export * from "./TemplatingNodeChatHistoryResult";
 export * from "./TemplatingNodeJsonResult";
 export * from "./TemplatingNodeResult";
@@ -110,6 +111,9 @@ export * from "./UploadDocumentResponse";
 export * from "./VellumVariable";
 export * from "./VellumVariableType";
 export * from "./WorkflowEventError";
+export * from "./WorkflowExecutionActualChatHistoryRequest";
+export * from "./WorkflowExecutionActualJsonRequest";
+export * from "./WorkflowExecutionActualStringRequest";
 export * from "./WorkflowExecutionEventErrorCode";
 export * from "./WorkflowExecutionEventType";
 export * from "./WorkflowExecutionNodeResultEvent";

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,11 +100,13 @@ __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);
 __exportStar(require("./SubmitCompletionActualRequest"), exports);
 __exportStar(require("./SubmitCompletionActualsErrorResponse"), exports);
+__exportStar(require("./SubmitWorkflowExecutionActualRequest"), exports);
 __exportStar(require("./TemplatingNodeChatHistoryResult"), exports);
 __exportStar(require("./TemplatingNodeJsonResult"), exports);
 __exportStar(require("./TemplatingNodeResult"), exports);
@@ -126,6 +127,9 @@ __exportStar(require("./UploadDocumentResponse"), exports);
 __exportStar(require("./VellumVariable"), exports);
 __exportStar(require("./VellumVariableType"), exports);
 __exportStar(require("./WorkflowEventError"), exports);
+__exportStar(require("./WorkflowExecutionActualChatHistoryRequest"), exports);
+__exportStar(require("./WorkflowExecutionActualJsonRequest"), exports);
+__exportStar(require("./WorkflowExecutionActualStringRequest"), exports);
 __exportStar(require("./WorkflowExecutionEventErrorCode"), exports);
 __exportStar(require("./WorkflowExecutionEventType"), exports);
 __exportStar(require("./WorkflowExecutionNodeResultEvent"), exports);

package/dist/Client.d.ts

@@ -21,7 +21,7 @@ export declare class VellumClient {
     protected readonly options: VellumClient.Options;
     constructor(options: VellumClient.Options);
     /**
-     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Stable</strong>
      *
      * Executes a deployed Workflow and streams back its results.
      * @throws {Vellum.BadRequestError}
@@ -75,6 +75,14 @@ export declare class VellumClient {
      * @throws {Vellum.InternalServerError}
      */
     submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to submit feedback regarding the quality of previous workflow execution and its outputs.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     */
+    submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest): Promise<void>;
     protected _deployments: Deployments | undefined;
     get deployments(): Deployments;
     protected _documentIndexes: DocumentIndexes | undefined;

package/dist/Client.js

@@ -49,7 +49,7 @@ class VellumClient {
         this.options = options;
     }
     /**
-     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Stable</strong>
      *
      * Executes a deployed Workflow and streams back its results.
      * @throws {Vellum.BadRequestError}
@@ -296,6 +296,48 @@ class VellumClient {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to submit feedback regarding the quality of previous workflow execution and its outputs.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     */
+    async submitWorkflowExecutionActuals(request) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, "v1/submit-workflow-execution-actuals"),
+            method: "POST",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+            body: await serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "strip",
+            }),
+        });
+        if (_response.ok) {
+            return;
+        }
+        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,
+                });
+        }
+    }
     _deployments;
     get deployments() {
         return (this._deployments ??= new Client_1.Deployments(this.options));

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../..";
+export interface SubmitWorkflowExecutionActualsRequest {
+    /** Feedback regarding the quality of an output on a previously executed workflow. */
+    actuals: Vellum.SubmitWorkflowExecutionActualRequest[];
+    /** The Vellum-generated ID of a previously executed workflow. Must provide either this or external_id. */
+    executionId?: string;
+    /** The external ID that was originally provided by when executing the workflow, if applicable, that you'd now like to submit actuals for. Must provide either this or execution_id. */
+    externalId?: string;
+}

package/dist/api/client/requests/SubmitWorkflowExecutionActualsRequest.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/dist/api/client/requests/index.d.ts

@@ -3,3 +3,4 @@ export { GenerateBodyRequest } from "./GenerateBodyRequest";
 export { GenerateStreamBodyRequest } from "./GenerateStreamBodyRequest";
 export { SearchRequestBodyRequest } from "./SearchRequestBodyRequest";
 export { SubmitCompletionActualsRequest } from "./SubmitCompletionActualsRequest";
+export { SubmitWorkflowExecutionActualsRequest } from "./SubmitWorkflowExecutionActualsRequest";

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/SearchResultDocument.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/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/SubmitWorkflowExecutionActualRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type SubmitWorkflowExecutionActualRequest = Vellum.SubmitWorkflowExecutionActualRequest.String | Vellum.SubmitWorkflowExecutionActualRequest.Json | Vellum.SubmitWorkflowExecutionActualRequest.ChatHistory;
+export declare namespace SubmitWorkflowExecutionActualRequest {
+    interface String extends Vellum.WorkflowExecutionActualStringRequest {
+        outputType: "STRING";
+    }
+    interface Json extends Vellum.WorkflowExecutionActualJsonRequest {
+        outputType: "JSON";
+    }
+    interface ChatHistory extends Vellum.WorkflowExecutionActualChatHistoryRequest {
+        outputType: "CHAT_HISTORY";
+    }
+}

package/dist/api/types/SubmitWorkflowExecutionActualRequest.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/dist/api/types/WorkflowExecutionActualChatHistoryRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface WorkflowExecutionActualChatHistoryRequest {
+    /** The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred. */
+    outputId?: string;
+    /** The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id. */
+    outputKey?: string;
+    /** Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best. */
+    quality?: number;
+    /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
+    timestamp?: number;
+    /** Optionally provide the value that the output ideally should have been. */
+    desiredOutputValue?: Vellum.ChatMessageRequest[];
+}

package/dist/api/types/WorkflowExecutionActualChatHistoryRequest.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/dist/api/types/WorkflowExecutionActualJsonRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface WorkflowExecutionActualJsonRequest {
+    /** The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred. */
+    outputId?: string;
+    /** The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id. */
+    outputKey?: string;
+    /** Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best. */
+    quality?: number;
+    /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
+    timestamp?: number;
+    /** Optionally provide the value that the output ideally should have been. */
+    desiredOutputValue?: Record<string, unknown>;
+}

package/dist/api/types/WorkflowExecutionActualJsonRequest.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/dist/api/types/WorkflowExecutionActualStringRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface WorkflowExecutionActualStringRequest {
+    /** The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred. */
+    outputId?: string;
+    /** The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id. */
+    outputKey?: string;
+    /** Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best. */
+    quality?: number;
+    /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
+    timestamp?: number;
+    /** Optionally provide the value that the output ideally should have been. */
+    desiredOutputValue?: string;
+}

package/dist/api/types/WorkflowExecutionActualStringRequest.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/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,11 +84,13 @@ export * from "./SearchNodeResultData";
 export * from "./SearchRequestOptionsRequest";
 export * from "./SearchResponse";
 export * from "./SearchResult";
+export * from "./SearchResultDocument";
 export * from "./SearchResultMergingRequest";
 export * from "./SearchWeightsRequest";
 export * from "./SlimDocument";
 export * from "./SubmitCompletionActualRequest";
 export * from "./SubmitCompletionActualsErrorResponse";
+export * from "./SubmitWorkflowExecutionActualRequest";
 export * from "./TemplatingNodeChatHistoryResult";
 export * from "./TemplatingNodeJsonResult";
 export * from "./TemplatingNodeResult";
@@ -110,6 +111,9 @@ export * from "./UploadDocumentResponse";
 export * from "./VellumVariable";
 export * from "./VellumVariableType";
 export * from "./WorkflowEventError";
+export * from "./WorkflowExecutionActualChatHistoryRequest";
+export * from "./WorkflowExecutionActualJsonRequest";
+export * from "./WorkflowExecutionActualStringRequest";
 export * from "./WorkflowExecutionEventErrorCode";
 export * from "./WorkflowExecutionEventType";
 export * from "./WorkflowExecutionNodeResultEvent";

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,11 +100,13 @@ __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);
 __exportStar(require("./SubmitCompletionActualRequest"), exports);
 __exportStar(require("./SubmitCompletionActualsErrorResponse"), exports);
+__exportStar(require("./SubmitWorkflowExecutionActualRequest"), exports);
 __exportStar(require("./TemplatingNodeChatHistoryResult"), exports);
 __exportStar(require("./TemplatingNodeJsonResult"), exports);
 __exportStar(require("./TemplatingNodeResult"), exports);
@@ -126,6 +127,9 @@ __exportStar(require("./UploadDocumentResponse"), exports);
 __exportStar(require("./VellumVariable"), exports);
 __exportStar(require("./VellumVariableType"), exports);
 __exportStar(require("./WorkflowEventError"), exports);
+__exportStar(require("./WorkflowExecutionActualChatHistoryRequest"), exports);
+__exportStar(require("./WorkflowExecutionActualJsonRequest"), exports);
+__exportStar(require("./WorkflowExecutionActualStringRequest"), exports);
 __exportStar(require("./WorkflowExecutionEventErrorCode"), exports);
 __exportStar(require("./WorkflowExecutionEventType"), exports);
 __exportStar(require("./WorkflowExecutionNodeResultEvent"), exports);