vellum-ai 0.14.52 → 0.14.54

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

@@ -13,5 +13,5 @@ export interface WorkflowDeploymentHistoryItem {
     inputVariables: Vellum.VellumVariable[];
     outputVariables: Vellum.VellumVariable[];
     /** A human-readable description of the workflow deployment */
-    description?: string;
+    description?: string | null;
 }

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowDeploymentParentContext {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     type: "WORKFLOW_RELEASE_TAG";
     spanId: string;
     deploymentId: string;
@@ -12,7 +12,7 @@ export interface WorkflowDeploymentParentContext {
     deploymentHistoryItemId: string;
     releaseTagId: string;
     releaseTagName: string;
-    externalId?: string;
-    metadata?: Record<string, unknown>;
+    externalId?: string | null;
+    metadata?: Record<string, unknown> | null;
     workflowVersionId: string;
 }

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

@@ -32,5 +32,5 @@ export interface WorkflowDeploymentRead {
     /** The output variables this Workflow Deployment produces values for when it's executed. */
     outputVariables: Vellum.VellumVariable[];
     /** A human-readable description of the workflow deployment */
-    description?: string;
+    description?: string | null;
 }

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

@@ -6,7 +6,7 @@ export interface WorkflowDeploymentRelease {
     id: string;
     created: Date;
     environment: Vellum.ReleaseEnvironment;
-    createdBy?: Vellum.ReleaseCreatedBy;
+    createdBy?: Vellum.ReleaseCreatedBy | null;
     workflowVersion: Vellum.WorkflowDeploymentReleaseWorkflowVersion;
     deployment: Vellum.WorkflowDeploymentReleaseWorkflowDeployment;
     description?: string;

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

@@ -4,14 +4,14 @@
 import * as Vellum from "../index";
 export interface WorkflowEventExecutionRead {
     spanId: string;
-    parentContext?: Vellum.WorkflowDeploymentParentContext;
+    parentContext?: Vellum.WorkflowDeploymentParentContext | null;
     start: Date;
-    end?: Date;
+    end?: Date | null;
     inputs: Vellum.ExecutionVellumValue[];
     outputs: Vellum.ExecutionVellumValue[];
-    error?: Vellum.WorkflowError;
-    latestActual?: Vellum.WorkflowExecutionActual;
+    error?: Vellum.WorkflowError | null;
+    latestActual?: Vellum.WorkflowExecutionActual | null;
     metricResults: Vellum.WorkflowExecutionViewOnlineEvalMetricResult[];
-    usageResults?: Vellum.WorkflowExecutionUsageResult[];
+    usageResults?: Vellum.WorkflowExecutionUsageResult[] | null;
     spans: Vellum.VellumSpan[];
 }

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

@@ -6,5 +6,5 @@ export interface WorkflowExecutionActual {
     output: Vellum.ExecutionVellumValue;
     timestamp: Date;
     quality: number;
-    metadata?: Record<string, unknown>;
+    metadata?: Record<string, unknown> | null;
 }

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

@@ -4,16 +4,16 @@
 import * as Vellum from "../index";
 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;
+    outputId?: string | null;
     /** 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;
+    outputKey?: string | null;
     /** 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;
+    quality?: number | null;
     /** Optionally provide additional metadata about the feedback submission. */
-    metadata?: Record<string, unknown>;
+    metadata?: Record<string, unknown> | null;
     /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
-    timestamp?: number;
+    timestamp?: number | null;
     outputType: "CHAT_HISTORY";
     /** Optionally provide the value that the output ideally should have been. */
-    desiredOutputValue?: Vellum.ChatMessageRequest[];
+    desiredOutputValue?: Vellum.ChatMessageRequest[] | null;
 }

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

@@ -3,16 +3,16 @@
  */
 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;
+    outputId?: string | null;
     /** 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;
+    outputKey?: string | null;
     /** 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;
+    quality?: number | null;
     /** Optionally provide additional metadata about the feedback submission. */
-    metadata?: Record<string, unknown>;
+    metadata?: Record<string, unknown> | null;
     /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
-    timestamp?: number;
+    timestamp?: number | null;
     outputType: "JSON";
     /** Optionally provide the value that the output ideally should have been. */
-    desiredOutputValue?: Record<string, unknown>;
+    desiredOutputValue?: Record<string, unknown> | null;
 }

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

@@ -3,16 +3,16 @@
  */
 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;
+    outputId?: string | null;
     /** 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;
+    outputKey?: string | null;
     /** 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;
+    quality?: number | null;
     /** Optionally provide additional metadata about the feedback submission. */
-    metadata?: Record<string, unknown>;
+    metadata?: Record<string, unknown> | null;
     /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
-    timestamp?: number;
+    timestamp?: number | null;
     outputType: "STRING";
     /** Optionally provide the value that the output ideally should have been. */
-    desiredOutputValue?: string;
+    desiredOutputValue?: string | null;
 }

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowExecutionFulfilledEvent {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     name: "workflow.execution.fulfilled";
     body: Vellum.WorkflowExecutionFulfilledBody;
     id: string;

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowExecutionInitiatedEvent {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     name: "workflow.execution.initiated";
     body: Vellum.WorkflowExecutionInitiatedBody;
     id: string;

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

@@ -7,8 +7,8 @@ import * as Vellum from "../index";
  */
 export interface WorkflowExecutionNodeResultEvent {
     executionId: string;
-    runId?: string;
-    externalId?: string;
+    runId?: string | null;
+    externalId?: string | null;
     type: "NODE";
     data: Vellum.WorkflowNodeResultEvent;
 }

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowExecutionPausedEvent {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     name: "workflow.execution.paused";
     body: Vellum.WorkflowExecutionPausedBody;
     id: string;

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowExecutionRejectedEvent {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     name: "workflow.execution.rejected";
     body: Vellum.WorkflowExecutionRejectedBody;
     id: string;

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowExecutionResumedEvent {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     name: "workflow.execution.resumed";
     body: Vellum.WorkflowExecutionResumedBody;
     id: string;

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowExecutionSnapshottedEvent {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     name: "workflow.execution.snapshotted";
     body: Vellum.WorkflowExecutionSnapshottedBody;
     id: string;

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

@@ -9,5 +9,5 @@ export interface WorkflowExecutionSpan {
     spanId: string;
     startTs: Date;
     endTs: Date;
-    parentSpanId?: string;
+    parentSpanId?: string | null;
 }

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowExecutionStreamingEvent {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     name: "workflow.execution.streaming";
     body: Vellum.WorkflowExecutionStreamingBody;
     id: string;

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

@@ -3,7 +3,7 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowExecutionUsageResult {
-    usage?: Vellum.MlModelUsageWrapper[];
-    cost?: Vellum.Price[];
-    error?: Vellum.WorkflowExecutionUsageCalculationError;
+    usage?: Vellum.MlModelUsageWrapper[] | null;
+    cost?: Vellum.Price[] | null;
+    error?: Vellum.WorkflowExecutionUsageCalculationError | null;
 }

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

@@ -7,8 +7,8 @@ import * as Vellum from "../index";
  */
 export interface WorkflowExecutionWorkflowResultEvent {
     executionId: string;
-    runId?: string;
-    externalId?: string;
+    runId?: string | null;
+    externalId?: string | null;
     type: "WORKFLOW";
     data: Vellum.WorkflowResultEvent;
 }

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

@@ -3,9 +3,9 @@
  */
 export interface WorkflowExpandMetaRequest {
     /** If enabled, the Prompt Node FULFILLED events will include model host usage tracking. This may increase latency for some model hosts. */
-    usage?: boolean;
+    usage?: boolean | null;
     /** If enabled, the Prompt Node FULFILLED events will include model host cost tracking. This may increase latency for some model hosts. */
-    cost?: boolean;
+    cost?: boolean | null;
     /** If enabled, the Prompt Node FULFILLED events will include model host name */
-    modelName?: boolean;
+    modelName?: boolean | null;
 }

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

@@ -10,5 +10,5 @@ export interface WorkflowOutputArray {
     /** The output's name, as defined in the workflow */
     name: string;
     type: "ARRAY";
-    value?: Vellum.VellumValue[];
+    value?: Vellum.VellumValue[] | null;
 }

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

@@ -10,5 +10,5 @@ export interface WorkflowOutputChatHistory {
     /** The output's name, as defined in the workflow */
     name: string;
     type: "CHAT_HISTORY";
-    value?: Vellum.ChatMessage[];
+    value?: Vellum.ChatMessage[] | null;
 }

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

@@ -10,5 +10,5 @@ export interface WorkflowOutputError {
     /** The output's name, as defined in the workflow */
     name: string;
     type: "ERROR";
-    value?: Vellum.VellumError;
+    value?: Vellum.VellumError | null;
 }

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

@@ -10,5 +10,5 @@ export interface WorkflowOutputFunctionCall {
     /** The output's name, as defined in the workflow */
     name: string;
     type: "FUNCTION_CALL";
-    value?: Vellum.FunctionCall;
+    value?: Vellum.FunctionCall | null;
 }

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

@@ -10,5 +10,5 @@ export interface WorkflowOutputImage {
     /** The output's name, as defined in the workflow */
     name: string;
     type: "IMAGE";
-    value?: Vellum.VellumImage;
+    value?: Vellum.VellumImage | null;
 }

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

@@ -9,5 +9,5 @@ export interface WorkflowOutputNumber {
     /** The output's name, as defined in the workflow */
     name: string;
     type: "NUMBER";
-    value?: number;
+    value?: number | null;
 }

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

@@ -10,5 +10,5 @@ export interface WorkflowOutputSearchResults {
     /** The output's name, as defined in the workflow */
     name: string;
     type: "SEARCH_RESULTS";
-    value?: Vellum.SearchResult[];
+    value?: Vellum.SearchResult[] | null;
 }

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

@@ -9,5 +9,5 @@ export interface WorkflowOutputString {
     /** The output's name, as defined in the workflow */
     name: string;
     type: "STRING";
-    value?: string;
+    value?: string | null;
 }

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowParentContext {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     workflowDefinition: Vellum.VellumCodeResourceDefinition;
     type: "WORKFLOW";
     spanId: string;

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface WorkflowPushDeploymentConfigRequest {
-    label?: string;
-    name?: string;
-    description?: string;
-    releaseTags?: string[];
+    label?: string | null;
+    name?: string | null;
+    description?: string | null;
+    releaseTags?: string[] | null;
 }

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

@@ -3,6 +3,6 @@
  */
 export interface WorkflowPushResponse {
     workflowSandboxId: string;
-    workflowDeploymentId?: string;
-    proposedDiffs?: Record<string, unknown>;
+    workflowDeploymentId?: string | null;
+    proposedDiffs?: Record<string, unknown> | null;
 }

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

@@ -6,8 +6,8 @@ export interface WorkflowResultEvent {
     id: string;
     state: Vellum.WorkflowNodeResultEventState;
     ts: Date;
-    output?: Vellum.WorkflowResultEventOutputData;
-    error?: Vellum.WorkflowEventError;
-    outputs?: Vellum.WorkflowOutput[];
-    inputs?: Vellum.ExecutionVellumValue[];
+    output?: Vellum.WorkflowResultEventOutputData | null;
+    error?: Vellum.WorkflowEventError | null;
+    outputs?: Vellum.WorkflowOutput[] | null;
+    inputs?: Vellum.ExecutionVellumValue[] | null;
 }

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

@@ -6,12 +6,12 @@ import * as Vellum from "../index";
  * An Array output returned from a Workflow execution.
  */
 export interface WorkflowResultEventOutputDataArray {
-    id?: string;
+    id?: string | null;
     name: string;
     state: Vellum.WorkflowNodeResultEventState;
     nodeId: string;
     /** The newly output string value. Only relevant for string outputs with a state of STREAMING. */
-    delta?: string;
+    delta?: string | null;
     type: "ARRAY";
-    value?: Vellum.VellumValue[];
+    value?: Vellum.VellumValue[] | null;
 }

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

@@ -6,12 +6,12 @@ import * as Vellum from "../index";
  * A Chat History output streamed from a Workflow execution.
  */
 export interface WorkflowResultEventOutputDataChatHistory {
-    id?: string;
+    id?: string | null;
     name: string;
     state: Vellum.WorkflowNodeResultEventState;
     nodeId: string;
     /** The newly output string value. Only relevant for string outputs with a state of STREAMING. */
-    delta?: string;
+    delta?: string | null;
     type: "CHAT_HISTORY";
-    value?: Vellum.ChatMessage[];
+    value?: Vellum.ChatMessage[] | null;
 }

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

@@ -6,12 +6,12 @@ import * as Vellum from "../index";
  * An Error output streamed from a Workflow execution.
  */
 export interface WorkflowResultEventOutputDataError {
-    id?: string;
+    id?: string | null;
     name: string;
     state: Vellum.WorkflowNodeResultEventState;
     nodeId: string;
     /** The newly output string value. Only relevant for string outputs with a state of STREAMING. */
-    delta?: string;
+    delta?: string | null;
     type: "ERROR";
-    value?: Vellum.VellumError;
+    value?: Vellum.VellumError | null;
 }

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

@@ -6,12 +6,12 @@ import * as Vellum from "../index";
  * A Function Call output returned from a Workflow execution.
  */
 export interface WorkflowResultEventOutputDataFunctionCall {
-    id?: string;
+    id?: string | null;
     name: string;
     state: Vellum.WorkflowNodeResultEventState;
     nodeId: string;
     /** The newly output string value. Only relevant for string outputs with a state of STREAMING. */
-    delta?: string;
+    delta?: string | null;
     type: "FUNCTION_CALL";
-    value?: Vellum.FunctionCall;
+    value?: Vellum.FunctionCall | null;
 }

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

@@ -6,12 +6,12 @@ import * as Vellum from "../index";
  * A JSON output streamed from a Workflow execution.
  */
 export interface WorkflowResultEventOutputDataJson {
-    id?: string;
+    id?: string | null;
     name: string;
     state: Vellum.WorkflowNodeResultEventState;
     nodeId: string;
     /** The newly output string value. Only relevant for string outputs with a state of STREAMING. */
-    delta?: string;
+    delta?: string | null;
     type: "JSON";
     value?: unknown;
 }

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

@@ -6,12 +6,12 @@ import * as Vellum from "../index";
  * A number output streamed from a Workflow execution.
  */
 export interface WorkflowResultEventOutputDataNumber {
-    id?: string;
+    id?: string | null;
     name: string;
     state: Vellum.WorkflowNodeResultEventState;
     nodeId: string;
     /** The newly output string value. Only relevant for string outputs with a state of STREAMING. */
-    delta?: string;
+    delta?: string | null;
     type: "NUMBER";
-    value?: number;
+    value?: number | null;
 }

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

@@ -6,12 +6,12 @@ import * as Vellum from "../index";
  * A Search Results output streamed from a Workflow execution.
  */
 export interface WorkflowResultEventOutputDataSearchResults {
-    id?: string;
+    id?: string | null;
     name: string;
     state: Vellum.WorkflowNodeResultEventState;
     nodeId: string;
     /** The newly output string value. Only relevant for string outputs with a state of STREAMING. */
-    delta?: string;
+    delta?: string | null;
     type: "SEARCH_RESULTS";
-    value?: Vellum.SearchResult[];
+    value?: Vellum.SearchResult[] | null;
 }

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

@@ -6,13 +6,13 @@ import * as Vellum from "../index";
  * A string output streamed from a Workflow execution.
  */
 export interface WorkflowResultEventOutputDataString {
-    id?: string;
+    id?: string | null;
     name: string;
     state: Vellum.WorkflowNodeResultEventState;
     nodeId: string;
     /** The newly output string value, meant to be concatenated with all previous. Will be non-null for events of state STREAMING. */
-    delta?: string;
+    delta?: string | null;
     type: "STRING";
     /** The entire string value. Will be non-null for events of state FULFILLED. */
-    value?: string;
+    value?: string | null;
 }

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

@@ -4,6 +4,6 @@
 export interface WorkflowSandboxExample {
     id: string;
     label: string;
-    description?: string;
-    iconName?: string;
+    description?: string | null;
+    iconName?: string | null;
 }

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

@@ -3,8 +3,8 @@
  */
 import * as Vellum from "../index";
 export interface WorkflowSandboxParentContext {
-    parent?: Vellum.ParentContext;
-    links?: Vellum.SpanLink[];
+    parent?: Vellum.ParentContext | null;
+    links?: Vellum.SpanLink[] | null;
     type: "WORKFLOW_SANDBOX";
     spanId: string;
     sandboxId: string;

package/dist/core/fetcher/APIResponse.d.ts

@@ -1,10 +1,20 @@
+import { RawResponse } from "./RawResponse";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
 export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
 export interface SuccessfulResponse<T> {
     ok: true;
     body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
     headers?: Record<string, any>;
+    rawResponse: RawResponse;
 }
 export interface FailedResponse<T> {
     ok: false;
     error: T;
+    rawResponse: RawResponse;
 }