Merge pull request #7 from Zipstack/feat/includeMetadata

Added include_metadata feature and some fixes

Author: ritwik-g

.pre-commit-config.yaml

@@ -52,7 +52,7 @@ repos:
     rev: 24.2.0
     hooks:
       - id: black
-        args: [--config=pyproject.toml, -l 120]
+        args: [--config=pyproject.toml, -l 88]
         language: system
         exclude: |
           (?x)^(
@@ -62,7 +62,7 @@ repos:
     rev: 7.0.0
     hooks:
       - id: flake8
-        args: [--max-line-length=120]
+        args: [--max-line-length=88]
         exclude: |
           (?x)^(
               .*migrations/.*\.py|

README.md

@@ -38,6 +38,7 @@ try:
         api_key=os.getenv("UNSTRACT_API_DEPLOYMENT_KEY"),
         api_timeout=10,
         logging_level="DEBUG",
+        include_metadata=False # optional
     )
     # Replace files with pdfs
     response = adc.structure_file(
@@ -58,6 +59,12 @@ except APIDeploymentsClientException as e:
     print(e)
 ```
 
+## Parameter Details
+
+`api_timeout`: Set a timeout for API requests, e.g., `api_timeout=10`.
+`logging_level`: Set logging verbosity (e.g., "`DEBUG`").
+`include_metadata`: If set to `True`, the response will include additional metadata (cost, tokens consumed and context) for each call made by the Prompt Studio exported tool.
+
 
 ## Questions and Feedback