package ocr_service

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Detect (DetectRequest, DetectResponse)

  ocr_service.proto:9

  message DetectRequest

  ocr_service.proto:85

  • string id = 1

  • string language_code = 2

  • bool crop_image = 3

  • bytes image_bytes = 4

  • string ocr_engine = 5

    MangaOCR | PaddleOCR | AppleVision

  message DetectResponse

  ocr_service.proto:98

  • string id = 1

  • repeated DetectionResult results = 2

  • optional ContextResolution context_resolution = 3

• rpc GetHardwareAccelerationOptions (GetHardwareAccelerationOptionsRequest, GetHardwareAccelerationOptionsResponse)

  ocr_service.proto:13

  message GetHardwareAccelerationOptionsRequest

  ocr_service.proto:161

  • string ocr_engine = 1

    MangaOCR | PaddleOCR | AppleVision

  message GetHardwareAccelerationOptionsResponse

  ocr_service.proto:164

  • repeated HardwareAccelerationOption options = 1

• rpc GetSupportedLanguages (GetSupportedLanguagesRequest, GetSupportedLanguagesResponse)

  ocr_service.proto:10

  message GetSupportedLanguagesRequest

  ocr_service.proto:77

  • string ocr_engine = 1

    MangaOCR | PaddleOCR | AppleVision

  message GetSupportedLanguagesResponse

  ocr_service.proto:80

  • repeated string language_codes = 1

• rpc GetSupportedModels (GetSupportedModelsRequest, GetSupportedModelsResponse)

  ocr_service.proto:11

  message GetSupportedModelsRequest

  ocr_service.proto:138

  • string ocr_engine = 1

    MangaOCR | PaddleOCR | AppleVision

  • string language_code = 2

  message GetSupportedModelsResponse

  ocr_service.proto:142

  • repeated TextRecognitionModel models = 1

• rpc InstallModel (InstallModelRequest, InstallModelResponse)

  ocr_service.proto:12

  message InstallModelRequest

  ocr_service.proto:146

  • string ocr_engine = 1

    MangaOCR | PaddleOCR | AppleVision

  • string model_name = 2

  message InstallModelResponse

  ocr_service.proto:150

  • bool success = 1

• rpc KeepAlive (KeepAliveRequest, KeepAliveResponse)

  ocr_service.proto:15

  message KeepAliveRequest

  ocr_service.proto:19

  • bool keep_alive = 1

  • int32 timeout_seconds = 2

  message KeepAliveResponse

  ocr_service.proto:23

  (message has no fields)

• rpc MotionDetection (MotionDetectionRequest, MotionDetectionResponse)

  ocr_service.proto:16

  message MotionDetectionRequest

  ocr_service.proto:104

  • string stream_id = 1

  • bytes frame = 2

  • int32 threshold_min = 3

  • int32 threshold_max = 4

  • int32 stream_length = 5

  message MotionDetectionResponse

  ocr_service.proto:111

  • int32 frame_diff_sum = 1

  • int32 frame_threshold_non_zero_count = 2

• rpc RecognizeBase64 (RecognizeBase64Request, RecognizeDefaultResponse)

  ocr_service.proto:8

  message RecognizeBase64Request

  ocr_service.proto:33

  • string id = 1

  • string language_code = 2

  • string base64_image = 3

  • repeated Box boxes = 4

  • string ocr_engine = 5

    MangaOCR | PaddleOCR | AppleVision

  • bool detection_only = 6

• rpc RecognizeBytes (RecognizeBytesRequest, RecognizeDefaultResponse)

  ocr_service.proto:6

  message RecognizeBytesRequest

  ocr_service.proto:25

  • string id = 1

  • string language_code = 2

  • bytes image_bytes = 3

  • repeated Box boxes = 4

  • string ocr_engine = 5

    MangaOCR | PaddleOCR

  • bool detection_only = 6

• rpc RecognizeSelective (RecognizeSelectiveRequest, RecognizeDefaultResponse)

  ocr_service.proto:7

  message RecognizeSelectiveRequest

  ocr_service.proto:169

  • string id = 1

    id of new or cached request

    Required

  • string language_code = 2

  • bytes image_bytes = 3

    Optional

  • string base64_image = 6

    Optional

  • repeated string result_ids = 4

    list of ids of results to be recognized

  • string ocr_engine = 5

    Required; MangaOCR

• rpc UpdatePpOcrSettings (UpdatePpOcrSettingsRequest, UpdateSettingsResponse)

  ocr_service.proto:14

  message UpdatePpOcrSettingsRequest

  ocr_service.proto:117

  • int32 max_image_width = 1

    ppocr "max_side_length"

  • int32 cpu_threads = 2

  • string inference_runtime = 3

  • double det_db_thresh = 4

  • double det_db_box_thresh = 5

  • double det_db_unclip_ratio = 6

  • string det_db_score_mode = 7

  • bool use_dilation = 8

  • double cls_thresh = 9

  message UpdateSettingsResponse

  ocr_service.proto:128

  • bool success = 1

Used in: DetectionResult, RecognizeBase64Request, RecognizeBytesRequest, Result, TextLine

• optional Vertex bottom_left = 1

• optional Vertex bottom_right = 2

• optional Vertex top_left = 3

• optional Vertex top_right = 4

Used in: DetectResponse, RecognizeDefaultResponse

• int32 width = 1

• int32 height = 2

Used in: DetectResponse

• bytes image_bytes = 1

• optional Box box = 2

• repeated TextLine text_lines = 3

Used in: GetHardwareAccelerationOptionsResponse

• string backend = 1

  'Torch' | 'ONNX'

• string compute_platform = 2

  'CPU' | 'CUDA' | 'ROCm' | 'Default';

• string compute_platform_version = 3

• string install_command = 4

• bool installed = 5

Used as response type in: OCRService.RecognizeBase64, OCRService.RecognizeBytes, OCRService.RecognizeSelective

• string id = 1

• repeated Result results = 2

• optional ContextResolution context_resolution = 3

Used in: RecognizeDefaultResponse

• repeated TextLine text_lines = 1

• float recognition_score = 2

• float classification_score = 3

• int32 classification_label = 4

  Text direction

• optional Box box = 5

• bool is_vertical = 6

• string id = 7

• string recognition_state = 8

Used in: DetectionResult, Result

• string content = 1

• optional Box box = 2

Used in: GetSupportedModelsResponse

• string name = 1

• repeated string language_codes = 2

• bool is_installed = 3

Used in: Box

• int32 x = 1

• int32 y = 2