studyfetch-sdk 0.1.0a18__py3-none-any.whl → 0.1.0a20__py3-none-any.whl

studyfetch_sdk/types/v1/__init__.py

@@ -4,52 +4,34 @@ from __future__ import annotations
 
 from .material import Material as Material
 from .component import Component as Component
-from .chat_stream_params import ChatStreamParams as ChatStreamParams
+from .content_param import ContentParam as ContentParam
 from .folder_list_params import FolderListParams as FolderListParams
-from .test_create_params import TestCreateParams as TestCreateParams
-from .test_retake_params import TestRetakeParams as TestRetakeParams
-from .test_submit_params import TestSubmitParams as TestSubmitParams
 from .embed_verify_params import EmbedVerifyParams as EmbedVerifyParams
 from .folder_create_params import FolderCreateParams as FolderCreateParams
 from .folder_update_params import FolderUpdateParams as FolderUpdateParams
 from .material_list_params import MaterialListParams as MaterialListParams
 from .material_move_params import MaterialMoveParams as MaterialMoveParams
 from .component_list_params import ComponentListParams as ComponentListParams
-from .flashcard_rate_params import FlashcardRateParams as FlashcardRateParams
 from .embed_get_theme_params import EmbedGetThemeParams as EmbedGetThemeParams
 from .material_create_params import MaterialCreateParams as MaterialCreateParams
 from .material_list_response import MaterialListResponse as MaterialListResponse
 from .material_rename_params import MaterialRenameParams as MaterialRenameParams
 from .material_search_params import MaterialSearchParams as MaterialSearchParams
-from .scenario_create_params import ScenarioCreateParams as ScenarioCreateParams
-from .scenario_update_params import ScenarioUpdateParams as ScenarioUpdateParams
 from .usage_get_stats_params import UsageGetStatsParams as UsageGetStatsParams
-from .chat_get_session_params import ChatGetSessionParams as ChatGetSessionParams
 from .component_create_params import ComponentCreateParams as ComponentCreateParams
 from .component_list_response import ComponentListResponse as ComponentListResponse
 from .component_update_params import ComponentUpdateParams as ComponentUpdateParams
-from .explainer_create_params import ExplainerCreateParams as ExplainerCreateParams
 from .material_debug_response import MaterialDebugResponse as MaterialDebugResponse
-from .chat_send_message_params import ChatSendMessageParams as ChatSendMessageParams
-from .flashcard_get_all_params import FlashcardGetAllParams as FlashcardGetAllParams
-from .flashcard_get_due_params import FlashcardGetDueParams as FlashcardGetDueParams
 from .material_search_response import MaterialSearchResponse as MaterialSearchResponse
 from .usage_get_summary_params import UsageGetSummaryParams as UsageGetSummaryParams
 from .usage_list_events_params import UsageListEventsParams as UsageListEventsParams
-from .test_submit_answer_params import TestSubmitAnswerParams as TestSubmitAnswerParams
 from .assignment_grader_response import AssignmentGraderResponse as AssignmentGraderResponse
-from .flashcard_get_stats_params import FlashcardGetStatsParams as FlashcardGetStatsParams
-from .flashcard_get_types_response import FlashcardGetTypesResponse as FlashcardGetTypesResponse
 from .material_batch_create_params import MaterialBatchCreateParams as MaterialBatchCreateParams
-from .scenario_submit_answer_params import ScenarioSubmitAnswerParams as ScenarioSubmitAnswerParams
-from .flashcard_batch_process_params import FlashcardBatchProcessParams as FlashcardBatchProcessParams
 from .material_batch_create_response import MaterialBatchCreateResponse as MaterialBatchCreateResponse
 from .assignment_grader_create_params import AssignmentGraderCreateParams as AssignmentGraderCreateParams
 from .component_generate_embed_params import ComponentGenerateEmbedParams as ComponentGenerateEmbedParams
-from .explainer_handle_webhook_params import ExplainerHandleWebhookParams as ExplainerHandleWebhookParams
-from .flashcard_batch_process_response import FlashcardBatchProcessResponse as FlashcardBatchProcessResponse
-from .flashcard_get_algorithm_response import FlashcardGetAlgorithmResponse as FlashcardGetAlgorithmResponse
 from .material_get_download_url_params import MaterialGetDownloadURLParams as MaterialGetDownloadURLParams
 from .component_generate_embed_response import ComponentGenerateEmbedResponse as ComponentGenerateEmbedResponse
 from .assignment_grader_get_all_response import AssignmentGraderGetAllResponse as AssignmentGraderGetAllResponse
+from .material_create_and_process_params import MaterialCreateAndProcessParams as MaterialCreateAndProcessParams
 from .material_get_download_url_response import MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse

studyfetch_sdk/types/v1/assignment_grader_response.py

@@ -1,5 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from typing import Optional
 from datetime import datetime
 
 from pydantic import Field as FieldInfo
@@ -10,7 +11,10 @@ __all__ = ["AssignmentGraderResponse"]
 
 
 class AssignmentGraderResponse(BaseModel):
-    id: str
+    api_v: float = FieldInfo(alias="__v")
+    """Version key"""
+
+    api_id: str = FieldInfo(alias="_id")
     """Assignment grader ID"""
 
     created_at: datetime = FieldInfo(alias="createdAt")
@@ -19,8 +23,23 @@ class AssignmentGraderResponse(BaseModel):
     grade: float
     """Overall grade percentage"""
 
+    organization_id: str = FieldInfo(alias="organizationId")
+    """Organization ID"""
+
     rubric: object
     """Grading results"""
 
     title: str
     """Assignment title"""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Update timestamp"""
+
+    material_id: Optional[str] = FieldInfo(alias="materialId", default=None)
+    """Material ID"""
+
+    text_to_grade: Optional[str] = FieldInfo(alias="textToGrade", default=None)
+    """Text that was graded"""
+
+    user_id: Optional[str] = FieldInfo(alias="userId", default=None)
+    """User ID"""

studyfetch_sdk/types/v1/component.py

@@ -34,7 +34,15 @@ class Component(BaseModel):
     """Component status"""
 
     type: Literal[
-        "chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"
+        "chat",
+        "data_analyst",
+        "flashcards",
+        "scenarios",
+        "practice_test",
+        "audio_recap",
+        "tutor_me",
+        "explainers",
+        "uploads",
     ]
     """Component type"""
 

studyfetch_sdk/types/v1/component_create_params.py

@@ -11,6 +11,8 @@ __all__ = [
     "ComponentCreateParams",
     "Config",
     "ConfigChatConfigDto",
+    "ConfigChatConfigDtoGuardrailRule",
+    "ConfigDataAnalystConfigDto",
     "ConfigFlashcardsConfigDto",
     "ConfigScenariosConfigDto",
     "ConfigScenariosConfigDtoCharacter",
@@ -32,7 +34,17 @@ class ComponentCreateParams(TypedDict, total=False):
     """Name of the component"""
 
     type: Required[
-        Literal["chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"]
+        Literal[
+            "chat",
+            "data_analyst",
+            "flashcards",
+            "scenarios",
+            "practice_test",
+            "audio_recap",
+            "tutor_me",
+            "explainers",
+            "uploads",
+        ]
     ]
     """Type of component to create"""
 
@@ -43,6 +55,23 @@ class ComponentCreateParams(TypedDict, total=False):
     """Additional metadata"""
 
 
+class ConfigChatConfigDtoGuardrailRule(TypedDict, total=False):
+    id: Required[str]
+    """Unique identifier for the rule"""
+
+    action: Required[Literal["block", "warn", "modify"]]
+    """Action to take when rule is triggered"""
+
+    condition: Required[str]
+    """Condition to check"""
+
+    description: Required[str]
+    """Description of the rule"""
+
+    message: str
+    """Message to show when rule is triggered"""
+
+
 class ConfigChatConfigDto(TypedDict, total=False):
     model: Required[str]
     """AI model to use"""
@@ -53,6 +82,9 @@ class ConfigChatConfigDto(TypedDict, total=False):
     enable_follow_ups: Annotated[bool, PropertyInfo(alias="enableFollowUps")]
     """Enable follow-up questions"""
 
+    enable_guardrails: Annotated[bool, PropertyInfo(alias="enableGuardrails")]
+    """Enable guardrails for content moderation"""
+
     enable_history: Annotated[bool, PropertyInfo(alias="enableHistory")]
     """Enable conversation history"""
 
@@ -68,6 +100,9 @@ class ConfigChatConfigDto(TypedDict, total=False):
     folders: List[str]
     """Folder IDs"""
 
+    guardrail_rules: Annotated[Iterable[ConfigChatConfigDtoGuardrailRule], PropertyInfo(alias="guardrailRules")]
+    """Guardrail rules for content moderation"""
+
     materials: List[str]
     """Material IDs"""
 
@@ -84,6 +119,50 @@ class ConfigChatConfigDto(TypedDict, total=False):
     """Temperature for response generation"""
 
 
+class ConfigDataAnalystConfigDto(TypedDict, total=False):
+    model: Required[str]
+    """AI model to use"""
+
+    enable_component_creation: Annotated[bool, PropertyInfo(alias="enableComponentCreation")]
+    """Enable component creation"""
+
+    enable_follow_ups: Annotated[bool, PropertyInfo(alias="enableFollowUps")]
+    """Enable follow-up questions"""
+
+    enable_history: Annotated[bool, PropertyInfo(alias="enableHistory")]
+    """Enable conversation history"""
+
+    enable_rag_search: Annotated[bool, PropertyInfo(alias="enableRAGSearch")]
+    """Enable RAG search"""
+
+    enable_voice: Annotated[bool, PropertyInfo(alias="enableVoice")]
+    """Enable voice interactions"""
+
+    enable_web_search: Annotated[bool, PropertyInfo(alias="enableWebSearch")]
+    """Enable web search"""
+
+    folders: List[str]
+    """Folder IDs"""
+
+    group_ids: Annotated[List[str], PropertyInfo(alias="groupIds")]
+    """Group IDs to filter data"""
+
+    materials: List[str]
+    """Material IDs"""
+
+    max_steps: Annotated[float, PropertyInfo(alias="maxSteps")]
+    """Maximum steps for multi-step tool calls"""
+
+    max_tokens: Annotated[float, PropertyInfo(alias="maxTokens")]
+    """Maximum tokens for response"""
+
+    system_prompt: Annotated[str, PropertyInfo(alias="systemPrompt")]
+    """System prompt for the data analyst"""
+
+    temperature: float
+    """Temperature for response generation"""
+
+
 class ConfigFlashcardsConfigDto(TypedDict, total=False):
     card_types: Annotated[List[str], PropertyInfo(alias="cardTypes")]
     """Types of flashcards"""
@@ -359,6 +438,7 @@ class ConfigTutorMeConfigDto(TypedDict, total=False):
 
 Config: TypeAlias = Union[
     ConfigChatConfigDto,
+    ConfigDataAnalystConfigDto,
     ConfigFlashcardsConfigDto,
     ConfigScenariosConfigDto,
     ConfigPracticeTestConfigDto,

studyfetch_sdk/types/v1/component_generate_embed_params.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from typing import List
-from typing_extensions import Annotated, TypedDict
+from typing_extensions import Required, Annotated, TypedDict
 
 from ..._utils import PropertyInfo
 
@@ -37,12 +37,18 @@ class ComponentGenerateEmbedParams(TypedDict, total=False):
 
 
 class Features(TypedDict, total=False):
+    enable_bad_words_filter: Required[Annotated[bool, PropertyInfo(alias="enableBadWordsFilter")]]
+    """Enable bad words filter"""
+
     enable_component_creation: Annotated[bool, PropertyInfo(alias="enableComponentCreation")]
     """Enable component creation"""
 
     enable_follow_ups: Annotated[bool, PropertyInfo(alias="enableFollowUps")]
     """Enable follow-up questions"""
 
+    enable_guardrails: Annotated[bool, PropertyInfo(alias="enableGuardrails")]
+    """Enable guardrails"""
+
     enable_history: Annotated[bool, PropertyInfo(alias="enableHistory")]
     """Enable history"""
 

studyfetch_sdk/types/v1/component_list_params.py

@@ -9,6 +9,14 @@ __all__ = ["ComponentListParams"]
 
 class ComponentListParams(TypedDict, total=False):
     type: Literal[
-        "chat", "flashcards", "scenarios", "practice_test", "audio_recap", "tutor_me", "explainers", "uploads"
+        "chat",
+        "data_analyst",
+        "flashcards",
+        "scenarios",
+        "practice_test",
+        "audio_recap",
+        "tutor_me",
+        "explainers",
+        "uploads",
     ]
     """Filter by component type"""

studyfetch_sdk/types/v1/content_param.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ContentParam"]
+
+
+class ContentParam(TypedDict, total=False):
+    type: Required[Literal["text", "pdf", "video", "audio", "url"]]
+    """Type of content"""
+
+    source_url: Annotated[str, PropertyInfo(alias="sourceUrl")]
+    """URL to fetch content from"""
+
+    text: str
+    """Text content (for text type)"""
+
+    url: str
+    """URL to the content (for url type)"""

studyfetch_sdk/types/v1/material_create_and_process_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+from .content_param import ContentParam
+
+__all__ = ["MaterialCreateAndProcessParams"]
+
+
+class MaterialCreateAndProcessParams(TypedDict, total=False):
+    content: Required[ContentParam]
+    """Content details"""
+
+    name: Required[str]
+    """Name of the material"""
+
+    folder_id: Annotated[str, PropertyInfo(alias="folderId")]
+    """Folder ID to place the material in"""
+
+    poll_interval_ms: Annotated[float, PropertyInfo(alias="pollIntervalMs")]
+    """Polling interval in milliseconds (default: 2 seconds)"""
+
+    timeout_ms: Annotated[float, PropertyInfo(alias="timeoutMs")]
+    """Maximum time to wait for processing in milliseconds (default: 5 minutes)"""

studyfetch_sdk/types/v1/material_create_params.py

@@ -2,15 +2,16 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Required, Annotated, TypedDict
 
 from ..._utils import PropertyInfo
+from .content_param import ContentParam
 
-__all__ = ["MaterialCreateParams", "Content"]
+__all__ = ["MaterialCreateParams"]
 
 
 class MaterialCreateParams(TypedDict, total=False):
-    content: Required[Content]
+    content: Required[ContentParam]
     """Content details"""
 
     name: Required[str]
@@ -18,17 +19,3 @@ class MaterialCreateParams(TypedDict, total=False):
 
     folder_id: Annotated[str, PropertyInfo(alias="folderId")]
     """Folder ID to place the material in"""
-
-
-class Content(TypedDict, total=False):
-    type: Required[Literal["text", "pdf", "video", "audio", "url"]]
-    """Type of content"""
-
-    source_url: Annotated[str, PropertyInfo(alias="sourceUrl")]
-    """URL to fetch content from"""
-
-    text: str
-    """Text content (for text type)"""
-
-    url: str
-    """URL to the content (for url type)"""

studyfetch_sdk/types/v1/materials/__init__.py

@@ -13,3 +13,5 @@ from .upload_complete_upload_params import UploadCompleteUploadParams as UploadC
 from .upload_upload_from_url_params import UploadUploadFromURLParams as UploadUploadFromURLParams
 from .upload_create_presigned_url_params import UploadCreatePresignedURLParams as UploadCreatePresignedURLParams
 from .upload_create_presigned_url_response import UploadCreatePresignedURLResponse as UploadCreatePresignedURLResponse
+from .upload_upload_url_and_process_params import UploadUploadURLAndProcessParams as UploadUploadURLAndProcessParams
+from .upload_upload_file_and_process_params import UploadUploadFileAndProcessParams as UploadUploadFileAndProcessParams

studyfetch_sdk/types/v1/materials/upload_create_presigned_url_params.py

@@ -19,5 +19,8 @@ class UploadCreatePresignedURLParams(TypedDict, total=False):
     name: Required[str]
     """Display name for the material"""
 
+    extract_images: Annotated[bool, PropertyInfo(alias="extractImages")]
+    """Whether to extract images from files"""
+
     folder_id: Annotated[str, PropertyInfo(alias="folderId")]
     """Folder ID to place the material in"""

studyfetch_sdk/types/v1/materials/upload_upload_file_and_process_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ...._types import FileTypes
+from ...._utils import PropertyInfo
+
+__all__ = ["UploadUploadFileAndProcessParams"]
+
+
+class UploadUploadFileAndProcessParams(TypedDict, total=False):
+    file: Required[FileTypes]
+
+    name: Required[str]
+    """Material name"""
+
+    extract_images: Annotated[str, PropertyInfo(alias="extractImages")]
+    """Whether to extract images from files (true/false, default: true)"""
+
+    folder_id: Annotated[str, PropertyInfo(alias="folderId")]
+    """Folder ID (optional)"""
+
+    poll_interval_ms: Annotated[float, PropertyInfo(alias="pollIntervalMs")]
+    """Polling interval in milliseconds (default: 2000)"""
+
+    timeout_ms: Annotated[float, PropertyInfo(alias="timeoutMs")]
+    """Processing timeout in milliseconds (default: 300000)"""

studyfetch_sdk/types/v1/materials/upload_upload_file_params.py

@@ -16,5 +16,8 @@ class UploadUploadFileParams(TypedDict, total=False):
     name: Required[str]
     """Material name"""
 
+    extract_images: Annotated[str, PropertyInfo(alias="extractImages")]
+    """Whether to extract images from files (true/false, default: true)"""
+
     folder_id: Annotated[str, PropertyInfo(alias="folderId")]
     """Folder ID (optional)"""

studyfetch_sdk/types/v1/materials/upload_upload_url_and_process_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["UploadUploadURLAndProcessParams"]
+
+
+class UploadUploadURLAndProcessParams(TypedDict, total=False):
+    name: Required[str]
+    """Material name"""
+
+    url: Required[str]
+    """URL to fetch content from"""
+
+    folder_id: Annotated[str, PropertyInfo(alias="folderId")]
+    """Folder ID (optional)"""
+
+    poll_interval_ms: Annotated[float, PropertyInfo(alias="pollIntervalMs")]
+    """Polling interval in milliseconds (default: 2 seconds)"""
+
+    timeout_ms: Annotated[float, PropertyInfo(alias="timeoutMs")]
+    """Maximum time to wait for processing in milliseconds (default: 5 minutes)"""

studyfetch_sdk/types/v1/usage/__init__.py

@@ -3,3 +3,6 @@
 from __future__ import annotations
 
 from .analyst_list_events_params import AnalystListEventsParams as AnalystListEventsParams
+from .analyst_get_test_questions_params import AnalystGetTestQuestionsParams as AnalystGetTestQuestionsParams
+from .analyst_list_chat_messages_params import AnalystListChatMessagesParams as AnalystListChatMessagesParams
+from .analyst_list_chat_messages_response import AnalystListChatMessagesResponse as AnalystListChatMessagesResponse

studyfetch_sdk/types/v1/usage/analyst_get_test_questions_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["AnalystGetTestQuestionsParams"]
+
+
+class AnalystGetTestQuestionsParams(TypedDict, total=False):
+    group_ids: Annotated[List[str], PropertyInfo(alias="groupIds")]
+    """Array of group IDs to filter"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID to get test results for"""

studyfetch_sdk/types/v1/usage/analyst_list_chat_messages_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["AnalystListChatMessagesParams"]
+
+
+class AnalystListChatMessagesParams(TypedDict, total=False):
+    group_ids: Annotated[List[str], PropertyInfo(alias="groupIds")]
+    """Array of group IDs to filter"""
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """User ID to get chat messages for"""

studyfetch_sdk/types/v1/usage/analyst_list_chat_messages_response.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ...._models import BaseModel
+
+__all__ = ["AnalystListChatMessagesResponse", "Message"]
+
+
+class Message(BaseModel):
+    component_id: Optional[str] = FieldInfo(alias="componentId", default=None)
+
+    content: Optional[str] = None
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+
+    metadata: Optional[object] = None
+
+    role: Optional[Literal["user", "assistant", "system"]] = None
+
+    session_id: Optional[str] = FieldInfo(alias="sessionId", default=None)
+
+    user_id: Optional[str] = FieldInfo(alias="userId", default=None)
+
+
+class AnalystListChatMessagesResponse(BaseModel):
+    messages: Optional[List[Message]] = None
+
+    session_count: Optional[float] = FieldInfo(alias="sessionCount", default=None)
+
+    total: Optional[float] = None

studyfetch_sdk/types/v1/usage/analyst_list_events_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import List
 from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from ...._utils import PropertyInfo
@@ -47,3 +48,9 @@ class AnalystListEventsParams(TypedDict, total=False):
 
     start_date: Required[Annotated[str, PropertyInfo(alias="startDate")]]
     """Start date for filtering (ISO 8601)"""
+
+    group_ids: Annotated[List[str], PropertyInfo(alias="groupIds")]
+    """Array of group IDs to filter"""
+
+    user_ids: Annotated[List[str], PropertyInfo(alias="userIds")]
+    """Array of user IDs to filter"""

{studyfetch_sdk-0.1.0a18.dist-info → studyfetch_sdk-0.1.0a20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: studyfetch_sdk
-Version: 0.1.0a18
+Version: 0.1.0a20
 Summary: The official Python library for the studyfetch-sdk API
 Project-URL: Homepage, https://github.com/GoStudyFetchGo/studyfetch-sdk-python
 Project-URL: Repository, https://github.com/GoStudyFetchGo/studyfetch-sdk-python