OCRAnalysesApi.md

core_openapi.api.OCRAnalysesApi

Load the API package

import 'package:pieces_os_client/api.dart';

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
ocrAnalysesSnapshot	GET /ocr_analyses	Your GET endpoint

ocrAnalysesSnapshot

OCRAnalyses ocrAnalysesSnapshot(transferables)

Your GET endpoint

This will get a snapshot of all of your ocr analyses, an ocr analysis is attached to an image analysis.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = OCRAnalysesApi();
final transferables = true; // bool | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)

try {
    final result = api_instance.ocrAnalysesSnapshot(transferables);
    print(result);
} catch (e) {
    print('Exception when calling OCRAnalysesApi->ocrAnalysesSnapshot: $e\n');
}

Parameters

Name	Type	Description	Notes
transferables	bool	This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)	[optional]

Return type

OCRAnalyses

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]