Extraction option Internal

AI Pedant Document Service API (proto file)

This document describes the gRPC API defined in the document_service.proto file for document-related internal communication functionalities.

Dependencies

google/protobuf/empty.proto: Used for empty response messages.
common.proto: Likely defines shared message types used across other services.

Services

The ExtractionOptionsInternalService offers gRPC methods for managing extraction options for invoices and delivery notes.

Functions:

CreateInvoiceExtractionOptions: Creates extraction options for an invoice for the specified company.
CreateDeliveryNoteExtractionOptions: Creates extraction options for a delivery note for the specified company.
DeleteInvoiceExtractionOptions: Deletes extraction options for an invoice based on the provided ID.
DeleteDeliveryNoteExtractionOptions: Deletes extraction options for a delivery note based on the provided ID.

Messages

CreateInvoiceExtractionOptionsRequest:

companyId: Identifier of the company for which to create the extraction options.

CreateDeliveryNoteExtractionOptionsRequest:

companyId: Identifier of the company for which to create the extraction options.

DeleteInvoiceExtractionOptionsRequest:

id: Identifier of the extraction options to be deleted.

DeleteDeliveryNoteExtractionOptionsRequest:

id: Identifier of the extraction options to be deleted.

Proto Definition (Markdown format)

syntax = "proto3";

package ai.pedant.srv.document;

option java_package = "ai.pedant.srv.document";
option go_package = "pedant.ai/pedant-document-service/grpc-gateway";

import "google/protobuf/empty.proto";
import "common.proto";

service ExtractionOptionsInternalService {
  rpc CreateInvoiceExtractionOptions (CreateInvoiceExtractionOptionsRequest) returns (ExtractionOptions);
  rpc CreateDeliveryNoteExtractionOptions (CreateDeliveryNoteExtractionOptionsRequest) returns (ExtractionOptions);
  rpc DeleteInvoiceExtractionOptions (DeleteInvoiceExtractionOptionsRequest) returns (google.protobuf.Empty);
  rpc DeleteDeliveryNoteExtractionOptions (DeleteDeliveryNoteExtractionOptionsRequest) returns (google.protobuf.Empty);
}

message CreateInvoiceExtractionOptionsRequest {
  string companyId = 1;
}

message CreateDeliveryNoteExtractionOptionsRequest {
  string companyId = 1;
}

message DeleteInvoiceExtractionOptionsRequest {
  string id = 1;
}

message DeleteDeliveryNoteExtractionOptionsRequest {
  string id = 1;
}

Last modified: 20 October 2024