@ord-api/ord-api-types 1.0.11 → 1.0.13
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/package.json +1 -1
- package/types.ts +170 -40
package/package.json
CHANGED
package/types.ts
CHANGED
|
@@ -524,7 +524,7 @@ export interface paths {
|
|
|
524
524
|
patch?: never;
|
|
525
525
|
trace?: never;
|
|
526
526
|
};
|
|
527
|
-
"/api/v1/conversations/ongoing/
|
|
527
|
+
"/api/v1/conversations/ongoing/user/save-message": {
|
|
528
528
|
parameters: {
|
|
529
529
|
query?: never;
|
|
530
530
|
header?: never;
|
|
@@ -534,17 +534,17 @@ export interface paths {
|
|
|
534
534
|
get?: never;
|
|
535
535
|
put?: never;
|
|
536
536
|
/**
|
|
537
|
-
*
|
|
538
|
-
* @description
|
|
537
|
+
* Save user message
|
|
538
|
+
* @description Save a user message to a conversation
|
|
539
539
|
*/
|
|
540
|
-
post: operations["
|
|
540
|
+
post: operations["saveUserMessage"];
|
|
541
541
|
delete?: never;
|
|
542
542
|
options?: never;
|
|
543
543
|
head?: never;
|
|
544
544
|
patch?: never;
|
|
545
545
|
trace?: never;
|
|
546
546
|
};
|
|
547
|
-
"/api/v1/conversations/ongoing/
|
|
547
|
+
"/api/v1/conversations/ongoing/user/generate-feedback": {
|
|
548
548
|
parameters: {
|
|
549
549
|
query?: never;
|
|
550
550
|
header?: never;
|
|
@@ -554,17 +554,17 @@ export interface paths {
|
|
|
554
554
|
get?: never;
|
|
555
555
|
put?: never;
|
|
556
556
|
/**
|
|
557
|
-
*
|
|
558
|
-
* @description
|
|
557
|
+
* Generate feedback for user message
|
|
558
|
+
* @description Generate AI-powered grammar and language feedback for an existing user message
|
|
559
559
|
*/
|
|
560
|
-
post: operations["
|
|
560
|
+
post: operations["generateFeedback"];
|
|
561
561
|
delete?: never;
|
|
562
562
|
options?: never;
|
|
563
563
|
head?: never;
|
|
564
564
|
patch?: never;
|
|
565
565
|
trace?: never;
|
|
566
566
|
};
|
|
567
|
-
"/api/v1/conversations/ongoing/
|
|
567
|
+
"/api/v1/conversations/ongoing/ai/request-message": {
|
|
568
568
|
parameters: {
|
|
569
569
|
query?: never;
|
|
570
570
|
header?: never;
|
|
@@ -574,10 +574,30 @@ export interface paths {
|
|
|
574
574
|
get?: never;
|
|
575
575
|
put?: never;
|
|
576
576
|
/**
|
|
577
|
-
*
|
|
578
|
-
* @description
|
|
577
|
+
* Request AI response
|
|
578
|
+
* @description Request an AI-generated response in an ongoing conversation (streaming response)
|
|
579
579
|
*/
|
|
580
|
-
post: operations["
|
|
580
|
+
post: operations["requestAIMessage"];
|
|
581
|
+
delete?: never;
|
|
582
|
+
options?: never;
|
|
583
|
+
head?: never;
|
|
584
|
+
patch?: never;
|
|
585
|
+
trace?: never;
|
|
586
|
+
};
|
|
587
|
+
"/api/v1/conversations/ongoing/ai/initialize": {
|
|
588
|
+
parameters: {
|
|
589
|
+
query?: never;
|
|
590
|
+
header?: never;
|
|
591
|
+
path?: never;
|
|
592
|
+
cookie?: never;
|
|
593
|
+
};
|
|
594
|
+
get?: never;
|
|
595
|
+
put?: never;
|
|
596
|
+
/**
|
|
597
|
+
* Initialize conversation with AI
|
|
598
|
+
* @description Start a conversation with an AI-generated opening message (streaming response)
|
|
599
|
+
*/
|
|
600
|
+
post: operations["initializeConversationByAI"];
|
|
581
601
|
delete?: never;
|
|
582
602
|
options?: never;
|
|
583
603
|
head?: never;
|
|
@@ -1744,17 +1764,20 @@ export interface components {
|
|
|
1744
1764
|
/** @enum {string} */
|
|
1745
1765
|
avatarId: "AVATAR_ALPHA" | "AVATAR_BETA" | "AVATAR_GAMMA" | "AVATAR_DELTA" | "AVATAR_EPSILON" | "AVATAR_ZETA" | "AVATAR_ETA" | "AVATAR_THETA";
|
|
1746
1766
|
};
|
|
1747
|
-
|
|
1767
|
+
SaveUserConversationMessageRequest: {
|
|
1748
1768
|
/** Format: uuid */
|
|
1749
1769
|
conversationId: string;
|
|
1770
|
+
/** Format: uuid */
|
|
1771
|
+
messageId: string;
|
|
1772
|
+
content: string;
|
|
1750
1773
|
/** Format: int32 */
|
|
1751
1774
|
messageOrder: number;
|
|
1752
|
-
latestUserMessage: string;
|
|
1753
1775
|
};
|
|
1754
|
-
|
|
1776
|
+
GetFeedbackOnUserConversationMessageRequest: {
|
|
1755
1777
|
/** Format: uuid */
|
|
1756
1778
|
conversationId: string;
|
|
1757
|
-
|
|
1779
|
+
/** Format: uuid */
|
|
1780
|
+
messageId: string;
|
|
1758
1781
|
/** Format: int32 */
|
|
1759
1782
|
messageOrder: number;
|
|
1760
1783
|
latestAIMessage?: string;
|
|
@@ -1778,6 +1801,13 @@ export interface components {
|
|
|
1778
1801
|
alternativeExpressions: components["schemas"]["AlternativeExpression"][];
|
|
1779
1802
|
culturalNote?: string;
|
|
1780
1803
|
};
|
|
1804
|
+
CreateAIConversationMessageRequest: {
|
|
1805
|
+
/** Format: uuid */
|
|
1806
|
+
conversationId: string;
|
|
1807
|
+
/** Format: int32 */
|
|
1808
|
+
messageOrder: number;
|
|
1809
|
+
latestUserMessage: string;
|
|
1810
|
+
};
|
|
1781
1811
|
/** @description Request to verify OTP code and authenticate user */
|
|
1782
1812
|
OtpVerifyDto: {
|
|
1783
1813
|
/**
|
|
@@ -1945,6 +1975,61 @@ export interface components {
|
|
|
1945
1975
|
updatedAt: string;
|
|
1946
1976
|
details?: components["schemas"]["WordDetailsCompactDTO"];
|
|
1947
1977
|
};
|
|
1978
|
+
/** @enum {string} */
|
|
1979
|
+
LanguageProficiencyLevel: "A1" | "A2" | "B1" | "B2" | "C1" | "C2";
|
|
1980
|
+
/**
|
|
1981
|
+
* @description Supported languages in the platform
|
|
1982
|
+
* @enum {string}
|
|
1983
|
+
*/
|
|
1984
|
+
LanguageName: "POLISH" | "ENGLISH" | "GERMAN" | "FRENCH" | "SPANISH" | "ITALIAN" | "NORWEGIAN" | "RUSSIAN" | "SLOVENIAN";
|
|
1985
|
+
/** @enum {string} */
|
|
1986
|
+
Gender: "MALE" | "FEMALE";
|
|
1987
|
+
/** @enum {string} */
|
|
1988
|
+
GetAllWordsSortOptions: "CREATED_AT" | "SOURCE_WORD";
|
|
1989
|
+
/** @enum {string} */
|
|
1990
|
+
WordToggleableProperty: "IS_BOOKMARKED";
|
|
1991
|
+
/** @enum {string} */
|
|
1992
|
+
WordCollocationFrequency: "VERY_COMMON" | "COMMON" | "OCCASIONAL";
|
|
1993
|
+
/** @enum {string} */
|
|
1994
|
+
WordGender: "MASCULINE" | "FEMININE" | "NEUTER";
|
|
1995
|
+
/**
|
|
1996
|
+
* @description Type of word or expression
|
|
1997
|
+
* @enum {string}
|
|
1998
|
+
*/
|
|
1999
|
+
WordType: "NOUN" | "VERB" | "ADJECTIVE" | "ADVERB" | "IDIOM" | "PHRASE";
|
|
2000
|
+
/**
|
|
2001
|
+
* @description Extra marks or tags for word classification by register or domain
|
|
2002
|
+
* @enum {string}
|
|
2003
|
+
*/
|
|
2004
|
+
WordExtraMark: "OFFENSIVE" | "SLANG" | "FORMAL" | "INFORMAL" | "SCIENTIFIC" | "TECHNICAL" | "LEGAL" | "MEDICAL" | "COLLOQUIAL" | "POETIC";
|
|
2005
|
+
/** @enum {string} */
|
|
2006
|
+
SortDirection: "ASC" | "DESC";
|
|
2007
|
+
/** @enum {string} */
|
|
2008
|
+
GameResult: "COMPLETED" | "CANCELLED";
|
|
2009
|
+
/** @enum {string} */
|
|
2010
|
+
GameDifficulty: "EASY" | "MEDIUM" | "HARD";
|
|
2011
|
+
/** @enum {string} */
|
|
2012
|
+
GameGrade: "S" | "A" | "B" | "C" | "D" | "NA";
|
|
2013
|
+
/** @enum {string} */
|
|
2014
|
+
GameType: "WORDS_TYPING" | "CROSSWORD" | "SENTENCES_WRITING";
|
|
2015
|
+
/** @enum {string} */
|
|
2016
|
+
CrosswordWordDirection: "HORIZONTAL" | "VERTICAL";
|
|
2017
|
+
/** @enum {string} */
|
|
2018
|
+
WordAnswerScore: "CORRECT" | "HALF_CORRECT" | "INCORRECT";
|
|
2019
|
+
/** @enum {string} */
|
|
2020
|
+
UserActivityFrequency: "DAILY" | "WEEKLY" | "MONTHLY" | "NON_PERIODIC";
|
|
2021
|
+
/** @enum {string} */
|
|
2022
|
+
UserActivityType: "CROSSWORD_GAME_COMPLETED_FLAWLESSLY" | "CROSSWORD_GAME_COMPLETED_WITH_MISTAKES" | "WORDS_TYPING_GAME_COMPLETED_FLAWLESSLY" | "WORDS_TYPING_GAME_COMPLETED_WITH_MISTAKES" | "SENTENCES_WRITING_GAME_COMPLETED_FLAWLESSLY" | "SENTENCES_WRITING_GAME_COMPLETED_WITH_MISTAKES" | "GAME_QUIT" | "WORDS_ADDED_IN_ONE_DAY_10" | "WORDS_ADDED_IN_ONE_WEEK_50" | "WORD_COMPLETED" | "WORDS_COMPLETED_IN_ONE_DAY_10" | "WORDS_COMPLETED_IN_ONE_WEEK_30";
|
|
2023
|
+
/** @enum {string} */
|
|
2024
|
+
ConversationMessageSender: "USER" | "AI";
|
|
2025
|
+
/** @enum {string} */
|
|
2026
|
+
ErrorType: "GRAMMAR_TENSE" | "GRAMMAR_AGREEMENT" | "GRAMMAR_WORD_ORDER" | "VOCABULARY_WRONG_WORD" | "VOCABULARY_UNNATURAL_COLLOCATION" | "SPELLING" | "PUNCTUATION" | "MISSING_WORD" | "UNNECESSARY_WORD" | "REGISTER_MISMATCH" | "COHERENCE_ISSUE";
|
|
2027
|
+
/** @enum {string} */
|
|
2028
|
+
ConversationTone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
|
|
2029
|
+
/** @enum {string} */
|
|
2030
|
+
ConversationAIBotAvatar: "AVATAR_ALPHA" | "AVATAR_BETA" | "AVATAR_GAMMA" | "AVATAR_DELTA" | "AVATAR_EPSILON" | "AVATAR_ZETA" | "AVATAR_ETA" | "AVATAR_THETA";
|
|
2031
|
+
/** @enum {string} */
|
|
2032
|
+
ConversationType: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
|
|
1948
2033
|
};
|
|
1949
2034
|
responses: never;
|
|
1950
2035
|
parameters: never;
|
|
@@ -3203,7 +3288,7 @@ export interface operations {
|
|
|
3203
3288
|
};
|
|
3204
3289
|
};
|
|
3205
3290
|
};
|
|
3206
|
-
|
|
3291
|
+
saveUserMessage: {
|
|
3207
3292
|
parameters: {
|
|
3208
3293
|
query?: never;
|
|
3209
3294
|
header?: never;
|
|
@@ -3212,17 +3297,17 @@ export interface operations {
|
|
|
3212
3297
|
};
|
|
3213
3298
|
requestBody: {
|
|
3214
3299
|
content: {
|
|
3215
|
-
"application/json": components["schemas"]["
|
|
3300
|
+
"application/json": components["schemas"]["SaveUserConversationMessageRequest"];
|
|
3216
3301
|
};
|
|
3217
3302
|
};
|
|
3218
3303
|
responses: {
|
|
3219
|
-
/** @description
|
|
3304
|
+
/** @description User message saved successfully */
|
|
3220
3305
|
200: {
|
|
3221
3306
|
headers: {
|
|
3222
3307
|
[name: string]: unknown;
|
|
3223
3308
|
};
|
|
3224
3309
|
content: {
|
|
3225
|
-
"
|
|
3310
|
+
"*/*": components["schemas"]["ConversationMessageDTO"];
|
|
3226
3311
|
};
|
|
3227
3312
|
};
|
|
3228
3313
|
/** @description Invalid request data */
|
|
@@ -3248,38 +3333,34 @@ export interface operations {
|
|
|
3248
3333
|
};
|
|
3249
3334
|
};
|
|
3250
3335
|
};
|
|
3251
|
-
|
|
3336
|
+
generateFeedback: {
|
|
3252
3337
|
parameters: {
|
|
3253
|
-
query
|
|
3254
|
-
/**
|
|
3255
|
-
* @description Conversation ID
|
|
3256
|
-
* @example 650e8400-e29b-41d4-a716-446655440000
|
|
3257
|
-
*/
|
|
3258
|
-
conversationId: string;
|
|
3259
|
-
};
|
|
3338
|
+
query?: never;
|
|
3260
3339
|
header?: never;
|
|
3261
3340
|
path?: never;
|
|
3262
3341
|
cookie?: never;
|
|
3263
3342
|
};
|
|
3264
|
-
requestBody
|
|
3343
|
+
requestBody: {
|
|
3344
|
+
content: {
|
|
3345
|
+
"application/json": components["schemas"]["GetFeedbackOnUserConversationMessageRequest"];
|
|
3346
|
+
};
|
|
3347
|
+
};
|
|
3265
3348
|
responses: {
|
|
3266
|
-
/** @description
|
|
3349
|
+
/** @description Feedback generated successfully */
|
|
3267
3350
|
200: {
|
|
3268
3351
|
headers: {
|
|
3269
3352
|
[name: string]: unknown;
|
|
3270
3353
|
};
|
|
3271
3354
|
content: {
|
|
3272
|
-
"
|
|
3355
|
+
"*/*": components["schemas"]["ReviewedUserConversationMessage"];
|
|
3273
3356
|
};
|
|
3274
3357
|
};
|
|
3275
|
-
/** @description
|
|
3358
|
+
/** @description Invalid request data */
|
|
3276
3359
|
400: {
|
|
3277
3360
|
headers: {
|
|
3278
3361
|
[name: string]: unknown;
|
|
3279
3362
|
};
|
|
3280
|
-
content
|
|
3281
|
-
"*/*": components["schemas"]["BadRequestResponse"];
|
|
3282
|
-
};
|
|
3363
|
+
content?: never;
|
|
3283
3364
|
};
|
|
3284
3365
|
/** @description Unauthorized */
|
|
3285
3366
|
401: {
|
|
@@ -3288,7 +3369,7 @@ export interface operations {
|
|
|
3288
3369
|
};
|
|
3289
3370
|
content?: never;
|
|
3290
3371
|
};
|
|
3291
|
-
/** @description Conversation not found */
|
|
3372
|
+
/** @description Conversation or message not found */
|
|
3292
3373
|
404: {
|
|
3293
3374
|
headers: {
|
|
3294
3375
|
[name: string]: unknown;
|
|
@@ -3297,7 +3378,7 @@ export interface operations {
|
|
|
3297
3378
|
};
|
|
3298
3379
|
};
|
|
3299
3380
|
};
|
|
3300
|
-
|
|
3381
|
+
requestAIMessage: {
|
|
3301
3382
|
parameters: {
|
|
3302
3383
|
query?: never;
|
|
3303
3384
|
header?: never;
|
|
@@ -3306,17 +3387,17 @@ export interface operations {
|
|
|
3306
3387
|
};
|
|
3307
3388
|
requestBody: {
|
|
3308
3389
|
content: {
|
|
3309
|
-
"application/json": components["schemas"]["
|
|
3390
|
+
"application/json": components["schemas"]["CreateAIConversationMessageRequest"];
|
|
3310
3391
|
};
|
|
3311
3392
|
};
|
|
3312
3393
|
responses: {
|
|
3313
|
-
/** @description
|
|
3394
|
+
/** @description AI message stream started successfully */
|
|
3314
3395
|
200: {
|
|
3315
3396
|
headers: {
|
|
3316
3397
|
[name: string]: unknown;
|
|
3317
3398
|
};
|
|
3318
3399
|
content: {
|
|
3319
|
-
"
|
|
3400
|
+
"text/event-stream": string[];
|
|
3320
3401
|
};
|
|
3321
3402
|
};
|
|
3322
3403
|
/** @description Invalid request data */
|
|
@@ -3342,6 +3423,55 @@ export interface operations {
|
|
|
3342
3423
|
};
|
|
3343
3424
|
};
|
|
3344
3425
|
};
|
|
3426
|
+
initializeConversationByAI: {
|
|
3427
|
+
parameters: {
|
|
3428
|
+
query: {
|
|
3429
|
+
/**
|
|
3430
|
+
* @description Conversation ID
|
|
3431
|
+
* @example 650e8400-e29b-41d4-a716-446655440000
|
|
3432
|
+
*/
|
|
3433
|
+
conversationId: string;
|
|
3434
|
+
};
|
|
3435
|
+
header?: never;
|
|
3436
|
+
path?: never;
|
|
3437
|
+
cookie?: never;
|
|
3438
|
+
};
|
|
3439
|
+
requestBody?: never;
|
|
3440
|
+
responses: {
|
|
3441
|
+
/** @description Conversation initialization stream started successfully */
|
|
3442
|
+
200: {
|
|
3443
|
+
headers: {
|
|
3444
|
+
[name: string]: unknown;
|
|
3445
|
+
};
|
|
3446
|
+
content: {
|
|
3447
|
+
"text/event-stream": string[];
|
|
3448
|
+
};
|
|
3449
|
+
};
|
|
3450
|
+
/** @description Bad Request */
|
|
3451
|
+
400: {
|
|
3452
|
+
headers: {
|
|
3453
|
+
[name: string]: unknown;
|
|
3454
|
+
};
|
|
3455
|
+
content: {
|
|
3456
|
+
"*/*": components["schemas"]["BadRequestResponse"];
|
|
3457
|
+
};
|
|
3458
|
+
};
|
|
3459
|
+
/** @description Unauthorized */
|
|
3460
|
+
401: {
|
|
3461
|
+
headers: {
|
|
3462
|
+
[name: string]: unknown;
|
|
3463
|
+
};
|
|
3464
|
+
content?: never;
|
|
3465
|
+
};
|
|
3466
|
+
/** @description Conversation not found */
|
|
3467
|
+
404: {
|
|
3468
|
+
headers: {
|
|
3469
|
+
[name: string]: unknown;
|
|
3470
|
+
};
|
|
3471
|
+
content?: never;
|
|
3472
|
+
};
|
|
3473
|
+
};
|
|
3474
|
+
};
|
|
3345
3475
|
verifyOtp: {
|
|
3346
3476
|
parameters: {
|
|
3347
3477
|
query?: never;
|