vellum-ai 0.14.52 → 0.14.54

package/api/types/NodeOutputCompiledNumberValue.d.ts

@@ -7,7 +7,7 @@ import * as Vellum from "../index";
  */
 export interface NodeOutputCompiledNumberValue {
     type: "NUMBER";
-    value?: number;
+    value?: number | null;
     nodeOutputId: string;
     state?: Vellum.WorkflowNodeResultEventState;
 }

package/api/types/NodeOutputCompiledSearchResultsValue.d.ts

@@ -7,7 +7,7 @@ import * as Vellum from "../index";
  */
 export interface NodeOutputCompiledSearchResultsValue {
     type: "SEARCH_RESULTS";
-    value?: Vellum.SearchResult[];
+    value?: Vellum.SearchResult[] | null;
     nodeOutputId: string;
     state?: Vellum.WorkflowNodeResultEventState;
 }

package/api/types/NodeOutputCompiledStringValue.d.ts

@@ -7,7 +7,7 @@ import * as Vellum from "../index";
  */
 export interface NodeOutputCompiledStringValue {
     type: "STRING";
-    value?: string;
+    value?: string | null;
     nodeOutputId: string;
     state?: Vellum.WorkflowNodeResultEventState;
 }

package/api/types/NodeParentContext.d.ts

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

package/api/types/NormalizedLogProbs.d.ts

@@ -4,5 +4,5 @@
 import * as Vellum from "../index";
 export interface NormalizedLogProbs {
     tokens: Vellum.NormalizedTokenLogProbs[];
-    likelihood?: number;
+    likelihood?: number | null;
 }

package/api/types/NormalizedTokenLogProbs.d.ts

@@ -3,7 +3,7 @@
  */
 export interface NormalizedTokenLogProbs {
     token: string;
-    logprob?: number;
-    topLogprobs?: Record<string, number | undefined>;
+    logprob?: number | null;
+    topLogprobs?: Record<string, (number | null) | undefined> | null;
     textOffset: number;
 }

package/api/types/NumberVellumValue.d.ts

@@ -6,5 +6,5 @@
  */
 export interface NumberVellumValue {
     type: "NUMBER";
-    value?: number;
+    value?: number | null;
 }

package/api/types/NumberVellumValueRequest.d.ts

@@ -6,5 +6,5 @@
  */
 export interface NumberVellumValueRequest {
     type: "NUMBER";
-    value?: number;
+    value?: number | null;
 }

package/api/types/PaginatedContainerImageReadList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedContainerImageReadList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.ContainerImageRead[];
 }

package/api/types/PaginatedDeploymentReleaseTagReadList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedDeploymentReleaseTagReadList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.DeploymentReleaseTagRead[];
 }

package/api/types/PaginatedDocumentIndexReadList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedDocumentIndexReadList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.DocumentIndexRead[];
 }

package/api/types/PaginatedFolderEntityList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedFolderEntityList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.FolderEntity[];
 }

package/api/types/PaginatedSlimDeploymentReadList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedSlimDeploymentReadList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.SlimDeploymentRead[];
 }

package/api/types/PaginatedSlimDocumentList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedSlimDocumentList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.SlimDocument[];
 }

package/api/types/PaginatedSlimWorkflowDeploymentList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedSlimWorkflowDeploymentList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.SlimWorkflowDeployment[];
 }

package/api/types/PaginatedTestSuiteRunExecutionList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedTestSuiteRunExecutionList {
     count: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results: Vellum.TestSuiteRunExecution[];
 }

package/api/types/PaginatedTestSuiteTestCaseList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedTestSuiteTestCaseList {
     count: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results: Vellum.TestSuiteTestCase[];
 }

package/api/types/PaginatedWorkflowReleaseTagReadList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedWorkflowReleaseTagReadList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.WorkflowReleaseTagRead[];
 }

package/api/types/PaginatedWorkflowSandboxExampleList.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface PaginatedWorkflowSandboxExampleList {
     count?: number;
-    next?: string;
-    previous?: string;
+    next?: string | null;
+    previous?: string | null;
     results?: Vellum.WorkflowSandboxExample[];
 }

package/api/types/PdfSearchResultMetaSource.d.ts

@@ -7,7 +7,7 @@
 export interface PdfSearchResultMetaSource {
     documentType: "PDF";
     /** The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types. */
-    startPageNum?: number;
+    startPageNum?: number | null;
     /** The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types. */
-    endPageNum?: number;
+    endPageNum?: number | null;
 }

package/api/types/PdfSearchResultMetaSourceRequest.d.ts

@@ -7,7 +7,7 @@
 export interface PdfSearchResultMetaSourceRequest {
     documentType: "PDF";
     /** The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types. */
-    startPageNum?: number;
+    startPageNum?: number | null;
     /** The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types. */
-    endPageNum?: number;
+    endPageNum?: number | null;
 }

package/api/types/PlainTextPromptBlock.d.ts

@@ -8,6 +8,6 @@ import * as Vellum from "../index";
 export interface PlainTextPromptBlock {
     blockType: "PLAIN_TEXT";
     state?: Vellum.PromptBlockState;
-    cacheConfig?: Vellum.EphemeralPromptCacheConfig;
+    cacheConfig?: Vellum.EphemeralPromptCacheConfig | null;
     text: string;
 }

package/api/types/PromptDeploymentExpandMetaRequest.d.ts

@@ -3,17 +3,17 @@
  */
 export interface PromptDeploymentExpandMetaRequest {
     /** If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt. */
-    modelName?: boolean;
+    modelName?: boolean | null;
     /** If enabled, the response will include model host usage tracking. This may increase latency for some model hosts. */
-    usage?: boolean;
+    usage?: boolean | null;
     /** If enabled, the response will include model host cost tracking. This may increase latency for some model hosts. */
-    cost?: boolean;
+    cost?: boolean | null;
     /** If enabled, the response will include the reason provided by the model for why the execution finished. */
-    finishReason?: boolean;
+    finishReason?: boolean | null;
     /** If enabled, the response will include the time in nanoseconds it took to execute the Prompt Deployment. */
-    latency?: boolean;
+    latency?: boolean | null;
     /** If enabled, the response will include the release tag of the Prompt Deployment. */
-    deploymentReleaseTag?: boolean;
+    deploymentReleaseTag?: boolean | null;
     /** If enabled, the response will include the ID of the Prompt Version backing the deployment. */
-    promptVersionId?: boolean;
+    promptVersionId?: boolean | null;
 }

package/api/types/PromptDeploymentParentContext.d.ts

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

package/api/types/PromptDeploymentRelease.d.ts

@@ -6,7 +6,7 @@ export interface PromptDeploymentRelease {
     id: string;
     created: Date;
     environment: Vellum.ReleaseEnvironment;
-    createdBy?: Vellum.ReleaseCreatedBy;
+    createdBy?: Vellum.ReleaseCreatedBy | null;
     promptVersion: Vellum.PromptDeploymentReleasePromptVersion;
     deployment: Vellum.PromptDeploymentReleasePromptDeployment;
     description?: string;

package/api/types/PromptExecConfig.d.ts

@@ -6,7 +6,7 @@ export interface PromptExecConfig {
     mlModel: string;
     inputVariables: Vellum.VellumVariable[];
     parameters: Vellum.PromptParameters;
-    settings?: Vellum.PromptSettings;
+    settings?: Vellum.PromptSettings | null;
     blocks: Vellum.PromptBlock[];
-    functions?: Vellum.FunctionDefinition[];
+    functions?: Vellum.FunctionDefinition[] | null;
 }

package/api/types/PromptExecutionMeta.d.ts

@@ -6,11 +6,11 @@ import * as Vellum from "../index";
  * The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
  */
 export interface PromptExecutionMeta {
-    modelName?: string;
-    latency?: number;
-    deploymentReleaseTag?: string;
-    promptVersionId?: string;
-    finishReason?: Vellum.FinishReasonEnum;
-    usage?: Vellum.MlModelUsage;
-    cost?: Vellum.Price;
+    modelName?: string | null;
+    latency?: number | null;
+    deploymentReleaseTag?: string | null;
+    promptVersionId?: string | null;
+    finishReason?: Vellum.FinishReasonEnum | null;
+    usage?: Vellum.MlModelUsage | null;
+    cost?: Vellum.Price | null;
 }

package/api/types/PromptNodeExecutionMeta.d.ts

@@ -6,7 +6,7 @@ import * as Vellum from "../index";
  * The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
  */
 export interface PromptNodeExecutionMeta {
-    usage?: Vellum.MlModelUsage;
-    cost?: Vellum.Price;
-    modelName?: string;
+    usage?: Vellum.MlModelUsage | null;
+    cost?: Vellum.Price | null;
+    modelName?: string | null;
 }

package/api/types/PromptNodeResultData.d.ts

@@ -3,10 +3,10 @@
  */
 import * as Vellum from "../index";
 export interface PromptNodeResultData {
-    executionMeta?: Vellum.PromptNodeExecutionMeta;
+    executionMeta?: Vellum.PromptNodeExecutionMeta | null;
     outputId: string;
-    arrayOutputId?: string;
-    executionId?: string;
-    text?: string;
-    delta?: string;
+    arrayOutputId?: string | null;
+    executionId?: string | null;
+    text?: string | null;
+    delta?: string | null;
 }

package/api/types/PromptParameters.d.ts

@@ -2,13 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface PromptParameters {
-    stop?: string[];
-    temperature?: number;
-    maxTokens?: number;
-    topP?: number;
-    topK?: number;
-    frequencyPenalty?: number;
-    presencePenalty?: number;
-    logitBias?: Record<string, number | undefined>;
-    customParameters?: Record<string, unknown>;
+    stop?: string[] | null;
+    temperature?: number | null;
+    maxTokens?: number | null;
+    topP?: number | null;
+    topK?: number | null;
+    frequencyPenalty?: number | null;
+    presencePenalty?: number | null;
+    logitBias?: Record<string, (number | null) | undefined> | null;
+    customParameters?: Record<string, unknown> | null;
 }

package/api/types/PromptSettings.d.ts

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface PromptSettings {
-    timeout?: number;
-    streamEnabled?: boolean;
+    timeout?: number | null;
+    streamEnabled?: boolean | null;
 }

package/api/types/RawPromptExecutionOverridesRequest.d.ts

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface RawPromptExecutionOverridesRequest {
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | null;
     /** The raw headers to send to the model host. */
-    headers?: Record<string, string | undefined>;
+    headers?: Record<string, (string | null) | undefined> | null;
     /** The raw URL to send to the model host. */
-    url?: string;
+    url?: string | null;
 }

package/api/types/RejectedPromptExecutionMeta.d.ts

@@ -6,6 +6,6 @@ import * as Vellum from "../index";
  * The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
  */
 export interface RejectedPromptExecutionMeta {
-    latency?: number;
-    finishReason?: Vellum.FinishReasonEnum;
+    latency?: number | null;
+    finishReason?: Vellum.FinishReasonEnum | null;
 }

package/api/types/RejectedWorkflowNodeResultEvent.d.ts

@@ -10,8 +10,8 @@ export interface RejectedWorkflowNodeResultEvent {
     nodeId: string;
     nodeResultId: string;
     state: "REJECTED";
-    ts?: Date;
-    data?: Vellum.WorkflowNodeResultData;
-    sourceExecutionId?: string;
+    ts?: Date | null;
+    data?: Vellum.WorkflowNodeResultData | null;
+    sourceExecutionId?: string | null;
     error: Vellum.WorkflowEventError;
 }

package/api/types/ReplaceTestSuiteTestCaseRequest.d.ts

@@ -7,11 +7,11 @@ import * as Vellum from "../index";
  */
 export interface ReplaceTestSuiteTestCaseRequest {
     /** The Vellum-generated ID of the Test Case whose data you'd like to replace. Must specify either this or external_id. */
-    id?: string;
+    id?: string | null;
     /** The ID that was originally provided upon Test Case creation that uniquely identifies the Test Case whose data you'd like to replace. Must specify either this of id. */
-    externalId?: string;
+    externalId?: string | null;
     /** A human-readable label used to convey the intention of this Test Case */
-    label?: string;
+    label?: string | null;
     /** Values for each of the Test Case's input variables */
     inputValues: Vellum.NamedTestCaseVariableValueRequest[];
     /** Values for each of the Test Case's evaluation variables */

package/api/types/RichTextPromptBlock.d.ts

@@ -8,6 +8,6 @@ import * as Vellum from "../index";
 export interface RichTextPromptBlock {
     blockType: "RICH_TEXT";
     state?: Vellum.PromptBlockState;
-    cacheConfig?: Vellum.EphemeralPromptCacheConfig;
+    cacheConfig?: Vellum.EphemeralPromptCacheConfig | null;
     blocks: Vellum.RichTextChildBlock[];
 }

package/api/types/ScenarioInputChatHistoryVariableValue.d.ts

@@ -7,6 +7,6 @@ import * as Vellum from "../index";
  */
 export interface ScenarioInputChatHistoryVariableValue {
     type: "CHAT_HISTORY";
-    value?: Vellum.ChatMessage[];
+    value?: Vellum.ChatMessage[] | null;
     inputVariableId: string;
 }

package/api/types/ScenarioInputStringVariableValue.d.ts

@@ -6,6 +6,6 @@
  */
 export interface ScenarioInputStringVariableValue {
     type: "STRING";
-    value?: string;
+    value?: string | null;
     inputVariableId: string;
 }

package/api/types/SearchFiltersRequest.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "../index";
 export interface SearchFiltersRequest {
     /** The document external IDs to filter by */
-    externalIds?: string[];
+    externalIds?: string[] | null;
     /** The metadata filters to apply to the search */
-    metadata?: Vellum.MetadataFiltersRequest;
+    metadata?: Vellum.MetadataFiltersRequest | null;
 }

package/api/types/SearchNodeResultData.d.ts

@@ -7,5 +7,5 @@ export interface SearchNodeResultData {
     /** The results of the search. Each result represents a chunk that matches the search query. */
     results: Vellum.SearchResult[];
     textOutputId: string;
-    text?: string;
+    text?: string | null;
 }

package/api/types/SearchRequestOptionsRequest.d.ts

@@ -4,11 +4,11 @@
 import * as Vellum from "../index";
 export interface SearchRequestOptionsRequest {
     /** The maximum number of results to return. */
-    limit?: number;
+    limit?: number | null;
     /** The weights to use for the search. Must add up to 1.0. */
-    weights?: Vellum.SearchWeightsRequest;
+    weights?: Vellum.SearchWeightsRequest | null;
     /** The configuration for merging results. */
-    resultMerging?: Vellum.SearchResultMergingRequest;
+    resultMerging?: Vellum.SearchResultMergingRequest | null;
     /** The filters to apply to the search. */
-    filters?: Vellum.SearchFiltersRequest;
+    filters?: Vellum.SearchFiltersRequest | null;
 }

package/api/types/SearchResult.d.ts

@@ -11,5 +11,5 @@ export interface SearchResult {
     /** The document that contains the chunk that matched the search query. */
     document: Vellum.SearchResultDocument;
     /** Additional information about the search result. */
-    meta?: Vellum.SearchResultMeta;
+    meta?: Vellum.SearchResultMeta | null;
 }

package/api/types/SearchResultDocument.d.ts

@@ -3,11 +3,11 @@
  */
 export interface SearchResultDocument {
     /** The ID of the document. */
-    id?: string;
+    id?: string | null;
     /** The human-readable name for the document. */
     label: string;
     /** The unique ID of the document as represented in an external system and specified when it was originally uploaded. */
-    externalId?: string;
+    externalId?: string | null;
     /** A previously supplied JSON object containing metadata that can be filtered on when searching. */
-    metadata?: Record<string, unknown>;
+    metadata?: Record<string, unknown> | null;
 }

package/api/types/SearchResultDocumentRequest.d.ts

@@ -3,11 +3,11 @@
  */
 export interface SearchResultDocumentRequest {
     /** The ID of the document. */
-    id?: string;
+    id?: string | null;
     /** The human-readable name for the document. */
     label: string;
     /** The unique ID of the document as represented in an external system and specified when it was originally uploaded. */
-    externalId?: string;
+    externalId?: string | null;
     /** A previously supplied JSON object containing metadata that can be filtered on when searching. */
-    metadata?: Record<string, unknown>;
+    metadata?: Record<string, unknown> | null;
 }

package/api/types/SearchResultMeta.d.ts

@@ -3,5 +3,5 @@
  */
 import * as Vellum from "../index";
 export interface SearchResultMeta {
-    source?: Vellum.ComponentsSchemasPdfSearchResultMetaSource;
+    source?: Vellum.ComponentsSchemasPdfSearchResultMetaSource | null;
 }

package/api/types/SearchResultMetaRequest.d.ts

@@ -3,5 +3,5 @@
  */
 import * as Vellum from "../index";
 export interface SearchResultMetaRequest {
-    source?: Vellum.ComponentsSchemasPdfSearchResultMetaSourceRequest;
+    source?: Vellum.ComponentsSchemasPdfSearchResultMetaSourceRequest | null;
 }

package/api/types/SearchResultRequest.d.ts

@@ -11,5 +11,5 @@ export interface SearchResultRequest {
     /** The document that contains the chunk that matched the search query. */
     document: Vellum.SearchResultDocumentRequest;
     /** Additional information about the search result. */
-    meta?: Vellum.SearchResultMetaRequest;
+    meta?: Vellum.SearchResultMetaRequest | null;
 }

package/api/types/SearchResultsVellumValue.d.ts

@@ -7,5 +7,5 @@ import * as Vellum from "../index";
  */
 export interface SearchResultsVellumValue {
     type: "SEARCH_RESULTS";
-    value?: Vellum.SearchResult[];
+    value?: Vellum.SearchResult[] | null;
 }

package/api/types/SearchResultsVellumValueRequest.d.ts

@@ -7,5 +7,5 @@ import * as Vellum from "../index";
  */
 export interface SearchResultsVellumValueRequest {
     type: "SEARCH_RESULTS";
-    value?: Vellum.SearchResultRequest[];
+    value?: Vellum.SearchResultRequest[] | null;
 }

package/api/types/SlimDeploymentRead.d.ts

@@ -27,5 +27,5 @@ export interface SlimDeploymentRead {
     lastDeployedOn: Date;
     inputVariables: Vellum.VellumVariable[];
     /** A human-readable description of the deployment */
-    description?: string;
+    description?: string | null;
 }

package/api/types/SlimDocument.d.ts

@@ -6,7 +6,7 @@ export interface SlimDocument {
     /** Vellum-generated ID that uniquely identifies this document. */
     id: string;
     /** The external ID that was originally provided when uploading the document. */
-    externalId?: string;
+    externalId?: string | null;
     /** A timestamp representing when this document was most recently uploaded. */
     lastUploadedAt: Date;
     /** Human-friendly name for this document. */
@@ -18,7 +18,7 @@ export interface SlimDocument {
      * * `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
      * * `INVALID_FILE` - Invalid File
      */
-    processingFailureReason?: Vellum.ProcessingFailureReasonEnum;
+    processingFailureReason?: Vellum.ProcessingFailureReasonEnum | null;
     /**
      * The document's current status.
      *
@@ -28,6 +28,6 @@ export interface SlimDocument {
     /** 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>;
+    metadata?: Record<string, unknown> | null;
     documentToDocumentIndexes: Vellum.SlimDocumentDocumentToDocumentIndex[];
 }

package/api/types/SlimWorkflowDeployment.d.ts

@@ -30,5 +30,5 @@ export interface SlimWorkflowDeployment {
     /** The output variables this Workflow Deployment will produce when it is executed. */
     outputVariables: Vellum.VellumVariable[];
     /** A human-readable description of the workflow deployment */
-    description?: string;
+    description?: string | null;
 }