@ord-api/ord-api-types 1.0.23 → 1.0.25
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 +108 -4
package/package.json
CHANGED
package/types.ts
CHANGED
|
@@ -604,6 +604,26 @@ export interface paths {
|
|
|
604
604
|
patch?: never;
|
|
605
605
|
trace?: never;
|
|
606
606
|
};
|
|
607
|
+
"/api/v1/conversations/ongoing/ai/generate-learning-tips": {
|
|
608
|
+
parameters: {
|
|
609
|
+
query?: never;
|
|
610
|
+
header?: never;
|
|
611
|
+
path?: never;
|
|
612
|
+
cookie?: never;
|
|
613
|
+
};
|
|
614
|
+
get?: never;
|
|
615
|
+
put?: never;
|
|
616
|
+
/**
|
|
617
|
+
* Generate learning tips from latest AI message
|
|
618
|
+
* @description Generate structured learning tips and annotations from the most recent AI message in the conversation that doesn't have learning tips yet. The system automatically identifies the appropriate message.
|
|
619
|
+
*/
|
|
620
|
+
post: operations["generateLearningTipsForAIMessage"];
|
|
621
|
+
delete?: never;
|
|
622
|
+
options?: never;
|
|
623
|
+
head?: never;
|
|
624
|
+
patch?: never;
|
|
625
|
+
trace?: never;
|
|
626
|
+
};
|
|
607
627
|
"/api/v1/auth/otp-verify": {
|
|
608
628
|
parameters: {
|
|
609
629
|
query?: never;
|
|
@@ -1658,14 +1678,39 @@ export interface components {
|
|
|
1658
1678
|
tone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
|
|
1659
1679
|
/** @enum {string} */
|
|
1660
1680
|
type: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
|
|
1661
|
-
aiInterlocutorName
|
|
1662
|
-
aiInterlocutorAvatarId
|
|
1681
|
+
aiInterlocutorName: string;
|
|
1682
|
+
aiInterlocutorAvatarId: string;
|
|
1663
1683
|
};
|
|
1664
1684
|
AlternativeExpression: {
|
|
1665
1685
|
context: string;
|
|
1666
1686
|
alternatives: string[];
|
|
1667
1687
|
note?: string;
|
|
1668
1688
|
};
|
|
1689
|
+
AnnotatedGrammarTip: {
|
|
1690
|
+
phrase: string;
|
|
1691
|
+
explanation: string;
|
|
1692
|
+
grammarPoint: string;
|
|
1693
|
+
};
|
|
1694
|
+
AnnotatedIdiomTip: {
|
|
1695
|
+
phrase: string;
|
|
1696
|
+
meaning: string;
|
|
1697
|
+
example: string;
|
|
1698
|
+
};
|
|
1699
|
+
AnnotatedVocabularyTip: {
|
|
1700
|
+
word: string;
|
|
1701
|
+
definition: string;
|
|
1702
|
+
usageNote: string;
|
|
1703
|
+
proficiencyLevel: string;
|
|
1704
|
+
};
|
|
1705
|
+
ConversationAIMessageLearningTipsDTO: {
|
|
1706
|
+
/** Format: uuid */
|
|
1707
|
+
id: string;
|
|
1708
|
+
grammarTips: components["schemas"]["AnnotatedGrammarTip"][];
|
|
1709
|
+
vocabularyTips: components["schemas"]["AnnotatedVocabularyTip"][];
|
|
1710
|
+
idiomTips: components["schemas"]["AnnotatedIdiomTip"][];
|
|
1711
|
+
/** Format: uuid */
|
|
1712
|
+
messageId: string;
|
|
1713
|
+
};
|
|
1669
1714
|
ConversationDTO: {
|
|
1670
1715
|
/** Format: uuid */
|
|
1671
1716
|
id: string;
|
|
@@ -1681,8 +1726,8 @@ export interface components {
|
|
|
1681
1726
|
type: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
|
|
1682
1727
|
/** @enum {string} */
|
|
1683
1728
|
aiTone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
|
|
1684
|
-
aiInterlocutorName
|
|
1685
|
-
aiInterlocutorAvatarId
|
|
1729
|
+
aiInterlocutorName: string;
|
|
1730
|
+
aiInterlocutorAvatarId: string;
|
|
1686
1731
|
additionalContext?: string;
|
|
1687
1732
|
messages: components["schemas"]["ConversationMessageDTO"][];
|
|
1688
1733
|
/** Format: date-time */
|
|
@@ -1699,12 +1744,14 @@ export interface components {
|
|
|
1699
1744
|
sender: "USER" | "AI";
|
|
1700
1745
|
content: string;
|
|
1701
1746
|
feedback?: components["schemas"]["ConversationUserMessageFeedbackDTO"];
|
|
1747
|
+
learningTips?: components["schemas"]["ConversationAIMessageLearningTipsDTO"];
|
|
1702
1748
|
/** Format: date-time */
|
|
1703
1749
|
createdAt: string;
|
|
1704
1750
|
};
|
|
1705
1751
|
ConversationUserMessageFeedbackDTO: {
|
|
1706
1752
|
/** Format: uuid */
|
|
1707
1753
|
id: string;
|
|
1754
|
+
tutorComment: string;
|
|
1708
1755
|
/** Format: int32 */
|
|
1709
1756
|
grammar: number;
|
|
1710
1757
|
/** Format: int32 */
|
|
@@ -1790,6 +1837,7 @@ export interface components {
|
|
|
1790
1837
|
};
|
|
1791
1838
|
ReviewedUserConversationMessage: {
|
|
1792
1839
|
sabotage?: string;
|
|
1840
|
+
tutorComment: string;
|
|
1793
1841
|
/** Format: int32 */
|
|
1794
1842
|
grammar: number;
|
|
1795
1843
|
/** Format: int32 */
|
|
@@ -1814,6 +1862,15 @@ export interface components {
|
|
|
1814
1862
|
messageOrder: number;
|
|
1815
1863
|
latestUserMessage: string;
|
|
1816
1864
|
};
|
|
1865
|
+
GetLearningTipsForAIMessageRequest: {
|
|
1866
|
+
/** Format: uuid */
|
|
1867
|
+
conversationId: string;
|
|
1868
|
+
};
|
|
1869
|
+
AIMessageLearningTips: {
|
|
1870
|
+
grammarTips: components["schemas"]["AnnotatedGrammarTip"][];
|
|
1871
|
+
vocabularyTips: components["schemas"]["AnnotatedVocabularyTip"][];
|
|
1872
|
+
idiomTips: components["schemas"]["AnnotatedIdiomTip"][];
|
|
1873
|
+
};
|
|
1817
1874
|
/** @description Request to verify OTP code and authenticate user */
|
|
1818
1875
|
OtpVerifyDto: {
|
|
1819
1876
|
/**
|
|
@@ -3478,6 +3535,53 @@ export interface operations {
|
|
|
3478
3535
|
};
|
|
3479
3536
|
};
|
|
3480
3537
|
};
|
|
3538
|
+
generateLearningTipsForAIMessage: {
|
|
3539
|
+
parameters: {
|
|
3540
|
+
query?: never;
|
|
3541
|
+
header?: never;
|
|
3542
|
+
path?: never;
|
|
3543
|
+
cookie?: never;
|
|
3544
|
+
};
|
|
3545
|
+
requestBody: {
|
|
3546
|
+
content: {
|
|
3547
|
+
"application/json": components["schemas"]["GetLearningTipsForAIMessageRequest"];
|
|
3548
|
+
};
|
|
3549
|
+
};
|
|
3550
|
+
responses: {
|
|
3551
|
+
/** @description Learning tips generated successfully */
|
|
3552
|
+
200: {
|
|
3553
|
+
headers: {
|
|
3554
|
+
[name: string]: unknown;
|
|
3555
|
+
};
|
|
3556
|
+
content: {
|
|
3557
|
+
"*/*": components["schemas"]["AIMessageLearningTips"];
|
|
3558
|
+
};
|
|
3559
|
+
};
|
|
3560
|
+
/** @description Bad Request */
|
|
3561
|
+
400: {
|
|
3562
|
+
headers: {
|
|
3563
|
+
[name: string]: unknown;
|
|
3564
|
+
};
|
|
3565
|
+
content: {
|
|
3566
|
+
"*/*": components["schemas"]["BadRequestResponse"];
|
|
3567
|
+
};
|
|
3568
|
+
};
|
|
3569
|
+
/** @description Unauthorized */
|
|
3570
|
+
401: {
|
|
3571
|
+
headers: {
|
|
3572
|
+
[name: string]: unknown;
|
|
3573
|
+
};
|
|
3574
|
+
content?: never;
|
|
3575
|
+
};
|
|
3576
|
+
/** @description Conversation not found or no AI message without learning tips exists */
|
|
3577
|
+
404: {
|
|
3578
|
+
headers: {
|
|
3579
|
+
[name: string]: unknown;
|
|
3580
|
+
};
|
|
3581
|
+
content?: never;
|
|
3582
|
+
};
|
|
3583
|
+
};
|
|
3584
|
+
};
|
|
3481
3585
|
verifyOtp: {
|
|
3482
3586
|
parameters: {
|
|
3483
3587
|
query?: never;
|