♻️ add integration failure reporting & update documentation (#216)

Author: sebastianMindee

.github/workflows/test-code-samples.yml

@@ -45,3 +45,13 @@ jobs:
       - name: Tests code samples
         run: |
             ./tests/test_code_samples.sh ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }} ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }} ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
+
+      - name: Notify Slack Action on Failure
+        uses: ravsamhq/notify-slack-action@2.3.0
+        if: ${{ always() && github.ref_name == 'main' }}
+        with:
+          status: ${{ job.status }}
+          notify_when: "failure"
+          notification_title: "{workflow} is failing"
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.PRODUCTION_ISSUES_SLACK_HOOK_URL }}

docs/extras/guide/generated_v1.md

@@ -7,24 +7,24 @@ Generated APIs can theoretically support all APIs in a catch-all generic format.
 # Quick-Start
 
 ```python
-from mindee import Client, product
+from mindee import Client, PredictResponse, product
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")
 
-# Add your custom endpoint (document)
+# Add the corresponding endpoint (document). Set the account_name to "mindee" if you are using OTS.
 my_endpoint = mindee_client.create_endpoint(
     account_name="my-account",
     endpoint_name="my-endpoint",
-    version="my-version" # Note: version should be always provided when using for OTS products
+    version="my-version"
 )
 
 # Load a file from disk
 input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
 
 # Parse the file.
 # The endpoint must be specified since it cannot be determined from the class.
-result = mindee_client.parse(
+result: PredictResponse = mindee_client.enqueue_and_parse(
     product.GeneratedV1,
     input_doc,
     endpoint=my_endpoint
@@ -33,9 +33,9 @@ result = mindee_client.parse(
 # Print a brief summary of the parsed data
 print(result.document)
 
-# Iterate over all the fields in the document
-for field_name, field_values in result.document.fields.items():
-    print(field_name, "=", field_values)
+# # Iterate over all the fields in the document
+# for field_name, field_values in result.document.inference.prediction.fields.items():
+#     print(field_name, "=", field_values)
 ```
 
 # Generated Endpoints

mindee/parsing/generated/generated_object.py

@@ -46,7 +46,7 @@ def __init__(
 
     def _str_level(self, level=0) -> str:
         """
-        ReSTructured-complient string representation.
+        ReSTructured-compliant string representation.
 
         Takes into account level of indentation & displays elements as list elements.