chunkr-ai 0.1.0a1__py3-none-any.whl → 0.1.0a3__py3-none-any.whl

{chunkr_ai-0.1.0a1.dist-info → chunkr_ai-0.1.0a3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: chunkr-ai
-Version: 0.1.0a1
+Version: 0.1.0a3
 Summary: The official Python library for the chunkr API
 Project-URL: Homepage, https://github.com/lumina-ai-inc/chunkr-python
 Project-URL: Repository, https://github.com/lumina-ai-inc/chunkr-python
@@ -70,7 +70,7 @@ client = Chunkr(
     api_key=os.environ.get("CHUNKR_API_KEY"),  # This is the default and can be omitted
 )
 
-task = client.task.parse(
+task = client.tasks.parse.create(
     file="string",
 )
 print(task.task_id)
@@ -96,7 +96,7 @@ client = AsyncChunkr(
 
 
 async def main() -> None:
-    task = await client.task.parse(
+    task = await client.tasks.parse.create(
         file="string",
     )
     print(task.task_id)
@@ -131,7 +131,7 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        task = await client.task.parse(
+        task = await client.tasks.parse.create(
             file="string",
         )
         print(task.task_id)
@@ -162,7 +162,7 @@ client = Chunkr()
 
 all_tasks = []
 # Automatically fetches more pages as needed.
-for task in client.task.list(
+for task in client.tasks.list(
     limit=100,
 ):
     # Do something with task here
@@ -182,7 +182,7 @@ client = AsyncChunkr()
 async def main() -> None:
     all_tasks = []
     # Iterate through items across all pages, issuing requests as needed.
-    async for task in client.task.list(
+    async for task in client.tasks.list(
         limit=100,
     ):
         all_tasks.append(task)
@@ -195,7 +195,7 @@ asyncio.run(main())
 Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
 
 ```python
-first_page = await client.task.list(
+first_page = await client.tasks.list(
     limit=100,
 )
 if first_page.has_next_page():
@@ -209,7 +209,7 @@ if first_page.has_next_page():
 Or just work directly with the returned data:
 
 ```python
-first_page = await client.task.list(
+first_page = await client.tasks.list(
     limit=100,
 )
 
@@ -229,13 +229,31 @@ from chunkr_ai import Chunkr
 
 client = Chunkr()
 
-task = client.task.parse(
+task = client.tasks.parse.create(
     file="file",
     chunk_processing={},
 )
 print(task.chunk_processing)
 ```
 
+## File uploads
+
+Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
+
+```python
+from pathlib import Path
+from chunkr_ai import Chunkr
+
+client = Chunkr()
+
+client.files.create(
+    file=Path("/path/to/file"),
+    file_metadata="file_metadata",
+)
+```
+
+The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `chunkr_ai.APIConnectionError` is raised.
@@ -252,8 +270,8 @@ from chunkr_ai import Chunkr
 client = Chunkr()
 
 try:
-    client.task.parse(
-        file="base64 or url",
+    client.tasks.parse.create(
+        file="string",
     )
 except chunkr_ai.APIConnectionError as e:
     print("The server could not be reached")
@@ -297,8 +315,8 @@ client = Chunkr(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).task.parse(
-    file="base64 or url",
+client.with_options(max_retries=5).tasks.parse.create(
+    file="string",
 )
 ```
 
@@ -322,8 +340,8 @@ client = Chunkr(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).task.parse(
-    file="base64 or url",
+client.with_options(timeout=5.0).tasks.parse.create(
+    file="string",
 )
 ```
 
@@ -365,13 +383,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from chunkr_ai import Chunkr
 
 client = Chunkr()
-response = client.task.with_raw_response.parse(
-    file="base64 or url",
+response = client.tasks.parse.with_raw_response.create(
+    file="string",
 )
 print(response.headers.get('X-My-Header'))
 
-task = response.parse()  # get the object that `task.parse()` would have returned
-print(task.task_id)
+parse = response.parse()  # get the object that `tasks.parse.create()` would have returned
+print(parse.task_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/lumina-ai-inc/chunkr-python/tree/main/src/chunkr_ai/_response.py) object.
@@ -385,8 +403,8 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.task.with_streaming_response.parse(
-    file="base64 or url",
+with client.tasks.parse.with_streaming_response.create(
+    file="string",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

chunkr_ai-0.1.0a3.dist-info/RECORD

@@ -0,0 +1,52 @@
+chunkr_ai/__init__.py,sha256=scS30uHiCpLbaalKTAJSCFSTqnu_b9R5JCkTu2hmbzU,2587
+chunkr_ai/_base_client.py,sha256=Nv5b_rmVdmmPbF42mlOfymbSC6lxcYsrsvBhKSBDXWQ,67038
+chunkr_ai/_client.py,sha256=fseZHGtnXGw3uSa1Le8SxH2oSBeHczn6mOsLeLGj4rY,15867
+chunkr_ai/_compat.py,sha256=VWemUKbj6DDkQ-O4baSpHVLJafotzeXmCQGJugfVTIw,6580
+chunkr_ai/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
+chunkr_ai/_exceptions.py,sha256=ClgXUcwf4qhBTXnK4LzUPQCFdFldRxAlcYdOFFgpTxA,3220
+chunkr_ai/_files.py,sha256=SUFtic_gwSzbvhLtMdQ7TBem8szrqZE2nZFFMRa0KTw,3619
+chunkr_ai/_models.py,sha256=KvjsMfb88XZlFUKVoOxr8OyDj47MhoH2OKqWNEbBhk4,30010
+chunkr_ai/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
+chunkr_ai/_resource.py,sha256=f5tiwjxcKdbeMor8idoHtMFTUhqD9yc2xXtq5rqeLLk,1100
+chunkr_ai/_response.py,sha256=xXNpF53hiYARmAW7npKuxQ5UHAEjgAzm7ME_L3eIstY,28800
+chunkr_ai/_streaming.py,sha256=ZmyrVWk7-AWkLAATR55WgNxnyFzYmaqJt2LthA_PTqQ,10100
+chunkr_ai/_types.py,sha256=dnzU2Q2tLcuk29QFEcnPC1wp0-4XB4Cpef_3AnRhV5Y,6200
+chunkr_ai/_version.py,sha256=ZlaSb0jnVJ7N4kkTfvr8UrgWy--cDr9CwSzUZLsiWbo,169
+chunkr_ai/pagination.py,sha256=bT-ErcJ80YlKBV6tWq2s9uqg-wv7o66SKe_AgUAGrKc,3533
+chunkr_ai/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+chunkr_ai/_utils/__init__.py,sha256=PNZ_QJuzZEgyYXqkO1HVhGkj5IU9bglVUcw7H-Knjzw,2062
+chunkr_ai/_utils/_logs.py,sha256=ylZvP2JTPNlFCbxYajpsnWkA253kDFgnFYDWWuvgf_Q,780
+chunkr_ai/_utils/_proxy.py,sha256=aglnj2yBTDyGX9Akk2crZHrl10oqRmceUy2Zp008XEs,1975
+chunkr_ai/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU,1364
+chunkr_ai/_utils/_resources_proxy.py,sha256=3KbSCApjaz7x_frFAxJe9ltY-dIJBQUVnIhR2GvVRY8,604
+chunkr_ai/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
+chunkr_ai/_utils/_sync.py,sha256=TpGLrrhRNWTJtODNE6Fup3_k7zrWm1j2RlirzBwre-0,2862
+chunkr_ai/_utils/_transform.py,sha256=n7kskEWz6o__aoNvhFoGVyDoalNe6mJwp-g7BWkdj88,15617
+chunkr_ai/_utils/_typing.py,sha256=D0DbbNu8GnYQTSICnTSHDGsYXj8TcAKyhejb0XcnjtY,4602
+chunkr_ai/_utils/_utils.py,sha256=ts4CiiuNpFiGB6YMdkQRh2SZvYvsl7mAF-JWHCcLDf4,12312
+chunkr_ai/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
+chunkr_ai/resources/__init__.py,sha256=K-axuAEg2pJQl45N5ao1tm8AnRwpQVVNp_b6qSMgB6A,1426
+chunkr_ai/resources/files.py,sha256=Dez080pD_xUr1jOW3y6QSg92sSSZhEYObPze2RWktoY,26304
+chunkr_ai/resources/health.py,sha256=XTvUtRs5hEK-uccb_40mcIex85eEUo1a171nQUjpSOs,4965
+chunkr_ai/resources/tasks/__init__.py,sha256=W-sclAx_Kfm7OBGlSs694QzNCMkewtz9LU9KRcb8Ud0,976
+chunkr_ai/resources/tasks/parse.py,sha256=um0sw2ZU7bY6AK7LKAS0GxAHUyuSzav_NlhxXPjNjxY,28491
+chunkr_ai/resources/tasks/tasks.py,sha256=UC15zZNpY7u85X_JJudDuNrnpaeULiISaBde4BRHGSw,21653
+chunkr_ai/types/__init__.py,sha256=70x8dXFkNKZJZMQyHDswdY2c-gppLNAda9aqGksZwjM,728
+chunkr_ai/types/delete.py,sha256=EU78fjXpc8-fqvgcFTuJ0ejs5u_UjbhOz5frkeUHvxY,225
+chunkr_ai/types/file.py,sha256=kOxR0g-3A-qOxz2cjuTcq0wFMqPoph9uQuLYQ56zb-c,718
+chunkr_ai/types/file_create_params.py,sha256=eR5tUPv1ZxGk94y6Ps5PDF5AoHsTfPRM9jNxnrEEnCQ,440
+chunkr_ai/types/file_list_params.py,sha256=oJGTf88aAxBhNfmQDbxGT63b95HdSbMXUubKjXM22_U,822
+chunkr_ai/types/file_url.py,sha256=L434WnOXkNmt59dJiaAgT1_3pN3BIsxm2q14zHQK6xY,365
+chunkr_ai/types/file_url_params.py,sha256=ZHfKiy_6B25StdDemulavGcsPggNNMKLWf6KN7xfPTY,413
+chunkr_ai/types/files_page_response.py,sha256=N0Wwr8NeDxF-AX4Zs1HYDMeFoxJ8jxkFoCADgt6bZik,506
+chunkr_ai/types/health_check_response.py,sha256=6Zn5YYHCQf2RgMjDlf39mtiTPqfaBfC9Vv599U_rKCI,200
+chunkr_ai/types/task.py,sha256=aew6aT0ngKtwgfUCSCvMTJOBQL1Xp0F0otB_wxumIGQ,46703
+chunkr_ai/types/task_get_params.py,sha256=Nx2luhebcoaiuRln4KP4FarWvBPd1OYi__efi56zHPM,460
+chunkr_ai/types/task_list_params.py,sha256=fCku42QW6QUsLmZgKJBaxisGvUcmcQ5fa6LgHHRIwiQ,1043
+chunkr_ai/types/tasks/__init__.py,sha256=VdLEmQvgPoiykSEYaRhkMYVaIueGDkR4P_MjCq9SbQY,267
+chunkr_ai/types/tasks/parse_create_params.py,sha256=PBg2VR_OnBdB8K4NihuefGJXgUXBn7v5317LZG7PDks,34340
+chunkr_ai/types/tasks/parse_update_params.py,sha256=B1cKfdX_cNDh0m2zDoH0FiZP_Qc-a5GFy-5iXHDHuy8,34113
+chunkr_ai-0.1.0a3.dist-info/METADATA,sha256=1KrH5ko1te-nf_LOutXz2FeuCG8BErWw2WdXFDrXMKc,16441
+chunkr_ai-0.1.0a3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+chunkr_ai-0.1.0a3.dist-info/licenses/LICENSE,sha256=3FDRL-L-DFkrFy8yJpb1Nxhuztm0PB2kawcCgK5utFg,11336
+chunkr_ai-0.1.0a3.dist-info/RECORD,,