llama-cloud 0.0.8__py3-none-any.whl → 0.0.10__py3-none-any.whl

llama_cloud/resources/extraction/client.py

@@ -9,6 +9,7 @@ from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.remove_none_from_dict import remove_none_from_dict
 from ...errors.unprocessable_entity_error import UnprocessableEntityError
+from ...types.extraction_job import ExtractionJob
 from ...types.extraction_result import ExtractionResult
 from ...types.extraction_schema import ExtractionSchema
 from ...types.http_validation_error import HttpValidationError
@@ -31,17 +32,25 @@ class ExtractionClient:
         self._client_wrapper = client_wrapper
 
     def infer_schema(
-        self, *, name: str, project_id: typing.Optional[str] = OMIT, file_ids: typing.List[str], openai_api_key: str
+        self,
+        *,
+        schema_id: typing.Optional[str] = OMIT,
+        name: str,
+        project_id: typing.Optional[str] = OMIT,
+        file_ids: typing.List[str],
+        stream: typing.Optional[bool] = OMIT,
     ) -> ExtractionSchema:
         """
         Parameters:
+            - schema_id: typing.Optional[str]. The ID of a schema to update with the new schema
+
             - name: str. The name of the extraction schema
 
             - project_id: typing.Optional[str]. The ID of the project that the extraction schema belongs to
 
             - file_ids: typing.List[str]. The IDs of the files that the extraction schema contains
 
-            - openai_api_key: str. The API key for the OpenAI API
+            - stream: typing.Optional[bool]. Whether to stream the results of the extraction schema
         ---
         from llama_cloud.client import LlamaCloud
 
@@ -51,12 +60,15 @@ class ExtractionClient:
         client.extraction.infer_schema(
             name="string",
             file_ids=[],
-            openai_api_key="string",
         )
         """
-        _request: typing.Dict[str, typing.Any] = {"name": name, "file_ids": file_ids, "openai_api_key": openai_api_key}
+        _request: typing.Dict[str, typing.Any] = {"name": name, "file_ids": file_ids}
+        if schema_id is not OMIT:
+            _request["schema_id"] = schema_id
         if project_id is not OMIT:
             _request["project_id"] = project_id
+        if stream is not OMIT:
+            _request["stream"] = stream
         _response = self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "api/v1/extraction/schemas/infer"),
@@ -138,15 +150,12 @@ class ExtractionClient:
         schema_id: str,
         *,
         data_schema: typing.Optional[typing.Dict[str, ExtractionSchemaUpdateDataSchemaValue]] = OMIT,
-        openai_api_key: typing.Optional[str] = OMIT,
     ) -> ExtractionSchema:
         """
         Parameters:
             - schema_id: str.
 
             - data_schema: typing.Optional[typing.Dict[str, ExtractionSchemaUpdateDataSchemaValue]]. The schema of the data
-
-            - openai_api_key: typing.Optional[str]. The API key for the OpenAI API
         ---
         from llama_cloud.client import LlamaCloud
 
@@ -160,8 +169,6 @@ class ExtractionClient:
         _request: typing.Dict[str, typing.Any] = {}
         if data_schema is not OMIT:
             _request["data_schema"] = data_schema
-        if openai_api_key is not OMIT:
-            _request["openai_api_key"] = openai_api_key
         _response = self._client_wrapper.httpx_client.request(
             "PUT",
             urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", f"api/v1/extraction/schemas/{schema_id}"),
@@ -179,17 +186,19 @@ class ExtractionClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def list_jobs(self, *, schema_id: typing.Optional[str] = None) -> typing.List[ExtractionResult]:
+    def list_jobs(self, *, schema_id: str) -> typing.List[ExtractionJob]:
         """
         Parameters:
-            - schema_id: typing.Optional[str].
+            - schema_id: str.
         ---
         from llama_cloud.client import LlamaCloud
 
         client = LlamaCloud(
             token="YOUR_TOKEN",
         )
-        client.extraction.list_jobs()
+        client.extraction.list_jobs(
+            schema_id="string",
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "GET",
@@ -199,7 +208,7 @@ class ExtractionClient:
             timeout=60,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic.parse_obj_as(typing.List[ExtractionResult], _response.json())  # type: ignore
+            return pydantic.parse_obj_as(typing.List[ExtractionJob], _response.json())  # type: ignore
         if _response.status_code == 422:
             raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
         try:
@@ -208,7 +217,7 @@ class ExtractionClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def run_job(self, *, schema_id: str, file_id: str) -> ExtractionResult:
+    def run_job(self, *, schema_id: str, file_id: str) -> ExtractionJob:
         """
         Parameters:
             - schema_id: str. The id of the schema
@@ -233,7 +242,7 @@ class ExtractionClient:
             timeout=60,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic.parse_obj_as(ExtractionResult, _response.json())  # type: ignore
+            return pydantic.parse_obj_as(ExtractionJob, _response.json())  # type: ignore
         if _response.status_code == 422:
             raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
         try:
@@ -242,7 +251,7 @@ class ExtractionClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def get_job(self, job_id: str) -> ExtractionResult:
+    def get_job(self, job_id: str) -> ExtractionJob:
         """
         Parameters:
             - job_id: str.
@@ -263,7 +272,7 @@ class ExtractionClient:
             timeout=60,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic.parse_obj_as(ExtractionResult, _response.json())  # type: ignore
+            return pydantic.parse_obj_as(ExtractionJob, _response.json())  # type: ignore
         if _response.status_code == 422:
             raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
         try:
@@ -272,7 +281,7 @@ class ExtractionClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def run_jobs_in_batch(self, *, schema_id: str, file_ids: typing.List[str]) -> typing.List[ExtractionResult]:
+    def run_jobs_in_batch(self, *, schema_id: str, file_ids: typing.List[str]) -> typing.List[ExtractionJob]:
         """
         Parameters:
             - schema_id: str. The id of the schema
@@ -297,7 +306,7 @@ class ExtractionClient:
             timeout=60,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic.parse_obj_as(typing.List[ExtractionResult], _response.json())  # type: ignore
+            return pydantic.parse_obj_as(typing.List[ExtractionJob], _response.json())  # type: ignore
         if _response.status_code == 422:
             raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
         try:
@@ -342,17 +351,25 @@ class AsyncExtractionClient:
         self._client_wrapper = client_wrapper
 
     async def infer_schema(
-        self, *, name: str, project_id: typing.Optional[str] = OMIT, file_ids: typing.List[str], openai_api_key: str
+        self,
+        *,
+        schema_id: typing.Optional[str] = OMIT,
+        name: str,
+        project_id: typing.Optional[str] = OMIT,
+        file_ids: typing.List[str],
+        stream: typing.Optional[bool] = OMIT,
     ) -> ExtractionSchema:
         """
         Parameters:
+            - schema_id: typing.Optional[str]. The ID of a schema to update with the new schema
+
             - name: str. The name of the extraction schema
 
             - project_id: typing.Optional[str]. The ID of the project that the extraction schema belongs to
 
             - file_ids: typing.List[str]. The IDs of the files that the extraction schema contains
 
-            - openai_api_key: str. The API key for the OpenAI API
+            - stream: typing.Optional[bool]. Whether to stream the results of the extraction schema
         ---
         from llama_cloud.client import AsyncLlamaCloud
 
@@ -362,12 +379,15 @@ class AsyncExtractionClient:
         await client.extraction.infer_schema(
             name="string",
             file_ids=[],
-            openai_api_key="string",
         )
         """
-        _request: typing.Dict[str, typing.Any] = {"name": name, "file_ids": file_ids, "openai_api_key": openai_api_key}
+        _request: typing.Dict[str, typing.Any] = {"name": name, "file_ids": file_ids}
+        if schema_id is not OMIT:
+            _request["schema_id"] = schema_id
         if project_id is not OMIT:
             _request["project_id"] = project_id
+        if stream is not OMIT:
+            _request["stream"] = stream
         _response = await self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "api/v1/extraction/schemas/infer"),
@@ -449,15 +469,12 @@ class AsyncExtractionClient:
         schema_id: str,
         *,
         data_schema: typing.Optional[typing.Dict[str, ExtractionSchemaUpdateDataSchemaValue]] = OMIT,
-        openai_api_key: typing.Optional[str] = OMIT,
     ) -> ExtractionSchema:
         """
         Parameters:
             - schema_id: str.
 
             - data_schema: typing.Optional[typing.Dict[str, ExtractionSchemaUpdateDataSchemaValue]]. The schema of the data
-
-            - openai_api_key: typing.Optional[str]. The API key for the OpenAI API
         ---
         from llama_cloud.client import AsyncLlamaCloud
 
@@ -471,8 +488,6 @@ class AsyncExtractionClient:
         _request: typing.Dict[str, typing.Any] = {}
         if data_schema is not OMIT:
             _request["data_schema"] = data_schema
-        if openai_api_key is not OMIT:
-            _request["openai_api_key"] = openai_api_key
         _response = await self._client_wrapper.httpx_client.request(
             "PUT",
             urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", f"api/v1/extraction/schemas/{schema_id}"),
@@ -490,17 +505,19 @@ class AsyncExtractionClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def list_jobs(self, *, schema_id: typing.Optional[str] = None) -> typing.List[ExtractionResult]:
+    async def list_jobs(self, *, schema_id: str) -> typing.List[ExtractionJob]:
         """
         Parameters:
-            - schema_id: typing.Optional[str].
+            - schema_id: str.
         ---
         from llama_cloud.client import AsyncLlamaCloud
 
         client = AsyncLlamaCloud(
             token="YOUR_TOKEN",
         )
-        await client.extraction.list_jobs()
+        await client.extraction.list_jobs(
+            schema_id="string",
+        )
         """
         _response = await self._client_wrapper.httpx_client.request(
             "GET",
@@ -510,7 +527,7 @@ class AsyncExtractionClient:
             timeout=60,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic.parse_obj_as(typing.List[ExtractionResult], _response.json())  # type: ignore
+            return pydantic.parse_obj_as(typing.List[ExtractionJob], _response.json())  # type: ignore
         if _response.status_code == 422:
             raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
         try:
@@ -519,7 +536,7 @@ class AsyncExtractionClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def run_job(self, *, schema_id: str, file_id: str) -> ExtractionResult:
+    async def run_job(self, *, schema_id: str, file_id: str) -> ExtractionJob:
         """
         Parameters:
             - schema_id: str. The id of the schema
@@ -544,7 +561,7 @@ class AsyncExtractionClient:
             timeout=60,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic.parse_obj_as(ExtractionResult, _response.json())  # type: ignore
+            return pydantic.parse_obj_as(ExtractionJob, _response.json())  # type: ignore
         if _response.status_code == 422:
             raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
         try:
@@ -553,7 +570,7 @@ class AsyncExtractionClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def get_job(self, job_id: str) -> ExtractionResult:
+    async def get_job(self, job_id: str) -> ExtractionJob:
         """
         Parameters:
             - job_id: str.
@@ -574,7 +591,7 @@ class AsyncExtractionClient:
             timeout=60,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic.parse_obj_as(ExtractionResult, _response.json())  # type: ignore
+            return pydantic.parse_obj_as(ExtractionJob, _response.json())  # type: ignore
         if _response.status_code == 422:
             raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
         try:
@@ -583,7 +600,7 @@ class AsyncExtractionClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def run_jobs_in_batch(self, *, schema_id: str, file_ids: typing.List[str]) -> typing.List[ExtractionResult]:
+    async def run_jobs_in_batch(self, *, schema_id: str, file_ids: typing.List[str]) -> typing.List[ExtractionJob]:
         """
         Parameters:
             - schema_id: str. The id of the schema
@@ -608,7 +625,7 @@ class AsyncExtractionClient:
             timeout=60,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic.parse_obj_as(typing.List[ExtractionResult], _response.json())  # type: ignore
+            return pydantic.parse_obj_as(typing.List[ExtractionJob], _response.json())  # type: ignore
         if _response.status_code == 422:
             raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
         try:

llama_cloud/resources/organizations/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+