Merge pull request #50 from veryfi/add-classify-document-api

Add support for Classify Document API

Author: dbirulia

tests/test_bank_statements.py

@@ -2,7 +2,6 @@
 
 from veryfi import Client
 
-
 MOCK = {
     "transactions": [
         {

tests/test_bussines_cards.py

@@ -2,7 +2,6 @@
 
 from veryfi import Client
 
-
 MOCK = {
     "text": "Dmitry Birulia\ndmitry@veryfi.com\nVERYFI\twww.veryfi.com",
     "id": 4662609,

tests/test_checks.py

@@ -2,7 +2,6 @@
 
 from veryfi import Client
 
-
 MOCK = {
     "pdf_url": "https://scdn.veryfi.com/checks/919ba4778c039560/78535c60-e371-40fd-ae78-6d0c019b2c35/067e7057-e38b-4c32-9d87-720e0a8e232f.pdf?Expires=1730233783&Signature=fbR-arwLoH1YC8GVK52SvvilH59eHWIYp1o2WXw5UWr0s0CjKkrJ1Bx-PORKVzLbnJHOoYJDC4lU1iiqdq4~yDyz~-ygRHTNxyT9BJovFSzCBAc3Gnzv7uWMNIp-9mdV0QGk-Fu25eZfwd56Dfd2ZhG-EzreCRfh66r6338UF4EaHK5SG5b4i-NwkDaZ~qRZC6jNzYUJOGbXexYPbQxF5tMinc97ok~~fLQ--r0HWr7SvQyJisUqDnKS0DMTQujDz-7lStMJmvvlQX0jmpdcsq8DBIR6SnWZxHA7tM-ydD27Jt8l753X3uNtZuao61CeGSpQP09CnWlctTewm4IHKQ__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
     "id": 4662680,

tests/test_classify.py

@@ -0,0 +1,53 @@
+import responses
+
+from veryfi import Client
+
+MOCK = {
+    "id": 12345,
+    "document_type": {
+        "score": 0.98,
+        "value": "receipt",
+    },
+}
+
+
+@responses.activate
+def test_classify_document_url():
+    client = Client(client_id="v", client_secret="w", username="o", api_key="c")
+    responses.add(
+        responses.POST,
+        f"{client.versioned_url}/partner/classify/",
+        json=MOCK,
+        status=200,
+    )
+    d = client.classify_document_url(file_url="https://cdn.example.com/receipt.jpg")
+    assert d == MOCK
+
+
+@responses.activate
+def test_classify_document():
+    client = Client(client_id="v", client_secret="w", username="o", api_key="c")
+    responses.add(
+        responses.POST,
+        f"{client.versioned_url}/partner/classify/",
+        json=MOCK,
+        status=200,
+    )
+    d = client.classify_document(file_path="tests/assets/receipt_public.jpg")
+    assert d == MOCK
+
+
+@responses.activate
+def test_classify_document_url_with_document_types():
+    client = Client(client_id="v", client_secret="w", username="o", api_key="c")
+    responses.add(
+        responses.POST,
+        f"{client.versioned_url}/partner/classify/",
+        json=MOCK,
+        status=200,
+    )
+    d = client.classify_document_url(
+        file_url="https://cdn.example.com/receipt.jpg",
+        document_types=["receipt", "invoice", "check"],
+    )
+    assert d == MOCK

tests/test_w2s.py

@@ -2,7 +2,6 @@
 
 from veryfi import Client
 
-
 MOCK = {
     "pdf_url": None,
     "id": 4559395,

tests/test_w8s.py

@@ -2,7 +2,6 @@
 
 from veryfi import Client
 
-
 MOCK = {
     "pdf_url": "https://scdn.veryfi.com/w8s/919ba4778c039560/64ea51e9-4293-4a0e-99a6-8c3cd0a4f7ab/8468d271-2943-46e7-b9a2-3dd0372d3648.pdf?Expires=1730234368&Signature=e1bOil~yK4P4uKYLxX1NPfHA3PxiTxd-Ds4HVnjNXxY22D-ng2NGJQQrWAst5E0ionsdkkFPc7mKy0fp6MkmwnZF~I-j8e1P9fhbI-T-0NhiDji4gp6xt4~vm-i9MG34K~Xa3TWPA~kMbQ~Hj2gjiMMniXsH6HeqH99yfl-Vt2ZWEMdWl3~ZlMWEpnPVIzDXdDBc~uRYCOS0KiLD2pfNAORYwp1ayNiuhiJzucJPAfRuK00y0BoUEPBmBS-aLa62VhNYVKmUPtVNobS2MjcGcnqnBhOZlbw0B5VTLNqrSIgKSVy6I6Co4zAwLjgviQyoPArVtgmJR8UNdFRk9LuDqw__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
     "id": 4662698,

tests/test_w9s.py

@@ -2,7 +2,6 @@
 
 from veryfi import Client
 
-
 MOCK = {
     "account_numbers": "",
     "address1": "28 E 3rd Ave, Suite 201",

veryfi/classify.py

@@ -0,0 +1,65 @@
+import os
+import base64
+from typing import Dict, List, Optional
+
+from veryfi.client_base import Client
+
+
+class Classify:
+    def __init__(self, client: Client):
+        self.client = client
+
+    def classify_document(
+        self,
+        file_path: str,
+        document_types: Optional[List] = None,
+        **kwargs,
+    ) -> Dict:
+        """
+        Classify a document from a file path.
+        https://docs.veryfi.com/api/classify/classify-a-document/
+
+        :param file_path: Path on disk to a file to submit for classification
+        :param document_types: Optional list of document types to classify into. If omitted, a preset set of types will be used.
+        :param kwargs: Additional body parameters
+        :return: Classification result with document type prediction
+        """
+        endpoint_name = "/classify/"
+        file_name = os.path.basename(file_path)
+        with open(file_path, "rb") as image_file:
+            base64_encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
+        request_arguments = {
+            "file_name": file_name,
+            "file_data": base64_encoded_string,
+        }
+        if document_types is not None:
+            request_arguments["document_types"] = document_types
+        request_arguments.update(kwargs)
+        return self.client._request("POST", endpoint_name, request_arguments)
+
+    def classify_document_url(
+        self,
+        file_url: Optional[str] = None,
+        file_urls: Optional[List[str]] = None,
+        document_types: Optional[List] = None,
+        **kwargs,
+    ) -> Dict:
+        """
+        Classify a document from a URL.
+        https://docs.veryfi.com/api/classify/classify-a-document/
+
+        :param file_url: Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
+        :param file_urls: Required if file_url isn't specified. List of publicly accessible URLs to multiple files.
+        :param document_types: Optional list of document types to classify into. If omitted, a preset set of types will be used.
+        :param kwargs: Additional body parameters
+        :return: Classification result with document type prediction
+        """
+        endpoint_name = "/classify/"
+        request_arguments = {
+            "file_url": file_url,
+            "file_urls": file_urls,
+        }
+        if document_types is not None:
+            request_arguments["document_types"] = document_types
+        request_arguments.update(kwargs)
+        return self.client._request("POST", endpoint_name, request_arguments)

veryfi/client.py

@@ -4,13 +4,16 @@
 from veryfi.bank_statements import BankStatements
 from veryfi.bussines_cards import BussinesCards
 from veryfi.checks import Checks
+from veryfi.classify import Classify
 from veryfi.documents import Documents
 from veryfi.w2s import W2s
 from veryfi.w8s import W8s
 from veryfi.w9s import W9s
 
 
-class Client(ClientBase, ADocs, BankStatements, BussinesCards, Checks, Documents, W2s, W8s, W9s):
+class Client(
+    ClientBase, ADocs, BankStatements, BussinesCards, Checks, Classify, Documents, W2s, W8s, W9s
+):
     def __init__(
         self,
         client_id: str,
@@ -34,6 +37,7 @@ def __init__(
         BankStatements.__init__(self, super())
         BussinesCards.__init__(self, super())
         Checks.__init__(self, super())
+        Classify.__init__(self, super())
         Documents.__init__(self, super())
         W2s.__init__(self, super())
         W8s.__init__(self, super())