Skip to content

Latest commit

 

History

History
391 lines (303 loc) · 10.9 KB

ImageProcessingApi.md

File metadata and controls

391 lines (303 loc) · 10.9 KB
Raw

ImageProcessingApi

All URIs are relative to http://localhost

Method HTTP request Description
getResultFile GET /v5.0/ocr/ImageProcessing/GetResultFile GetResultFile
getResultTask GET /v5.0/ocr/ImageProcessing/GetResultTask GetResultTask
postBinarizationFile POST /v5.0/ocr/ImageProcessing/PostBinarizationFile PostBinarizationFile
postDewarpingFile POST /v5.0/ocr/ImageProcessing/PostDewarpingFile PostDewarpingFile
postSkewCorrectionFile POST /v5.0/ocr/ImageProcessing/PostSkewCorrectionFile PostSkewCorrectionFile
postUpsamplingFile POST /v5.0/ocr/ImageProcessing/PostUpsamplingImageFile PostUpsamplingImageFile

getResultFile

Object getResultFile(id)

GetResultFile

Example

// Import classes:
import Aspose.OCR.Cloud.SDK.ApiClient;
import Aspose.OCR.Cloud.SDK.ApiException;
import Aspose.OCR.Cloud.SDK.Configuration;
import Aspose.OCR.Cloud.SDK.auth.*;
import Aspose.OCR.Cloud.SDK.models.*;
import Aspose.OCR.Cloud.SDK.ImageProcessingApi;

public class Example {
  public static void main(String[] args) {
    
    String clientId = "";
    String clientSecret = "";
    // Creating new API instance with your credentials
    ImageProcessingApi apiInstance = new ImageProcessingApi(clientId, clientSecret);
    String id = "id_example"; // String | 
    try {
      Object result = apiInstance.getResultFile(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageProcessingApi#getResultFile");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id String

Return type

Object

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: image/png

HTTP response details

Status code Description Response headers
200 Success -
204 Rsults expired -

getResultTask

OCRResponse getResultTask(id)

GetResultTask

Example

// Import classes:
import Aspose.OCR.Cloud.SDK.ApiClient;
import Aspose.OCR.Cloud.SDK.ApiException;
import Aspose.OCR.Cloud.SDK.Configuration;
import Aspose.OCR.Cloud.SDK.auth.*;
import Aspose.OCR.Cloud.SDK.models.*;
import Aspose.OCR.Cloud.SDK.ImageProcessingApi;

public class Example {
  public static void main(String[] args) {
    
    String clientId = "";
    String clientSecret = "";
    // Creating new API instance with your credentials
    ImageProcessingApi apiInstance = new ImageProcessingApi(clientId, clientSecret);
    String id = "id_example"; // String | 
    try {
      OCRResponse result = apiInstance.getResultTask(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageProcessingApi#getResultTask");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id String

Return type

OCRResponse

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -

postBinarizationFile

String postBinarizationFile(_file)

PostBinarizationFile

Example

// Import classes:
import Aspose.OCR.Cloud.SDK.ApiClient;
import Aspose.OCR.Cloud.SDK.ApiException;
import Aspose.OCR.Cloud.SDK.Configuration;
import Aspose.OCR.Cloud.SDK.auth.*;
import Aspose.OCR.Cloud.SDK.models.*;
import Aspose.OCR.Cloud.SDK.ImageProcessingApi;

public class Example {
  public static void main(String[] args) {
    
    String clientId = "";
    String clientSecret = "";
    // Creating new API instance with your credentials
    ImageProcessingApi apiInstance = new ImageProcessingApi(clientId, clientSecret);
    File _file = new File("/path/to/file"); // File | 
    try {
      String result = apiInstance.postBinarizationFile(_file);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageProcessingApi#postBinarizationFile");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
_file File [optional]

Return type

String

Authorization

JWT

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -

postDewarpingFile

String postDewarpingFile(_file)

PostDewarpingFile

Example

// Import classes:
import Aspose.OCR.Cloud.SDK.ApiClient;
import Aspose.OCR.Cloud.SDK.ApiException;
import Aspose.OCR.Cloud.SDK.Configuration;
import Aspose.OCR.Cloud.SDK.auth.*;
import Aspose.OCR.Cloud.SDK.models.*;
import Aspose.OCR.Cloud.SDK.ImageProcessingApi;

public class Example {
  public static void main(String[] args) {
    
    String clientId = "";
    String clientSecret = "";
    // Creating new API instance with your credentials
    ImageProcessingApi apiInstance = new ImageProcessingApi(clientId, clientSecret);
    File _file = new File("/path/to/file"); // File | 
    try {
      String result = apiInstance.postDewarpingFile(_file);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageProcessingApi#postDewarpingFile");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
_file File [optional]

Return type

String

Authorization

JWT

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -

postSkewCorrectionFile

String postSkewCorrectionFile(_file)

PostSkewCorrectionFile

Example

// Import classes:
import Aspose.OCR.Cloud.SDK.ApiClient;
import Aspose.OCR.Cloud.SDK.ApiException;
import Aspose.OCR.Cloud.SDK.Configuration;
import Aspose.OCR.Cloud.SDK.auth.*;
import Aspose.OCR.Cloud.SDK.models.*;
import Aspose.OCR.Cloud.SDK.ImageProcessingApi;

public class Example {
  public static void main(String[] args) {
    
    String clientId = "";
    String clientSecret = "";
    // Creating new API instance with your credentials
    ImageProcessingApi apiInstance = new ImageProcessingApi(clientId, clientSecret);
    File _file = new File("/path/to/file"); // File | 
    try {
      String result = apiInstance.postSkewCorrectionFile(_file);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageProcessingApi#postSkewCorrectionFile");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
_file File [optional]

Return type

String

Authorization

JWT

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -

postUpsamplingFile

String postUpsamplingFile(_file)

PostUpsamplingImageFile

Example

// Import classes:
import Aspose.OCR.Cloud.SDK.ApiClient;
import Aspose.OCR.Cloud.SDK.ApiException;
import Aspose.OCR.Cloud.SDK.Configuration;
import Aspose.OCR.Cloud.SDK.auth.*;
import Aspose.OCR.Cloud.SDK.models.*;
import Aspose.OCR.Cloud.SDK.ImageProcessingApi;

public class Example {
  public static void main(String[] args) {
    
    String clientId = "";
    String clientSecret = "";
    // Creating new API instance with your credentials
    ImageProcessingApi apiInstance = new ImageProcessingApi(clientId, clientSecret);
    File _file = new File("/path/to/file"); // File | 
    try {
      String result = apiInstance.postUpsamplingFile(_file);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageProcessingApi#postUpsamplingFile");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
_file File [optional]

Return type

String

Authorization

JWT

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -