vellum-ai 0.0.40 → 0.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/Client.d.ts +2 -14
  2. package/Client.js +2 -14
  3. package/api/client/requests/SearchRequestBodyRequest.d.ts +1 -1
  4. package/api/resources/deployments/client/Client.d.ts +0 -4
  5. package/api/resources/deployments/client/Client.js +0 -4
  6. package/api/resources/documentIndexes/client/Client.d.ts +0 -2
  7. package/api/resources/documentIndexes/client/Client.js +0 -2
  8. package/api/resources/documentIndexes/client/requests/DocumentIndexCreateRequest.d.ts +2 -2
  9. package/api/resources/documents/client/Client.d.ts +0 -10
  10. package/api/resources/documents/client/Client.js +0 -10
  11. package/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +1 -1
  12. package/api/resources/documents/client/requests/UploadDocumentBodyRequest.d.ts +1 -1
  13. package/api/resources/modelVersions/client/Client.d.ts +0 -6
  14. package/api/resources/modelVersions/client/Client.js +0 -6
  15. package/api/resources/registeredPrompts/client/Client.d.ts +0 -2
  16. package/api/resources/registeredPrompts/client/Client.js +0 -2
  17. package/api/resources/registeredPrompts/client/requests/RegisterPromptRequestRequest.d.ts +3 -3
  18. package/api/resources/sandboxes/client/Client.d.ts +0 -4
  19. package/api/resources/sandboxes/client/Client.js +0 -4
  20. package/api/resources/sandboxes/client/requests/UpsertSandboxScenarioRequestRequest.d.ts +1 -1
  21. package/api/resources/testSuites/client/Client.d.ts +1 -4
  22. package/api/resources/testSuites/client/Client.js +1 -4
  23. package/api/resources/testSuites/client/requests/TestSuiteTestCaseRequest.d.ts +1 -1
  24. package/api/types/DeploymentRead.d.ts +4 -4
  25. package/api/types/DocumentIndexRead.d.ts +3 -3
  26. package/api/types/DocumentRead.d.ts +2 -2
  27. package/api/types/LogicalOperator.d.ts +98 -0
  28. package/api/types/LogicalOperator.js +26 -0
  29. package/api/types/MetadataFilterConfigRequest.d.ts +1 -4
  30. package/api/types/MetadataFilterRuleRequest.d.ts +1 -4
  31. package/api/types/ModelVersionRead.d.ts +3 -3
  32. package/api/types/PromptTemplateBlockPropertiesRequest.d.ts +0 -2
  33. package/api/types/PromptTemplateBlockRequest.d.ts +0 -1
  34. package/api/types/RegisteredPromptInputVariableRequest.d.ts +0 -2
  35. package/api/types/ScenarioInputRequest.d.ts +0 -1
  36. package/api/types/SearchResultDocument.d.ts +1 -1
  37. package/api/types/SlimDocument.d.ts +2 -2
  38. package/api/types/SubmitCompletionActualRequest.d.ts +1 -1
  39. package/api/types/WorkflowExecutionEventErrorCode.d.ts +3 -1
  40. package/api/types/WorkflowExecutionEventErrorCode.js +1 -0
  41. package/api/types/WorkflowNodeResultEvent.d.ts +1 -1
  42. package/api/types/WorkflowRequestChatHistoryInputRequest.d.ts +1 -1
  43. package/api/types/WorkflowRequestJsonInputRequest.d.ts +1 -1
  44. package/api/types/WorkflowRequestStringInputRequest.d.ts +1 -1
  45. package/api/types/WorkflowResultEvent.d.ts +1 -1
  46. package/api/types/index.d.ts +1 -0
  47. package/api/types/index.js +1 -0
  48. package/dist/Client.d.ts +2 -14
  49. package/dist/Client.js +2 -14
  50. package/dist/api/client/requests/SearchRequestBodyRequest.d.ts +1 -1
  51. package/dist/api/resources/deployments/client/Client.d.ts +0 -4
  52. package/dist/api/resources/deployments/client/Client.js +0 -4
  53. package/dist/api/resources/documentIndexes/client/Client.d.ts +0 -2
  54. package/dist/api/resources/documentIndexes/client/Client.js +0 -2
  55. package/dist/api/resources/documentIndexes/client/requests/DocumentIndexCreateRequest.d.ts +2 -2
  56. package/dist/api/resources/documents/client/Client.d.ts +0 -10
  57. package/dist/api/resources/documents/client/Client.js +0 -10
  58. package/dist/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +1 -1
  59. package/dist/api/resources/documents/client/requests/UploadDocumentBodyRequest.d.ts +1 -1
  60. package/dist/api/resources/modelVersions/client/Client.d.ts +0 -6
  61. package/dist/api/resources/modelVersions/client/Client.js +0 -6
  62. package/dist/api/resources/registeredPrompts/client/Client.d.ts +0 -2
  63. package/dist/api/resources/registeredPrompts/client/Client.js +0 -2
  64. package/dist/api/resources/registeredPrompts/client/requests/RegisterPromptRequestRequest.d.ts +3 -3
  65. package/dist/api/resources/sandboxes/client/Client.d.ts +0 -4
  66. package/dist/api/resources/sandboxes/client/Client.js +0 -4
  67. package/dist/api/resources/sandboxes/client/requests/UpsertSandboxScenarioRequestRequest.d.ts +1 -1
  68. package/dist/api/resources/testSuites/client/Client.d.ts +1 -4
  69. package/dist/api/resources/testSuites/client/Client.js +1 -4
  70. package/dist/api/resources/testSuites/client/requests/TestSuiteTestCaseRequest.d.ts +1 -1
  71. package/dist/api/types/DeploymentRead.d.ts +4 -4
  72. package/dist/api/types/DocumentIndexRead.d.ts +3 -3
  73. package/dist/api/types/DocumentRead.d.ts +2 -2
  74. package/dist/api/types/LogicalOperator.d.ts +98 -0
  75. package/dist/api/types/LogicalOperator.js +26 -0
  76. package/dist/api/types/MetadataFilterConfigRequest.d.ts +1 -4
  77. package/dist/api/types/MetadataFilterRuleRequest.d.ts +1 -4
  78. package/dist/api/types/ModelVersionRead.d.ts +3 -3
  79. package/dist/api/types/PromptTemplateBlockPropertiesRequest.d.ts +0 -2
  80. package/dist/api/types/PromptTemplateBlockRequest.d.ts +0 -1
  81. package/dist/api/types/RegisteredPromptInputVariableRequest.d.ts +0 -2
  82. package/dist/api/types/ScenarioInputRequest.d.ts +0 -1
  83. package/dist/api/types/SearchResultDocument.d.ts +1 -1
  84. package/dist/api/types/SlimDocument.d.ts +2 -2
  85. package/dist/api/types/SubmitCompletionActualRequest.d.ts +1 -1
  86. package/dist/api/types/WorkflowExecutionEventErrorCode.d.ts +3 -1
  87. package/dist/api/types/WorkflowExecutionEventErrorCode.js +1 -0
  88. package/dist/api/types/WorkflowNodeResultEvent.d.ts +1 -1
  89. package/dist/api/types/WorkflowRequestChatHistoryInputRequest.d.ts +1 -1
  90. package/dist/api/types/WorkflowRequestJsonInputRequest.d.ts +1 -1
  91. package/dist/api/types/WorkflowRequestStringInputRequest.d.ts +1 -1
  92. package/dist/api/types/WorkflowResultEvent.d.ts +1 -1
  93. package/dist/api/types/index.d.ts +1 -0
  94. package/dist/api/types/index.js +1 -0
  95. package/dist/serialization/types/DeploymentRead.js +2 -2
  96. package/dist/serialization/types/DocumentIndexRead.js +1 -1
  97. package/dist/serialization/types/DocumentRead.js +1 -1
  98. package/dist/serialization/types/LogicalOperator.d.ts +10 -0
  99. package/dist/serialization/types/LogicalOperator.js +50 -0
  100. package/dist/serialization/types/MetadataFilterConfigRequest.d.ts +1 -1
  101. package/dist/serialization/types/MetadataFilterConfigRequest.js +1 -1
  102. package/dist/serialization/types/MetadataFilterRuleRequest.d.ts +1 -1
  103. package/dist/serialization/types/MetadataFilterRuleRequest.js +1 -1
  104. package/dist/serialization/types/ModelVersionRead.js +1 -1
  105. package/dist/serialization/types/SlimDocument.js +1 -1
  106. package/dist/serialization/types/SubmitCompletionActualRequest.js +1 -1
  107. package/dist/serialization/types/WorkflowExecutionEventErrorCode.d.ts +1 -1
  108. package/dist/serialization/types/WorkflowExecutionEventErrorCode.js +1 -0
  109. package/dist/serialization/types/WorkflowNodeResultEvent.js +1 -1
  110. package/dist/serialization/types/WorkflowResultEvent.js +1 -1
  111. package/dist/serialization/types/index.d.ts +1 -0
  112. package/dist/serialization/types/index.js +1 -0
  113. package/package.json +1 -1
  114. package/serialization/types/DeploymentRead.js +2 -2
  115. package/serialization/types/DocumentIndexRead.js +1 -1
  116. package/serialization/types/DocumentRead.js +1 -1
  117. package/serialization/types/LogicalOperator.d.ts +10 -0
  118. package/serialization/types/LogicalOperator.js +50 -0
  119. package/serialization/types/MetadataFilterConfigRequest.d.ts +1 -1
  120. package/serialization/types/MetadataFilterConfigRequest.js +1 -1
  121. package/serialization/types/MetadataFilterRuleRequest.d.ts +1 -1
  122. package/serialization/types/MetadataFilterRuleRequest.js +1 -1
  123. package/serialization/types/ModelVersionRead.js +1 -1
  124. package/serialization/types/SlimDocument.js +1 -1
  125. package/serialization/types/SubmitCompletionActualRequest.js +1 -1
  126. package/serialization/types/WorkflowExecutionEventErrorCode.d.ts +1 -1
  127. package/serialization/types/WorkflowExecutionEventErrorCode.js +1 -0
  128. package/serialization/types/WorkflowNodeResultEvent.js +1 -1
  129. package/serialization/types/WorkflowResultEvent.js +1 -1
  130. package/serialization/types/index.d.ts +1 -0
  131. package/serialization/types/index.js +1 -0
@@ -6,8 +6,8 @@ export interface ModelVersionRead {
6
6
  /** Vellum-generated ID that uniquely identifies this model version. */
7
7
  id: string;
8
8
  /** Timestamp of when this model version was created. */
9
- created: string;
10
- /** Human-friendly name for this model version. <span style="white-space: nowrap">`<= 150 characters`</span> */
9
+ created: Date;
10
+ /** Human-friendly name for this model version. */
11
11
  label: string;
12
12
  modelType: Vellum.ModelTypeDeprecated;
13
13
  /**
@@ -23,7 +23,7 @@ export interface ModelVersionRead {
23
23
  * * `PYQ` - Pyq
24
24
  */
25
25
  provider: Vellum.ProviderEnum;
26
- /** The unique id of this model version as it exists in the above provider's system. <span style="white-space: nowrap">`<= 250 characters`</span> */
26
+ /** The unique id of this model version as it exists in the above provider's system. */
27
27
  externalId: string;
28
28
  /** Configuration used to build this model version. */
29
29
  buildConfig: Vellum.ModelVersionBuildConfig;
@@ -7,9 +7,7 @@ export interface PromptTemplateBlockPropertiesRequest {
7
7
  chatMessageUnterminated?: boolean;
8
8
  template?: string;
9
9
  templateType?: Vellum.ContentType;
10
- /** <span style="white-space: nowrap">`non-empty`</span> */
11
10
  functionName?: string;
12
- /** <span style="white-space: nowrap">`non-empty`</span> */
13
11
  functionDescription?: string;
14
12
  functionParameters?: Record<string, unknown>;
15
13
  functionForced?: boolean;
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Vellum from "..";
5
5
  export interface PromptTemplateBlockRequest {
6
- /** <span style="white-space: nowrap">`non-empty`</span> */
7
6
  id: string;
8
7
  blockType: Vellum.BlockTypeEnum;
9
8
  properties: Vellum.PromptTemplateBlockPropertiesRequest;
@@ -3,9 +3,7 @@
3
3
  */
4
4
  import * as Vellum from "..";
5
5
  export interface RegisteredPromptInputVariableRequest {
6
- /** <span style="white-space: nowrap">`non-empty`</span> */
7
6
  key: string;
8
- /** <span style="white-space: nowrap">`non-empty`</span> */
9
7
  id?: string;
10
8
  type?: Vellum.VellumVariableType;
11
9
  }
@@ -3,7 +3,6 @@
3
3
  */
4
4
  import * as Vellum from "..";
5
5
  export interface ScenarioInputRequest {
6
- /** <span style="white-space: nowrap">`non-empty`</span> */
7
6
  key: string;
8
7
  type?: Vellum.ScenarioInputTypeEnum;
9
8
  value?: string;
@@ -4,7 +4,7 @@
4
4
  export interface SearchResultDocument {
5
5
  /** The ID of the document. */
6
6
  id: string;
7
- /** The human-readable name for the document. <span style="white-space: nowrap">`<= 1000 characters`</span> */
7
+ /** The human-readable name for the document. */
8
8
  label: string;
9
9
  /** The unique ID of the document as represented in an external system and specified when it was originally uploaded. */
10
10
  externalId?: string;
@@ -8,8 +8,8 @@ export interface SlimDocument {
8
8
  /** The external ID that was originally provided when uploading the document. */
9
9
  externalId?: string;
10
10
  /** A timestamp representing when this document was most recently uploaded. */
11
- lastUploadedAt: string;
12
- /** Human-friendly name for this document. <span style="white-space: nowrap">`<= 1000 characters`</span> */
11
+ lastUploadedAt: Date;
12
+ /** Human-friendly name for this document. */
13
13
  label: string;
14
14
  /**
15
15
  * An enum value representing where this document is along its processing lifecycle. Note that this is different than its indexing lifecycle.
@@ -11,5 +11,5 @@ export interface SubmitCompletionActualRequest {
11
11
  /** A number between 0 and 1 representing the quality of the completion. 0 is the worst, 1 is the best. */
12
12
  quality?: number;
13
13
  /** Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes. */
14
- timestamp?: string;
14
+ timestamp?: Date;
15
15
  }
@@ -4,14 +4,16 @@
4
4
  /**
5
5
  * * `WORKFLOW_INITIALIZATION` - WORKFLOW_INITIALIZATION
6
6
  * * `NODE_EXECUTION_COUNT_LIMIT_REACHED` - NODE_EXECUTION_COUNT_LIMIT_REACHED
7
+ * * `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
7
8
  * * `NODE_EXECUTION` - NODE_EXECUTION
8
9
  * * `LLM_PROVIDER` - LLM_PROVIDER
9
10
  * * `INVALID_TEMPLATE` - INVALID_TEMPLATE
10
11
  */
11
- export declare type WorkflowExecutionEventErrorCode = "WORKFLOW_INITIALIZATION" | "NODE_EXECUTION_COUNT_LIMIT_REACHED" | "NODE_EXECUTION" | "LLM_PROVIDER" | "INVALID_TEMPLATE";
12
+ export declare type WorkflowExecutionEventErrorCode = "WORKFLOW_INITIALIZATION" | "NODE_EXECUTION_COUNT_LIMIT_REACHED" | "INTERNAL_SERVER_ERROR" | "NODE_EXECUTION" | "LLM_PROVIDER" | "INVALID_TEMPLATE";
12
13
  export declare const WorkflowExecutionEventErrorCode: {
13
14
  readonly WorkflowInitialization: "WORKFLOW_INITIALIZATION";
14
15
  readonly NodeExecutionCountLimitReached: "NODE_EXECUTION_COUNT_LIMIT_REACHED";
16
+ readonly InternalServerError: "INTERNAL_SERVER_ERROR";
15
17
  readonly NodeExecution: "NODE_EXECUTION";
16
18
  readonly LlmProvider: "LLM_PROVIDER";
17
19
  readonly InvalidTemplate: "INVALID_TEMPLATE";
@@ -7,6 +7,7 @@ exports.WorkflowExecutionEventErrorCode = void 0;
7
7
  exports.WorkflowExecutionEventErrorCode = {
8
8
  WorkflowInitialization: "WORKFLOW_INITIALIZATION",
9
9
  NodeExecutionCountLimitReached: "NODE_EXECUTION_COUNT_LIMIT_REACHED",
10
+ InternalServerError: "INTERNAL_SERVER_ERROR",
10
11
  NodeExecution: "NODE_EXECUTION",
11
12
  LlmProvider: "LLM_PROVIDER",
12
13
  InvalidTemplate: "INVALID_TEMPLATE",
@@ -7,7 +7,7 @@ export interface WorkflowNodeResultEvent {
7
7
  nodeId: string;
8
8
  nodeResultId: string;
9
9
  state: Vellum.WorkflowNodeResultEventState;
10
- ts?: string;
10
+ ts?: Date;
11
11
  data?: Vellum.WorkflowNodeResultData;
12
12
  error?: Vellum.WorkflowEventError;
13
13
  inputValues?: Vellum.NodeInputVariableCompiledValue[];
@@ -3,7 +3,7 @@
3
3
  */
4
4
  import * as Vellum from "..";
5
5
  export interface WorkflowRequestChatHistoryInputRequest {
6
- /** The variable's name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> */
6
+ /** The variable's name, as defined in the Workflow. */
7
7
  name: string;
8
8
  value: Vellum.ChatMessageRequest[];
9
9
  }
@@ -2,7 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  export interface WorkflowRequestJsonInputRequest {
5
- /** The variable's name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> */
5
+ /** The variable's name, as defined in the Workflow. */
6
6
  name: string;
7
7
  value: Record<string, unknown>;
8
8
  }
@@ -2,7 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  export interface WorkflowRequestStringInputRequest {
5
- /** The variable's name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> */
5
+ /** The variable's name, as defined in the Workflow. */
6
6
  name: string;
7
7
  value: string;
8
8
  }
@@ -5,7 +5,7 @@ import * as Vellum from "..";
5
5
  export interface WorkflowResultEvent {
6
6
  id: string;
7
7
  state: Vellum.WorkflowNodeResultEventState;
8
- ts: string;
8
+ ts: Date;
9
9
  output?: Vellum.WorkflowResultEventOutputData;
10
10
  error?: Vellum.WorkflowEventError;
11
11
  }
@@ -29,6 +29,7 @@ export * from "./GenerateStreamResponse";
29
29
  export * from "./GenerateStreamResult";
30
30
  export * from "./GenerateStreamResultData";
31
31
  export * from "./IndexingStateEnum";
32
+ export * from "./LogicalOperator";
32
33
  export * from "./LogprobsEnum";
33
34
  export * from "./MetadataFilterConfigRequest";
34
35
  export * from "./MetadataFilterRuleCombinator";
@@ -45,6 +45,7 @@ __exportStar(require("./GenerateStreamResponse"), exports);
45
45
  __exportStar(require("./GenerateStreamResult"), exports);
46
46
  __exportStar(require("./GenerateStreamResultData"), exports);
47
47
  __exportStar(require("./IndexingStateEnum"), exports);
48
+ __exportStar(require("./LogicalOperator"), exports);
48
49
  __exportStar(require("./LogprobsEnum"), exports);
49
50
  __exportStar(require("./MetadataFilterConfigRequest"), exports);
50
51
  __exportStar(require("./MetadataFilterRuleCombinator"), exports);
package/dist/Client.d.ts CHANGED
@@ -21,8 +21,6 @@ export declare class VellumClient {
21
21
  protected readonly options: VellumClient.Options;
22
22
  constructor(options: VellumClient.Options);
23
23
  /**
24
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Stable</strong>
25
- *
26
24
  * Executes a deployed Workflow and streams back its results.
27
25
  * @throws {Vellum.BadRequestError}
28
26
  * @throws {Vellum.NotFoundError}
@@ -30,8 +28,6 @@ export declare class VellumClient {
30
28
  */
31
29
  executeWorkflowStream(request: Vellum.ExecuteWorkflowStreamRequest, cb: (data: Vellum.WorkflowStreamEvent) => void, opts?: Pick<core.StreamingFetcher.Args, "onError" | "onFinish" | "abortController" | "timeoutMs">): Promise<void>;
32
30
  /**
33
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
34
- *
35
31
  * Generate a completion using a previously defined deployment.
36
32
  *
37
33
  * **Note:** Uses a base url of `https://predict.vellum.ai`.
@@ -42,8 +38,6 @@ export declare class VellumClient {
42
38
  */
43
39
  generate(request: Vellum.GenerateBodyRequest): Promise<Vellum.GenerateResponse>;
44
40
  /**
45
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
46
- *
47
41
  * Generate a stream of completions using a previously defined deployment.
48
42
  *
49
43
  * **Note:** Uses a base url of `https://predict.vellum.ai`.
@@ -54,8 +48,6 @@ export declare class VellumClient {
54
48
  */
55
49
  generateStream(request: Vellum.GenerateStreamBodyRequest, cb: (data: Vellum.GenerateStreamResponse) => void, opts?: Pick<core.StreamingFetcher.Args, "onError" | "onFinish" | "abortController" | "timeoutMs">): Promise<void>;
56
50
  /**
57
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
58
- *
59
51
  * Perform a search against a document index.
60
52
  *
61
53
  * **Note:** Uses a base url of `https://predict.vellum.ai`.
@@ -65,8 +57,6 @@ export declare class VellumClient {
65
57
  */
66
58
  search(request: Vellum.SearchRequestBodyRequest): Promise<Vellum.SearchResponse>;
67
59
  /**
68
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
69
- *
70
60
  * Used to submit feedback regarding the quality of previously generated completions.
71
61
  *
72
62
  * **Note:** Uses a base url of `https://predict.vellum.ai`.
@@ -76,11 +66,9 @@ export declare class VellumClient {
76
66
  */
77
67
  submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
78
68
  /**
79
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
80
- *
81
- * Used to submit feedback regarding the quality of previous workflow execution and its outputs.
69
+ * Used to submit feedback regarding the quality of previous workflow execution and its outputs.
82
70
  *
83
- * **Note:** Uses a base url of `https://predict.vellum.ai`.
71
+ * **Note:** Uses a base url of `https://predict.vellum.ai`.
84
72
  */
85
73
  submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest): Promise<void>;
86
74
  protected _deployments: Deployments | undefined;
package/dist/Client.js CHANGED
@@ -49,8 +49,6 @@ class VellumClient {
49
49
  this.options = options;
50
50
  }
51
51
  /**
52
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Stable</strong>
53
- *
54
52
  * Executes a deployed Workflow and streams back its results.
55
53
  * @throws {Vellum.BadRequestError}
56
54
  * @throws {Vellum.NotFoundError}
@@ -86,8 +84,6 @@ class VellumClient {
86
84
  });
87
85
  }
88
86
  /**
89
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
90
- *
91
87
  * Generate a completion using a previously defined deployment.
92
88
  *
93
89
  * **Note:** Uses a base url of `https://predict.vellum.ai`.
@@ -149,8 +145,6 @@ class VellumClient {
149
145
  }
150
146
  }
151
147
  /**
152
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
153
- *
154
148
  * Generate a stream of completions using a previously defined deployment.
155
149
  *
156
150
  * **Note:** Uses a base url of `https://predict.vellum.ai`.
@@ -187,8 +181,6 @@ class VellumClient {
187
181
  });
188
182
  }
189
183
  /**
190
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
191
- *
192
184
  * Perform a search against a document index.
193
185
  *
194
186
  * **Note:** Uses a base url of `https://predict.vellum.ai`.
@@ -243,8 +235,6 @@ class VellumClient {
243
235
  }
244
236
  }
245
237
  /**
246
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
247
- *
248
238
  * Used to submit feedback regarding the quality of previously generated completions.
249
239
  *
250
240
  * **Note:** Uses a base url of `https://predict.vellum.ai`.
@@ -297,11 +287,9 @@ class VellumClient {
297
287
  }
298
288
  }
299
289
  /**
300
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
301
- *
302
- * Used to submit feedback regarding the quality of previous workflow execution and its outputs.
290
+ * Used to submit feedback regarding the quality of previous workflow execution and its outputs.
303
291
  *
304
- * **Note:** Uses a base url of `https://predict.vellum.ai`.
292
+ * **Note:** Uses a base url of `https://predict.vellum.ai`.
305
293
  */
306
294
  async submitWorkflowExecutionActuals(request) {
307
295
  const _response = await core.fetcher({
@@ -7,7 +7,7 @@ export interface SearchRequestBodyRequest {
7
7
  indexId?: string;
8
8
  /** The name of the index to search against. Must provide either this or index_id. */
9
9
  indexName?: string;
10
- /** The query to search for. <span style="white-space: nowrap">`non-empty`</span> */
10
+ /** The query to search for. */
11
11
  query: string;
12
12
  /** Configuration options for the search. */
13
13
  options?: Vellum.SearchRequestOptionsRequest;
@@ -14,11 +14,7 @@ export declare class Deployments {
14
14
  protected readonly options: Deployments.Options;
15
15
  constructor(options: Deployments.Options);
16
16
  /**
17
- *
18
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
19
- *
20
17
  * Used to retrieve a deployment given its ID or name.
21
- *
22
18
  */
23
19
  retrieve(id: string): Promise<Vellum.DeploymentRead>;
24
20
  }
@@ -41,11 +41,7 @@ class Deployments {
41
41
  this.options = options;
42
42
  }
43
43
  /**
44
- *
45
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
46
- *
47
44
  * Used to retrieve a deployment given its ID or name.
48
- *
49
45
  */
50
46
  async retrieve(id) {
51
47
  const _response = await core.fetcher({
@@ -14,8 +14,6 @@ export declare class DocumentIndexes {
14
14
  protected readonly options: DocumentIndexes.Options;
15
15
  constructor(options: DocumentIndexes.Options);
16
16
  /**
17
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
18
- *
19
17
  * Creates a new document index.
20
18
  */
21
19
  create(request: Vellum.DocumentIndexCreateRequest): Promise<Vellum.DocumentIndexRead>;
@@ -41,8 +41,6 @@ class DocumentIndexes {
41
41
  this.options = options;
42
42
  }
43
43
  /**
44
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
45
- *
46
44
  * Creates a new document index.
47
45
  */
48
46
  async create(request) {
@@ -3,9 +3,9 @@
3
3
  */
4
4
  import * as Vellum from "../../../..";
5
5
  export interface DocumentIndexCreateRequest {
6
- /** A human-readable label for the document index <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 150 characters`</span> */
6
+ /** A human-readable label for the document index */
7
7
  label: string;
8
- /** A name that uniquely identifies this index within its workspace <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 150 characters`</span> */
8
+ /** A name that uniquely identifies this index within its workspace */
9
9
  name: string;
10
10
  /**
11
11
  * The current status of the document index
@@ -16,25 +16,15 @@ export declare class Documents {
16
16
  protected readonly options: Documents.Options;
17
17
  constructor(options: Documents.Options);
18
18
  /**
19
- *
20
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
21
- *
22
19
  * Used to list documents. Optionally filter on supported fields.
23
- *
24
20
  */
25
21
  list(request?: Vellum.DocumentsListRequest): Promise<Vellum.PaginatedSlimDocumentList>;
26
22
  /**
27
- *
28
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
29
- *
30
23
  * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
31
- *
32
24
  */
33
25
  partialUpdate(id: string, request?: Vellum.PatchedDocumentUpdateRequest): Promise<Vellum.DocumentRead>;
34
26
  destroy(id: string): Promise<void>;
35
27
  /**
36
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
37
- *
38
28
  * Upload a document to be indexed and used for search.
39
29
  *
40
30
  * **Note:** Uses a base url of `https://documents.vellum.ai`.
@@ -44,11 +44,7 @@ class Documents {
44
44
  this.options = options;
45
45
  }
46
46
  /**
47
- *
48
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
49
- *
50
47
  * Used to list documents. Optionally filter on supported fields.
51
- *
52
48
  */
53
49
  async list(request = {}) {
54
50
  const { documentIndexId, limit, offset, ordering } = request;
@@ -102,11 +98,7 @@ class Documents {
102
98
  }
103
99
  }
104
100
  /**
105
- *
106
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
107
- *
108
101
  * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
109
- *
110
102
  */
111
103
  async partialUpdate(id, request = {}) {
112
104
  const _response = await core.fetcher({
@@ -180,8 +172,6 @@ class Documents {
180
172
  }
181
173
  }
182
174
  /**
183
- * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
184
- *
185
175
  * Upload a document to be indexed and used for search.
186
176
  *
187
177
  * **Note:** Uses a base url of `https://documents.vellum.ai`.
@@ -3,7 +3,7 @@
3
3
  */
4
4
  import * as Vellum from "../../../..";
5
5
  export interface PatchedDocumentUpdateRequest {
6
- /** A human-readable label for the document. Defaults to the originally uploaded file's file name. <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 1000 characters`</span> */
6
+ /** A human-readable label for the document. Defaults to the originally uploaded file's file name. */
7
7
  label?: string;
8
8
  /**
9
9
  * The current status of the document
@@ -6,7 +6,7 @@ export interface UploadDocumentBodyRequest {
6
6
  addToIndexNames?: string[];
7
7
  /** Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed. */
8
8
  externalId?: string;
9
- /** A human-friendly name for this document. Typically the filename. <span style="white-space: nowrap">`non-empty`</span> */
9
+ /** A human-friendly name for this document. Typically the filename. */
10
10
  label: string;
11
11
  /** Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches. */
12
12
  keywords?: string[];
@@ -14,16 +14,10 @@ export declare class ModelVersions {
14
14
  protected readonly options: ModelVersions.Options;
15
15
  constructor(options: ModelVersions.Options);
16
16
  /**
17
- *
18
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
19
- *
20
17
  * Used to retrieve a model version given its ID.
21
- *
22
18
  */
23
19
  retrieve(id: string): Promise<Vellum.ModelVersionRead>;
24
20
  /**
25
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
26
- *
27
21
  * Compiles the prompt backing the model version using the provided input values.
28
22
  */
29
23
  modelVersionCompilePrompt(id: string, request: Vellum.ModelVersionCompilePromptRequestRequest): Promise<Vellum.ModelVersionCompilePromptResponse>;
@@ -41,11 +41,7 @@ class ModelVersions {
41
41
  this.options = options;
42
42
  }
43
43
  /**
44
- *
45
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
46
- *
47
44
  * Used to retrieve a model version given its ID.
48
- *
49
45
  */
50
46
  async retrieve(id) {
51
47
  const _response = await core.fetcher({
@@ -84,8 +80,6 @@ class ModelVersions {
84
80
  }
85
81
  }
86
82
  /**
87
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
88
- *
89
83
  * Compiles the prompt backing the model version using the provided input values.
90
84
  */
91
85
  async modelVersionCompilePrompt(id, request) {
@@ -14,8 +14,6 @@ export declare class RegisteredPrompts {
14
14
  protected readonly options: RegisteredPrompts.Options;
15
15
  constructor(options: RegisteredPrompts.Options);
16
16
  /**
17
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
18
- *
19
17
  * Registers a prompt within Vellum and creates associated Vellum entities. Intended to be used by integration
20
18
  * partners, not directly by Vellum users.
21
19
  *
@@ -42,8 +42,6 @@ class RegisteredPrompts {
42
42
  this.options = options;
43
43
  }
44
44
  /**
45
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
46
- *
47
45
  * Registers a prompt within Vellum and creates associated Vellum entities. Intended to be used by integration
48
46
  * partners, not directly by Vellum users.
49
47
  *
@@ -3,9 +3,9 @@
3
3
  */
4
4
  import * as Vellum from "../../../..";
5
5
  export interface RegisterPromptRequestRequest {
6
- /** A human-friendly label for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span> */
6
+ /** A human-friendly label for corresponding entities created in Vellum. */
7
7
  label: string;
8
- /** A uniquely-identifying name for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span> */
8
+ /** A uniquely-identifying name for corresponding entities created in Vellum. */
9
9
  name: string;
10
10
  /** Information about how to execute the prompt template. */
11
11
  prompt: Vellum.RegisterPromptPromptInfoRequest;
@@ -22,7 +22,7 @@ export interface RegisterPromptRequestRequest {
22
22
  * * `PYQ` - Pyq
23
23
  */
24
24
  provider: Vellum.ProviderEnum;
25
- /** The initial model to use for this prompt <span style="white-space: nowrap">`non-empty`</span> */
25
+ /** The initial model to use for this prompt */
26
26
  model: string;
27
27
  /** The initial model parameters to use for this prompt */
28
28
  parameters: Vellum.RegisterPromptModelParametersRequest;
@@ -14,8 +14,6 @@ export declare class Sandboxes {
14
14
  protected readonly options: Sandboxes.Options;
15
15
  constructor(options: Sandboxes.Options);
16
16
  /**
17
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
18
- *
19
17
  * Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.
20
18
  *
21
19
  * If an id is provided and has a match, the scenario will be updated. If no id is provided or no match
@@ -26,8 +24,6 @@ export declare class Sandboxes {
26
24
  */
27
25
  upsertSandboxScenario(id: string, request: Vellum.UpsertSandboxScenarioRequestRequest): Promise<Vellum.SandboxScenario>;
28
26
  /**
29
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
30
- *
31
27
  * Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
32
28
  */
33
29
  deleteSandboxScenario(id: string, scenarioId: string): Promise<void>;
@@ -41,8 +41,6 @@ class Sandboxes {
41
41
  this.options = options;
42
42
  }
43
43
  /**
44
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
45
- *
46
44
  * Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.
47
45
  *
48
46
  * If an id is provided and has a match, the scenario will be updated. If no id is provided or no match
@@ -91,8 +89,6 @@ class Sandboxes {
91
89
  }
92
90
  }
93
91
  /**
94
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
95
- *
96
92
  * Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
97
93
  */
98
94
  async deleteSandboxScenario(id, scenarioId) {
@@ -6,7 +6,7 @@ export interface UpsertSandboxScenarioRequestRequest {
6
6
  label?: string;
7
7
  /** The inputs for the scenario */
8
8
  inputs: Vellum.ScenarioInputRequest[];
9
- /** The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended. <span style="white-space: nowrap">`non-empty`</span> */
9
+ /** The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended. */
10
10
  scenarioId?: string;
11
11
  metricInputParams?: Vellum.SandboxMetricInputParamsRequest;
12
12
  }
@@ -14,8 +14,6 @@ export declare class TestSuites {
14
14
  protected readonly options: TestSuites.Options;
15
15
  constructor(options: TestSuites.Options);
16
16
  /**
17
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
18
- *
19
17
  * Upserts a new test case for a test suite, keying off of the optionally provided test case id.
20
18
  *
21
19
  * If an id is provided and has a match, the test case will be updated. If no id is provided or no match
@@ -26,9 +24,8 @@ export declare class TestSuites {
26
24
  */
27
25
  upsertTestSuiteTestCase(id: string, request: Vellum.TestSuiteTestCaseRequest): Promise<Vellum.TestSuiteTestCase>;
28
26
  /**
29
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
30
- *
31
27
  * Deletes an existing test case for a test suite, keying off of the test case id.
28
+ *
32
29
  */
33
30
  deleteTestSuiteTestCase(id: string, testCaseId: string): Promise<void>;
34
31
  }
@@ -41,8 +41,6 @@ class TestSuites {
41
41
  this.options = options;
42
42
  }
43
43
  /**
44
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
45
- *
46
44
  * Upserts a new test case for a test suite, keying off of the optionally provided test case id.
47
45
  *
48
46
  * If an id is provided and has a match, the test case will be updated. If no id is provided or no match
@@ -89,9 +87,8 @@ class TestSuites {
89
87
  }
90
88
  }
91
89
  /**
92
- * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
93
- *
94
90
  * Deletes an existing test case for a test suite, keying off of the test case id.
91
+ *
95
92
  */
96
93
  async deleteTestSuiteTestCase(id, testCaseId) {
97
94
  const _response = await core.fetcher({
@@ -3,7 +3,7 @@
3
3
  */
4
4
  import * as Vellum from "../../../..";
5
5
  export interface TestSuiteTestCaseRequest {
6
- /** The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended. <span style="white-space: nowrap">`non-empty`</span> */
6
+ /** The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended. */
7
7
  testCaseId?: string;
8
8
  /** A human-friendly label for the test case. */
9
9
  label?: string;