Page History
Parameter summary Type of execution to perform default json name type - json - Return the lexItems found in the highest confidence route, any vertex with metadata, and the actual highestRoute including all the tokens
- matchExtraction - Return the lexItems matched by a semantic tag found in the highest confidence route, any vertex with metadata.
- analytics - Return the lexItems found in the highest confidence route, any vertex with metadata, the tokens_detail with every token in the route, the inputText and the outputText (Text parsed ready for modeling data)
route - Return only the SEMANTIC_TAG tokens in the highestRoute
Info More types can when requested
Parameter summary List of tags to identify in the text name tags type string array required true Parameter summary Process Id of the pipeline you want to work from. Can only be used if no tags where defined. Format is: PipelineName:StageId name processor required true Parameter summary Number of engines per process unit default 10 name enginePoolSize type integer Parameter summary Should the engine be create at once, otherwise each engine will be generated as required default false name createEngines type boolean Parameter summary Time in milliseconds, for the engine to timeout default 30000 name engineTimeout type integer Parameter summary Regex which will split the text into more manageable blocks to be process by Saga default [\n\s ]+ name splitRegex Parameter summary Should the splitRegex apply on multiple lines default true name multiline Parameter summary Maximum number of character to process, more than that and the data will be truncated. If the value is 0, no maximum is applied default 0 name maxCharsSizeToProcess type integer Parameter summary Return only the exact same tags specified in the field "tags" default false name exactTags type boolean Parameter summary List of tags to ignore from the regular process name ignoredTags type string array Parameter summary List of Flags to include in the result, regardless of other configuration name includeFlags type string array Parameter summary List of flags to exclude from the results default TEXT_BLOCK name excludeFlags type string array Parameter summary Include the metadata in the tags and vertices default false name includeMetadata type boolean Parameter summary Should routes of the same confidence be combined into one route default false name combineRoutes type boolean Parameter summary List of specific components to add, any other component will be ignore name includeTheseComponents type string array Parameter summary Include the components (tokens which compose the tag) of each tag matched default true name includeComponents type boolean Parameter summary If components are included, does the metadata of each one needs to be added default false name includeComponentMetadata type boolean Parameter summary Boolean or JOSN default false name expires type json - If JSON - Can specify the amount of the time, in which it will expire. If refreshExpiration is activated, this is the amount to reset each time
Parameter summary Amount of time to extent the expiration time default 0 name amount type integer Parameter summary Time unit in which the amount is expressed. All the ChronoUnit are valid (Nanos, Micros, Millis, Seconds, Minutes, Hours, ...) default Seconds name timeUnit
- If true - If true, the process unit will expire immediately after the process has ended
- If JSON - Can specify the amount of the time, in which it will expire. If refreshExpiration is activated, this is the amount to reset each time
Parameter summary Rerefresh expiration time every time the unit does a process default false name refreshExpiration type boolean Parameter summary If True the process unit will be saved in the database and every time the server restarts the process unit will be loaded default false name persistent type boolean Info If persistent is true, expiration will be disabled
Parameter summary If True the statistics of the engine and the pipeline are included in the response default false name includeStats type boolean
Overview
Content Tools