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

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 +33 -35
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ord-api/ord-api-types",
3
- "version": "1.0.24",
3
+ "version": "1.0.26",
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
@@ -614,8 +614,8 @@ export interface paths {
614
614
  get?: never;
615
615
  put?: never;
616
616
  /**
617
- * Generate learning tips from AI message
618
- * @description Generate structured learning tips and annotations from an AI message in the conversation
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
619
  */
620
620
  post: operations["generateLearningTipsForAIMessage"];
621
621
  delete?: never;
@@ -1678,18 +1678,8 @@ export interface components {
1678
1678
  tone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
1679
1679
  /** @enum {string} */
1680
1680
  type: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
1681
- aiInterlocutorName?: string;
1682
- aiInterlocutorAvatarId?: string;
1683
- };
1684
- AlternativeExpression: {
1685
- context: string;
1686
- alternatives: string[];
1687
- note?: string;
1688
- };
1689
- AnnotatedCulturalTip: {
1690
- phrase: string;
1691
- culturalContext: string;
1692
- regionalNote: string;
1681
+ aiInterlocutorName: string;
1682
+ aiInterlocutorAvatarId: string;
1693
1683
  };
1694
1684
  AnnotatedGrammarTip: {
1695
1685
  phrase: string;
@@ -1713,7 +1703,6 @@ export interface components {
1713
1703
  grammarTips: components["schemas"]["AnnotatedGrammarTip"][];
1714
1704
  vocabularyTips: components["schemas"]["AnnotatedVocabularyTip"][];
1715
1705
  idiomTips: components["schemas"]["AnnotatedIdiomTip"][];
1716
- culturalTips: components["schemas"]["AnnotatedCulturalTip"][];
1717
1706
  /** Format: uuid */
1718
1707
  messageId: string;
1719
1708
  };
@@ -1732,8 +1721,8 @@ export interface components {
1732
1721
  type: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
1733
1722
  /** @enum {string} */
1734
1723
  aiTone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
1735
- aiInterlocutorName?: string;
1736
- aiInterlocutorAvatarId?: string;
1724
+ aiInterlocutorName: string;
1725
+ aiInterlocutorAvatarId: string;
1737
1726
  additionalContext?: string;
1738
1727
  messages: components["schemas"]["ConversationMessageDTO"][];
1739
1728
  /** Format: date-time */
@@ -1757,6 +1746,7 @@ export interface components {
1757
1746
  ConversationUserMessageFeedbackDTO: {
1758
1747
  /** Format: uuid */
1759
1748
  id: string;
1749
+ tutorComment: string;
1760
1750
  /** Format: int32 */
1761
1751
  grammar: number;
1762
1752
  /** Format: int32 */
@@ -1769,10 +1759,8 @@ export interface components {
1769
1759
  coherenceWithContext: number;
1770
1760
  registerAppropriate: boolean;
1771
1761
  mistakes: components["schemas"]["Mistake"][];
1772
- strengthsIdentified: string[];
1773
- vocabularyEnrichment: components["schemas"]["VocabularyEnrichment"][];
1774
- alternativeExpressions: components["schemas"]["AlternativeExpression"][];
1775
- culturalNote?: string;
1762
+ strengths: components["schemas"]["Strength"][];
1763
+ suggestions: components["schemas"]["Suggestion"][];
1776
1764
  /** Format: uuid */
1777
1765
  messageId: string;
1778
1766
  };
@@ -1781,13 +1769,21 @@ export interface components {
1781
1769
  /** Format: int32 */
1782
1770
  severity: number;
1783
1771
  /** @enum {string} */
1784
- errorType: "GRAMMAR_TENSE" | "GRAMMAR_AGREEMENT" | "GRAMMAR_WORD_ORDER" | "VOCABULARY_WRONG_WORD" | "VOCABULARY_UNNATURAL_COLLOCATION" | "SPELLING" | "PUNCTUATION" | "MISSING_WORD" | "UNNECESSARY_WORD" | "REGISTER_MISMATCH" | "COHERENCE_ISSUE";
1772
+ errorType: "GRAMMAR" | "VOCABULARY" | "SPELLING" | "PUNCTUATION" | "REGISTER";
1785
1773
  explanation: string;
1786
1774
  correctForm: string;
1787
1775
  };
1788
- VocabularyEnrichment: {
1776
+ Strength: {
1777
+ phrase: string;
1778
+ /** @enum {string} */
1779
+ strengthType: "GRAMMAR" | "VOCABULARY" | "FLUENCY" | "PRAGMATICS" | "COMMUNICATION";
1780
+ explanation: string;
1781
+ };
1782
+ Suggestion: {
1789
1783
  original: string;
1790
- suggestion: string;
1784
+ /** @enum {string} */
1785
+ suggestionType: "IMPROVEMENT" | "ENRICHMENT";
1786
+ alternatives: string[];
1791
1787
  explanation: string;
1792
1788
  };
1793
1789
  SuggestConversationTopicRequest: {
@@ -1842,6 +1838,7 @@ export interface components {
1842
1838
  };
1843
1839
  ReviewedUserConversationMessage: {
1844
1840
  sabotage?: string;
1841
+ tutorComment: string;
1845
1842
  /** Format: int32 */
1846
1843
  grammar: number;
1847
1844
  /** Format: int32 */
@@ -1854,10 +1851,8 @@ export interface components {
1854
1851
  coherenceWithContext: number;
1855
1852
  registerAppropriate: boolean;
1856
1853
  mistakes: components["schemas"]["Mistake"][];
1857
- strengthsIdentified: string[];
1858
- vocabularyEnrichment: components["schemas"]["VocabularyEnrichment"][];
1859
- alternativeExpressions: components["schemas"]["AlternativeExpression"][];
1860
- culturalNote?: string;
1854
+ strengths: components["schemas"]["Strength"][];
1855
+ suggestions: components["schemas"]["Suggestion"][];
1861
1856
  };
1862
1857
  CreateAIConversationMessageRequest: {
1863
1858
  /** Format: uuid */
@@ -1869,14 +1864,11 @@ export interface components {
1869
1864
  GetLearningTipsForAIMessageRequest: {
1870
1865
  /** Format: uuid */
1871
1866
  conversationId: string;
1872
- /** Format: uuid */
1873
- messageId: string;
1874
1867
  };
1875
1868
  AIMessageLearningTips: {
1876
1869
  grammarTips: components["schemas"]["AnnotatedGrammarTip"][];
1877
1870
  vocabularyTips: components["schemas"]["AnnotatedVocabularyTip"][];
1878
1871
  idiomTips: components["schemas"]["AnnotatedIdiomTip"][];
1879
- culturalTips: components["schemas"]["AnnotatedCulturalTip"][];
1880
1872
  };
1881
1873
  /** @description Request to verify OTP code and authenticate user */
1882
1874
  OtpVerifyDto: {
@@ -2093,7 +2085,11 @@ export interface components {
2093
2085
  /** @enum {string} */
2094
2086
  ConversationMessageSender: "USER" | "AI";
2095
2087
  /** @enum {string} */
2096
- ErrorType: "GRAMMAR_TENSE" | "GRAMMAR_AGREEMENT" | "GRAMMAR_WORD_ORDER" | "VOCABULARY_WRONG_WORD" | "VOCABULARY_UNNATURAL_COLLOCATION" | "SPELLING" | "PUNCTUATION" | "MISSING_WORD" | "UNNECESSARY_WORD" | "REGISTER_MISMATCH" | "COHERENCE_ISSUE";
2088
+ ErrorType: "GRAMMAR" | "VOCABULARY" | "SPELLING" | "PUNCTUATION" | "REGISTER";
2089
+ /** @enum {string} */
2090
+ SuggestionType: "IMPROVEMENT" | "ENRICHMENT";
2091
+ /** @enum {string} */
2092
+ StrengthType: "GRAMMAR" | "VOCABULARY" | "FLUENCY" | "PRAGMATICS" | "COMMUNICATION";
2097
2093
  /** @enum {string} */
2098
2094
  ConversationTone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
2099
2095
  /** @enum {string} */
@@ -3564,12 +3560,14 @@ export interface operations {
3564
3560
  "*/*": components["schemas"]["AIMessageLearningTips"];
3565
3561
  };
3566
3562
  };
3567
- /** @description Invalid request data or message is not from AI */
3563
+ /** @description Bad Request */
3568
3564
  400: {
3569
3565
  headers: {
3570
3566
  [name: string]: unknown;
3571
3567
  };
3572
- content?: never;
3568
+ content: {
3569
+ "*/*": components["schemas"]["BadRequestResponse"];
3570
+ };
3573
3571
  };
3574
3572
  /** @description Unauthorized */
3575
3573
  401: {
@@ -3578,7 +3576,7 @@ export interface operations {
3578
3576
  };
3579
3577
  content?: never;
3580
3578
  };
3581
- /** @description Conversation or message not found */
3579
+ /** @description Conversation not found or no AI message without learning tips exists */
3582
3580
  404: {
3583
3581
  headers: {
3584
3582
  [name: string]: unknown;