@ord-api/ord-api-types 1.0.23 → 1.0.24

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 (2) hide show
  1. package/package.json +1 -1
  2. package/types.ts +109 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ord-api/ord-api-types",
3
- "version": "1.0.23",
3
+ "version": "1.0.24",
4
4
  "description": "TypeScript types for ORD API - Auto-generated from OpenAPI specification",
5
5
  "main": "types.ts",
6
6
  "types": "types.ts",
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 AI message
618
+ * @description Generate structured learning tips and annotations from an AI message in the conversation
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;
@@ -1666,6 +1686,37 @@ export interface components {
1666
1686
  alternatives: string[];
1667
1687
  note?: string;
1668
1688
  };
1689
+ AnnotatedCulturalTip: {
1690
+ phrase: string;
1691
+ culturalContext: string;
1692
+ regionalNote: string;
1693
+ };
1694
+ AnnotatedGrammarTip: {
1695
+ phrase: string;
1696
+ explanation: string;
1697
+ grammarPoint: string;
1698
+ };
1699
+ AnnotatedIdiomTip: {
1700
+ phrase: string;
1701
+ meaning: string;
1702
+ example: string;
1703
+ };
1704
+ AnnotatedVocabularyTip: {
1705
+ word: string;
1706
+ definition: string;
1707
+ usageNote: string;
1708
+ proficiencyLevel: string;
1709
+ };
1710
+ ConversationAIMessageLearningTipsDTO: {
1711
+ /** Format: uuid */
1712
+ id: string;
1713
+ grammarTips: components["schemas"]["AnnotatedGrammarTip"][];
1714
+ vocabularyTips: components["schemas"]["AnnotatedVocabularyTip"][];
1715
+ idiomTips: components["schemas"]["AnnotatedIdiomTip"][];
1716
+ culturalTips: components["schemas"]["AnnotatedCulturalTip"][];
1717
+ /** Format: uuid */
1718
+ messageId: string;
1719
+ };
1669
1720
  ConversationDTO: {
1670
1721
  /** Format: uuid */
1671
1722
  id: string;
@@ -1699,6 +1750,7 @@ export interface components {
1699
1750
  sender: "USER" | "AI";
1700
1751
  content: string;
1701
1752
  feedback?: components["schemas"]["ConversationUserMessageFeedbackDTO"];
1753
+ learningTips?: components["schemas"]["ConversationAIMessageLearningTipsDTO"];
1702
1754
  /** Format: date-time */
1703
1755
  createdAt: string;
1704
1756
  };
@@ -1814,6 +1866,18 @@ export interface components {
1814
1866
  messageOrder: number;
1815
1867
  latestUserMessage: string;
1816
1868
  };
1869
+ GetLearningTipsForAIMessageRequest: {
1870
+ /** Format: uuid */
1871
+ conversationId: string;
1872
+ /** Format: uuid */
1873
+ messageId: string;
1874
+ };
1875
+ AIMessageLearningTips: {
1876
+ grammarTips: components["schemas"]["AnnotatedGrammarTip"][];
1877
+ vocabularyTips: components["schemas"]["AnnotatedVocabularyTip"][];
1878
+ idiomTips: components["schemas"]["AnnotatedIdiomTip"][];
1879
+ culturalTips: components["schemas"]["AnnotatedCulturalTip"][];
1880
+ };
1817
1881
  /** @description Request to verify OTP code and authenticate user */
1818
1882
  OtpVerifyDto: {
1819
1883
  /**
@@ -3478,6 +3542,51 @@ export interface operations {
3478
3542
  };
3479
3543
  };
3480
3544
  };
3545
+ generateLearningTipsForAIMessage: {
3546
+ parameters: {
3547
+ query?: never;
3548
+ header?: never;
3549
+ path?: never;
3550
+ cookie?: never;
3551
+ };
3552
+ requestBody: {
3553
+ content: {
3554
+ "application/json": components["schemas"]["GetLearningTipsForAIMessageRequest"];
3555
+ };
3556
+ };
3557
+ responses: {
3558
+ /** @description Learning tips generated successfully */
3559
+ 200: {
3560
+ headers: {
3561
+ [name: string]: unknown;
3562
+ };
3563
+ content: {
3564
+ "*/*": components["schemas"]["AIMessageLearningTips"];
3565
+ };
3566
+ };
3567
+ /** @description Invalid request data or message is not from AI */
3568
+ 400: {
3569
+ headers: {
3570
+ [name: string]: unknown;
3571
+ };
3572
+ content?: never;
3573
+ };
3574
+ /** @description Unauthorized */
3575
+ 401: {
3576
+ headers: {
3577
+ [name: string]: unknown;
3578
+ };
3579
+ content?: never;
3580
+ };
3581
+ /** @description Conversation or message not found */
3582
+ 404: {
3583
+ headers: {
3584
+ [name: string]: unknown;
3585
+ };
3586
+ content?: never;
3587
+ };
3588
+ };
3589
+ };
3481
3590
  verifyOtp: {
3482
3591
  parameters: {
3483
3592
  query?: never;