@studyfetch/sdk 1.9.0 → 1.11.0

package/src/resources/v1/components.ts

@@ -13,7 +13,7 @@ export class Components extends APIResource {
    * @example
    * ```ts
    * const component = await client.v1.components.create({
-   *   config: {},
+   *   config: { model: 'gpt-4o-mini-2024-07-18' },
    *   name: 'My Study Component',
    *   origin: 'chat',
    *   type: 'chat',
@@ -177,7 +177,15 @@ export interface ComponentCreateResponse {
   /**
    * Component type
    */
-  type: 'chat' | 'flashcards' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+  type:
+    | 'chat'
+    | 'flashcards'
+    | 'scenarios'
+    | 'practice_test'
+    | 'audio_recap'
+    | 'tutor_me'
+    | 'explainers'
+    | 'uploads';
 
   /**
    * Last update timestamp
@@ -234,7 +242,15 @@ export interface ComponentRetrieveResponse {
   /**
    * Component type
    */
-  type: 'chat' | 'flashcards' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+  type:
+    | 'chat'
+    | 'flashcards'
+    | 'scenarios'
+    | 'practice_test'
+    | 'audio_recap'
+    | 'tutor_me'
+    | 'explainers'
+    | 'uploads';
 
   /**
    * Last update timestamp
@@ -291,7 +307,15 @@ export interface ComponentUpdateResponse {
   /**
    * Component type
    */
-  type: 'chat' | 'flashcards' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+  type:
+    | 'chat'
+    | 'flashcards'
+    | 'scenarios'
+    | 'practice_test'
+    | 'audio_recap'
+    | 'tutor_me'
+    | 'explainers'
+    | 'uploads';
 
   /**
    * Last update timestamp
@@ -351,7 +375,15 @@ export namespace ComponentListResponse {
     /**
      * Component type
      */
-    type: 'chat' | 'flashcards' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+    type:
+      | 'chat'
+      | 'flashcards'
+      | 'scenarios'
+      | 'practice_test'
+      | 'audio_recap'
+      | 'tutor_me'
+      | 'explainers'
+      | 'uploads';
 
     /**
      * Last update timestamp
@@ -423,7 +455,15 @@ export interface ComponentCreateParams {
   /**
    * Component-specific configuration
    */
-  config: unknown;
+  config:
+    | ComponentCreateParams.ChatConfigDto
+    | ComponentCreateParams.FlashcardsConfigDto
+    | ComponentCreateParams.ScenariosConfigDto
+    | ComponentCreateParams.PracticeTestConfigDto
+    | ComponentCreateParams.AudioRecapConfigDto
+    | ComponentCreateParams.ExplainersConfigDto
+    | ComponentCreateParams.UploadsConfigDto
+    | ComponentCreateParams.TutorMeConfigDto;
 
   /**
    * Name of the component
@@ -459,6 +499,522 @@ export interface ComponentCreateParams {
   metadata?: unknown;
 }
 
+export namespace ComponentCreateParams {
+  export interface ChatConfigDto {
+    /**
+     * AI model to use
+     */
+    model: string;
+
+    /**
+     * Enable component creation
+     */
+    enableComponentCreation?: boolean;
+
+    /**
+     * Enable follow-up questions
+     */
+    enableFollowUps?: boolean;
+
+    /**
+     * Enable conversation history
+     */
+    enableHistory?: boolean;
+
+    /**
+     * Enable RAG search
+     */
+    enableRAGSearch?: boolean;
+
+    /**
+     * Enable voice interactions
+     */
+    enableVoice?: boolean;
+
+    /**
+     * Enable web search
+     */
+    enableWebSearch?: boolean;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Maximum steps for multi-step tool calls
+     */
+    maxSteps?: number;
+
+    /**
+     * Maximum tokens for response
+     */
+    maxTokens?: number;
+
+    /**
+     * System prompt for the chat
+     */
+    systemPrompt?: string;
+
+    /**
+     * Temperature for response generation
+     */
+    temperature?: number;
+  }
+
+  export interface FlashcardsConfigDto {
+    /**
+     * Types of flashcards
+     */
+    cardTypes?: Array<string>;
+
+    /**
+     * Difficulty level
+     */
+    difficulty?: 'easy' | 'medium' | 'hard' | 'mixed';
+
+    /**
+     * Enable spaced repetition
+     */
+    enableSpacedRepetition?: boolean;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Learning steps configuration
+     */
+    learningSteps?: string;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Maximum review interval in days
+     */
+    maxReviewInterval?: number;
+
+    /**
+     * AI model to use for flashcard generation
+     */
+    model?: string;
+
+    /**
+     * Total number of flashcards to generate
+     */
+    totalFlashcards?: number;
+
+    /**
+     * View mode for flashcards
+     */
+    viewMode?: 'spaced_repetition' | 'normal';
+  }
+
+  export interface ScenariosConfigDto {
+    /**
+     * Scenario characters
+     */
+    characters?: Array<ScenariosConfigDto.Character>;
+
+    /**
+     * Scenario context
+     */
+    context?: string;
+
+    /**
+     * Enable history
+     */
+    enableHistory?: boolean;
+
+    /**
+     * Enable voice
+     */
+    enableVoice?: boolean;
+
+    /**
+     * Final answer prompt
+     */
+    finalAnswerPrompt?: string;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Scenario format
+     */
+    format?: string;
+
+    /**
+     * Scenario goal
+     */
+    goal?: string;
+
+    /**
+     * Character ID for greeting
+     */
+    greetingCharacterId?: string;
+
+    /**
+     * Greeting message
+     */
+    greetingMessage?: string;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * AI model to use for scenario generation
+     */
+    model?: string;
+
+    /**
+     * Placeholder text
+     */
+    placeholderText?: string;
+
+    /**
+     * Requires final answer
+     */
+    requiresFinalAnswer?: boolean;
+
+    /**
+     * Available tools
+     */
+    tools?: Array<ScenariosConfigDto.Tool>;
+  }
+
+  export namespace ScenariosConfigDto {
+    export interface Character {
+      /**
+       * Character ID
+       */
+      id: string;
+
+      /**
+       * Character name
+       */
+      name: string;
+
+      /**
+       * Character role
+       */
+      role: string;
+
+      /**
+       * Character description
+       */
+      description?: string;
+    }
+
+    export interface Tool {
+      /**
+       * Tool ID
+       */
+      id: string;
+
+      /**
+       * Tool name
+       */
+      name: string;
+
+      /**
+       * Data format provided by the tool
+       */
+      dataFormat?: string;
+
+      /**
+       * Tool description
+       */
+      description?: string;
+
+      /**
+       * Tool type
+       */
+      type?: string;
+    }
+  }
+
+  export interface PracticeTestConfigDto {
+    /**
+     * Question types
+     */
+    questionTypes: Array<string>;
+
+    /**
+     * AI generation mode
+     */
+    aiGenerationMode?: 'balanced' | 'comprehensive' | 'focused' | 'adaptive';
+
+    /**
+     * Allow retakes
+     */
+    allowRetakes?: boolean;
+
+    /**
+     * Difficulty level
+     */
+    difficulty?: 'easy' | 'medium' | 'hard' | 'mixed';
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Maximum attempts allowed
+     */
+    maxAttempts?: number;
+
+    /**
+     * AI model to use for question generation and grading
+     */
+    model?: string;
+
+    /**
+     * Passing score percentage
+     */
+    passingScore?: number;
+
+    /**
+     * Distribution of question types
+     */
+    questionDistribution?: PracticeTestConfigDto.QuestionDistribution;
+
+    /**
+     * Number of questions per test
+     */
+    questionsPerTest?: number;
+
+    /**
+     * Randomize answer order
+     */
+    randomizeAnswers?: boolean;
+
+    /**
+     * Randomize question order
+     */
+    randomizeQuestions?: boolean;
+
+    /**
+     * Show correct answers after submission
+     */
+    showCorrectAnswers?: boolean;
+
+    /**
+     * Show explanations for answers
+     */
+    showExplanations?: boolean;
+
+    /**
+     * Time limit in minutes
+     */
+    timeLimit?: number;
+  }
+
+  export namespace PracticeTestConfigDto {
+    /**
+     * Distribution of question types
+     */
+    export interface QuestionDistribution {
+      /**
+       * Number of fill in the blank questions
+       */
+      fillinblank?: number;
+
+      /**
+       * Number of free response questions
+       */
+      frq?: number;
+
+      /**
+       * Number of multiple choice questions
+       */
+      multiplechoice?: number;
+
+      /**
+       * Number of short answer questions
+       */
+      shortanswer?: number;
+
+      /**
+       * Number of true/false questions
+       */
+      truefalse?: number;
+    }
+  }
+
+  export interface AudioRecapConfigDto {
+    /**
+     * Duration of audio recap in minutes
+     */
+    duration?: number;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Enable multi-voice conversation mode
+     */
+    isMultiVoice?: boolean;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * AI model to use for generation
+     */
+    model?: string;
+
+    /**
+     * Number of parts to split the audio into
+     */
+    numParts?: number;
+
+    /**
+     * Type of audio recap
+     */
+    recapType?: 'SUMMARY' | 'LECTURE' | 'PODCAST' | 'AUDIO_BOOK';
+
+    /**
+     * Theme or style for the audio recap
+     */
+    theme?: string;
+
+    /**
+     * Specific topic to focus on
+     */
+    topic?: string;
+
+    /**
+     * Primary voice for narration
+     */
+    voice1?: string;
+
+    /**
+     * Secondary voice for multi-voice mode
+     */
+    voice2?: string;
+  }
+
+  export interface ExplainersConfigDto {
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Enable image search for visuals
+     */
+    imageSearch?: boolean;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * AI model to use for generation
+     */
+    model?: string;
+
+    /**
+     * Video style
+     */
+    style?: string;
+
+    /**
+     * Target length in seconds
+     */
+    targetLength?: number;
+
+    /**
+     * Video title (defaults to component name if not provided)
+     */
+    title?: string;
+
+    /**
+     * Create vertical video format (9:16)
+     */
+    verticalVideo?: boolean;
+
+    /**
+     * Enable web search for additional content
+     */
+    webSearch?: boolean;
+  }
+
+  export interface UploadsConfigDto {
+    /**
+     * Folder ID where uploads will be stored
+     */
+    folderId: string;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+  }
+
+  export interface TutorMeConfigDto {
+    /**
+     * Enable video
+     */
+    enableVideo?: boolean;
+
+    /**
+     * Enable voice
+     */
+    enableVoice?: boolean;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Session duration in minutes
+     */
+    sessionDuration?: number;
+
+    /**
+     * Tutor personality
+     */
+    tutorPersonality?: string;
+  }
+}
+
 export interface ComponentUpdateParams {
   /**
    * Component status