vellum-ai 0.0.29 → 0.0.31

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 (97) hide show
  1. package/Client.d.ts +1 -0
  2. package/Client.js +1 -0
  3. package/api/resources/documents/client/Client.d.ts +8 -0
  4. package/api/resources/documents/client/Client.js +46 -0
  5. package/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +16 -0
  6. package/api/resources/documents/client/requests/index.d.ts +1 -0
  7. package/api/types/DeploymentRead.d.ts +1 -1
  8. package/api/types/{DeploymentReadStatusEnum.d.ts → DeploymentStatus.d.ts} +2 -2
  9. package/{dist/api/types/DeploymentReadStatusEnum.js → api/types/DeploymentStatus.js} +2 -2
  10. package/api/types/DocumentRead.d.ts +32 -0
  11. package/{dist/api/types/SlimDocumentStatusEnum.d.ts → api/types/DocumentStatus.d.ts} +1 -1
  12. package/api/types/DocumentStatus.js +5 -0
  13. package/api/types/SlimDocument.d.ts +1 -1
  14. package/api/types/TerminalNodeChatHistoryResult.d.ts +1 -1
  15. package/api/types/TerminalNodeJsonResult.d.ts +1 -1
  16. package/api/types/TerminalNodeStringResult.d.ts +1 -1
  17. package/api/types/index.d.ts +3 -2
  18. package/api/types/index.js +3 -2
  19. package/dist/Client.d.ts +1 -0
  20. package/dist/Client.js +1 -0
  21. package/dist/api/resources/documents/client/Client.d.ts +8 -0
  22. package/dist/api/resources/documents/client/Client.js +46 -0
  23. package/dist/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +16 -0
  24. package/dist/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.js +5 -0
  25. package/dist/api/resources/documents/client/requests/index.d.ts +1 -0
  26. package/dist/api/types/DeploymentRead.d.ts +1 -1
  27. package/dist/api/types/{DeploymentReadStatusEnum.d.ts → DeploymentStatus.d.ts} +2 -2
  28. package/{api/types/DeploymentReadStatusEnum.js → dist/api/types/DeploymentStatus.js} +2 -2
  29. package/dist/api/types/DocumentRead.d.ts +32 -0
  30. package/dist/api/types/DocumentRead.js +5 -0
  31. package/{api/types/SlimDocumentStatusEnum.d.ts → dist/api/types/DocumentStatus.d.ts} +1 -1
  32. package/dist/api/types/DocumentStatus.js +5 -0
  33. package/dist/api/types/SlimDocument.d.ts +1 -1
  34. package/dist/api/types/TerminalNodeChatHistoryResult.d.ts +1 -1
  35. package/dist/api/types/TerminalNodeJsonResult.d.ts +1 -1
  36. package/dist/api/types/TerminalNodeStringResult.d.ts +1 -1
  37. package/dist/api/types/index.d.ts +3 -2
  38. package/dist/api/types/index.js +3 -2
  39. package/dist/serialization/resources/documents/client/index.d.ts +1 -0
  40. package/dist/serialization/resources/documents/client/index.js +17 -0
  41. package/dist/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +14 -0
  42. package/dist/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.js +35 -0
  43. package/dist/serialization/resources/documents/client/requests/index.d.ts +1 -0
  44. package/dist/serialization/resources/documents/client/requests/index.js +5 -0
  45. package/dist/serialization/resources/documents/index.d.ts +1 -0
  46. package/dist/serialization/resources/documents/index.js +17 -0
  47. package/dist/serialization/resources/index.d.ts +2 -0
  48. package/dist/serialization/resources/index.js +3 -1
  49. package/dist/serialization/types/DeploymentRead.d.ts +1 -1
  50. package/dist/serialization/types/DeploymentRead.js +1 -1
  51. package/dist/serialization/types/{DeploymentReadStatusEnum.d.ts → DeploymentStatus.d.ts} +2 -2
  52. package/dist/serialization/types/{DeploymentReadStatusEnum.js → DeploymentStatus.js} +2 -2
  53. package/dist/serialization/types/DocumentRead.d.ts +21 -0
  54. package/dist/serialization/types/DocumentRead.js +42 -0
  55. package/dist/serialization/types/{SlimDocumentStatusEnum.d.ts → DocumentStatus.d.ts} +2 -2
  56. package/dist/serialization/types/{SlimDocumentStatusEnum.js → DocumentStatus.js} +2 -2
  57. package/dist/serialization/types/SlimDocument.d.ts +1 -1
  58. package/dist/serialization/types/SlimDocument.js +1 -1
  59. package/dist/serialization/types/TerminalNodeChatHistoryResult.d.ts +1 -1
  60. package/dist/serialization/types/TerminalNodeChatHistoryResult.js +3 -1
  61. package/dist/serialization/types/TerminalNodeJsonResult.d.ts +1 -1
  62. package/dist/serialization/types/TerminalNodeJsonResult.js +1 -1
  63. package/dist/serialization/types/TerminalNodeStringResult.d.ts +1 -1
  64. package/dist/serialization/types/TerminalNodeStringResult.js +1 -1
  65. package/dist/serialization/types/index.d.ts +3 -2
  66. package/dist/serialization/types/index.js +3 -2
  67. package/package.json +1 -1
  68. package/serialization/resources/documents/client/index.d.ts +1 -0
  69. package/serialization/resources/documents/client/index.js +17 -0
  70. package/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +14 -0
  71. package/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.js +35 -0
  72. package/serialization/resources/documents/client/requests/index.d.ts +1 -0
  73. package/serialization/resources/documents/client/requests/index.js +5 -0
  74. package/serialization/resources/documents/index.d.ts +1 -0
  75. package/serialization/resources/documents/index.js +17 -0
  76. package/serialization/resources/index.d.ts +2 -0
  77. package/serialization/resources/index.js +3 -1
  78. package/serialization/types/DeploymentRead.d.ts +1 -1
  79. package/serialization/types/DeploymentRead.js +1 -1
  80. package/serialization/types/{DeploymentReadStatusEnum.d.ts → DeploymentStatus.d.ts} +2 -2
  81. package/serialization/types/{DeploymentReadStatusEnum.js → DeploymentStatus.js} +2 -2
  82. package/serialization/types/DocumentRead.d.ts +21 -0
  83. package/serialization/types/DocumentRead.js +42 -0
  84. package/serialization/types/{SlimDocumentStatusEnum.d.ts → DocumentStatus.d.ts} +2 -2
  85. package/serialization/types/{SlimDocumentStatusEnum.js → DocumentStatus.js} +2 -2
  86. package/serialization/types/SlimDocument.d.ts +1 -1
  87. package/serialization/types/SlimDocument.js +1 -1
  88. package/serialization/types/TerminalNodeChatHistoryResult.d.ts +1 -1
  89. package/serialization/types/TerminalNodeChatHistoryResult.js +3 -1
  90. package/serialization/types/TerminalNodeJsonResult.d.ts +1 -1
  91. package/serialization/types/TerminalNodeJsonResult.js +1 -1
  92. package/serialization/types/TerminalNodeStringResult.d.ts +1 -1
  93. package/serialization/types/TerminalNodeStringResult.js +1 -1
  94. package/serialization/types/index.d.ts +3 -2
  95. package/serialization/types/index.js +3 -2
  96. /package/api/{types/SlimDocumentStatusEnum.js → resources/documents/client/requests/PatchedDocumentUpdateRequest.js} +0 -0
  97. /package/{dist/api/types/SlimDocumentStatusEnum.js → api/types/DocumentRead.js} +0 -0
package/Client.d.ts CHANGED
@@ -24,6 +24,7 @@ export declare class VellumClient {
24
24
  * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
25
25
  *
26
26
  * Executes a deployed Workflow and streams back its results.
27
+ * @throws {Vellum.BadRequestError}
27
28
  * @throws {Vellum.NotFoundError}
28
29
  * @throws {Vellum.InternalServerError}
29
30
  */
package/Client.js CHANGED
@@ -52,6 +52,7 @@ class VellumClient {
52
52
  * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
53
53
  *
54
54
  * Executes a deployed Workflow and streams back its results.
55
+ * @throws {Vellum.BadRequestError}
55
56
  * @throws {Vellum.NotFoundError}
56
57
  * @throws {Vellum.InternalServerError}
57
58
  */
@@ -23,6 +23,14 @@ export declare class Documents {
23
23
  *
24
24
  */
25
25
  list(request?: Vellum.DocumentsListRequest): Promise<Vellum.PaginatedSlimDocumentList>;
26
+ /**
27
+ *
28
+ * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
29
+ *
30
+ * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
31
+ *
32
+ */
33
+ partialUpdate(id: string, request?: Vellum.PatchedDocumentUpdateRequest): Promise<Vellum.DocumentRead>;
26
34
  /**
27
35
  * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
28
36
  *
@@ -101,6 +101,52 @@ class Documents {
101
101
  });
102
102
  }
103
103
  }
104
+ /**
105
+ *
106
+ * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
107
+ *
108
+ * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
109
+ *
110
+ */
111
+ async partialUpdate(id, request = {}) {
112
+ const _response = await core.fetcher({
113
+ url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/documents/${id}`),
114
+ method: "PATCH",
115
+ headers: {
116
+ X_API_KEY: await core.Supplier.get(this.options.apiKey),
117
+ },
118
+ contentType: "application/json",
119
+ body: await serializers.PatchedDocumentUpdateRequest.jsonOrThrow(request, {
120
+ unrecognizedObjectKeys: "strip",
121
+ }),
122
+ });
123
+ if (_response.ok) {
124
+ return await serializers.DocumentRead.parseOrThrow(_response.body, {
125
+ unrecognizedObjectKeys: "passthrough",
126
+ allowUnrecognizedUnionMembers: true,
127
+ allowUnrecognizedEnumValues: true,
128
+ });
129
+ }
130
+ if (_response.error.reason === "status-code") {
131
+ throw new errors.VellumError({
132
+ statusCode: _response.error.statusCode,
133
+ body: _response.error.body,
134
+ });
135
+ }
136
+ switch (_response.error.reason) {
137
+ case "non-json":
138
+ throw new errors.VellumError({
139
+ statusCode: _response.error.statusCode,
140
+ body: _response.error.rawBody,
141
+ });
142
+ case "timeout":
143
+ throw new errors.VellumTimeoutError();
144
+ case "unknown":
145
+ throw new errors.VellumError({
146
+ message: _response.error.errorMessage,
147
+ });
148
+ }
149
+ }
104
150
  /**
105
151
  * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
106
152
  *
@@ -0,0 +1,16 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../../../..";
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> */
7
+ label?: string;
8
+ /**
9
+ * The current status of the document
10
+ *
11
+ * * `ACTIVE` - Active
12
+ */
13
+ status?: Vellum.DocumentStatus;
14
+ /** A JSON object containing any metadata associated with the document that you'd like to filter upon later. */
15
+ metadata?: Record<string, unknown>;
16
+ }
@@ -1,2 +1,3 @@
1
1
  export { DocumentsListRequest } from "./DocumentsListRequest";
2
+ export { PatchedDocumentUpdateRequest } from "./PatchedDocumentUpdateRequest";
2
3
  export { UploadDocumentBodyRequest } from "./UploadDocumentBodyRequest";
@@ -16,7 +16,7 @@ export interface DeploymentRead {
16
16
  * * `INACTIVE` - Inactive
17
17
  * * `ARCHIVED` - Archived
18
18
  */
19
- status?: Vellum.DeploymentReadStatusEnum;
19
+ status?: Vellum.DeploymentStatus;
20
20
  /**
21
21
  * The environment this deployment is used in
22
22
  *
@@ -6,8 +6,8 @@
6
6
  * * `INACTIVE` - Inactive
7
7
  * * `ARCHIVED` - Archived
8
8
  */
9
- export declare type DeploymentReadStatusEnum = "ACTIVE" | "INACTIVE" | "ARCHIVED";
10
- export declare const DeploymentReadStatusEnum: {
9
+ export declare type DeploymentStatus = "ACTIVE" | "INACTIVE" | "ARCHIVED";
10
+ export declare const DeploymentStatus: {
11
11
  readonly Active: "ACTIVE";
12
12
  readonly Inactive: "INACTIVE";
13
13
  readonly Archived: "ARCHIVED";
@@ -3,8 +3,8 @@
3
3
  * This file was auto-generated by Fern from our API Definition.
4
4
  */
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.DeploymentReadStatusEnum = void 0;
7
- exports.DeploymentReadStatusEnum = {
6
+ exports.DeploymentStatus = void 0;
7
+ exports.DeploymentStatus = {
8
8
  Active: "ACTIVE",
9
9
  Inactive: "INACTIVE",
10
10
  Archived: "ARCHIVED",
@@ -0,0 +1,32 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface DocumentRead {
6
+ id: string;
7
+ /** The unique id of this document as it exists in the user's system. */
8
+ externalId?: string;
9
+ lastUploadedAt: string;
10
+ /** A human-readable label for the document. Defaults to the originally uploaded file's file name. <span style="white-space: nowrap">`<= 1000 characters`</span> */
11
+ label: string;
12
+ /**
13
+ * The current processing state of the document
14
+ *
15
+ * * `QUEUED` - Queued
16
+ * * `PROCESSING` - Processing
17
+ * * `PROCESSED` - Processed
18
+ * * `FAILED` - Failed
19
+ */
20
+ processingState?: Vellum.ProcessingStateEnum;
21
+ /**
22
+ * The current status of the document
23
+ *
24
+ * * `ACTIVE` - Active
25
+ */
26
+ status?: Vellum.DocumentStatus;
27
+ originalFileUrl?: string;
28
+ processedFileUrl?: string;
29
+ documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
30
+ /** A previously supplied JSON object containing metadata that can filtered on when searching. */
31
+ metadata?: Record<string, unknown>;
32
+ }
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type SlimDocumentStatusEnum = "ACTIVE";
4
+ export declare type DocumentStatus = "ACTIVE";
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -32,7 +32,7 @@ export interface SlimDocument {
32
32
  *
33
33
  * * `ACTIVE` - Active
34
34
  */
35
- status?: Vellum.SlimDocumentStatusEnum;
35
+ status?: Vellum.DocumentStatus;
36
36
  /** A list of keywords associated with this document. Originally provided when uploading the document. */
37
37
  keywords?: string[];
38
38
  documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
@@ -5,5 +5,5 @@ import * as Vellum from "..";
5
5
  export interface TerminalNodeChatHistoryResult {
6
6
  /** The unique name given to the terminal node that produced this output. */
7
7
  name: string;
8
- value: Vellum.ChatMessage[];
8
+ value?: Vellum.ChatMessage[];
9
9
  }
@@ -4,5 +4,5 @@
4
4
  export interface TerminalNodeJsonResult {
5
5
  /** The unique name given to the terminal node that produced this output. */
6
6
  name: string;
7
- value: Record<string, unknown>;
7
+ value?: Record<string, unknown>;
8
8
  }
@@ -4,5 +4,5 @@
4
4
  export interface TerminalNodeStringResult {
5
5
  /** The unique name given to the terminal node that produced this output. */
6
6
  name: string;
7
- value: string;
7
+ value?: string;
8
8
  }
@@ -8,11 +8,13 @@ export * from "./ContentType";
8
8
  export * from "./DeploymentNodeResult";
9
9
  export * from "./DeploymentNodeResultData";
10
10
  export * from "./DeploymentRead";
11
- export * from "./DeploymentReadStatusEnum";
11
+ export * from "./DeploymentStatus";
12
12
  export * from "./Document";
13
13
  export * from "./DocumentDocumentToDocumentIndex";
14
14
  export * from "./DocumentIndexRead";
15
15
  export * from "./DocumentIndexStatus";
16
+ export * from "./DocumentRead";
17
+ export * from "./DocumentStatus";
16
18
  export * from "./EnrichedNormalizedCompletion";
17
19
  export * from "./EnvironmentEnum";
18
20
  export * from "./EvaluationParams";
@@ -87,7 +89,6 @@ export * from "./SearchResult";
87
89
  export * from "./SearchResultMergingRequest";
88
90
  export * from "./SearchWeightsRequest";
89
91
  export * from "./SlimDocument";
90
- export * from "./SlimDocumentStatusEnum";
91
92
  export * from "./SubmitCompletionActualRequest";
92
93
  export * from "./SubmitCompletionActualsErrorResponse";
93
94
  export * from "./TerminalNodeChatHistoryResult";
@@ -24,11 +24,13 @@ __exportStar(require("./ContentType"), exports);
24
24
  __exportStar(require("./DeploymentNodeResult"), exports);
25
25
  __exportStar(require("./DeploymentNodeResultData"), exports);
26
26
  __exportStar(require("./DeploymentRead"), exports);
27
- __exportStar(require("./DeploymentReadStatusEnum"), exports);
27
+ __exportStar(require("./DeploymentStatus"), exports);
28
28
  __exportStar(require("./Document"), exports);
29
29
  __exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
30
30
  __exportStar(require("./DocumentIndexRead"), exports);
31
31
  __exportStar(require("./DocumentIndexStatus"), exports);
32
+ __exportStar(require("./DocumentRead"), exports);
33
+ __exportStar(require("./DocumentStatus"), exports);
32
34
  __exportStar(require("./EnrichedNormalizedCompletion"), exports);
33
35
  __exportStar(require("./EnvironmentEnum"), exports);
34
36
  __exportStar(require("./EvaluationParams"), exports);
@@ -103,7 +105,6 @@ __exportStar(require("./SearchResult"), exports);
103
105
  __exportStar(require("./SearchResultMergingRequest"), exports);
104
106
  __exportStar(require("./SearchWeightsRequest"), exports);
105
107
  __exportStar(require("./SlimDocument"), exports);
106
- __exportStar(require("./SlimDocumentStatusEnum"), exports);
107
108
  __exportStar(require("./SubmitCompletionActualRequest"), exports);
108
109
  __exportStar(require("./SubmitCompletionActualsErrorResponse"), exports);
109
110
  __exportStar(require("./TerminalNodeChatHistoryResult"), exports);
package/dist/Client.d.ts CHANGED
@@ -24,6 +24,7 @@ export declare class VellumClient {
24
24
  * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
25
25
  *
26
26
  * Executes a deployed Workflow and streams back its results.
27
+ * @throws {Vellum.BadRequestError}
27
28
  * @throws {Vellum.NotFoundError}
28
29
  * @throws {Vellum.InternalServerError}
29
30
  */
package/dist/Client.js CHANGED
@@ -52,6 +52,7 @@ class VellumClient {
52
52
  * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
53
53
  *
54
54
  * Executes a deployed Workflow and streams back its results.
55
+ * @throws {Vellum.BadRequestError}
55
56
  * @throws {Vellum.NotFoundError}
56
57
  * @throws {Vellum.InternalServerError}
57
58
  */
@@ -23,6 +23,14 @@ export declare class Documents {
23
23
  *
24
24
  */
25
25
  list(request?: Vellum.DocumentsListRequest): Promise<Vellum.PaginatedSlimDocumentList>;
26
+ /**
27
+ *
28
+ * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
29
+ *
30
+ * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
31
+ *
32
+ */
33
+ partialUpdate(id: string, request?: Vellum.PatchedDocumentUpdateRequest): Promise<Vellum.DocumentRead>;
26
34
  /**
27
35
  * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
28
36
  *
@@ -101,6 +101,52 @@ class Documents {
101
101
  });
102
102
  }
103
103
  }
104
+ /**
105
+ *
106
+ * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
107
+ *
108
+ * Update a Document, keying off of its Vellum-generated ID. Particularly useful for updating its metadata.
109
+ *
110
+ */
111
+ async partialUpdate(id, request = {}) {
112
+ const _response = await core.fetcher({
113
+ url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/documents/${id}`),
114
+ method: "PATCH",
115
+ headers: {
116
+ X_API_KEY: await core.Supplier.get(this.options.apiKey),
117
+ },
118
+ contentType: "application/json",
119
+ body: await serializers.PatchedDocumentUpdateRequest.jsonOrThrow(request, {
120
+ unrecognizedObjectKeys: "strip",
121
+ }),
122
+ });
123
+ if (_response.ok) {
124
+ return await serializers.DocumentRead.parseOrThrow(_response.body, {
125
+ unrecognizedObjectKeys: "passthrough",
126
+ allowUnrecognizedUnionMembers: true,
127
+ allowUnrecognizedEnumValues: true,
128
+ });
129
+ }
130
+ if (_response.error.reason === "status-code") {
131
+ throw new errors.VellumError({
132
+ statusCode: _response.error.statusCode,
133
+ body: _response.error.body,
134
+ });
135
+ }
136
+ switch (_response.error.reason) {
137
+ case "non-json":
138
+ throw new errors.VellumError({
139
+ statusCode: _response.error.statusCode,
140
+ body: _response.error.rawBody,
141
+ });
142
+ case "timeout":
143
+ throw new errors.VellumTimeoutError();
144
+ case "unknown":
145
+ throw new errors.VellumError({
146
+ message: _response.error.errorMessage,
147
+ });
148
+ }
149
+ }
104
150
  /**
105
151
  * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
106
152
  *
@@ -0,0 +1,16 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../../../..";
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> */
7
+ label?: string;
8
+ /**
9
+ * The current status of the document
10
+ *
11
+ * * `ACTIVE` - Active
12
+ */
13
+ status?: Vellum.DocumentStatus;
14
+ /** A JSON object containing any metadata associated with the document that you'd like to filter upon later. */
15
+ metadata?: Record<string, unknown>;
16
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,2 +1,3 @@
1
1
  export { DocumentsListRequest } from "./DocumentsListRequest";
2
+ export { PatchedDocumentUpdateRequest } from "./PatchedDocumentUpdateRequest";
2
3
  export { UploadDocumentBodyRequest } from "./UploadDocumentBodyRequest";
@@ -16,7 +16,7 @@ export interface DeploymentRead {
16
16
  * * `INACTIVE` - Inactive
17
17
  * * `ARCHIVED` - Archived
18
18
  */
19
- status?: Vellum.DeploymentReadStatusEnum;
19
+ status?: Vellum.DeploymentStatus;
20
20
  /**
21
21
  * The environment this deployment is used in
22
22
  *
@@ -6,8 +6,8 @@
6
6
  * * `INACTIVE` - Inactive
7
7
  * * `ARCHIVED` - Archived
8
8
  */
9
- export declare type DeploymentReadStatusEnum = "ACTIVE" | "INACTIVE" | "ARCHIVED";
10
- export declare const DeploymentReadStatusEnum: {
9
+ export declare type DeploymentStatus = "ACTIVE" | "INACTIVE" | "ARCHIVED";
10
+ export declare const DeploymentStatus: {
11
11
  readonly Active: "ACTIVE";
12
12
  readonly Inactive: "INACTIVE";
13
13
  readonly Archived: "ARCHIVED";
@@ -3,8 +3,8 @@
3
3
  * This file was auto-generated by Fern from our API Definition.
4
4
  */
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.DeploymentReadStatusEnum = void 0;
7
- exports.DeploymentReadStatusEnum = {
6
+ exports.DeploymentStatus = void 0;
7
+ exports.DeploymentStatus = {
8
8
  Active: "ACTIVE",
9
9
  Inactive: "INACTIVE",
10
10
  Archived: "ARCHIVED",
@@ -0,0 +1,32 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface DocumentRead {
6
+ id: string;
7
+ /** The unique id of this document as it exists in the user's system. */
8
+ externalId?: string;
9
+ lastUploadedAt: string;
10
+ /** A human-readable label for the document. Defaults to the originally uploaded file's file name. <span style="white-space: nowrap">`<= 1000 characters`</span> */
11
+ label: string;
12
+ /**
13
+ * The current processing state of the document
14
+ *
15
+ * * `QUEUED` - Queued
16
+ * * `PROCESSING` - Processing
17
+ * * `PROCESSED` - Processed
18
+ * * `FAILED` - Failed
19
+ */
20
+ processingState?: Vellum.ProcessingStateEnum;
21
+ /**
22
+ * The current status of the document
23
+ *
24
+ * * `ACTIVE` - Active
25
+ */
26
+ status?: Vellum.DocumentStatus;
27
+ originalFileUrl?: string;
28
+ processedFileUrl?: string;
29
+ documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
30
+ /** A previously supplied JSON object containing metadata that can filtered on when searching. */
31
+ metadata?: Record<string, unknown>;
32
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type SlimDocumentStatusEnum = "ACTIVE";
4
+ export declare type DocumentStatus = "ACTIVE";
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -32,7 +32,7 @@ export interface SlimDocument {
32
32
  *
33
33
  * * `ACTIVE` - Active
34
34
  */
35
- status?: Vellum.SlimDocumentStatusEnum;
35
+ status?: Vellum.DocumentStatus;
36
36
  /** A list of keywords associated with this document. Originally provided when uploading the document. */
37
37
  keywords?: string[];
38
38
  documentToDocumentIndexes: Vellum.DocumentDocumentToDocumentIndex[];
@@ -5,5 +5,5 @@ import * as Vellum from "..";
5
5
  export interface TerminalNodeChatHistoryResult {
6
6
  /** The unique name given to the terminal node that produced this output. */
7
7
  name: string;
8
- value: Vellum.ChatMessage[];
8
+ value?: Vellum.ChatMessage[];
9
9
  }
@@ -4,5 +4,5 @@
4
4
  export interface TerminalNodeJsonResult {
5
5
  /** The unique name given to the terminal node that produced this output. */
6
6
  name: string;
7
- value: Record<string, unknown>;
7
+ value?: Record<string, unknown>;
8
8
  }
@@ -4,5 +4,5 @@
4
4
  export interface TerminalNodeStringResult {
5
5
  /** The unique name given to the terminal node that produced this output. */
6
6
  name: string;
7
- value: string;
7
+ value?: string;
8
8
  }
@@ -8,11 +8,13 @@ export * from "./ContentType";
8
8
  export * from "./DeploymentNodeResult";
9
9
  export * from "./DeploymentNodeResultData";
10
10
  export * from "./DeploymentRead";
11
- export * from "./DeploymentReadStatusEnum";
11
+ export * from "./DeploymentStatus";
12
12
  export * from "./Document";
13
13
  export * from "./DocumentDocumentToDocumentIndex";
14
14
  export * from "./DocumentIndexRead";
15
15
  export * from "./DocumentIndexStatus";
16
+ export * from "./DocumentRead";
17
+ export * from "./DocumentStatus";
16
18
  export * from "./EnrichedNormalizedCompletion";
17
19
  export * from "./EnvironmentEnum";
18
20
  export * from "./EvaluationParams";
@@ -87,7 +89,6 @@ export * from "./SearchResult";
87
89
  export * from "./SearchResultMergingRequest";
88
90
  export * from "./SearchWeightsRequest";
89
91
  export * from "./SlimDocument";
90
- export * from "./SlimDocumentStatusEnum";
91
92
  export * from "./SubmitCompletionActualRequest";
92
93
  export * from "./SubmitCompletionActualsErrorResponse";
93
94
  export * from "./TerminalNodeChatHistoryResult";
@@ -24,11 +24,13 @@ __exportStar(require("./ContentType"), exports);
24
24
  __exportStar(require("./DeploymentNodeResult"), exports);
25
25
  __exportStar(require("./DeploymentNodeResultData"), exports);
26
26
  __exportStar(require("./DeploymentRead"), exports);
27
- __exportStar(require("./DeploymentReadStatusEnum"), exports);
27
+ __exportStar(require("./DeploymentStatus"), exports);
28
28
  __exportStar(require("./Document"), exports);
29
29
  __exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
30
30
  __exportStar(require("./DocumentIndexRead"), exports);
31
31
  __exportStar(require("./DocumentIndexStatus"), exports);
32
+ __exportStar(require("./DocumentRead"), exports);
33
+ __exportStar(require("./DocumentStatus"), exports);
32
34
  __exportStar(require("./EnrichedNormalizedCompletion"), exports);
33
35
  __exportStar(require("./EnvironmentEnum"), exports);
34
36
  __exportStar(require("./EvaluationParams"), exports);
@@ -103,7 +105,6 @@ __exportStar(require("./SearchResult"), exports);
103
105
  __exportStar(require("./SearchResultMergingRequest"), exports);
104
106
  __exportStar(require("./SearchWeightsRequest"), exports);
105
107
  __exportStar(require("./SlimDocument"), exports);
106
- __exportStar(require("./SlimDocumentStatusEnum"), exports);
107
108
  __exportStar(require("./SubmitCompletionActualRequest"), exports);
108
109
  __exportStar(require("./SubmitCompletionActualsErrorResponse"), exports);
109
110
  __exportStar(require("./TerminalNodeChatHistoryResult"), exports);
@@ -0,0 +1 @@
1
+ export * from "./requests";
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./requests"), exports);
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../..";
5
+ import * as Vellum from "../../../../../api";
6
+ import * as core from "../../../../../core";
7
+ export declare const PatchedDocumentUpdateRequest: core.serialization.Schema<serializers.PatchedDocumentUpdateRequest.Raw, Vellum.PatchedDocumentUpdateRequest>;
8
+ export declare namespace PatchedDocumentUpdateRequest {
9
+ interface Raw {
10
+ label?: string | null;
11
+ status?: serializers.DocumentStatus.Raw | null;
12
+ metadata?: Record<string, unknown> | null;
13
+ }
14
+ }
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.PatchedDocumentUpdateRequest = void 0;
30
+ const core = __importStar(require("../../../../../core"));
31
+ exports.PatchedDocumentUpdateRequest = core.serialization.object({
32
+ label: core.serialization.string().optional(),
33
+ status: core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("../../../..")))).DocumentStatus).optional(),
34
+ metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
35
+ });
@@ -0,0 +1 @@
1
+ export { PatchedDocumentUpdateRequest } from "./PatchedDocumentUpdateRequest";