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

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 (41) hide show
  1. studyfetch_sdk/_version.py +1 -1
  2. studyfetch_sdk/resources/v1/__init__.py +0 -14
  3. studyfetch_sdk/resources/v1/auth/__init__.py +0 -28
  4. studyfetch_sdk/resources/v1/auth/auth.py +14 -466
  5. studyfetch_sdk/resources/v1/auth/number_2fa.py +1 -294
  6. studyfetch_sdk/resources/v1/usage.py +1 -593
  7. studyfetch_sdk/resources/v1/v1.py +0 -32
  8. studyfetch_sdk/types/v1/__init__.py +0 -5
  9. studyfetch_sdk/types/v1/auth/__init__.py +0 -8
  10. {studyfetch_sdk-0.1.0a1.dist-info → studyfetch_sdk-0.1.0a3.dist-info}/METADATA +11 -35
  11. {studyfetch_sdk-0.1.0a1.dist-info → studyfetch_sdk-0.1.0a3.dist-info}/RECORD +13 -41
  12. studyfetch_sdk/resources/v1/auth/login.py +0 -374
  13. studyfetch_sdk/resources/v1/auth/organization_invites.py +0 -160
  14. studyfetch_sdk/resources/v1/organizations/__init__.py +0 -103
  15. studyfetch_sdk/resources/v1/organizations/api_keys.py +0 -260
  16. studyfetch_sdk/resources/v1/organizations/logo/__init__.py +0 -33
  17. studyfetch_sdk/resources/v1/organizations/logo/logo.py +0 -166
  18. studyfetch_sdk/resources/v1/organizations/logo/upload.py +0 -184
  19. studyfetch_sdk/resources/v1/organizations/organizations.py +0 -428
  20. studyfetch_sdk/resources/v1/organizations/profile/__init__.py +0 -47
  21. studyfetch_sdk/resources/v1/organizations/profile/models.py +0 -134
  22. studyfetch_sdk/resources/v1/organizations/profile/profile.py +0 -248
  23. studyfetch_sdk/resources/v1/organizations/profile/team.py +0 -462
  24. studyfetch_sdk/resources/v1/organizations/team/__init__.py +0 -33
  25. studyfetch_sdk/resources/v1/organizations/team/invite.py +0 -236
  26. studyfetch_sdk/resources/v1/organizations/team/team.py +0 -564
  27. studyfetch_sdk/resources/v1/organizations/theme.py +0 -184
  28. studyfetch_sdk/resources/v1/organizations/usage.py +0 -160
  29. studyfetch_sdk/types/v1/auth/login_authenticate_params.py +0 -15
  30. studyfetch_sdk/types/v1/auth/login_verify_2fa_params.py +0 -15
  31. studyfetch_sdk/types/v1/auth/login_verify_backup_code_params.py +0 -17
  32. studyfetch_sdk/types/v1/auth/number_2fa_disable_params.py +0 -12
  33. studyfetch_sdk/types/v1/auth/number_2fa_enable_params.py +0 -12
  34. studyfetch_sdk/types/v1/auth/number_2fa_regenerate_backup_codes_params.py +0 -12
  35. studyfetch_sdk/types/v1/auth_register_new_user_params.py +0 -23
  36. studyfetch_sdk/types/v1/auth_request_password_reset_params.py +0 -12
  37. studyfetch_sdk/types/v1/auth_reset_password_params.py +0 -17
  38. studyfetch_sdk/types/v1/usage_track_chat_params.py +0 -54
  39. studyfetch_sdk/types/v1/usage_track_event_params.py +0 -128
  40. {studyfetch_sdk-0.1.0a1.dist-info → studyfetch_sdk-0.1.0a3.dist-info}/WHEEL +0 -0
  41. {studyfetch_sdk-0.1.0a1.dist-info → studyfetch_sdk-0.1.0a3.dist-info}/licenses/LICENSE +0 -0
@@ -1,184 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- import httpx
6
-
7
- from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
8
- from ...._compat import cached_property
9
- from ...._resource import SyncAPIResource, AsyncAPIResource
10
- from ...._response import (
11
- to_raw_response_wrapper,
12
- to_streamed_response_wrapper,
13
- async_to_raw_response_wrapper,
14
- async_to_streamed_response_wrapper,
15
- )
16
- from ...._base_client import make_request_options
17
-
18
- __all__ = ["ThemeResource", "AsyncThemeResource"]
19
-
20
-
21
- class ThemeResource(SyncAPIResource):
22
- @cached_property
23
- def with_raw_response(self) -> ThemeResourceWithRawResponse:
24
- """
25
- This property can be used as a prefix for any HTTP method call to return
26
- the raw response object instead of the parsed content.
27
-
28
- For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#accessing-raw-response-data-eg-headers
29
- """
30
- return ThemeResourceWithRawResponse(self)
31
-
32
- @cached_property
33
- def with_streaming_response(self) -> ThemeResourceWithStreamingResponse:
34
- """
35
- An alternative to `.with_raw_response` that doesn't eagerly read the response body.
36
-
37
- For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#with_streaming_response
38
- """
39
- return ThemeResourceWithStreamingResponse(self)
40
-
41
- def create(
42
- self,
43
- *,
44
- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
45
- # The extra values given here take precedence over values defined on the client or passed to this method.
46
- extra_headers: Headers | None = None,
47
- extra_query: Query | None = None,
48
- extra_body: Body | None = None,
49
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
50
- ) -> None:
51
- extra_headers = {"Accept": "*/*", **(extra_headers or {})}
52
- return self._put(
53
- "/api/v1/organizations/theme",
54
- options=make_request_options(
55
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
56
- ),
57
- cast_to=NoneType,
58
- )
59
-
60
- def list(
61
- self,
62
- *,
63
- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
64
- # The extra values given here take precedence over values defined on the client or passed to this method.
65
- extra_headers: Headers | None = None,
66
- extra_query: Query | None = None,
67
- extra_body: Body | None = None,
68
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
69
- ) -> None:
70
- extra_headers = {"Accept": "*/*", **(extra_headers or {})}
71
- return self._get(
72
- "/api/v1/organizations/theme",
73
- options=make_request_options(
74
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
75
- ),
76
- cast_to=NoneType,
77
- )
78
-
79
-
80
- class AsyncThemeResource(AsyncAPIResource):
81
- @cached_property
82
- def with_raw_response(self) -> AsyncThemeResourceWithRawResponse:
83
- """
84
- This property can be used as a prefix for any HTTP method call to return
85
- the raw response object instead of the parsed content.
86
-
87
- For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#accessing-raw-response-data-eg-headers
88
- """
89
- return AsyncThemeResourceWithRawResponse(self)
90
-
91
- @cached_property
92
- def with_streaming_response(self) -> AsyncThemeResourceWithStreamingResponse:
93
- """
94
- An alternative to `.with_raw_response` that doesn't eagerly read the response body.
95
-
96
- For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#with_streaming_response
97
- """
98
- return AsyncThemeResourceWithStreamingResponse(self)
99
-
100
- async def create(
101
- self,
102
- *,
103
- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
104
- # The extra values given here take precedence over values defined on the client or passed to this method.
105
- extra_headers: Headers | None = None,
106
- extra_query: Query | None = None,
107
- extra_body: Body | None = None,
108
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
109
- ) -> None:
110
- extra_headers = {"Accept": "*/*", **(extra_headers or {})}
111
- return await self._put(
112
- "/api/v1/organizations/theme",
113
- options=make_request_options(
114
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
115
- ),
116
- cast_to=NoneType,
117
- )
118
-
119
- async def list(
120
- self,
121
- *,
122
- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
123
- # The extra values given here take precedence over values defined on the client or passed to this method.
124
- extra_headers: Headers | None = None,
125
- extra_query: Query | None = None,
126
- extra_body: Body | None = None,
127
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
128
- ) -> None:
129
- extra_headers = {"Accept": "*/*", **(extra_headers or {})}
130
- return await self._get(
131
- "/api/v1/organizations/theme",
132
- options=make_request_options(
133
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
134
- ),
135
- cast_to=NoneType,
136
- )
137
-
138
-
139
- class ThemeResourceWithRawResponse:
140
- def __init__(self, theme: ThemeResource) -> None:
141
- self._theme = theme
142
-
143
- self.create = to_raw_response_wrapper(
144
- theme.create,
145
- )
146
- self.list = to_raw_response_wrapper(
147
- theme.list,
148
- )
149
-
150
-
151
- class AsyncThemeResourceWithRawResponse:
152
- def __init__(self, theme: AsyncThemeResource) -> None:
153
- self._theme = theme
154
-
155
- self.create = async_to_raw_response_wrapper(
156
- theme.create,
157
- )
158
- self.list = async_to_raw_response_wrapper(
159
- theme.list,
160
- )
161
-
162
-
163
- class ThemeResourceWithStreamingResponse:
164
- def __init__(self, theme: ThemeResource) -> None:
165
- self._theme = theme
166
-
167
- self.create = to_streamed_response_wrapper(
168
- theme.create,
169
- )
170
- self.list = to_streamed_response_wrapper(
171
- theme.list,
172
- )
173
-
174
-
175
- class AsyncThemeResourceWithStreamingResponse:
176
- def __init__(self, theme: AsyncThemeResource) -> None:
177
- self._theme = theme
178
-
179
- self.create = async_to_streamed_response_wrapper(
180
- theme.create,
181
- )
182
- self.list = async_to_streamed_response_wrapper(
183
- theme.list,
184
- )
@@ -1,160 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- import httpx
6
-
7
- from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
8
- from ...._compat import cached_property
9
- from ...._resource import SyncAPIResource, AsyncAPIResource
10
- from ...._response import (
11
- to_raw_response_wrapper,
12
- to_streamed_response_wrapper,
13
- async_to_raw_response_wrapper,
14
- async_to_streamed_response_wrapper,
15
- )
16
- from ...._base_client import make_request_options
17
-
18
- __all__ = ["UsageResource", "AsyncUsageResource"]
19
-
20
-
21
- class UsageResource(SyncAPIResource):
22
- @cached_property
23
- def with_raw_response(self) -> UsageResourceWithRawResponse:
24
- """
25
- This property can be used as a prefix for any HTTP method call to return
26
- the raw response object instead of the parsed content.
27
-
28
- For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#accessing-raw-response-data-eg-headers
29
- """
30
- return UsageResourceWithRawResponse(self)
31
-
32
- @cached_property
33
- def with_streaming_response(self) -> UsageResourceWithStreamingResponse:
34
- """
35
- An alternative to `.with_raw_response` that doesn't eagerly read the response body.
36
-
37
- For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#with_streaming_response
38
- """
39
- return UsageResourceWithStreamingResponse(self)
40
-
41
- def list(
42
- self,
43
- id: str,
44
- *,
45
- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
46
- # The extra values given here take precedence over values defined on the client or passed to this method.
47
- extra_headers: Headers | None = None,
48
- extra_query: Query | None = None,
49
- extra_body: Body | None = None,
50
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
51
- ) -> None:
52
- """
53
- Args:
54
- extra_headers: Send extra headers
55
-
56
- extra_query: Add additional query parameters to the request
57
-
58
- extra_body: Add additional JSON properties to the request
59
-
60
- timeout: Override the client-level default timeout for this request, in seconds
61
- """
62
- if not id:
63
- raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
64
- extra_headers = {"Accept": "*/*", **(extra_headers or {})}
65
- return self._get(
66
- f"/api/v1/organizations/{id}/usage",
67
- options=make_request_options(
68
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
69
- ),
70
- cast_to=NoneType,
71
- )
72
-
73
-
74
- class AsyncUsageResource(AsyncAPIResource):
75
- @cached_property
76
- def with_raw_response(self) -> AsyncUsageResourceWithRawResponse:
77
- """
78
- This property can be used as a prefix for any HTTP method call to return
79
- the raw response object instead of the parsed content.
80
-
81
- For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#accessing-raw-response-data-eg-headers
82
- """
83
- return AsyncUsageResourceWithRawResponse(self)
84
-
85
- @cached_property
86
- def with_streaming_response(self) -> AsyncUsageResourceWithStreamingResponse:
87
- """
88
- An alternative to `.with_raw_response` that doesn't eagerly read the response body.
89
-
90
- For more information, see https://www.github.com/GoStudyFetchGo/studyfetch-sdk-python#with_streaming_response
91
- """
92
- return AsyncUsageResourceWithStreamingResponse(self)
93
-
94
- async def list(
95
- self,
96
- id: str,
97
- *,
98
- # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
99
- # The extra values given here take precedence over values defined on the client or passed to this method.
100
- extra_headers: Headers | None = None,
101
- extra_query: Query | None = None,
102
- extra_body: Body | None = None,
103
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
104
- ) -> None:
105
- """
106
- Args:
107
- extra_headers: Send extra headers
108
-
109
- extra_query: Add additional query parameters to the request
110
-
111
- extra_body: Add additional JSON properties to the request
112
-
113
- timeout: Override the client-level default timeout for this request, in seconds
114
- """
115
- if not id:
116
- raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
117
- extra_headers = {"Accept": "*/*", **(extra_headers or {})}
118
- return await self._get(
119
- f"/api/v1/organizations/{id}/usage",
120
- options=make_request_options(
121
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
122
- ),
123
- cast_to=NoneType,
124
- )
125
-
126
-
127
- class UsageResourceWithRawResponse:
128
- def __init__(self, usage: UsageResource) -> None:
129
- self._usage = usage
130
-
131
- self.list = to_raw_response_wrapper(
132
- usage.list,
133
- )
134
-
135
-
136
- class AsyncUsageResourceWithRawResponse:
137
- def __init__(self, usage: AsyncUsageResource) -> None:
138
- self._usage = usage
139
-
140
- self.list = async_to_raw_response_wrapper(
141
- usage.list,
142
- )
143
-
144
-
145
- class UsageResourceWithStreamingResponse:
146
- def __init__(self, usage: UsageResource) -> None:
147
- self._usage = usage
148
-
149
- self.list = to_streamed_response_wrapper(
150
- usage.list,
151
- )
152
-
153
-
154
- class AsyncUsageResourceWithStreamingResponse:
155
- def __init__(self, usage: AsyncUsageResource) -> None:
156
- self._usage = usage
157
-
158
- self.list = async_to_streamed_response_wrapper(
159
- usage.list,
160
- )
@@ -1,15 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, TypedDict
6
-
7
- __all__ = ["LoginAuthenticateParams"]
8
-
9
-
10
- class LoginAuthenticateParams(TypedDict, total=False):
11
- email: Required[str]
12
- """User email address"""
13
-
14
- password: Required[str]
15
- """User password"""
@@ -1,15 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, TypedDict
6
-
7
- __all__ = ["LoginVerify2faParams"]
8
-
9
-
10
- class LoginVerify2faParams(TypedDict, total=False):
11
- code: Required[str]
12
- """6-digit verification code"""
13
-
14
- email: Required[str]
15
- """User email address"""
@@ -1,17 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, Annotated, TypedDict
6
-
7
- from ...._utils import PropertyInfo
8
-
9
- __all__ = ["LoginVerifyBackupCodeParams"]
10
-
11
-
12
- class LoginVerifyBackupCodeParams(TypedDict, total=False):
13
- backup_code: Required[Annotated[str, PropertyInfo(alias="backupCode")]]
14
- """Backup code"""
15
-
16
- email: Required[str]
17
- """User email address"""
@@ -1,12 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, TypedDict
6
-
7
- __all__ = ["Number2faDisableParams"]
8
-
9
-
10
- class Number2faDisableParams(TypedDict, total=False):
11
- password: Required[str]
12
- """User password for verification"""
@@ -1,12 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, TypedDict
6
-
7
- __all__ = ["Number2faEnableParams"]
8
-
9
-
10
- class Number2faEnableParams(TypedDict, total=False):
11
- password: Required[str]
12
- """User password for verification"""
@@ -1,12 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, TypedDict
6
-
7
- __all__ = ["Number2faRegenerateBackupCodesParams"]
8
-
9
-
10
- class Number2faRegenerateBackupCodesParams(TypedDict, total=False):
11
- password: Required[str]
12
- """User password for verification"""
@@ -1,23 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, Annotated, TypedDict
6
-
7
- from ..._utils import PropertyInfo
8
-
9
- __all__ = ["AuthRegisterNewUserParams"]
10
-
11
-
12
- class AuthRegisterNewUserParams(TypedDict, total=False):
13
- email: Required[str]
14
- """User email address"""
15
-
16
- name: Required[str]
17
- """User full name"""
18
-
19
- organization_name: Required[Annotated[str, PropertyInfo(alias="organizationName")]]
20
- """Organization name"""
21
-
22
- password: Required[str]
23
- """User password"""
@@ -1,12 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, TypedDict
6
-
7
- __all__ = ["AuthRequestPasswordResetParams"]
8
-
9
-
10
- class AuthRequestPasswordResetParams(TypedDict, total=False):
11
- email: Required[str]
12
- """Email address to send reset link"""
@@ -1,17 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Required, Annotated, TypedDict
6
-
7
- from ..._utils import PropertyInfo
8
-
9
- __all__ = ["AuthResetPasswordParams"]
10
-
11
-
12
- class AuthResetPasswordParams(TypedDict, total=False):
13
- token: Required[str]
14
- """Password reset token from email"""
15
-
16
- new_password: Required[Annotated[str, PropertyInfo(alias="newPassword")]]
17
- """New password"""
@@ -1,54 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Literal, Required, Annotated, TypedDict
6
-
7
- from ..._utils import PropertyInfo
8
-
9
- __all__ = ["UsageTrackChatParams"]
10
-
11
-
12
- class UsageTrackChatParams(TypedDict, total=False):
13
- input_tokens: Required[Annotated[float, PropertyInfo(alias="inputTokens")]]
14
- """Number of input tokens"""
15
-
16
- model: Required[
17
- Literal[
18
- "openai:gpt-4.1",
19
- "openai:gpt-4o",
20
- "openai:gpt-4o-mini",
21
- "openai:gpt-4",
22
- "openai:gpt-3.5-turbo",
23
- "openai:o1",
24
- "openai:o1-mini",
25
- "openai:o3-mini",
26
- "anthropic:claude-3-opus",
27
- "anthropic:claude-3-sonnet",
28
- "anthropic:claude-3-haiku",
29
- "google:gemini-pro",
30
- "meta:llama-3",
31
- ]
32
- ]
33
- """AI model used"""
34
-
35
- output_tokens: Required[Annotated[float, PropertyInfo(alias="outputTokens")]]
36
- """Number of output tokens"""
37
-
38
- session_id: Required[Annotated[str, PropertyInfo(alias="sessionId")]]
39
- """Chat session ID"""
40
-
41
- component_id: Annotated[str, PropertyInfo(alias="componentId")]
42
- """Component ID"""
43
-
44
- group_id: Annotated[str, PropertyInfo(alias="groupId")]
45
- """Group ID"""
46
-
47
- metadata: object
48
- """Additional metadata"""
49
-
50
- reasoning_tokens: Annotated[float, PropertyInfo(alias="reasoningTokens")]
51
- """Number of reasoning tokens"""
52
-
53
- user_id: Annotated[str, PropertyInfo(alias="userId")]
54
- """User ID"""
@@ -1,128 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing_extensions import Literal, Required, Annotated, TypedDict
6
-
7
- from ..._utils import PropertyInfo
8
-
9
- __all__ = ["UsageTrackEventParams"]
10
-
11
-
12
- class UsageTrackEventParams(TypedDict, total=False):
13
- event_type: Required[
14
- Annotated[
15
- Literal[
16
- "material_created",
17
- "material_uploaded",
18
- "material_processed",
19
- "material_deleted",
20
- "component_created",
21
- "component_accessed",
22
- "component_deleted",
23
- "component_usage",
24
- "chat_message_sent",
25
- "chat_session_started",
26
- "chat_session_ended",
27
- "test_created",
28
- "test_started",
29
- "test_completed",
30
- "test_question_answered",
31
- "test_retaken",
32
- "audio_recap_create",
33
- "api_call",
34
- "cache_hit",
35
- "sso_login",
36
- "sso_logout",
37
- "student_performance",
38
- ],
39
- PropertyInfo(alias="eventType"),
40
- ]
41
- ]
42
- """Type of usage event"""
43
-
44
- cache_hit: Annotated[bool, PropertyInfo(alias="cacheHit")]
45
- """Whether response was served from cache"""
46
-
47
- component_name: Annotated[str, PropertyInfo(alias="componentName")]
48
- """Component name"""
49
-
50
- component_type: Annotated[str, PropertyInfo(alias="componentType")]
51
- """Component type"""
52
-
53
- content_size: Annotated[float, PropertyInfo(alias="contentSize")]
54
- """Size of content in bytes"""
55
-
56
- endpoint: str
57
- """API endpoint accessed"""
58
-
59
- file_size: Annotated[float, PropertyInfo(alias="fileSize")]
60
- """File size in bytes"""
61
-
62
- file_type: Annotated[str, PropertyInfo(alias="fileType")]
63
- """File MIME type"""
64
-
65
- group_id: Annotated[str, PropertyInfo(alias="groupId")]
66
- """Group ID for collaborative sessions"""
67
-
68
- input_tokens: Annotated[float, PropertyInfo(alias="inputTokens")]
69
- """Number of input tokens"""
70
-
71
- ip_address: Annotated[str, PropertyInfo(alias="ipAddress")]
72
- """Client IP address"""
73
-
74
- metadata: object
75
- """Additional metadata"""
76
-
77
- method: str
78
- """HTTP method used"""
79
-
80
- model: Literal[
81
- "openai:gpt-4.1",
82
- "openai:gpt-4o",
83
- "openai:gpt-4o-mini",
84
- "openai:gpt-4",
85
- "openai:gpt-3.5-turbo",
86
- "openai:o1",
87
- "openai:o1-mini",
88
- "openai:o3-mini",
89
- "anthropic:claude-3-opus",
90
- "anthropic:claude-3-sonnet",
91
- "anthropic:claude-3-haiku",
92
- "google:gemini-pro",
93
- "meta:llama-3",
94
- ]
95
- """AI model used"""
96
-
97
- output_tokens: Annotated[float, PropertyInfo(alias="outputTokens")]
98
- """Number of output tokens"""
99
-
100
- performance_data: Annotated[object, PropertyInfo(alias="performanceData")]
101
- """Performance metrics data"""
102
-
103
- reasoning_tokens: Annotated[float, PropertyInfo(alias="reasoningTokens")]
104
- """Number of reasoning tokens"""
105
-
106
- resource_id: Annotated[str, PropertyInfo(alias="resourceId")]
107
- """Resource ID being accessed"""
108
-
109
- resource_type: Annotated[str, PropertyInfo(alias="resourceType")]
110
- """Type of resource"""
111
-
112
- response_time: Annotated[float, PropertyInfo(alias="responseTime")]
113
- """Response time in milliseconds"""
114
-
115
- session_id: Annotated[str, PropertyInfo(alias="sessionId")]
116
- """Session ID"""
117
-
118
- status_code: Annotated[float, PropertyInfo(alias="statusCode")]
119
- """HTTP status code"""
120
-
121
- total_tokens: Annotated[float, PropertyInfo(alias="totalTokens")]
122
- """Total number of tokens"""
123
-
124
- user_agent: Annotated[str, PropertyInfo(alias="userAgent")]
125
- """Client user agent"""
126
-
127
- user_id: Annotated[str, PropertyInfo(alias="userId")]
128
- """User ID"""