studyfetch-sdk 0.1.0a4__py3-none-any.whl → 0.1.0a6__py3-none-any.whl

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_update_params, scenario_submit_answer_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
             ),
@@ -265,10 +369,12 @@ class ScenariosResource(SyncAPIResource):
             cast_to=NoneType,
         )
 
-    def submit(
+    def submit_answer(
         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_answer_params.ScenarioSubmitAnswerParams,
+            ),
             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
             ),
@@ -519,10 +740,12 @@ class AsyncScenariosResource(AsyncAPIResource):
             cast_to=NoneType,
         )
 
-    async def submit(
+    async def submit_answer(
         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_answer_params.ScenarioSubmitAnswerParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -574,8 +810,8 @@ class ScenariosResourceWithRawResponse:
         self.get_stats = to_raw_response_wrapper(
             scenarios.get_stats,
         )
-        self.submit = to_raw_response_wrapper(
-            scenarios.submit,
+        self.submit_answer = to_raw_response_wrapper(
+            scenarios.submit_answer,
         )
 
     @cached_property
@@ -613,8 +849,8 @@ class AsyncScenariosResourceWithRawResponse:
         self.get_stats = async_to_raw_response_wrapper(
             scenarios.get_stats,
         )
-        self.submit = async_to_raw_response_wrapper(
-            scenarios.submit,
+        self.submit_answer = async_to_raw_response_wrapper(
+            scenarios.submit_answer,
         )
 
     @cached_property
@@ -652,8 +888,8 @@ class ScenariosResourceWithStreamingResponse:
         self.get_stats = to_streamed_response_wrapper(
             scenarios.get_stats,
         )
-        self.submit = to_streamed_response_wrapper(
-            scenarios.submit,
+        self.submit_answer = to_streamed_response_wrapper(
+            scenarios.submit_answer,
         )
 
     @cached_property
@@ -691,8 +927,8 @@ class AsyncScenariosResourceWithStreamingResponse:
         self.get_stats = async_to_streamed_response_wrapper(
             scenarios.get_stats,
         )
-        self.submit = async_to_streamed_response_wrapper(
-            scenarios.submit,
+        self.submit_answer = async_to_streamed_response_wrapper(
+            scenarios.submit_answer,
         )
 
     @cached_property

studyfetch_sdk/resources/v1/scenarios/submissions/user.py

@@ -38,9 +38,8 @@ class UserResource(SyncAPIResource):
         """
         return UserResourceWithStreamingResponse(self)
 
-    def retrieve(
+    def get_all(
         self,
-        id: str,
         *,
         # 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.
@@ -49,29 +48,18 @@ class UserResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
-        """
-        Args:
-          extra_headers: Send extra headers
-
-          extra_query: Add additional query parameters to the request
-
-          extra_body: Add additional JSON properties to the request
-
-          timeout: Override the client-level default timeout for this request, in seconds
-        """
-        if not id:
-            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._get(
-            f"/api/v1/scenarios/{id}/submissions/user",
+            "/api/v1/scenarios/submissions/user",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
             cast_to=NoneType,
         )
 
-    def list(
+    def get_by_scenario(
         self,
+        id: str,
         *,
         # 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.
@@ -80,9 +68,21 @@ class UserResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
+        """
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._get(
-            "/api/v1/scenarios/submissions/user",
+            f"/api/v1/scenarios/{id}/submissions/user",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -110,9 +110,8 @@ class AsyncUserResource(AsyncAPIResource):
         """
         return AsyncUserResourceWithStreamingResponse(self)
 
-    async def retrieve(
+    async def get_all(
         self,
-        id: str,
         *,
         # 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.
@@ -121,29 +120,18 @@ class AsyncUserResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
-        """
-        Args:
-          extra_headers: Send extra headers
-
-          extra_query: Add additional query parameters to the request
-
-          extra_body: Add additional JSON properties to the request
-
-          timeout: Override the client-level default timeout for this request, in seconds
-        """
-        if not id:
-            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._get(
-            f"/api/v1/scenarios/{id}/submissions/user",
+            "/api/v1/scenarios/submissions/user",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
             cast_to=NoneType,
         )
 
-    async def list(
+    async def get_by_scenario(
         self,
+        id: str,
         *,
         # 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.
@@ -152,9 +140,21 @@ class AsyncUserResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> None:
+        """
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._get(
-            "/api/v1/scenarios/submissions/user",
+            f"/api/v1/scenarios/{id}/submissions/user",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -166,11 +166,11 @@ class UserResourceWithRawResponse:
     def __init__(self, user: UserResource) -> None:
         self._user = user
 
-        self.retrieve = to_raw_response_wrapper(
-            user.retrieve,
+        self.get_all = to_raw_response_wrapper(
+            user.get_all,
         )
-        self.list = to_raw_response_wrapper(
-            user.list,
+        self.get_by_scenario = to_raw_response_wrapper(
+            user.get_by_scenario,
         )
 
 
@@ -178,11 +178,11 @@ class AsyncUserResourceWithRawResponse:
     def __init__(self, user: AsyncUserResource) -> None:
         self._user = user
 
-        self.retrieve = async_to_raw_response_wrapper(
-            user.retrieve,
+        self.get_all = async_to_raw_response_wrapper(
+            user.get_all,
         )
-        self.list = async_to_raw_response_wrapper(
-            user.list,
+        self.get_by_scenario = async_to_raw_response_wrapper(
+            user.get_by_scenario,
         )
 
 
@@ -190,11 +190,11 @@ class UserResourceWithStreamingResponse:
     def __init__(self, user: UserResource) -> None:
         self._user = user
 
-        self.retrieve = to_streamed_response_wrapper(
-            user.retrieve,
+        self.get_all = to_streamed_response_wrapper(
+            user.get_all,
         )
-        self.list = to_streamed_response_wrapper(
-            user.list,
+        self.get_by_scenario = to_streamed_response_wrapper(
+            user.get_by_scenario,
         )
 
 
@@ -202,9 +202,9 @@ class AsyncUserResourceWithStreamingResponse:
     def __init__(self, user: AsyncUserResource) -> None:
         self._user = user
 
-        self.retrieve = async_to_streamed_response_wrapper(
-            user.retrieve,
+        self.get_all = async_to_streamed_response_wrapper(
+            user.get_all,
         )
-        self.list = async_to_streamed_response_wrapper(
-            user.list,
+        self.get_by_scenario = async_to_streamed_response_wrapper(
+            user.get_by_scenario,
         )