@instructure/athena-api-client 4.2.0 → 4.3.0
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/README.md +4 -0
- package/dist/apis/AdminApi.d.ts +35 -5
- package/dist/apis/AdminApi.js +96 -4
- package/dist/esm/apis/AdminApi.d.ts +35 -5
- package/dist/esm/apis/AdminApi.js +97 -5
- package/dist/esm/models/AdminConceptDiagram.d.ts +6 -0
- package/dist/esm/models/AdminConceptDiagram.js +4 -0
- package/dist/esm/models/AdminConceptDiagramDetail.d.ts +6 -0
- package/dist/esm/models/AdminConceptDiagramDetail.js +4 -0
- package/dist/esm/models/AdminConceptImage.d.ts +6 -0
- package/dist/esm/models/AdminConceptImage.js +4 -0
- package/dist/esm/models/AdminConceptImageDetail.d.ts +6 -0
- package/dist/esm/models/AdminConceptImageDetail.js +4 -0
- package/dist/esm/models/AdminConceptMediaJob.d.ts +4 -3
- package/dist/esm/models/AdminConceptMediaJob.js +2 -1
- package/dist/esm/models/AdminReviseConceptDiagramRequest.d.ts +44 -0
- package/dist/esm/models/AdminReviseConceptDiagramRequest.js +47 -0
- package/dist/esm/models/AdminReviseConceptImageRequest.d.ts +38 -0
- package/dist/esm/models/AdminReviseConceptImageRequest.js +45 -0
- package/dist/esm/models/AdminShownConceptDiagram.d.ts +6 -0
- package/dist/esm/models/AdminShownConceptDiagram.js +4 -0
- package/dist/esm/models/AdminShownConceptImage.d.ts +6 -0
- package/dist/esm/models/AdminShownConceptImage.js +4 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/AdminConceptDiagram.d.ts +6 -0
- package/dist/models/AdminConceptDiagram.js +4 -0
- package/dist/models/AdminConceptDiagramDetail.d.ts +6 -0
- package/dist/models/AdminConceptDiagramDetail.js +4 -0
- package/dist/models/AdminConceptImage.d.ts +6 -0
- package/dist/models/AdminConceptImage.js +4 -0
- package/dist/models/AdminConceptImageDetail.d.ts +6 -0
- package/dist/models/AdminConceptImageDetail.js +4 -0
- package/dist/models/AdminConceptMediaJob.d.ts +4 -3
- package/dist/models/AdminConceptMediaJob.js +2 -1
- package/dist/models/AdminReviseConceptDiagramRequest.d.ts +44 -0
- package/dist/models/AdminReviseConceptDiagramRequest.js +54 -0
- package/dist/models/AdminReviseConceptImageRequest.d.ts +38 -0
- package/dist/models/AdminReviseConceptImageRequest.js +52 -0
- package/dist/models/AdminShownConceptDiagram.d.ts +6 -0
- package/dist/models/AdminShownConceptDiagram.js +4 -0
- package/dist/models/AdminShownConceptImage.d.ts +6 -0
- package/dist/models/AdminShownConceptImage.js +4 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
|
@@ -149,6 +149,12 @@ export interface AdminConceptImage {
|
|
|
149
149
|
* @memberof AdminConceptImage
|
|
150
150
|
*/
|
|
151
151
|
revisesImageId: string | null;
|
|
152
|
+
/**
|
|
153
|
+
* The changes an admin asked for when this image was revised from the previous version (revisesImageId) by editing it, with everything else kept. Null for a fresh image and for a regeneration from a rewritten prompt.
|
|
154
|
+
* @type {string}
|
|
155
|
+
* @memberof AdminConceptImage
|
|
156
|
+
*/
|
|
157
|
+
revisionInstructions: string | null;
|
|
152
158
|
/**
|
|
153
159
|
*
|
|
154
160
|
* @type {string}
|
|
@@ -76,6 +76,8 @@ export function instanceOfAdminConceptImage(value) {
|
|
|
76
76
|
return false;
|
|
77
77
|
if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
|
|
78
78
|
return false;
|
|
79
|
+
if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
|
|
80
|
+
return false;
|
|
79
81
|
if (!('quality' in value) || value['quality'] === undefined)
|
|
80
82
|
return false;
|
|
81
83
|
if (!('mimeType' in value) || value['mimeType'] === undefined)
|
|
@@ -118,6 +120,7 @@ export function AdminConceptImageFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
118
120
|
'costUsd': json['costUsd'],
|
|
119
121
|
'description': json['description'],
|
|
120
122
|
'revisesImageId': json['revisesImageId'],
|
|
123
|
+
'revisionInstructions': json['revisionInstructions'],
|
|
121
124
|
'quality': json['quality'],
|
|
122
125
|
'mimeType': json['mimeType'],
|
|
123
126
|
'width': json['width'],
|
|
@@ -155,6 +158,7 @@ export function AdminConceptImageToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
155
158
|
'costUsd': value['costUsd'],
|
|
156
159
|
'description': value['description'],
|
|
157
160
|
'revisesImageId': value['revisesImageId'],
|
|
161
|
+
'revisionInstructions': value['revisionInstructions'],
|
|
158
162
|
'quality': value['quality'],
|
|
159
163
|
'mimeType': value['mimeType'],
|
|
160
164
|
'width': value['width'],
|
|
@@ -151,6 +151,12 @@ export interface AdminConceptImageDetail {
|
|
|
151
151
|
* @memberof AdminConceptImageDetail
|
|
152
152
|
*/
|
|
153
153
|
revisesImageId: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* The changes an admin asked for when this image was revised from the previous version (revisesImageId) by editing it, with everything else kept. Null for a fresh image and for a regeneration from a rewritten prompt.
|
|
156
|
+
* @type {string}
|
|
157
|
+
* @memberof AdminConceptImageDetail
|
|
158
|
+
*/
|
|
159
|
+
revisionInstructions: string | null;
|
|
154
160
|
/**
|
|
155
161
|
*
|
|
156
162
|
* @type {string}
|
|
@@ -78,6 +78,8 @@ export function instanceOfAdminConceptImageDetail(value) {
|
|
|
78
78
|
return false;
|
|
79
79
|
if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
|
|
80
80
|
return false;
|
|
81
|
+
if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
|
|
82
|
+
return false;
|
|
81
83
|
if (!('quality' in value) || value['quality'] === undefined)
|
|
82
84
|
return false;
|
|
83
85
|
if (!('mimeType' in value) || value['mimeType'] === undefined)
|
|
@@ -132,6 +134,7 @@ export function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator)
|
|
|
132
134
|
'costUsd': json['costUsd'],
|
|
133
135
|
'description': json['description'],
|
|
134
136
|
'revisesImageId': json['revisesImageId'],
|
|
137
|
+
'revisionInstructions': json['revisionInstructions'],
|
|
135
138
|
'quality': json['quality'],
|
|
136
139
|
'mimeType': json['mimeType'],
|
|
137
140
|
'width': json['width'],
|
|
@@ -175,6 +178,7 @@ export function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator =
|
|
|
175
178
|
'costUsd': value['costUsd'],
|
|
176
179
|
'description': value['description'],
|
|
177
180
|
'revisesImageId': value['revisesImageId'],
|
|
181
|
+
'revisionInstructions': value['revisionInstructions'],
|
|
178
182
|
'quality': value['quality'],
|
|
179
183
|
'mimeType': value['mimeType'],
|
|
180
184
|
'width': value['width'],
|
|
@@ -29,7 +29,7 @@ export interface AdminConceptMediaJob {
|
|
|
29
29
|
*/
|
|
30
30
|
kind: AdminConceptMediaJobKindEnum;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* generate: a new draft. regenerate: a revision from a rewritten prompt or brief. revise: a revision edited from the source row with only the requested changes applied.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof AdminConceptMediaJob
|
|
35
35
|
*/
|
|
@@ -47,13 +47,13 @@ export interface AdminConceptMediaJob {
|
|
|
47
47
|
*/
|
|
48
48
|
concept: AdminConceptMediaConcept;
|
|
49
49
|
/**
|
|
50
|
-
* How the draft's concept (see concept) was chosen. selected: conceptId was given. For a conceptName: matched_exact, an existing concept with the same name (case-insensitive, normalized); matched_similar, the nearest existing concept within the dedup distance; created, no concept matched, so a new one was created. Null for a regenerate, which files under the revised row's concept.
|
|
50
|
+
* How the draft's concept (see concept) was chosen. selected: conceptId was given. For a conceptName: matched_exact, an existing concept with the same name (case-insensitive, normalized); matched_similar, the nearest existing concept within the dedup distance; created, no concept matched, so a new one was created. Null for a regenerate or revise, which files under the revised row's concept.
|
|
51
51
|
* @type {string}
|
|
52
52
|
* @memberof AdminConceptMediaJob
|
|
53
53
|
*/
|
|
54
54
|
conceptResolution: AdminConceptMediaJobConceptResolutionEnum | null;
|
|
55
55
|
/**
|
|
56
|
-
* For a regenerate, the image or diagram being revised
|
|
56
|
+
* For a regenerate or revise, the image or diagram being revised
|
|
57
57
|
* @type {string}
|
|
58
58
|
* @memberof AdminConceptMediaJob
|
|
59
59
|
*/
|
|
@@ -109,6 +109,7 @@ export type AdminConceptMediaJobKindEnum = typeof AdminConceptMediaJobKindEnum[k
|
|
|
109
109
|
export declare const AdminConceptMediaJobOperationEnum: {
|
|
110
110
|
readonly Generate: "generate";
|
|
111
111
|
readonly Regenerate: "regenerate";
|
|
112
|
+
readonly Revise: "revise";
|
|
112
113
|
};
|
|
113
114
|
export type AdminConceptMediaJobOperationEnum = typeof AdminConceptMediaJobOperationEnum[keyof typeof AdminConceptMediaJobOperationEnum];
|
|
114
115
|
/**
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AdminReviseConceptDiagramRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface AdminReviseConceptDiagramRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Only what should change, in plain words. The new diagram is made from the revised diagram itself with these changes applied and everything else kept. Recorded on the new revision as revisionInstructions.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof AdminReviseConceptDiagramRequest
|
|
22
|
+
*/
|
|
23
|
+
instructions: string;
|
|
24
|
+
/**
|
|
25
|
+
* Title for the new revision. Defaults to the original's.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof AdminReviseConceptDiagramRequest
|
|
28
|
+
*/
|
|
29
|
+
title?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Description for the new revision. Defaults to the original's; set it when the changes make that inaccurate.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof AdminReviseConceptDiagramRequest
|
|
34
|
+
*/
|
|
35
|
+
description?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the AdminReviseConceptDiagramRequest interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfAdminReviseConceptDiagramRequest(value: object): value is AdminReviseConceptDiagramRequest;
|
|
41
|
+
export declare function AdminReviseConceptDiagramRequestFromJSON(json: any): AdminReviseConceptDiagramRequest;
|
|
42
|
+
export declare function AdminReviseConceptDiagramRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminReviseConceptDiagramRequest;
|
|
43
|
+
export declare function AdminReviseConceptDiagramRequestToJSON(json: any): AdminReviseConceptDiagramRequest;
|
|
44
|
+
export declare function AdminReviseConceptDiagramRequestToJSONTyped(value?: AdminReviseConceptDiagramRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the AdminReviseConceptDiagramRequest interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfAdminReviseConceptDiagramRequest(value) {
|
|
18
|
+
if (!('instructions' in value) || value['instructions'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
return true;
|
|
21
|
+
}
|
|
22
|
+
export function AdminReviseConceptDiagramRequestFromJSON(json) {
|
|
23
|
+
return AdminReviseConceptDiagramRequestFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
export function AdminReviseConceptDiagramRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
26
|
+
if (json == null) {
|
|
27
|
+
return json;
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
'instructions': json['instructions'],
|
|
31
|
+
'title': json['title'] == null ? undefined : json['title'],
|
|
32
|
+
'description': json['description'] == null ? undefined : json['description'],
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
export function AdminReviseConceptDiagramRequestToJSON(json) {
|
|
36
|
+
return AdminReviseConceptDiagramRequestToJSONTyped(json, false);
|
|
37
|
+
}
|
|
38
|
+
export function AdminReviseConceptDiagramRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
39
|
+
if (value == null) {
|
|
40
|
+
return value;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'instructions': value['instructions'],
|
|
44
|
+
'title': value['title'],
|
|
45
|
+
'description': value['description'],
|
|
46
|
+
};
|
|
47
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AdminReviseConceptImageRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface AdminReviseConceptImageRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Only what should change, in plain words. The new image is made from the revised image itself with these changes applied and everything else kept. Recorded on the new revision as revisionInstructions.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof AdminReviseConceptImageRequest
|
|
22
|
+
*/
|
|
23
|
+
instructions: string;
|
|
24
|
+
/**
|
|
25
|
+
* Alt text for the new revision. Defaults to the original's; set it when the changes make that inaccurate.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof AdminReviseConceptImageRequest
|
|
28
|
+
*/
|
|
29
|
+
description?: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the AdminReviseConceptImageRequest interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfAdminReviseConceptImageRequest(value: object): value is AdminReviseConceptImageRequest;
|
|
35
|
+
export declare function AdminReviseConceptImageRequestFromJSON(json: any): AdminReviseConceptImageRequest;
|
|
36
|
+
export declare function AdminReviseConceptImageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminReviseConceptImageRequest;
|
|
37
|
+
export declare function AdminReviseConceptImageRequestToJSON(json: any): AdminReviseConceptImageRequest;
|
|
38
|
+
export declare function AdminReviseConceptImageRequestToJSONTyped(value?: AdminReviseConceptImageRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the AdminReviseConceptImageRequest interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfAdminReviseConceptImageRequest(value) {
|
|
18
|
+
if (!('instructions' in value) || value['instructions'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
return true;
|
|
21
|
+
}
|
|
22
|
+
export function AdminReviseConceptImageRequestFromJSON(json) {
|
|
23
|
+
return AdminReviseConceptImageRequestFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
export function AdminReviseConceptImageRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
26
|
+
if (json == null) {
|
|
27
|
+
return json;
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
'instructions': json['instructions'],
|
|
31
|
+
'description': json['description'] == null ? undefined : json['description'],
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
export function AdminReviseConceptImageRequestToJSON(json) {
|
|
35
|
+
return AdminReviseConceptImageRequestToJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function AdminReviseConceptImageRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
38
|
+
if (value == null) {
|
|
39
|
+
return value;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'instructions': value['instructions'],
|
|
43
|
+
'description': value['description'],
|
|
44
|
+
};
|
|
45
|
+
}
|
|
@@ -151,6 +151,12 @@ export interface AdminShownConceptDiagram {
|
|
|
151
151
|
* @memberof AdminShownConceptDiagram
|
|
152
152
|
*/
|
|
153
153
|
revisesDiagramId: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* The changes an admin asked for when this diagram was revised from the previous version (revisesDiagramId) by editing it, with everything else kept. Null for a fresh diagram and for a regeneration from a rewritten brief.
|
|
156
|
+
* @type {string}
|
|
157
|
+
* @memberof AdminShownConceptDiagram
|
|
158
|
+
*/
|
|
159
|
+
revisionInstructions: string | null;
|
|
154
160
|
/**
|
|
155
161
|
*
|
|
156
162
|
* @type {string}
|
|
@@ -78,6 +78,8 @@ export function instanceOfAdminShownConceptDiagram(value) {
|
|
|
78
78
|
return false;
|
|
79
79
|
if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
|
|
80
80
|
return false;
|
|
81
|
+
if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
|
|
82
|
+
return false;
|
|
81
83
|
if (!('title' in value) || value['title'] === undefined)
|
|
82
84
|
return false;
|
|
83
85
|
if (!('effort' in value) || value['effort'] === undefined)
|
|
@@ -130,6 +132,7 @@ export function AdminShownConceptDiagramFromJSONTyped(json, ignoreDiscriminator)
|
|
|
130
132
|
'costUsd': json['costUsd'],
|
|
131
133
|
'description': json['description'],
|
|
132
134
|
'revisesDiagramId': json['revisesDiagramId'],
|
|
135
|
+
'revisionInstructions': json['revisionInstructions'],
|
|
133
136
|
'title': json['title'],
|
|
134
137
|
'effort': json['effort'],
|
|
135
138
|
'brief': json['brief'],
|
|
@@ -172,6 +175,7 @@ export function AdminShownConceptDiagramToJSONTyped(value, ignoreDiscriminator =
|
|
|
172
175
|
'costUsd': value['costUsd'],
|
|
173
176
|
'description': value['description'],
|
|
174
177
|
'revisesDiagramId': value['revisesDiagramId'],
|
|
178
|
+
'revisionInstructions': value['revisionInstructions'],
|
|
175
179
|
'title': value['title'],
|
|
176
180
|
'effort': value['effort'],
|
|
177
181
|
'brief': value['brief'],
|
|
@@ -151,6 +151,12 @@ export interface AdminShownConceptImage {
|
|
|
151
151
|
* @memberof AdminShownConceptImage
|
|
152
152
|
*/
|
|
153
153
|
revisesImageId: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* The changes an admin asked for when this image was revised from the previous version (revisesImageId) by editing it, with everything else kept. Null for a fresh image and for a regeneration from a rewritten prompt.
|
|
156
|
+
* @type {string}
|
|
157
|
+
* @memberof AdminShownConceptImage
|
|
158
|
+
*/
|
|
159
|
+
revisionInstructions: string | null;
|
|
154
160
|
/**
|
|
155
161
|
*
|
|
156
162
|
* @type {string}
|
|
@@ -78,6 +78,8 @@ export function instanceOfAdminShownConceptImage(value) {
|
|
|
78
78
|
return false;
|
|
79
79
|
if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
|
|
80
80
|
return false;
|
|
81
|
+
if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
|
|
82
|
+
return false;
|
|
81
83
|
if (!('quality' in value) || value['quality'] === undefined)
|
|
82
84
|
return false;
|
|
83
85
|
if (!('mimeType' in value) || value['mimeType'] === undefined)
|
|
@@ -136,6 +138,7 @@ export function AdminShownConceptImageFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
136
138
|
'costUsd': json['costUsd'],
|
|
137
139
|
'description': json['description'],
|
|
138
140
|
'revisesImageId': json['revisesImageId'],
|
|
141
|
+
'revisionInstructions': json['revisionInstructions'],
|
|
139
142
|
'quality': json['quality'],
|
|
140
143
|
'mimeType': json['mimeType'],
|
|
141
144
|
'width': json['width'],
|
|
@@ -181,6 +184,7 @@ export function AdminShownConceptImageToJSONTyped(value, ignoreDiscriminator = f
|
|
|
181
184
|
'costUsd': value['costUsd'],
|
|
182
185
|
'description': value['description'],
|
|
183
186
|
'revisesImageId': value['revisesImageId'],
|
|
187
|
+
'revisionInstructions': value['revisionInstructions'],
|
|
184
188
|
'quality': value['quality'],
|
|
185
189
|
'mimeType': value['mimeType'],
|
|
186
190
|
'width': value['width'],
|
|
@@ -53,6 +53,8 @@ export * from './AdminQuizSourceMaterial';
|
|
|
53
53
|
export * from './AdminRegenerateConceptDiagramRequest';
|
|
54
54
|
export * from './AdminRegenerateConceptImageRequest';
|
|
55
55
|
export * from './AdminResetLearningDataResponse';
|
|
56
|
+
export * from './AdminReviseConceptDiagramRequest';
|
|
57
|
+
export * from './AdminReviseConceptImageRequest';
|
|
56
58
|
export * from './AdminShowConceptMediaRequest';
|
|
57
59
|
export * from './AdminShownConceptDiagram';
|
|
58
60
|
export * from './AdminShownConceptImage';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -55,6 +55,8 @@ export * from './AdminQuizSourceMaterial';
|
|
|
55
55
|
export * from './AdminRegenerateConceptDiagramRequest';
|
|
56
56
|
export * from './AdminRegenerateConceptImageRequest';
|
|
57
57
|
export * from './AdminResetLearningDataResponse';
|
|
58
|
+
export * from './AdminReviseConceptDiagramRequest';
|
|
59
|
+
export * from './AdminReviseConceptImageRequest';
|
|
58
60
|
export * from './AdminShowConceptMediaRequest';
|
|
59
61
|
export * from './AdminShownConceptDiagram';
|
|
60
62
|
export * from './AdminShownConceptImage';
|
|
@@ -149,6 +149,12 @@ export interface AdminConceptDiagram {
|
|
|
149
149
|
* @memberof AdminConceptDiagram
|
|
150
150
|
*/
|
|
151
151
|
revisesDiagramId: string | null;
|
|
152
|
+
/**
|
|
153
|
+
* The changes an admin asked for when this diagram was revised from the previous version (revisesDiagramId) by editing it, with everything else kept. Null for a fresh diagram and for a regeneration from a rewritten brief.
|
|
154
|
+
* @type {string}
|
|
155
|
+
* @memberof AdminConceptDiagram
|
|
156
|
+
*/
|
|
157
|
+
revisionInstructions: string | null;
|
|
152
158
|
/**
|
|
153
159
|
*
|
|
154
160
|
* @type {string}
|
|
@@ -84,6 +84,8 @@ function instanceOfAdminConceptDiagram(value) {
|
|
|
84
84
|
return false;
|
|
85
85
|
if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
|
|
86
86
|
return false;
|
|
87
|
+
if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
|
|
88
|
+
return false;
|
|
87
89
|
if (!('title' in value) || value['title'] === undefined)
|
|
88
90
|
return false;
|
|
89
91
|
if (!('effort' in value) || value['effort'] === undefined)
|
|
@@ -120,6 +122,7 @@ function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
120
122
|
'costUsd': json['costUsd'],
|
|
121
123
|
'description': json['description'],
|
|
122
124
|
'revisesDiagramId': json['revisesDiagramId'],
|
|
125
|
+
'revisionInstructions': json['revisionInstructions'],
|
|
123
126
|
'title': json['title'],
|
|
124
127
|
'effort': json['effort'],
|
|
125
128
|
};
|
|
@@ -154,6 +157,7 @@ function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
154
157
|
'costUsd': value['costUsd'],
|
|
155
158
|
'description': value['description'],
|
|
156
159
|
'revisesDiagramId': value['revisesDiagramId'],
|
|
160
|
+
'revisionInstructions': value['revisionInstructions'],
|
|
157
161
|
'title': value['title'],
|
|
158
162
|
'effort': value['effort'],
|
|
159
163
|
};
|
|
@@ -151,6 +151,12 @@ export interface AdminConceptDiagramDetail {
|
|
|
151
151
|
* @memberof AdminConceptDiagramDetail
|
|
152
152
|
*/
|
|
153
153
|
revisesDiagramId: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* The changes an admin asked for when this diagram was revised from the previous version (revisesDiagramId) by editing it, with everything else kept. Null for a fresh diagram and for a regeneration from a rewritten brief.
|
|
156
|
+
* @type {string}
|
|
157
|
+
* @memberof AdminConceptDiagramDetail
|
|
158
|
+
*/
|
|
159
|
+
revisionInstructions: string | null;
|
|
154
160
|
/**
|
|
155
161
|
*
|
|
156
162
|
* @type {string}
|
|
@@ -86,6 +86,8 @@ function instanceOfAdminConceptDiagramDetail(value) {
|
|
|
86
86
|
return false;
|
|
87
87
|
if (!('revisesDiagramId' in value) || value['revisesDiagramId'] === undefined)
|
|
88
88
|
return false;
|
|
89
|
+
if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
|
|
90
|
+
return false;
|
|
89
91
|
if (!('title' in value) || value['title'] === undefined)
|
|
90
92
|
return false;
|
|
91
93
|
if (!('effort' in value) || value['effort'] === undefined)
|
|
@@ -134,6 +136,7 @@ function AdminConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
134
136
|
'costUsd': json['costUsd'],
|
|
135
137
|
'description': json['description'],
|
|
136
138
|
'revisesDiagramId': json['revisesDiagramId'],
|
|
139
|
+
'revisionInstructions': json['revisionInstructions'],
|
|
137
140
|
'title': json['title'],
|
|
138
141
|
'effort': json['effort'],
|
|
139
142
|
'brief': json['brief'],
|
|
@@ -174,6 +177,7 @@ function AdminConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator = false
|
|
|
174
177
|
'costUsd': value['costUsd'],
|
|
175
178
|
'description': value['description'],
|
|
176
179
|
'revisesDiagramId': value['revisesDiagramId'],
|
|
180
|
+
'revisionInstructions': value['revisionInstructions'],
|
|
177
181
|
'title': value['title'],
|
|
178
182
|
'effort': value['effort'],
|
|
179
183
|
'brief': value['brief'],
|
|
@@ -149,6 +149,12 @@ export interface AdminConceptImage {
|
|
|
149
149
|
* @memberof AdminConceptImage
|
|
150
150
|
*/
|
|
151
151
|
revisesImageId: string | null;
|
|
152
|
+
/**
|
|
153
|
+
* The changes an admin asked for when this image was revised from the previous version (revisesImageId) by editing it, with everything else kept. Null for a fresh image and for a regeneration from a rewritten prompt.
|
|
154
|
+
* @type {string}
|
|
155
|
+
* @memberof AdminConceptImage
|
|
156
|
+
*/
|
|
157
|
+
revisionInstructions: string | null;
|
|
152
158
|
/**
|
|
153
159
|
*
|
|
154
160
|
* @type {string}
|
|
@@ -84,6 +84,8 @@ function instanceOfAdminConceptImage(value) {
|
|
|
84
84
|
return false;
|
|
85
85
|
if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
|
|
86
86
|
return false;
|
|
87
|
+
if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
|
|
88
|
+
return false;
|
|
87
89
|
if (!('quality' in value) || value['quality'] === undefined)
|
|
88
90
|
return false;
|
|
89
91
|
if (!('mimeType' in value) || value['mimeType'] === undefined)
|
|
@@ -126,6 +128,7 @@ function AdminConceptImageFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
126
128
|
'costUsd': json['costUsd'],
|
|
127
129
|
'description': json['description'],
|
|
128
130
|
'revisesImageId': json['revisesImageId'],
|
|
131
|
+
'revisionInstructions': json['revisionInstructions'],
|
|
129
132
|
'quality': json['quality'],
|
|
130
133
|
'mimeType': json['mimeType'],
|
|
131
134
|
'width': json['width'],
|
|
@@ -163,6 +166,7 @@ function AdminConceptImageToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
163
166
|
'costUsd': value['costUsd'],
|
|
164
167
|
'description': value['description'],
|
|
165
168
|
'revisesImageId': value['revisesImageId'],
|
|
169
|
+
'revisionInstructions': value['revisionInstructions'],
|
|
166
170
|
'quality': value['quality'],
|
|
167
171
|
'mimeType': value['mimeType'],
|
|
168
172
|
'width': value['width'],
|
|
@@ -151,6 +151,12 @@ export interface AdminConceptImageDetail {
|
|
|
151
151
|
* @memberof AdminConceptImageDetail
|
|
152
152
|
*/
|
|
153
153
|
revisesImageId: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* The changes an admin asked for when this image was revised from the previous version (revisesImageId) by editing it, with everything else kept. Null for a fresh image and for a regeneration from a rewritten prompt.
|
|
156
|
+
* @type {string}
|
|
157
|
+
* @memberof AdminConceptImageDetail
|
|
158
|
+
*/
|
|
159
|
+
revisionInstructions: string | null;
|
|
154
160
|
/**
|
|
155
161
|
*
|
|
156
162
|
* @type {string}
|
|
@@ -86,6 +86,8 @@ function instanceOfAdminConceptImageDetail(value) {
|
|
|
86
86
|
return false;
|
|
87
87
|
if (!('revisesImageId' in value) || value['revisesImageId'] === undefined)
|
|
88
88
|
return false;
|
|
89
|
+
if (!('revisionInstructions' in value) || value['revisionInstructions'] === undefined)
|
|
90
|
+
return false;
|
|
89
91
|
if (!('quality' in value) || value['quality'] === undefined)
|
|
90
92
|
return false;
|
|
91
93
|
if (!('mimeType' in value) || value['mimeType'] === undefined)
|
|
@@ -140,6 +142,7 @@ function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
140
142
|
'costUsd': json['costUsd'],
|
|
141
143
|
'description': json['description'],
|
|
142
144
|
'revisesImageId': json['revisesImageId'],
|
|
145
|
+
'revisionInstructions': json['revisionInstructions'],
|
|
143
146
|
'quality': json['quality'],
|
|
144
147
|
'mimeType': json['mimeType'],
|
|
145
148
|
'width': json['width'],
|
|
@@ -183,6 +186,7 @@ function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
183
186
|
'costUsd': value['costUsd'],
|
|
184
187
|
'description': value['description'],
|
|
185
188
|
'revisesImageId': value['revisesImageId'],
|
|
189
|
+
'revisionInstructions': value['revisionInstructions'],
|
|
186
190
|
'quality': value['quality'],
|
|
187
191
|
'mimeType': value['mimeType'],
|
|
188
192
|
'width': value['width'],
|
|
@@ -29,7 +29,7 @@ export interface AdminConceptMediaJob {
|
|
|
29
29
|
*/
|
|
30
30
|
kind: AdminConceptMediaJobKindEnum;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* generate: a new draft. regenerate: a revision from a rewritten prompt or brief. revise: a revision edited from the source row with only the requested changes applied.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof AdminConceptMediaJob
|
|
35
35
|
*/
|
|
@@ -47,13 +47,13 @@ export interface AdminConceptMediaJob {
|
|
|
47
47
|
*/
|
|
48
48
|
concept: AdminConceptMediaConcept;
|
|
49
49
|
/**
|
|
50
|
-
* How the draft's concept (see concept) was chosen. selected: conceptId was given. For a conceptName: matched_exact, an existing concept with the same name (case-insensitive, normalized); matched_similar, the nearest existing concept within the dedup distance; created, no concept matched, so a new one was created. Null for a regenerate, which files under the revised row's concept.
|
|
50
|
+
* How the draft's concept (see concept) was chosen. selected: conceptId was given. For a conceptName: matched_exact, an existing concept with the same name (case-insensitive, normalized); matched_similar, the nearest existing concept within the dedup distance; created, no concept matched, so a new one was created. Null for a regenerate or revise, which files under the revised row's concept.
|
|
51
51
|
* @type {string}
|
|
52
52
|
* @memberof AdminConceptMediaJob
|
|
53
53
|
*/
|
|
54
54
|
conceptResolution: AdminConceptMediaJobConceptResolutionEnum | null;
|
|
55
55
|
/**
|
|
56
|
-
* For a regenerate, the image or diagram being revised
|
|
56
|
+
* For a regenerate or revise, the image or diagram being revised
|
|
57
57
|
* @type {string}
|
|
58
58
|
* @memberof AdminConceptMediaJob
|
|
59
59
|
*/
|
|
@@ -109,6 +109,7 @@ export type AdminConceptMediaJobKindEnum = typeof AdminConceptMediaJobKindEnum[k
|
|
|
109
109
|
export declare const AdminConceptMediaJobOperationEnum: {
|
|
110
110
|
readonly Generate: "generate";
|
|
111
111
|
readonly Regenerate: "regenerate";
|
|
112
|
+
readonly Revise: "revise";
|
|
112
113
|
};
|
|
113
114
|
export type AdminConceptMediaJobOperationEnum = typeof AdminConceptMediaJobOperationEnum[keyof typeof AdminConceptMediaJobOperationEnum];
|
|
114
115
|
/**
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AdminReviseConceptDiagramRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface AdminReviseConceptDiagramRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Only what should change, in plain words. The new diagram is made from the revised diagram itself with these changes applied and everything else kept. Recorded on the new revision as revisionInstructions.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof AdminReviseConceptDiagramRequest
|
|
22
|
+
*/
|
|
23
|
+
instructions: string;
|
|
24
|
+
/**
|
|
25
|
+
* Title for the new revision. Defaults to the original's.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof AdminReviseConceptDiagramRequest
|
|
28
|
+
*/
|
|
29
|
+
title?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Description for the new revision. Defaults to the original's; set it when the changes make that inaccurate.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof AdminReviseConceptDiagramRequest
|
|
34
|
+
*/
|
|
35
|
+
description?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the AdminReviseConceptDiagramRequest interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfAdminReviseConceptDiagramRequest(value: object): value is AdminReviseConceptDiagramRequest;
|
|
41
|
+
export declare function AdminReviseConceptDiagramRequestFromJSON(json: any): AdminReviseConceptDiagramRequest;
|
|
42
|
+
export declare function AdminReviseConceptDiagramRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminReviseConceptDiagramRequest;
|
|
43
|
+
export declare function AdminReviseConceptDiagramRequestToJSON(json: any): AdminReviseConceptDiagramRequest;
|
|
44
|
+
export declare function AdminReviseConceptDiagramRequestToJSONTyped(value?: AdminReviseConceptDiagramRequest | null, ignoreDiscriminator?: boolean): any;
|