package lt_ml_server

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Match (MatchRequest, MatchResponse)

  ml_server.proto:54

  message MatchRequest

  ml_server.proto:93

  • repeated string sentences = 1

    input text to be analyzed

  • bool inputLogging = 2

    allow logging of input on error

  • repeated int64 textSessionID = 3

    session ID, for partial rollout & A/B tests

• rpc MatchAnalyzed (AnalyzedMatchRequest, MatchResponse)

  ml_server.proto:55

  message AnalyzedMatchRequest

  ml_server.proto:58

  • repeated AnalyzedSentence sentences = 1

  • bool inputLogging = 2

    allow logging of input on error

  • repeated int64 textSessionID = 3

    session ID, for partial rollout & A/B tests

for e.g. resorting suggestions

• rpc Process (PostProcessingRequest, MatchResponse)

  ml_server.proto:83

  message PostProcessingRequest

  ml_server.proto:86

  • repeated string sentences = 1

    input text to be analyzed

  • repeated MatchList matches = 2

    matches of input text, to be transformed

  • bool inputLogging = 3

    allow logging of input on error

  • repeated int64 textSessionID = 4

    session ID, for partial rollout & A/B tests

• rpc Analyze (AnalyzeRequest, AnalyzeResponse)

  ml_server.proto:49

  message AnalyzeRequest

  ml_server.proto:7

  NOTE: should this be split this up into different packages?

  • string text = 1

  • optional ProcessingOptions options = 2

  message AnalyzeResponse

  ml_server.proto:34

  • repeated AnalyzedSentence sentences = 1

• rpc Process (ProcessRequest, ProcessResponse)

  ml_server.proto:50

  message ProcessRequest

  ml_server.proto:38

  • repeated AnalyzedSentence sentences = 1

  • optional ProcessingOptions options = 2

  message ProcessResponse

  ml_server.proto:43

  • repeated Match rawMatches = 1

  • repeated Match matches = 2

• rpc Synthesize (SynthesizeRequest, SynthesizeResponse)

  synthesizer.proto:28

  message SynthesizeRequest

  synthesizer.proto:6

  • string languageCode = 1

  • repeated SynthesizeRequestItem items = 2

  message SynthesizeResponse

  synthesizer.proto:19

  • repeated SynthesizeResponseItem items = 1

Used in: AnalyzeResponse, AnalyzedMatchRequest, ProcessRequest

• string text = 1

• repeated AnalyzedTokenReadings tokens = 2

Used in: AnalyzedTokenReadings

• string token = 1

• string posTag = 2

• string lemma = 3

Used in: AnalyzedSentence, SynthesizeRequestItem

• repeated AnalyzedToken readings = 1

• repeated string chunkTags = 2

• int32 startPos = 3

• optional CachedRule rule = 1

• string message = 2

• string shortMessage = 3

• optional MatchPosition patternPosition = 4

  dont need the analyzed sentence here

• optional MatchPosition offsetPosition = 5

• optional MatchPosition sentencePosition = 6

• repeated SuggestedReplacement suggestedReplacements = 7

• string url = 8

• CachedResultMatch.MatchType type = 9

• bool autoCorrect = 10

• repeated NewLanguageMatch newLanguageMatches = 11

• string specificRuleId = 12

• string originalErrorString = 13

Used in: CachedResultMatch

• UnknownWord = 0

  * Spelling errors, typically red.

• Hint = 1

  * Style errors, typically light blue.

• Other = 2

  * Other errors (including grammar), typically yellow/orange.

Used in: CachedResultMatch

• string id = 1

• string subId = 2

• string description = 3

• uint32 estimateContextForSureMatch = 4

• string sourceFile = 5

• string issueType = 6

• bool tempOff = 7

• optional RuleCategory category = 8

• bool isPremium = 9

• repeated CachedRule.Tag tags = 10

Used in: CachedRule

• picky = 0

• academic = 1

• clarity = 2

• professional = 3

• creative = 4

• customer = 5

• jobapp = 6

• objective = 7

• elegant = 8

Used in: MatchList, ProcessResponse

• uint32 offset = 1

  start position in the sentence (i.e. not relative to whole text)

• uint32 length = 2

  length of matched area; >0

• string id = 3

  prefix for rule ids; should use a common value for one model/server

• string sub_id = 4

  more specific suffix for rule ids; i.e. one model/server can return multiple values to distinguish between mach types

• repeated string suggestions = 5

  legacy; use suggestedReplacements

• string ruleDescription = 6

  added later, optional (can be substituted by Java)

  description of the rule; can be specific to rule_id + sub_id or shared for all sub_ids of one rule_id

• string matchDescription = 7

  description of the match; displayed in e.g. the add-on pop-up

• string matchShortDescription = 8

  shortened description of the match; displayed in e.g. LibreOffice context menu

• string url = 9

  to show a link, e.g. with further explanations for this error

• repeated SuggestedReplacement suggestedReplacements = 10

  new and extended suggestions; overwrite any values set in suggestions

• bool autoCorrect = 11

  is this correction eligible for auto-correction?

• Match.MatchType type = 12

• sint32 contextForSureMatch = 13

• optional Rule rule = 14

Used in: Match

• UnknownWord = 0

  * Spelling errors, typically red.

• Hint = 1

  * Style errors, typically light blue.

• Other = 2

  * Other errors (including grammar), typically yellow/orange.

Used in: MatchResponse, PostProcessingRequest

• repeated Match matches = 1

  list of matches

Used in: CachedResultMatch

• uint32 start = 1

• uint32 end = 2

Used as response type in: MLServer.Match, MLServer.MatchAnalyzed, PostProcessingServer.Process

• repeated MatchList sentenceMatches = 1

  results for each corresponding sentence in MatchRequest (aligned)

Used in: CachedResultMatch

• string languageCode = 1

• float confidence = 2

Used in: AnalyzeRequest, ProcessRequest

• string language = 1

• bool tempOff = 2

• ProcessingOptions.Level level = 3

• bool premium = 4

• bool enabledOnly = 5

• repeated string enabledRules = 6

• repeated string disabledRules = 7

Used in: ProcessingOptions

• picky = 0

• academic = 1

• clarity = 2

• professional = 3

• creative = 4

• customer = 5

• jobapp = 6

• objective = 7

• elegant = 8

• defaultLevel = 9

Used in: Match

• string sourceFile = 1

  id, subId, description, url already in Match

• string issueType = 2

  see http://www.w3.org/International/multilingualweb/lt/drafts/its20/its20.html#lqissue-typevalues

• bool tempOff = 3

• optional RuleCategory category = 4

• bool isPremium = 5

• repeated Rule.Tag tags = 6

Used in: Rule

• picky = 0

• academic = 1

• clarity = 2

• professional = 3

• creative = 4

• customer = 5

• jobapp = 6

• objective = 7

• elegant = 8

Used in: CachedRule, Rule

• string id = 1

• string name = 2

Used in: CachedResultMatch, Match

• string replacement = 1

• string description = 2

• string suffix = 3

  Value shown in the UI after the replacement (but not part of it).

• float confidence = 4

  from 0 (lowest) to 1 (highest)

• SuggestedReplacement.SuggestionType type = 5

Used in: SuggestedReplacement

• Default = 0

• Translation = 1

• Curated = 2

Used in: SynthesizeRequest

• optional AnalyzedTokenReadings tokens = 1

• string postag = 2

• bool postag_regexp = 3

• string postag_replace = 4

• string lemma = 5

Used in: SynthesizeResponse

• repeated string forms = 1