studyfetch-sdk 0.1.0a3__py3-none-any.whl → 0.1.0a5__py3-none-any.whl

studyfetch_sdk/resources/v1/scenarios/component.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import Iterable
+
 import httpx
 
 from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
@@ -76,9 +78,20 @@ class ComponentResource(SyncAPIResource):
 
     def update(
         self,
-        component_id: str,
+        path_component_id: str,
         *,
-        body: str,
+        body_component_id: str,
+        name: str,
+        characters: Iterable[object] | NotGiven = NOT_GIVEN,
+        context: str | NotGiven = NOT_GIVEN,
+        description: str | NotGiven = NOT_GIVEN,
+        final_answer_prompt: str | NotGiven = NOT_GIVEN,
+        format: str | NotGiven = NOT_GIVEN,
+        goal: str | NotGiven = NOT_GIVEN,
+        greeting_character_id: str | NotGiven = NOT_GIVEN,
+        greeting_message: str | NotGiven = NOT_GIVEN,
+        requires_final_answer: bool | NotGiven = NOT_GIVEN,
+        tools: Iterable[object] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -90,6 +103,30 @@ class ComponentResource(SyncAPIResource):
         Update scenario by component ID
 
         Args:
+          body_component_id: Associated component ID
+
+          name: Scenario name
+
+          characters: Scenario characters
+
+          context: Scenario context
+
+          description: Scenario description
+
+          final_answer_prompt: Prompt for final answer
+
+          format: Interaction format
+
+          goal: Scenario goal
+
+          greeting_character_id: Character ID for greeting
+
+          greeting_message: Greeting message
+
+          requires_final_answer: Whether scenario requires a final answer
+
+          tools: Available tools
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -98,12 +135,28 @@ class ComponentResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not component_id:
-            raise ValueError(f"Expected a non-empty value for `component_id` but received {component_id!r}")
+        if not path_component_id:
+            raise ValueError(f"Expected a non-empty value for `path_component_id` but received {path_component_id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._put(
-            f"/api/v1/scenarios/component/{component_id}",
-            body=maybe_transform(body, component_update_params.ComponentUpdateParams),
+            f"/api/v1/scenarios/component/{path_component_id}",
+            body=maybe_transform(
+                {
+                    "body_component_id": body_component_id,
+                    "name": name,
+                    "characters": characters,
+                    "context": context,
+                    "description": description,
+                    "final_answer_prompt": final_answer_prompt,
+                    "format": format,
+                    "goal": goal,
+                    "greeting_character_id": greeting_character_id,
+                    "greeting_message": greeting_message,
+                    "requires_final_answer": requires_final_answer,
+                    "tools": tools,
+                },
+                component_update_params.ComponentUpdateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -201,9 +254,20 @@ class AsyncComponentResource(AsyncAPIResource):
 
     async def update(
         self,
-        component_id: str,
+        path_component_id: str,
         *,
-        body: str,
+        body_component_id: str,
+        name: str,
+        characters: Iterable[object] | NotGiven = NOT_GIVEN,
+        context: str | NotGiven = NOT_GIVEN,
+        description: str | NotGiven = NOT_GIVEN,
+        final_answer_prompt: str | NotGiven = NOT_GIVEN,
+        format: str | NotGiven = NOT_GIVEN,
+        goal: str | NotGiven = NOT_GIVEN,
+        greeting_character_id: str | NotGiven = NOT_GIVEN,
+        greeting_message: str | NotGiven = NOT_GIVEN,
+        requires_final_answer: bool | NotGiven = NOT_GIVEN,
+        tools: Iterable[object] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -215,6 +279,30 @@ class AsyncComponentResource(AsyncAPIResource):
         Update scenario by component ID
 
         Args:
+          body_component_id: Associated component ID
+
+          name: Scenario name
+
+          characters: Scenario characters
+
+          context: Scenario context
+
+          description: Scenario description
+
+          final_answer_prompt: Prompt for final answer
+
+          format: Interaction format
+
+          goal: Scenario goal
+
+          greeting_character_id: Character ID for greeting
+
+          greeting_message: Greeting message
+
+          requires_final_answer: Whether scenario requires a final answer
+
+          tools: Available tools
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -223,12 +311,28 @@ class AsyncComponentResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        if not component_id:
-            raise ValueError(f"Expected a non-empty value for `component_id` but received {component_id!r}")
+        if not path_component_id:
+            raise ValueError(f"Expected a non-empty value for `path_component_id` but received {path_component_id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._put(
-            f"/api/v1/scenarios/component/{component_id}",
-            body=await async_maybe_transform(body, component_update_params.ComponentUpdateParams),
+            f"/api/v1/scenarios/component/{path_component_id}",
+            body=await async_maybe_transform(
+                {
+                    "body_component_id": body_component_id,
+                    "name": name,
+                    "characters": characters,
+                    "context": context,
+                    "description": description,
+                    "final_answer_prompt": final_answer_prompt,
+                    "format": format,
+                    "goal": goal,
+                    "greeting_character_id": greeting_character_id,
+                    "greeting_message": greeting_message,
+                    "requires_final_answer": requires_final_answer,
+                    "tools": tools,
+                },
+                component_update_params.ComponentUpdateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

studyfetch_sdk/resources/v1/scenarios/scenarios.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import Iterable
+
 import httpx
 
 from .sessions import (
@@ -23,7 +25,7 @@ from .component import (
     AsyncComponentResourceWithStreamingResponse,
 )
 from ...._compat import cached_property
-from ....types.v1 import scenario_create_params, scenario_update_params
+from ....types.v1 import scenario_create_params, scenario_submit_params, scenario_update_params
 from ...._resource import SyncAPIResource, AsyncAPIResource
 from ...._response import (
     to_raw_response_wrapper,
@@ -79,7 +81,18 @@ class ScenariosResource(SyncAPIResource):
     def create(
         self,
         *,
-        body: str,
+        component_id: str,
+        name: str,
+        characters: Iterable[object] | NotGiven = NOT_GIVEN,
+        context: str | NotGiven = NOT_GIVEN,
+        description: str | NotGiven = NOT_GIVEN,
+        final_answer_prompt: str | NotGiven = NOT_GIVEN,
+        format: str | NotGiven = NOT_GIVEN,
+        goal: str | NotGiven = NOT_GIVEN,
+        greeting_character_id: str | NotGiven = NOT_GIVEN,
+        greeting_message: str | NotGiven = NOT_GIVEN,
+        requires_final_answer: bool | NotGiven = NOT_GIVEN,
+        tools: Iterable[object] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -91,6 +104,30 @@ class ScenariosResource(SyncAPIResource):
         Create a new scenario
 
         Args:
+          component_id: Associated component ID
+
+          name: Scenario name
+
+          characters: Scenario characters
+
+          context: Scenario context
+
+          description: Scenario description
+
+          final_answer_prompt: Prompt for final answer
+
+          format: Interaction format
+
+          goal: Scenario goal
+
+          greeting_character_id: Character ID for greeting
+
+          greeting_message: Greeting message
+
+          requires_final_answer: Whether scenario requires a final answer
+
+          tools: Available tools
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -102,7 +139,23 @@ class ScenariosResource(SyncAPIResource):
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             "/api/v1/scenarios",
-            body=maybe_transform(body, scenario_create_params.ScenarioCreateParams),
+            body=maybe_transform(
+                {
+                    "component_id": component_id,
+                    "name": name,
+                    "characters": characters,
+                    "context": context,
+                    "description": description,
+                    "final_answer_prompt": final_answer_prompt,
+                    "format": format,
+                    "goal": goal,
+                    "greeting_character_id": greeting_character_id,
+                    "greeting_message": greeting_message,
+                    "requires_final_answer": requires_final_answer,
+                    "tools": tools,
+                },
+                scenario_create_params.ScenarioCreateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -147,7 +200,18 @@ class ScenariosResource(SyncAPIResource):
         self,
         id: str,
         *,
-        body: str,
+        component_id: str,
+        name: str,
+        characters: Iterable[object] | NotGiven = NOT_GIVEN,
+        context: str | NotGiven = NOT_GIVEN,
+        description: str | NotGiven = NOT_GIVEN,
+        final_answer_prompt: str | NotGiven = NOT_GIVEN,
+        format: str | NotGiven = NOT_GIVEN,
+        goal: str | NotGiven = NOT_GIVEN,
+        greeting_character_id: str | NotGiven = NOT_GIVEN,
+        greeting_message: str | NotGiven = NOT_GIVEN,
+        requires_final_answer: bool | NotGiven = NOT_GIVEN,
+        tools: Iterable[object] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -159,6 +223,30 @@ class ScenariosResource(SyncAPIResource):
         Update scenario
 
         Args:
+          component_id: Associated component ID
+
+          name: Scenario name
+
+          characters: Scenario characters
+
+          context: Scenario context
+
+          description: Scenario description
+
+          final_answer_prompt: Prompt for final answer
+
+          format: Interaction format
+
+          goal: Scenario goal
+
+          greeting_character_id: Character ID for greeting
+
+          greeting_message: Greeting message
+
+          requires_final_answer: Whether scenario requires a final answer
+
+          tools: Available tools
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -172,7 +260,23 @@ class ScenariosResource(SyncAPIResource):
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._put(
             f"/api/v1/scenarios/{id}",
-            body=maybe_transform(body, scenario_update_params.ScenarioUpdateParams),
+            body=maybe_transform(
+                {
+                    "component_id": component_id,
+                    "name": name,
+                    "characters": characters,
+                    "context": context,
+                    "description": description,
+                    "final_answer_prompt": final_answer_prompt,
+                    "format": format,
+                    "goal": goal,
+                    "greeting_character_id": greeting_character_id,
+                    "greeting_message": greeting_message,
+                    "requires_final_answer": requires_final_answer,
+                    "tools": tools,
+                },
+                scenario_update_params.ScenarioUpdateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -269,6 +373,8 @@ class ScenariosResource(SyncAPIResource):
         self,
         id: str,
         *,
+        conversation_history: Iterable[object],
+        final_answer: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -277,7 +383,13 @@ class ScenariosResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
+        Submit scenario answer
+
         Args:
+          conversation_history: Conversation history
+
+          final_answer: Final answer for the scenario
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -291,6 +403,13 @@ class ScenariosResource(SyncAPIResource):
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
             f"/api/v1/scenarios/{id}/submit",
+            body=maybe_transform(
+                {
+                    "conversation_history": conversation_history,
+                    "final_answer": final_answer,
+                },
+                scenario_submit_params.ScenarioSubmitParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -333,7 +452,18 @@ class AsyncScenariosResource(AsyncAPIResource):
     async def create(
         self,
         *,
-        body: str,
+        component_id: str,
+        name: str,
+        characters: Iterable[object] | NotGiven = NOT_GIVEN,
+        context: str | NotGiven = NOT_GIVEN,
+        description: str | NotGiven = NOT_GIVEN,
+        final_answer_prompt: str | NotGiven = NOT_GIVEN,
+        format: str | NotGiven = NOT_GIVEN,
+        goal: str | NotGiven = NOT_GIVEN,
+        greeting_character_id: str | NotGiven = NOT_GIVEN,
+        greeting_message: str | NotGiven = NOT_GIVEN,
+        requires_final_answer: bool | NotGiven = NOT_GIVEN,
+        tools: Iterable[object] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -345,6 +475,30 @@ class AsyncScenariosResource(AsyncAPIResource):
         Create a new scenario
 
         Args:
+          component_id: Associated component ID
+
+          name: Scenario name
+
+          characters: Scenario characters
+
+          context: Scenario context
+
+          description: Scenario description
+
+          final_answer_prompt: Prompt for final answer
+
+          format: Interaction format
+
+          goal: Scenario goal
+
+          greeting_character_id: Character ID for greeting
+
+          greeting_message: Greeting message
+
+          requires_final_answer: Whether scenario requires a final answer
+
+          tools: Available tools
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -356,7 +510,23 @@ class AsyncScenariosResource(AsyncAPIResource):
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             "/api/v1/scenarios",
-            body=await async_maybe_transform(body, scenario_create_params.ScenarioCreateParams),
+            body=await async_maybe_transform(
+                {
+                    "component_id": component_id,
+                    "name": name,
+                    "characters": characters,
+                    "context": context,
+                    "description": description,
+                    "final_answer_prompt": final_answer_prompt,
+                    "format": format,
+                    "goal": goal,
+                    "greeting_character_id": greeting_character_id,
+                    "greeting_message": greeting_message,
+                    "requires_final_answer": requires_final_answer,
+                    "tools": tools,
+                },
+                scenario_create_params.ScenarioCreateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -401,7 +571,18 @@ class AsyncScenariosResource(AsyncAPIResource):
         self,
         id: str,
         *,
-        body: str,
+        component_id: str,
+        name: str,
+        characters: Iterable[object] | NotGiven = NOT_GIVEN,
+        context: str | NotGiven = NOT_GIVEN,
+        description: str | NotGiven = NOT_GIVEN,
+        final_answer_prompt: str | NotGiven = NOT_GIVEN,
+        format: str | NotGiven = NOT_GIVEN,
+        goal: str | NotGiven = NOT_GIVEN,
+        greeting_character_id: str | NotGiven = NOT_GIVEN,
+        greeting_message: str | NotGiven = NOT_GIVEN,
+        requires_final_answer: bool | NotGiven = NOT_GIVEN,
+        tools: Iterable[object] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -413,6 +594,30 @@ class AsyncScenariosResource(AsyncAPIResource):
         Update scenario
 
         Args:
+          component_id: Associated component ID
+
+          name: Scenario name
+
+          characters: Scenario characters
+
+          context: Scenario context
+
+          description: Scenario description
+
+          final_answer_prompt: Prompt for final answer
+
+          format: Interaction format
+
+          goal: Scenario goal
+
+          greeting_character_id: Character ID for greeting
+
+          greeting_message: Greeting message
+
+          requires_final_answer: Whether scenario requires a final answer
+
+          tools: Available tools
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -426,7 +631,23 @@ class AsyncScenariosResource(AsyncAPIResource):
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._put(
             f"/api/v1/scenarios/{id}",
-            body=await async_maybe_transform(body, scenario_update_params.ScenarioUpdateParams),
+            body=await async_maybe_transform(
+                {
+                    "component_id": component_id,
+                    "name": name,
+                    "characters": characters,
+                    "context": context,
+                    "description": description,
+                    "final_answer_prompt": final_answer_prompt,
+                    "format": format,
+                    "goal": goal,
+                    "greeting_character_id": greeting_character_id,
+                    "greeting_message": greeting_message,
+                    "requires_final_answer": requires_final_answer,
+                    "tools": tools,
+                },
+                scenario_update_params.ScenarioUpdateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -523,6 +744,8 @@ class AsyncScenariosResource(AsyncAPIResource):
         self,
         id: str,
         *,
+        conversation_history: Iterable[object],
+        final_answer: str | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -531,7 +754,13 @@ class AsyncScenariosResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
         """
+        Submit scenario answer
+
         Args:
+          conversation_history: Conversation history
+
+          final_answer: Final answer for the scenario
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -545,6 +774,13 @@ class AsyncScenariosResource(AsyncAPIResource):
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
             f"/api/v1/scenarios/{id}/submit",
+            body=await async_maybe_transform(
+                {
+                    "conversation_history": conversation_history,
+                    "final_answer": final_answer,
+                },
+                scenario_submit_params.ScenarioSubmitParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

studyfetch_sdk/types/v1/__init__.py

@@ -18,11 +18,13 @@ 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 .scenario_create_params import ScenarioCreateParams as ScenarioCreateParams
+from .scenario_submit_params import ScenarioSubmitParams as ScenarioSubmitParams
 from .scenario_update_params import ScenarioUpdateParams as ScenarioUpdateParams
 from .usage_get_stats_params import UsageGetStatsParams as UsageGetStatsParams
 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 .chat_send_message_params import ChatSendMessageParams as ChatSendMessageParams
 from .component_embed_response import ComponentEmbedResponse as ComponentEmbedResponse
 from .flashcard_get_all_params import FlashcardGetAllParams as FlashcardGetAllParams

studyfetch_sdk/types/v1/chat_send_message_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable
+from typing import List, Iterable
 from typing_extensions import Required, Annotated, TypedDict
 
 from ..._utils import PropertyInfo
@@ -22,8 +22,8 @@ class ChatSendMessageParams(TypedDict, total=False):
     context: object
     """Additional context data"""
 
-    group_id: Annotated[str, PropertyInfo(alias="groupId")]
-    """Group ID for collaboration"""
+    group_ids: Annotated[List[str], PropertyInfo(alias="groupIds")]
+    """Group IDs for collaboration"""
 
     session_id: Annotated[str, PropertyInfo(alias="sessionId")]
     """Session ID for conversation continuity"""