Batch refactor update (#49)

Author: gregorybchris

docs/batch/batch-job-info.md

@@ -0,0 +1 @@
+::: hume._batch.batch_job_info.BatchJobInfo

docs/batch/batch-job-result.md

@@ -0,0 +1 @@
+::: hume._batch.batch_job_state.BatchJobState

docs/batch/batch-job-state.md

@@ -36,10 +36,12 @@ job = client.submit_job(urls, [config])
 print(job)
 print("Running...")
 
-result = job.await_complete()
-result.download_predictions("predictions.json")
+job.await_complete()
+job.download_predictions("predictions.json")
+print("Predictions downloaded to predictions.json")
 
-print("Predictions downloaded!")
+job.download_artifacts("artifacts.zip")
+print("Artifacts downloaded to artifacts.zip")
 ```
 
 ### Rehydrate a batch job from a job ID

docs/index.md

@@ -30,15 +30,15 @@
     "print(job)\n",
     "print(\"Running...\")\n",
     "\n",
-    "result = job.await_complete()\n",
+    "job.await_complete()\n",
     "download_filepath = \"predictions.json\"\n",
-    "result.download_predictions(download_filepath)\n",
+    "job.download_predictions(download_filepath)\n",
     "\n",
     "print(\"Predictions ready!\")\n",
     "print()\n",
     "\n",
-    "with open(\"predictions.json\", \"r\") as fp:\n",
-    "    predictions = json.load(fp)\n",
+    "with open(\"predictions.json\", \"r\") as f:\n",
+    "    predictions = json.load(f)\n",
     "    for prediction in predictions:\n",
     "        for file_data in prediction[\"files\"]:\n",
     "            face_predictions = file_data[\"models\"][\"face\"]\n",

examples/batch-facial-action-coding-system/batch-facial-action-coding-system.ipynb

@@ -30,15 +30,15 @@
         "print(job)\n",
         "print(\"Running...\")\n",
         "\n",
-        "result = job.await_complete()\n",
+        "job.await_complete()\n",
         "download_filepath = \"predictions.json\"\n",
-        "result.download_predictions(download_filepath)\n",
+        "job.download_predictions(download_filepath)\n",
         "\n",
         "print(\"Predictions ready!\")\n",
         "print()\n",
         "\n",
-        "with open(\"predictions.json\", \"r\") as fp:\n",
-        "    predictions = json.load(fp)\n",
+        "with open(\"predictions.json\", \"r\") as f:\n",
+        "    predictions = json.load(f)\n",
         "    for prediction in predictions:\n",
         "        for file_data in prediction[\"files\"]:\n",
         "            ner_predictions = file_data[\"models\"][\"ner\"]\n",

examples/batch-text-entity-recognition/batch-text-entity-recognition.ipynb

@@ -30,15 +30,15 @@
         "print(job)\n",
         "print(\"Running...\")\n",
         "\n",
-        "result = job.await_complete()\n",
+        "job.await_complete()\n",
         "download_filepath = \"predictions.json\"\n",
-        "result.download_predictions(download_filepath)\n",
+        "job.download_predictions(download_filepath)\n",
         "\n",
         "print(\"Predictions ready!\")\n",
         "print()\n",
         "\n",
-        "with open(\"predictions.json\", \"r\") as fp:\n",
-        "    predictions = json.load(fp)\n",
+        "with open(\"predictions.json\", \"r\") as f:\n",
+        "    predictions = json.load(f)\n",
         "    for prediction in predictions:\n",
         "        for file_data in prediction[\"files\"]:\n",
         "            language_predictions = file_data[\"models\"][\"language\"]\n",

examples/batch-text-sentiment-analysis/batch-text-sentiment-analysis.ipynb

@@ -30,15 +30,15 @@
         "print(job)\n",
         "print(\"Running...\")\n",
         "\n",
-        "result = job.await_complete()\n",
+        "job.await_complete()\n",
         "download_filepath = \"predictions.json\"\n",
-        "result.download_predictions(download_filepath)\n",
+        "job.download_predictions(download_filepath)\n",
         "\n",
         "print(\"Predictions ready!\")\n",
         "print()\n",
         "\n",
-        "with open(\"predictions.json\", \"r\") as fp:\n",
-        "    predictions = json.load(fp)\n",
+        "with open(\"predictions.json\", \"r\") as f:\n",
+        "    predictions = json.load(f)\n",
         "    for prediction in predictions:\n",
         "        for file_data in prediction[\"files\"]:\n",
         "            language_predictions = file_data[\"models\"][\"language\"]\n",

examples/batch-text-toxicity-detection/batch-text-toxicity-detection.ipynb

@@ -32,14 +32,14 @@
         "print(job)\n",
         "print(\"Running...\")\n",
         "\n",
-        "result = job.await_complete()\n",
+        "job.await_complete()\n",
         "download_filepath = \"predictions.json\"\n",
-        "result.download_predictions(download_filepath)\n",
+        "job.download_predictions(download_filepath)\n",
         "\n",
         "print(\"Predictions ready!\")\n",
         "\n",
-        "with open(\"predictions.json\", \"r\") as fp:\n",
-        "    predictions = json.load(fp)\n",
+        "with open(\"predictions.json\", \"r\") as f:\n",
+        "    predictions = json.load(f)\n",
         "    for prediction in predictions:\n",
         "        for file_data in prediction[\"files\"]:\n",
         "            print()\n",

examples/batch-voice-expression/batch-voice-expression.ipynb

@@ -1,7 +1,7 @@
 """Module init."""
 from importlib.metadata import version
 
-from hume._batch import BatchJob, BatchJobResult, BatchJobStatus, HumeBatchClient
+from hume._batch import BatchJob, BatchJobInfo, BatchJobState, BatchJobStatus, HumeBatchClient, TranscriptionConfig
 from hume._stream import HumeStreamClient, StreamSocket
 from hume.error.hume_client_exception import HumeClientException
 
@@ -10,10 +10,12 @@
 __all__ = [
     "__version__",
     "BatchJob",
-    "BatchJobResult",
+    "BatchJobInfo",
+    "BatchJobState",
     "BatchJobStatus",
     "HumeBatchClient",
     "HumeClientException",
     "HumeStreamClient",
     "StreamSocket",
+    "TranscriptionConfig",
 ]