Primo.AI.Server.Linux 1.0.15

About

Primo RPA robot uses elements of the package to automate interaction with Primo AI Server intelligent data recognition server by Primo RPA company.

How to Use

In Primo RPA studio, create a project that will be executed by Primo RPA robot. Install this package via the ".Dependencies → Manage Dependencies" menu; the "AI" node with package elements will appear in Elements tree.

The "Primo AI server" element is a container for all other package elements. This element is used to connect to the server and to authenticate.
In pure code projects use the element as follows:

//app - [Primo.AI.Server.PrimoAIApp] PrimoAIApp application
//server - Server: [String] Server URL
//login - Login: [String] User login
//password - Password: [String] User password
//spassword - Secure password: [SecureString] Secure password
//to - Time-out: [Int32] Server interactions time-out (ms)
Primo.AI.Server.PrimoAIApp app = Primo.AI.Server.PrimoAIApp.Init(wf, server, [to], [login], [spassword], [password]);

The "Smart OCR\Create request OCR" element sends a request for document recognition. In response, it receives the request key.
In pure code projects:

//app - [Primo.AI.Server.PrimoAIApp] PrimoAIApp application
//modelType - [String] Model type for document processing
//file - Document: [String] Path to document file
System.Guid txt = app.CreateInference(file, modelType);

The "Smart OCR\Get result OCR" element receives the processing result from the server.
In pure code:

//app - [Primo.AI.Server.PrimoAIApp] PrimoAIApp application
//requestKey - [System.Guid] Request key
Primo.AI.Server.Model.InferenceResult txt = app.GetInference(requestKey);

The "Smart OCR\Validate document" element validates the recognized data and allows you to correct them.
It is not used in pure code.

The "NLP\Create request NLP" element sends a request NLP. In response, it receives the request key.
In pure code projects:

//app - [Primo.AI.Server.PrimoAIApp] PrimoAIApp application
//modelType - Routing key: [String] Routing key for request
//prompt - Prompt: [String] Text to be processed
//responseLength - Response length: [Int32] Maximum length of model responses in tokens
//responseSchema - Response keys: [List<String>] Parameters specific to each NLP task
//temperature - Temperature: [Double] The lower the temperature, the less variability in generation
//minP - Min p: [Double] An additional parameter that defines the threshold in the range of token selection (0 is any, 1 is the most likely)
//contextFile - Context: [String] Path to context file (.json)
//systemMessage - System message: [String] Controls the behavior of the model - how to approach the generation of the response, in what format to form it, etc.
//imageFile - Context: [String] Path to image file (jpg/png)
System.Guid txt = app.CreateRequestNlp(modelType, prompt, responseLength, [responseSchema], [temperature], [minP], [contextFile], [systemMessage], [imageFile]);

The "NLP\Get result NLP" element receives the result of the request NLP from the server.
In pure code:

//app - [Primo.AI.Server.PrimoAIApp] PrimoAIApp application
//requestKey - [System.Guid] Request key
Primo.AI.Server.Model.NlpResult txt = app.GetRequestNlp(requestKey);

The "Get file" element receives the processed file from the server.
In pure code:

//app - [Primo.AI.Server.PrimoAIApp] PrimoAIApp application
//requestKey - [System.Guid] Request key
//fileId - [System.Guid] File id
//requestType - [Primo.AI.Server.Model.RequestType] Request type
//pathSave - Path to save: [String] Path to save image
System.Byte[] txt = app.GetFile(requestKey, fileId, requestType, pathSave);

The "Tools\Smart OCR\Crop image" element that image cropping.
In pure code:

//resultContent - Recognition result: [Primo.AI.Server.Model.InferenceResultContent] Image recognition result
//fieldTypes - Image: [String] Path to image file (jpg/jpeg/png)
//pathSave - Path to save: [String] Path to save images
//imageFile - Image: [String] Path to image file (jpg/jpeg/png)
//fieldLimit - Field limit: [int] The maximum number of crops for a field of the same type. It cannot be less than 1.
//inflateCropHorizontally - Horizontal indentation: [int] How much to expand the crop horizontally. A non-negative number.
//inflateCropVertically - Vertical indentation: [int] How much to expand the crop vertically. A non-negative number.
var result = Primo.AI.Server.PrimoAIToolsApp.CropImage(wf, resultContent, fieldTypes, pathSave, imageFile, fieldLimit, inflateCropHorizontally, inflateCropVertically);
	

The "Tools\Smart OCR\Find text in area" element that searches for text in area.
In pure code:

//resultContent - Recognition result: [Primo.AI.Server.Model.InferenceResultContent] Image recognition result
//imageFile - Image: [String] Path to image file (jpg/jpeg/png)
//imageWidth - Image width: [int?] Image width
//imageHeight - Image height: [int?] Image height
//rowsCount - Rows count: [int] Rows count
//columnsCount - Columns count: [int] Columns count
//cellsToSearch - Cells to search: [List<Tuple<int, int>>] Cells to search
Primo.AI.Server.Tools.SmartOcr.TextInAreaSearcherResult result = Primo.AI.Server.PrimoAIToolsApp.FindTextArea(wf, resultContent, imageFile, imageWidth, imageHeight, rowsCount, columnsCount, cellsToSearch);

The "Tools\Smart OCR\Find text near field" that searches for text near a field.
In pure code:

//fieldName - Field name: [String] Field name
//resultContent - Recognition result: [Primo.AI.Server.Model.InferenceResultContent] Image recognition result
//horizontalDistance - Horizontal distance: [int] Horizontal distance
//verticalDistance - Vertical distance: [int] Vertical distance
Primo.AI.Server.Tools.SmartOcr.TextNearToFieldSearcherResult result = Primo.AI.Server.PrimoAIToolsApp.FindTextNearField(wf, fieldName, resultContent, horizontalDistance, verticalDistance);

Key Features

• High performance
• Supports .NET 8

Main Types

• Primo.AI.Server.Elements.WFAttachPrimoAIServer
• Primo.AI.Server.Elements.WFPrimoAIGetFile
• Primo.AI.Server.Elements.WFPrimoAICreateInference
• Primo.AI.Server.Elements.WFPrimoAIGetInference
• Primo.AI.Server.Elements.WFPrimoAICreateRequestNlp
• Primo.AI.Server.Elements.WFPrimoAIGetRequestNlp
• Primo.AI.Server.PrimoAIApp
• Primo.AI.Server.Model.BoundingBox
• Primo.AI.Server.Model.ImageTransforms
• Primo.AI.Server.Model.RectangleItemModel
• Primo.AI.Server.Model.InferenceResult
• Primo.AI.Server.Model.InferenceResultContent
• Primo.AI.Server.Model.InferenceResultFile
• Primo.AI.Server.Model.InferenceResultItem
• Primo.AI.Server.Model.InferenceResultItemRow
• Primo.AI.Server.Model.NlpResult
• Primo.AI.Server.Model.NlpResultContent
• Primo.AI.Server.Model.NlpResultFile
• Primo.AI.Server.Model.FileType
• Primo.AI.Server.Model.RequestType

Feedback

Bug reports and contributions are welcome at Primo RPA chat