mixpeek 0.12.0__py3-none-any.whl → 0.13__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 (270) hide show
  1. mixpeek/__init__.py +5 -79
  2. mixpeek/_hooks/__init__.py +5 -0
  3. mixpeek/_hooks/registration.py +13 -0
  4. mixpeek/_hooks/sdkhooks.py +76 -0
  5. mixpeek/_hooks/types.py +94 -0
  6. mixpeek/_version.py +11 -3
  7. mixpeek/assets.py +1561 -0
  8. mixpeek/basesdk.py +350 -0
  9. mixpeek/collections.py +1029 -0
  10. mixpeek/featureextractors.py +205 -0
  11. mixpeek/features.py +1181 -0
  12. mixpeek/health.py +167 -0
  13. mixpeek/httpclient.py +84 -0
  14. mixpeek/ingest.py +831 -0
  15. mixpeek/interactions.py +221 -0
  16. mixpeek/models/__init__.py +751 -0
  17. mixpeek/models/actionusage.py +16 -0
  18. mixpeek/models/apierror.py +22 -0
  19. mixpeek/models/apikey.py +25 -0
  20. mixpeek/models/apikeyupdate.py +49 -0
  21. mixpeek/models/assetfeatures.py +55 -0
  22. mixpeek/models/assetresponse.py +166 -0
  23. mixpeek/models/assets_model_searchquery.py +21 -0
  24. mixpeek/models/assetupdate.py +28 -0
  25. mixpeek/models/availableindexesresponse.py +23 -0
  26. mixpeek/models/availablemodels.py +12 -0
  27. mixpeek/models/boolindexparams.py +18 -0
  28. mixpeek/models/collectionmodel.py +70 -0
  29. mixpeek/models/collectionresult.py +73 -0
  30. mixpeek/models/create_api_key_organizations_users_user_email_api_keys_postop.py +23 -0
  31. mixpeek/models/create_collection_collections_postop.py +62 -0
  32. mixpeek/models/create_interaction_features_search_interactions_postop.py +59 -0
  33. mixpeek/models/createcollectionrequest.py +59 -0
  34. mixpeek/models/createnamespacerequest.py +62 -0
  35. mixpeek/models/datetimeindexparams.py +18 -0
  36. mixpeek/models/dateusage.py +22 -0
  37. mixpeek/models/db_model_paginationresponse.py +59 -0
  38. mixpeek/models/db_model_taskresponse.py +20 -0
  39. mixpeek/models/delete_api_key_organizations_users_user_email_api_keys_key_name_deleteop.py +23 -0
  40. mixpeek/models/delete_asset_assets_asset_id_deleteop.py +57 -0
  41. mixpeek/models/delete_collection_collections_collection_deleteop.py +59 -0
  42. mixpeek/models/delete_feature_features_feature_id_deleteop.py +57 -0
  43. mixpeek/models/delete_interaction_features_search_interactions_interaction_id_deleteop.py +59 -0
  44. mixpeek/models/delete_namespace_namespaces_namespace_deleteop.py +18 -0
  45. mixpeek/models/delete_user_organizations_users_user_email_deleteop.py +16 -0
  46. mixpeek/models/denseembedding.py +16 -0
  47. mixpeek/models/embeddingrequest.py +59 -0
  48. mixpeek/models/embeddingresponse.py +64 -0
  49. mixpeek/models/errormessage.py +13 -0
  50. mixpeek/models/errorresponse.py +21 -0
  51. mixpeek/models/facedetectsettings.py +52 -0
  52. mixpeek/models/featureextractionembeddingrequest.py +54 -0
  53. mixpeek/models/featureresponse.py +74 -0
  54. mixpeek/models/features_model_paginationresponse.py +59 -0
  55. mixpeek/models/featureupdaterequest.py +21 -0
  56. mixpeek/models/filtercondition.py +74 -0
  57. mixpeek/models/floatindexparams.py +18 -0
  58. mixpeek/models/full_asset_update_assets_asset_id_putop.py +69 -0
  59. mixpeek/models/full_feature_update_features_feature_id_putop.py +69 -0
  60. mixpeek/models/geoindexparams.py +18 -0
  61. mixpeek/models/get_asset_assets_asset_id_getop.py +73 -0
  62. mixpeek/models/get_asset_with_features_assets_asset_id_features_getop.py +73 -0
  63. mixpeek/models/get_collection_collections_collection_getop.py +59 -0
  64. mixpeek/models/get_feature_features_feature_id_getop.py +70 -0
  65. mixpeek/models/get_interaction_features_search_interactions_interaction_id_getop.py +59 -0
  66. mixpeek/models/get_namespace_namespaces_namespace_getop.py +18 -0
  67. mixpeek/models/get_task_tasks_task_id_getop.py +57 -0
  68. mixpeek/models/get_user_organizations_users_user_email_getop.py +16 -0
  69. mixpeek/models/groupbyoptions.py +71 -0
  70. mixpeek/models/groupbyoptionsasset.py +71 -0
  71. mixpeek/models/groupedassetdata.py +18 -0
  72. mixpeek/models/healthcheckresponse.py +13 -0
  73. mixpeek/models/httpvalidationerror.py +21 -0
  74. mixpeek/models/imagedescribesettings.py +82 -0
  75. mixpeek/models/imagedetectsettings.py +53 -0
  76. mixpeek/models/imagereadsettings.py +71 -0
  77. mixpeek/models/imagesettings.py +79 -0
  78. mixpeek/models/ingest_image_url_ingest_images_url_postop.py +59 -0
  79. mixpeek/models/ingest_text_ingest_text_postop.py +59 -0
  80. mixpeek/models/ingest_video_url_ingest_videos_url_postop.py +59 -0
  81. mixpeek/models/inputtype.py +11 -0
  82. mixpeek/models/integerindexparams.py +24 -0
  83. mixpeek/models/interactionresponse.py +87 -0
  84. mixpeek/models/interactiontype.py +11 -0
  85. mixpeek/models/jsonimageoutputsettings.py +55 -0
  86. mixpeek/models/jsontextoutputsettings.py +55 -0
  87. mixpeek/models/jsonvideooutputsettings.py +55 -0
  88. mixpeek/models/keywordindexparams.py +21 -0
  89. mixpeek/models/kill_task_tasks_task_id_deleteop.py +57 -0
  90. mixpeek/models/list_assets_assets_postop.py +77 -0
  91. mixpeek/models/list_collections_collections_getop.py +65 -0
  92. mixpeek/models/list_features_features_postop.py +79 -0
  93. mixpeek/models/list_interactions_features_search_interactions_getop.py +96 -0
  94. mixpeek/models/listassetsrequest.py +75 -0
  95. mixpeek/models/listassetsresponse.py +22 -0
  96. mixpeek/models/listcollectionsresponse.py +22 -0
  97. mixpeek/models/listfeaturesrequest.py +77 -0
  98. mixpeek/models/listfeaturesresponse.py +22 -0
  99. mixpeek/models/logicaloperator_input.py +88 -0
  100. mixpeek/models/logicaloperator_output.py +103 -0
  101. mixpeek/models/logodetectsettings.py +52 -0
  102. mixpeek/models/modality.py +13 -0
  103. mixpeek/models/modeldetails.py +57 -0
  104. mixpeek/models/namespaceresponse.py +54 -0
  105. mixpeek/models/organizationmodel.py +45 -0
  106. mixpeek/models/partial_asset_update_assets_asset_id_patchop.py +69 -0
  107. mixpeek/models/payloadindexconfig.py +94 -0
  108. mixpeek/models/payloadindextype.py +17 -0
  109. mixpeek/models/payloadschematype.py +15 -0
  110. mixpeek/models/percolaterequest.py +57 -0
  111. mixpeek/models/permission.py +10 -0
  112. mixpeek/models/processimageurlinput.py +99 -0
  113. mixpeek/models/processtextinput.py +94 -0
  114. mixpeek/models/processvideourlinput.py +99 -0
  115. mixpeek/models/querysettings.py +56 -0
  116. mixpeek/models/rerankingoptions.py +47 -0
  117. mixpeek/models/search_assets_assets_search_postop.py +59 -0
  118. mixpeek/models/search_features_features_search_postop.py +96 -0
  119. mixpeek/models/search_model_searchquery_input.py +76 -0
  120. mixpeek/models/searchassetsrequest.py +78 -0
  121. mixpeek/models/searchinteraction.py +82 -0
  122. mixpeek/models/searchquery_output.py +79 -0
  123. mixpeek/models/searchrequestfeatures_input.py +151 -0
  124. mixpeek/models/searchrequestfeatures_output.py +151 -0
  125. mixpeek/models/sortoption.py +28 -0
  126. mixpeek/models/sparseembedding.py +21 -0
  127. mixpeek/models/tasks_model_taskresponse.py +24 -0
  128. mixpeek/models/taskstatus.py +16 -0
  129. mixpeek/models/textindexparams.py +31 -0
  130. mixpeek/models/textsettings.py +61 -0
  131. mixpeek/models/tokenizertype.py +11 -0
  132. mixpeek/models/update_api_key_organizations_users_user_email_api_keys_key_name_patchop.py +30 -0
  133. mixpeek/models/update_collection_collections_collection_putop.py +74 -0
  134. mixpeek/models/update_namespace_namespaces_namespace_putop.py +28 -0
  135. mixpeek/models/updateassetrequest.py +60 -0
  136. mixpeek/models/updatenamespacerequest.py +26 -0
  137. mixpeek/models/usage.py +18 -0
  138. mixpeek/models/usermodel_input.py +36 -0
  139. mixpeek/models/usermodel_output.py +36 -0
  140. mixpeek/models/uuidindexparams.py +21 -0
  141. mixpeek/models/validationerror.py +26 -0
  142. mixpeek/models/vectormodel.py +11 -0
  143. mixpeek/models/vectortype.py +9 -0
  144. mixpeek/models/videodescribesettings.py +82 -0
  145. mixpeek/models/videodetectsettings.py +53 -0
  146. mixpeek/models/videoreadsettings.py +71 -0
  147. mixpeek/models/videosettings.py +101 -0
  148. mixpeek/models/videotranscriptionsettings.py +69 -0
  149. mixpeek/namespaces.py +1143 -0
  150. mixpeek/organizations.py +1508 -0
  151. mixpeek/py.typed +1 -0
  152. mixpeek/sdk.py +135 -0
  153. mixpeek/sdkconfiguration.py +45 -0
  154. mixpeek/searchinteractions.py +647 -0
  155. mixpeek/tasks.py +387 -0
  156. mixpeek/types/__init__.py +19 -29
  157. mixpeek/types/basemodel.py +39 -0
  158. mixpeek/utils/__init__.py +97 -0
  159. mixpeek/utils/annotations.py +55 -0
  160. mixpeek/utils/enums.py +34 -0
  161. mixpeek/utils/eventstreaming.py +238 -0
  162. mixpeek/utils/forms.py +202 -0
  163. mixpeek/utils/headers.py +136 -0
  164. mixpeek/utils/logger.py +27 -0
  165. mixpeek/utils/metadata.py +118 -0
  166. mixpeek/utils/queryparams.py +205 -0
  167. mixpeek/utils/requestbodies.py +66 -0
  168. mixpeek/utils/retries.py +217 -0
  169. mixpeek/utils/security.py +174 -0
  170. mixpeek/utils/serializers.py +215 -0
  171. mixpeek/utils/url.py +155 -0
  172. mixpeek/utils/values.py +134 -0
  173. mixpeek-0.13.dist-info/METADATA +439 -0
  174. mixpeek-0.13.dist-info/RECORD +176 -0
  175. {mixpeek-0.12.0.dist-info → mixpeek-0.13.dist-info}/WHEEL +1 -1
  176. py.typed +1 -0
  177. mixpeek/_base_client.py +0 -2041
  178. mixpeek/_client.py +0 -444
  179. mixpeek/_compat.py +0 -221
  180. mixpeek/_constants.py +0 -14
  181. mixpeek/_exceptions.py +0 -108
  182. mixpeek/_files.py +0 -123
  183. mixpeek/_models.py +0 -788
  184. mixpeek/_qs.py +0 -150
  185. mixpeek/_resource.py +0 -43
  186. mixpeek/_response.py +0 -824
  187. mixpeek/_streaming.py +0 -333
  188. mixpeek/_types.py +0 -219
  189. mixpeek/_utils/__init__.py +0 -56
  190. mixpeek/_utils/_logs.py +0 -25
  191. mixpeek/_utils/_proxy.py +0 -62
  192. mixpeek/_utils/_reflection.py +0 -42
  193. mixpeek/_utils/_streams.py +0 -12
  194. mixpeek/_utils/_sync.py +0 -81
  195. mixpeek/_utils/_transform.py +0 -387
  196. mixpeek/_utils/_typing.py +0 -120
  197. mixpeek/_utils/_utils.py +0 -414
  198. mixpeek/lib/.keep +0 -4
  199. mixpeek/resources/__init__.py +0 -117
  200. mixpeek/resources/accounts.py +0 -271
  201. mixpeek/resources/assets/__init__.py +0 -33
  202. mixpeek/resources/assets/assets.py +0 -708
  203. mixpeek/resources/assets/features.py +0 -172
  204. mixpeek/resources/collections.py +0 -283
  205. mixpeek/resources/entities/__init__.py +0 -47
  206. mixpeek/resources/entities/entities.py +0 -134
  207. mixpeek/resources/entities/faces.py +0 -514
  208. mixpeek/resources/entities/labels.py +0 -388
  209. mixpeek/resources/features/__init__.py +0 -33
  210. mixpeek/resources/features/features.py +0 -562
  211. mixpeek/resources/features/search.py +0 -731
  212. mixpeek/resources/healthcheck.py +0 -135
  213. mixpeek/resources/index/__init__.py +0 -47
  214. mixpeek/resources/index/images.py +0 -249
  215. mixpeek/resources/index/index.py +0 -289
  216. mixpeek/resources/index/videos.py +0 -249
  217. mixpeek/resources/tasks.py +0 -258
  218. mixpeek/types/account_update_params.py +0 -28
  219. mixpeek/types/asset_create_params.py +0 -36
  220. mixpeek/types/asset_create_response.py +0 -15
  221. mixpeek/types/asset_response.py +0 -46
  222. mixpeek/types/asset_search_params.py +0 -43
  223. mixpeek/types/asset_search_response.py +0 -15
  224. mixpeek/types/asset_update_params.py +0 -25
  225. mixpeek/types/asset_update_response.py +0 -11
  226. mixpeek/types/assets/__init__.py +0 -3
  227. mixpeek/types/collection_list_params.py +0 -19
  228. mixpeek/types/collection_list_response.py +0 -14
  229. mixpeek/types/entities/__init__.py +0 -13
  230. mixpeek/types/entities/face_create_params.py +0 -21
  231. mixpeek/types/entities/face_list_params.py +0 -18
  232. mixpeek/types/entities/face_list_response.py +0 -15
  233. mixpeek/types/entities/face_response.py +0 -17
  234. mixpeek/types/entities/face_update_params.py +0 -22
  235. mixpeek/types/entities/label_list_params.py +0 -18
  236. mixpeek/types/entities/label_list_response.py +0 -30
  237. mixpeek/types/entities/label_response.py +0 -30
  238. mixpeek/types/entities/label_update_params.py +0 -21
  239. mixpeek/types/feature.py +0 -32
  240. mixpeek/types/feature_list_params.py +0 -37
  241. mixpeek/types/feature_list_response.py +0 -28
  242. mixpeek/types/feature_retrieve_params.py +0 -18
  243. mixpeek/types/feature_update_params.py +0 -16
  244. mixpeek/types/features/__init__.py +0 -8
  245. mixpeek/types/features/search_feedback_params.py +0 -23
  246. mixpeek/types/features/search_file_params.py +0 -29
  247. mixpeek/types/features/search_text_params.py +0 -72
  248. mixpeek/types/features/search_url_params.py +0 -72
  249. mixpeek/types/grouped_asset_data.py +0 -24
  250. mixpeek/types/health_check_response.py +0 -10
  251. mixpeek/types/index/__init__.py +0 -8
  252. mixpeek/types/index/image_url_params.py +0 -135
  253. mixpeek/types/index/image_url_response.py +0 -20
  254. mixpeek/types/index/video_url_params.py +0 -154
  255. mixpeek/types/index/video_url_response.py +0 -20
  256. mixpeek/types/index_text_params.py +0 -77
  257. mixpeek/types/index_text_response.py +0 -14
  258. mixpeek/types/shared/__init__.py +0 -7
  259. mixpeek/types/shared/filter_condition.py +0 -19
  260. mixpeek/types/shared/logical_operator.py +0 -12
  261. mixpeek/types/shared/model_pagination_response.py +0 -21
  262. mixpeek/types/shared/sort_option.py +0 -15
  263. mixpeek/types/shared/task_response.py +0 -15
  264. mixpeek/types/shared_params/__init__.py +0 -4
  265. mixpeek/types/shared_params/logical_operator.py +0 -13
  266. mixpeek/types/shared_params/sort_option.py +0 -15
  267. mixpeek/types/user.py +0 -34
  268. mixpeek-0.12.0.dist-info/METADATA +0 -345
  269. mixpeek-0.12.0.dist-info/RECORD +0 -99
  270. mixpeek-0.12.0.dist-info/licenses/LICENSE +0 -201
@@ -1,30 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from typing import List, Optional
4
- from datetime import datetime
5
-
6
- from ..._models import BaseModel
7
-
8
- __all__ = ["LabelListResponse", "Result"]
9
-
10
-
11
- class Result(BaseModel):
12
- created_at: datetime
13
-
14
- description: str
15
-
16
- index_id: str
17
-
18
- label: str
19
-
20
- label_id: str
21
-
22
- metadata: Optional[object] = None
23
-
24
- updated_at: datetime
25
-
26
-
27
- class LabelListResponse(BaseModel):
28
- pagination: object
29
-
30
- results: List[Result]
@@ -1,30 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from typing import Optional
4
- from datetime import datetime
5
-
6
- from ..._models import BaseModel
7
-
8
- __all__ = ["LabelResponse", "Label"]
9
-
10
-
11
- class Label(BaseModel):
12
- created_at: datetime
13
-
14
- description: str
15
-
16
- index_id: str
17
-
18
- label: str
19
-
20
- label_id: str
21
-
22
- metadata: Optional[object] = None
23
-
24
- updated_at: datetime
25
-
26
-
27
- class LabelResponse(BaseModel):
28
- label: Label
29
-
30
- message: str
@@ -1,21 +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 import Optional
6
- from typing_extensions import Required, Annotated, TypedDict
7
-
8
- from ..._utils import PropertyInfo
9
-
10
- __all__ = ["LabelUpdateParams"]
11
-
12
-
13
- class LabelUpdateParams(TypedDict, total=False):
14
- path_label_id: Required[Annotated[str, PropertyInfo(alias="label_id")]]
15
-
16
- body_label_id: Required[Annotated[str, PropertyInfo(alias="label_id")]]
17
-
18
- metadata: Required[Optional[object]]
19
-
20
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
21
- """filter by organization"""
mixpeek/types/feature.py DELETED
@@ -1,32 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from typing import Optional
4
- from datetime import datetime
5
-
6
- from .._models import BaseModel
7
-
8
- __all__ = ["Feature"]
9
-
10
-
11
- class Feature(BaseModel):
12
- asset_id: Optional[str] = None
13
-
14
- created_at: Optional[datetime] = None
15
-
16
- description: Optional[str] = None
17
-
18
- detect: Optional[object] = None
19
-
20
- feature_id: Optional[str] = None
21
-
22
- json_output: Optional[object] = None
23
-
24
- metadata: Optional[object] = None
25
-
26
- modality: Optional[str] = None
27
-
28
- text: Optional[str] = None
29
-
30
- transcription: Optional[str] = None
31
-
32
- vectors: Optional[object] = None
@@ -1,37 +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 import List, Iterable, Optional
6
- from typing_extensions import Required, Annotated, TypedDict
7
-
8
- from .._utils import PropertyInfo
9
- from .shared_params.sort_option import SortOption
10
- from .shared_params.logical_operator import LogicalOperator
11
-
12
- __all__ = ["FeatureListParams"]
13
-
14
-
15
- class FeatureListParams(TypedDict, total=False):
16
- collection_ids: Required[List[str]]
17
- """Collection IDs to filter features"""
18
-
19
- offset_feature_id: Optional[str]
20
- """The offset id to start returning results from. Used for pagination"""
21
-
22
- page_size: int
23
-
24
- filters: Optional[LogicalOperator]
25
- """Complex nested query filters"""
26
-
27
- select: Optional[Iterable[object]]
28
- """List of fields to return in results, supports dot notation."""
29
-
30
- sort: Optional[SortOption]
31
- """
32
- List of fields to sort by, with direction (asc or desc). NOTE: fields will
33
- require a specialty index to use this, consult with the team.
34
- """
35
-
36
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
37
- """filter by organization"""
@@ -1,28 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from typing import List, Optional
4
-
5
- from .feature import Feature
6
- from .._models import BaseModel
7
-
8
- __all__ = ["FeatureListResponse", "Pagination"]
9
-
10
-
11
- class Pagination(BaseModel):
12
- current_page: int
13
-
14
- next_page: Optional[str] = None
15
-
16
- page_size: int
17
-
18
- previous_page: Optional[str] = None
19
-
20
- total: int
21
-
22
- total_pages: int
23
-
24
-
25
- class FeatureListResponse(BaseModel):
26
- pagination: Pagination
27
-
28
- results: List[Feature]
@@ -1,18 +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 import Optional
6
- from typing_extensions import Annotated, TypedDict
7
-
8
- from .._utils import PropertyInfo
9
-
10
- __all__ = ["FeatureRetrieveParams"]
11
-
12
-
13
- class FeatureRetrieveParams(TypedDict, total=False):
14
- include_vectors: Optional[bool]
15
- """When true, includes the feature's vector embeddings in the response"""
16
-
17
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
18
- """filter by organization"""
@@ -1,16 +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__ = ["FeatureUpdateParams"]
10
-
11
-
12
- class FeatureUpdateParams(TypedDict, total=False):
13
- metadata: Required[object]
14
-
15
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
16
- """filter by organization"""
@@ -1,8 +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 .search_url_params import SearchURLParams as SearchURLParams
6
- from .search_file_params import SearchFileParams as SearchFileParams
7
- from .search_text_params import SearchTextParams as SearchTextParams
8
- from .search_feedback_params import SearchFeedbackParams as SearchFeedbackParams
@@ -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 import Optional
6
- from typing_extensions import Required, Annotated, TypedDict
7
-
8
- from ..._utils import PropertyInfo
9
-
10
- __all__ = ["SearchFeedbackParams"]
11
-
12
-
13
- class SearchFeedbackParams(TypedDict, total=False):
14
- feature_id: Required[str]
15
-
16
- is_relevant: Required[bool]
17
-
18
- search_id: Required[str]
19
-
20
- feedback_text: Optional[str]
21
-
22
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
23
- """filter by organization"""
@@ -1,29 +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 import Optional
6
- from typing_extensions import Required, Annotated, TypedDict
7
-
8
- from ..._types import FileTypes
9
- from ..._utils import PropertyInfo
10
-
11
- __all__ = ["SearchFileParams"]
12
-
13
-
14
- class SearchFileParams(TypedDict, total=False):
15
- file: Required[FileTypes]
16
-
17
- offset_position: Optional[int]
18
- """The position to start returning results from.
19
-
20
- Used for pagination. Does not work with group_by
21
- """
22
-
23
- page_size: int
24
- """Number of results to return per page."""
25
-
26
- filters: str
27
-
28
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
29
- """filter by organization"""
@@ -1,72 +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 import List, Optional
6
- from typing_extensions import Literal, Required, Annotated, TypedDict
7
-
8
- from ..._utils import PropertyInfo
9
- from ..shared_params.sort_option import SortOption
10
- from ..shared_params.logical_operator import LogicalOperator
11
-
12
- __all__ = ["SearchTextParams", "GroupBy"]
13
-
14
-
15
- class SearchTextParams(TypedDict, total=False):
16
- collection_ids: Required[List[str]]
17
- """List of Collection IDs to search within, required"""
18
-
19
- offset_position: Optional[int]
20
- """The position to start returning results from.
21
-
22
- Used for pagination. Does not work with group_by
23
- """
24
-
25
- page_size: int
26
- """Number of results to return per page."""
27
-
28
- filters: Optional[LogicalOperator]
29
- """Complex nested query filters"""
30
-
31
- group_by: Optional[GroupBy]
32
- """Grouping options for search results"""
33
-
34
- model_id: Optional[Literal["vuse-generic-v1", "multimodal-v1", "image-embed-v1"]]
35
- """Embedding model to use"""
36
-
37
- query: Optional[str]
38
- """Text query for the search"""
39
-
40
- search_type: Literal["semantic", "fulltext"]
41
- """Type of search to perform"""
42
-
43
- select: Optional[List[str]]
44
- """List of fields to return in results, supports dot notation.
45
-
46
- If None, all fields are returned.
47
- """
48
-
49
- sort: Optional[SortOption]
50
- """List of fields to sort by, with direction (asc or desc).
51
-
52
- Supports dot notation for nested fields.
53
- """
54
-
55
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
56
- """filter by organization"""
57
-
58
-
59
- class GroupBy(TypedDict, total=False):
60
- field: Optional[str]
61
- """Field to group by
62
-
63
- Note: We currently do not support ad-hoc grouping.
64
- This means the field must be indexed separately.
65
- Please contact us to add additional fields for grouping.
66
- """
67
-
68
- max_features: Optional[int]
69
- """Maximum number of features to group"""
70
-
71
- sort: Optional[SortOption]
72
- """Sort options for ordering the inside of the groups"""
@@ -1,72 +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 import List, Optional
6
- from typing_extensions import Literal, Required, Annotated, TypedDict
7
-
8
- from ..._utils import PropertyInfo
9
- from ..shared_params.sort_option import SortOption
10
- from ..shared_params.logical_operator import LogicalOperator
11
-
12
- __all__ = ["SearchURLParams", "GroupBy"]
13
-
14
-
15
- class SearchURLParams(TypedDict, total=False):
16
- collection_ids: Required[List[str]]
17
- """List of Collection IDs to search within, required"""
18
-
19
- url: Required[str]
20
- """Url to fetch and search"""
21
-
22
- offset_position: Optional[int]
23
- """The position to start returning results from.
24
-
25
- Used for pagination. Does not work with group_by
26
- """
27
-
28
- page_size: int
29
- """Number of results to return per page."""
30
-
31
- filters: Optional[LogicalOperator]
32
- """Complex nested query filters"""
33
-
34
- group_by: Optional[GroupBy]
35
- """Grouping options for search results"""
36
-
37
- model_id: Optional[Literal["vuse-generic-v1", "multimodal-v1", "image-embed-v1"]]
38
- """Embedding model to use"""
39
-
40
- search_type: Literal["semantic", "fulltext"]
41
- """Type of search to perform"""
42
-
43
- select: Optional[List[str]]
44
- """List of fields to return in results, supports dot notation.
45
-
46
- If None, all fields are returned.
47
- """
48
-
49
- sort: Optional[SortOption]
50
- """List of fields to sort by, with direction (asc or desc).
51
-
52
- Supports dot notation for nested fields.
53
- """
54
-
55
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
56
- """filter by organization"""
57
-
58
-
59
- class GroupBy(TypedDict, total=False):
60
- field: Optional[str]
61
- """Field to group by
62
-
63
- Note: We currently do not support ad-hoc grouping.
64
- This means the field must be indexed separately.
65
- Please contact us to add additional fields for grouping.
66
- """
67
-
68
- max_features: Optional[int]
69
- """Maximum number of features to group"""
70
-
71
- sort: Optional[SortOption]
72
- """Sort options for ordering the inside of the groups"""
@@ -1,24 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from typing import Dict, List, Optional
4
-
5
- from .._models import BaseModel
6
- from .asset_response import AssetResponse
7
-
8
- __all__ = ["GroupedAssetData", "Features"]
9
-
10
-
11
- class Features(BaseModel):
12
- audio: Optional[List[Dict[str, object]]] = None
13
-
14
- image: Optional[List[Dict[str, object]]] = None
15
-
16
- text: Optional[List[Dict[str, object]]] = None
17
-
18
- video: Optional[List[Dict[str, object]]] = None
19
-
20
-
21
- class GroupedAssetData(BaseModel):
22
- asset: AssetResponse
23
-
24
- features: Features
@@ -1,10 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
-
4
- from .._models import BaseModel
5
-
6
- __all__ = ["HealthCheckResponse"]
7
-
8
-
9
- class HealthCheckResponse(BaseModel):
10
- status: str
@@ -1,8 +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 .image_url_params import ImageURLParams as ImageURLParams
6
- from .video_url_params import VideoURLParams as VideoURLParams
7
- from .image_url_response import ImageURLResponse as ImageURLResponse
8
- from .video_url_response import VideoURLResponse as VideoURLResponse
@@ -1,135 +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 import Optional
6
- from typing_extensions import Literal, Required, Annotated, TypedDict
7
-
8
- from ..._utils import PropertyInfo
9
-
10
- __all__ = [
11
- "ImageURLParams",
12
- "AssetUpdate",
13
- "ImageSettings",
14
- "ImageSettingsDescribe",
15
- "ImageSettingsDetect",
16
- "ImageSettingsDetectFaces",
17
- "ImageSettingsDetectLogos",
18
- "ImageSettingsEmbed",
19
- "ImageSettingsJsonOutput",
20
- "ImageSettingsRead",
21
- ]
22
-
23
-
24
- class ImageURLParams(TypedDict, total=False):
25
- collection_id: Required[str]
26
- """Unique identifier for the collection where the processed asset will be stored."""
27
-
28
- url: Required[str]
29
- """The URL of the asset to be processed. Must be a valid HTTP or HTTPS URL."""
30
-
31
- asset_update: Optional[AssetUpdate]
32
- """Asset update information for existing assets"""
33
-
34
- image_settings: Optional[ImageSettings]
35
- """Settings for image processing.
36
-
37
- Only applicable if the URL points to an image file.
38
- """
39
-
40
- metadata: object
41
- """Additional metadata associated with the asset.
42
-
43
- Can include any key-value pairs relevant to the asset.
44
- """
45
-
46
- prevent_duplicate: Optional[bool]
47
- """Indicates whether to prevent duplicate processing of the same URL."""
48
-
49
- should_save: Optional[bool]
50
- """Indicates whether the processed asset should be uploaded to S3 storage."""
51
-
52
- index_id: Annotated[str, PropertyInfo(alias="index-id")]
53
- """filter by organization"""
54
-
55
-
56
- class AssetUpdate(TypedDict, total=False):
57
- asset_id: Required[str]
58
- """Unique identifier for the asset to be updated"""
59
-
60
- mode: Required[Literal["replace", "append"]]
61
- """Update mode: 'replace' or 'append'"""
62
-
63
-
64
- class ImageSettingsDescribe(TypedDict, total=False):
65
- json_output: object
66
- """JSON format for the response"""
67
-
68
- max_length: Optional[int]
69
- """Maximum length of the description"""
70
-
71
- model_id: Optional[Literal["image-descriptor-v1"]]
72
-
73
- prompt: Optional[str]
74
- """Prompt for image description"""
75
-
76
-
77
- class ImageSettingsDetectFaces(TypedDict, total=False):
78
- confidence_threshold: Optional[float]
79
- """Minimum confidence threshold for detected objects"""
80
-
81
- model_id: Optional[Literal["face-detector-v1"]]
82
- """Model ID for face detection"""
83
-
84
-
85
- class ImageSettingsDetectLogos(TypedDict, total=False):
86
- confidence_threshold: Optional[float]
87
- """Minimum confidence threshold for detected logos"""
88
-
89
- model_id: Optional[Literal["logo-detector-v1"]]
90
- """Model ID for logo detection"""
91
-
92
-
93
- class ImageSettingsDetect(TypedDict, total=False):
94
- faces: Optional[ImageSettingsDetectFaces]
95
- """Settings for face detection"""
96
-
97
- logos: Optional[ImageSettingsDetectLogos]
98
- """Settings for logo detection"""
99
-
100
-
101
- class ImageSettingsEmbed(TypedDict, total=False):
102
- model_id: Optional[Literal["multimodal-v1"]]
103
-
104
-
105
- class ImageSettingsJsonOutput(TypedDict, total=False):
106
- prompt: Optional[str]
107
-
108
- response_shape: Optional[object]
109
-
110
-
111
- class ImageSettingsRead(TypedDict, total=False):
112
- json_output: object
113
- """JSON format for the response"""
114
-
115
- model_id: Optional[Literal["image-descriptor-v1"]]
116
-
117
- prompt: Optional[str]
118
- """Prompt for reading on-screen text"""
119
-
120
-
121
- class ImageSettings(TypedDict, total=False):
122
- describe: Optional[ImageSettingsDescribe]
123
- """Settings for generating image descriptions."""
124
-
125
- detect: Optional[ImageSettingsDetect]
126
- """Settings for object detection in images."""
127
-
128
- embed: Optional[ImageSettingsEmbed]
129
- """Settings for generating image embeddings."""
130
-
131
- json_output: Optional[ImageSettingsJsonOutput]
132
- """Settings for structured JSON output of image analysis."""
133
-
134
- read: Optional[ImageSettingsRead]
135
- """Settings for reading and analyzing image content."""
@@ -1,20 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from typing import Union
4
- from typing_extensions import TypeAlias
5
-
6
- from ..._models import BaseModel
7
- from ..asset_response import AssetResponse
8
-
9
- __all__ = ["ImageURLResponse", "DBModelTaskResponse"]
10
-
11
-
12
- class DBModelTaskResponse(BaseModel):
13
- message: str
14
- """A message describing the status of the task"""
15
-
16
- task_id: str
17
- """The unique identifier for the processing task"""
18
-
19
-
20
- ImageURLResponse: TypeAlias = Union[AssetResponse, DBModelTaskResponse]