vellum-ai 0.0.29 → 0.0.30
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.
- package/api/resources/documents/client/Client.d.ts +8 -0
- package/api/resources/documents/client/Client.js +46 -0
- package/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +16 -0
- package/api/resources/documents/client/requests/index.d.ts +1 -0
- package/api/types/DeploymentRead.d.ts +1 -1
- package/api/types/{DeploymentReadStatusEnum.d.ts → DeploymentStatus.d.ts} +2 -2
- package/{dist/api/types/DeploymentReadStatusEnum.js → api/types/DeploymentStatus.js} +2 -2
- package/api/types/DocumentRead.d.ts +32 -0
- package/{dist/api/types/SlimDocumentStatusEnum.d.ts → api/types/DocumentStatus.d.ts} +1 -1
- package/api/types/DocumentStatus.js +5 -0
- package/api/types/SlimDocument.d.ts +1 -1
- package/api/types/index.d.ts +3 -2
- package/api/types/index.js +3 -2
- package/dist/api/resources/documents/client/Client.d.ts +8 -0
- package/dist/api/resources/documents/client/Client.js +46 -0
- package/dist/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +16 -0
- package/dist/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.js +5 -0
- package/dist/api/resources/documents/client/requests/index.d.ts +1 -0
- package/dist/api/types/DeploymentRead.d.ts +1 -1
- package/dist/api/types/{DeploymentReadStatusEnum.d.ts → DeploymentStatus.d.ts} +2 -2
- package/{api/types/DeploymentReadStatusEnum.js → dist/api/types/DeploymentStatus.js} +2 -2
- package/dist/api/types/DocumentRead.d.ts +32 -0
- package/dist/api/types/DocumentRead.js +5 -0
- package/{api/types/SlimDocumentStatusEnum.d.ts → dist/api/types/DocumentStatus.d.ts} +1 -1
- package/dist/api/types/DocumentStatus.js +5 -0
- package/dist/api/types/SlimDocument.d.ts +1 -1
- package/dist/api/types/index.d.ts +3 -2
- package/dist/api/types/index.js +3 -2
- package/dist/serialization/resources/documents/client/index.d.ts +1 -0
- package/dist/serialization/resources/documents/client/index.js +17 -0
- package/dist/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +14 -0
- package/dist/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.js +35 -0
- package/dist/serialization/resources/documents/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/documents/client/requests/index.js +5 -0
- package/dist/serialization/resources/documents/index.d.ts +1 -0
- package/dist/serialization/resources/documents/index.js +17 -0
- package/dist/serialization/resources/index.d.ts +2 -0
- package/dist/serialization/resources/index.js +3 -1
- package/dist/serialization/types/DeploymentRead.d.ts +1 -1
- package/dist/serialization/types/DeploymentRead.js +1 -1
- package/dist/serialization/types/{DeploymentReadStatusEnum.d.ts → DeploymentStatus.d.ts} +2 -2
- package/dist/serialization/types/{DeploymentReadStatusEnum.js → DeploymentStatus.js} +2 -2
- package/dist/serialization/types/DocumentRead.d.ts +21 -0
- package/dist/serialization/types/DocumentRead.js +42 -0
- package/dist/serialization/types/{SlimDocumentStatusEnum.d.ts → DocumentStatus.d.ts} +2 -2
- package/dist/serialization/types/{SlimDocumentStatusEnum.js → DocumentStatus.js} +2 -2
- package/dist/serialization/types/SlimDocument.d.ts +1 -1
- package/dist/serialization/types/SlimDocument.js +1 -1
- package/dist/serialization/types/index.d.ts +3 -2
- package/dist/serialization/types/index.js +3 -2
- package/package.json +1 -1
- package/serialization/resources/documents/client/index.d.ts +1 -0
- package/serialization/resources/documents/client/index.js +17 -0
- package/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts +14 -0
- package/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.js +35 -0
- package/serialization/resources/documents/client/requests/index.d.ts +1 -0
- package/serialization/resources/documents/client/requests/index.js +5 -0
- package/serialization/resources/documents/index.d.ts +1 -0
- package/serialization/resources/documents/index.js +17 -0
- package/serialization/resources/index.d.ts +2 -0
- package/serialization/resources/index.js +3 -1
- package/serialization/types/DeploymentRead.d.ts +1 -1
- package/serialization/types/DeploymentRead.js +1 -1
- package/serialization/types/{DeploymentReadStatusEnum.d.ts → DeploymentStatus.d.ts} +2 -2
- package/serialization/types/{DeploymentReadStatusEnum.js → DeploymentStatus.js} +2 -2
- package/serialization/types/DocumentRead.d.ts +21 -0
- package/serialization/types/DocumentRead.js +42 -0
- package/serialization/types/{SlimDocumentStatusEnum.d.ts → DocumentStatus.d.ts} +2 -2
- package/serialization/types/{SlimDocumentStatusEnum.js → DocumentStatus.js} +2 -2
- package/serialization/types/SlimDocument.d.ts +1 -1
- package/serialization/types/SlimDocument.js +1 -1
- package/serialization/types/index.d.ts +3 -2
- package/serialization/types/index.js +3 -2
- /package/api/{types/SlimDocumentStatusEnum.js → resources/documents/client/requests/PatchedDocumentUpdateRequest.js} +0 -0
- /package/{dist/api/types/SlimDocumentStatusEnum.js → api/types/DocumentRead.js} +0 -0
|
@@ -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
|
+
}
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
* * `INACTIVE` - Inactive
|
|
7
7
|
* * `ARCHIVED` - Archived
|
|
8
8
|
*/
|
|
9
|
-
export declare type
|
|
10
|
-
export declare const
|
|
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.
|
|
7
|
-
exports.
|
|
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
|
+
}
|
|
@@ -32,7 +32,7 @@ export interface SlimDocument {
|
|
|
32
32
|
*
|
|
33
33
|
* * `ACTIVE` - Active
|
|
34
34
|
*/
|
|
35
|
-
status?: Vellum.
|
|
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[];
|
package/api/types/index.d.ts
CHANGED
|
@@ -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 "./
|
|
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";
|
package/api/types/index.js
CHANGED
|
@@ -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("./
|
|
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);
|
|
@@ -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
|
+
}
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
* * `INACTIVE` - Inactive
|
|
7
7
|
* * `ARCHIVED` - Archived
|
|
8
8
|
*/
|
|
9
|
-
export declare type
|
|
10
|
-
export declare const
|
|
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.
|
|
7
|
-
exports.
|
|
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
|
+
}
|
|
@@ -32,7 +32,7 @@ export interface SlimDocument {
|
|
|
32
32
|
*
|
|
33
33
|
* * `ACTIVE` - Active
|
|
34
34
|
*/
|
|
35
|
-
status?: Vellum.
|
|
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[];
|
|
@@ -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 "./
|
|
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";
|
package/dist/api/types/index.js
CHANGED
|
@@ -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("./
|
|
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);
|
package/dist/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts
ADDED
|
@@ -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
|
+
}
|
package/dist/serialization/resources/documents/client/requests/PatchedDocumentUpdateRequest.js
ADDED
|
@@ -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";
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PatchedDocumentUpdateRequest = void 0;
|
|
4
|
+
var PatchedDocumentUpdateRequest_1 = require("./PatchedDocumentUpdateRequest");
|
|
5
|
+
Object.defineProperty(exports, "PatchedDocumentUpdateRequest", { enumerable: true, get: function () { return PatchedDocumentUpdateRequest_1.PatchedDocumentUpdateRequest; } });
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client";
|
|
@@ -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("./client"), exports);
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
export * as documentIndexes from "./documentIndexes";
|
|
2
2
|
export * from "./documentIndexes/client/requests";
|
|
3
|
+
export * as documents from "./documents";
|
|
4
|
+
export * from "./documents/client/requests";
|
|
3
5
|
export * as modelVersions from "./modelVersions";
|
|
4
6
|
export * from "./modelVersions/client/requests";
|
|
5
7
|
export * as registeredPrompts from "./registeredPrompts";
|
|
@@ -26,9 +26,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
26
26
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
27
27
|
};
|
|
28
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
-
exports.testSuites = exports.sandboxes = exports.registeredPrompts = exports.modelVersions = exports.documentIndexes = void 0;
|
|
29
|
+
exports.testSuites = exports.sandboxes = exports.registeredPrompts = exports.modelVersions = exports.documents = exports.documentIndexes = void 0;
|
|
30
30
|
exports.documentIndexes = __importStar(require("./documentIndexes"));
|
|
31
31
|
__exportStar(require("./documentIndexes/client/requests"), exports);
|
|
32
|
+
exports.documents = __importStar(require("./documents"));
|
|
33
|
+
__exportStar(require("./documents/client/requests"), exports);
|
|
32
34
|
exports.modelVersions = __importStar(require("./modelVersions"));
|
|
33
35
|
__exportStar(require("./modelVersions/client/requests"), exports);
|
|
34
36
|
exports.registeredPrompts = __importStar(require("./registeredPrompts"));
|
|
@@ -11,7 +11,7 @@ export declare namespace DeploymentRead {
|
|
|
11
11
|
created: string;
|
|
12
12
|
label: string;
|
|
13
13
|
name: string;
|
|
14
|
-
status?: serializers.
|
|
14
|
+
status?: serializers.DeploymentStatus.Raw | null;
|
|
15
15
|
environment?: serializers.EnvironmentEnum.Raw | null;
|
|
16
16
|
model_type: serializers.ModelTypeEnum.Raw;
|
|
17
17
|
active_model_version_ids: string[];
|
|
@@ -33,7 +33,7 @@ exports.DeploymentRead = core.serialization.object({
|
|
|
33
33
|
created: core.serialization.string(),
|
|
34
34
|
label: core.serialization.string(),
|
|
35
35
|
name: core.serialization.string(),
|
|
36
|
-
status: core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("..")))).
|
|
36
|
+
status: core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("..")))).DeploymentStatus).optional(),
|
|
37
37
|
environment: core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("..")))).EnvironmentEnum).optional(),
|
|
38
38
|
modelType: core.serialization.property("model_type", core.serialization.lazy(async () => (await Promise.resolve().then(() => __importStar(require("..")))).ModelTypeEnum)),
|
|
39
39
|
activeModelVersionIds: core.serialization.property("active_model_version_ids", core.serialization.list(core.serialization.string())),
|