Linguistic

Linguistic

The request should be included in the body in the following form:

{
  "Xml": "string",
  "Options": {
    "IncludeValidTerms": true,
    "IncludeReporting": true,
    "IncludeContextMapping": true,
    "ExtractTermCandidates": true
  }
}

Options

IncludeValidTerms

IncludeReporting

IncludeContextMapping

ExtractTermCandidates

The response structure corresponds to LinguisticCheckResult3 class, see Congree Bulk Check Service documentation, see Type definitions - IBulkCheckService - Linguistic-related types.

{
  "ResultXml": "string",
  "Errors": [
    {
      "Id": "string",
      "ContextId": 0,
      "Type": "Abbreviation",
      "Descriptions": [
        {
          "Code": "string",
          "Description": {
            "Header": "string",
            "Instruction": "string",
            "Explanation": "string"
          },
          "Explanation": [
            {
              "Type": "Text",
              "Text": "string"
            }
          ],
          "ExplanationRewrite": [
            {
              "Type": "Text",
              "Text": "string"
            }
          ]
        }
      ],
      "Proposals": [
        {
          "Text": "string",
          "AdditionalInfo": "string",
          "BaseTermForm": "string",
          "ConceptId": 0
        }
      ]
    }
  ],
  "TermCandidates": [
    {
      "Id": "string",
      "Text": "string",
      "Context": "string",
      "IsExist": true
    }
  ],
  "Reporting": {
    "TotalCheckedWords": 0,
    "ReleaseLevel": 0,
    "RelativeReleaseLevel": 0,
    "SafeReleaseLevel": 0,
    "SafeReleaseLevelTitle": "string",
    "AcceptableReleaseLevel": 0,
    "AcceptableReleaseLevelTitle": "string",
    "UnsafeReleaseLevel": 0,
    "UnsafeReleaseLevelTitle": "string",
    "ReportingByTypes": [
      {
        "Type": "Abbreviation",
        "ErrorCount": 0,
        "Severity": 0,
        "RelativeSeverity": 0
      }
    ]
  },
  "FailedParagraphsInfo": {
    "FailedParagraphsAmount": 0
  }
}

Here comes an example to describe "String" in more detail:

<ul><li><?cngr-ctx-b 6?>Wie verständlich einzelne Passagen <?cngr-lc-b 13?>waren<?cngr-lc-e 13?><?cngr-ctx-e 6?></li><li>

Please note that in  the example, Processing Instructions are used to mark ranges:

Please find the additional response content explained below.

Errors

• Id: highlight/error ID to find the correct range of a Congree notification)
• ContextId: ContextId corresponds to a “ … ” region. These PIs are emitted when IncludeContextMapping is true or both IncludeReporting is true and RuleSet has reporting configuration set.
• Type: Spelling, Grammar, Style, Terminology, Abbreviation or Valid terms
• Descriptions:
  • Code: identifier for a specific Congree notification
  • Description:
    • Header: short summary to identify the notification
    • Instruction: short text telling the author what to correct
    • Explanation: short text telling the author why to correct
• Explanation: negative example
  • Type: can be Text or Explanation
  • Text
• ExplanationRewrite: positive example
  • Type: can be Text or Explanation
  • Text

Proposals

• Text: any string which should be applied by authors as their correction of some problem
• AdditionalInfo:  legacy property, has to be null
• BaseTermForm: String required for "Valid term" messages and also for Terminology Research to find a term
• ConceptId: If the proposal is a term, this is the concept ID of said term to be used if necessary.

TermCandidates

• Id: Id of corresponding “…” region
• Text: the candidates as displayed to the author
• Context: the sentence(s) in which a term candidate has been found
• IsExist: information if this term has already been proposed by someone else in the past

Reporting

• TotalCheckedWord: counter for the amount of checked words
• ReleaseLevel: value which shows the quality of checked text
• RelativeReleaseLevel: ReleaseLevel value, scaled as if quality levels (unsafe/acceptable/safe) were of equal length of 40. Returned values are in range [0…80) U {120}. 120 is returned only when ReleaseLevel = 100.
• SafeReleaseLevel: value when the shown release level is good
• SafeReleaseLevelTitle: name of the good release level
• AcceptableReleaseLevel: value when the shown release level is ok
• AcceptableReleaseLevelTitle: name of the ok release level
• UnsafeReleaseLevel: value when the shown release level is bad
• UnsafeReleaseLevelTitle: name of the bad release level
• ReportingByTypes: contains total counts and calculated severities of Language Check error types.
  • Type
  • ErrorCount
  • Severity
  • RelativeSeverity
• FailedParagraphsInfo
  • FailedParagraphsAmount: provides information on how many paragraphs were skipped due to errors

The request is the same as for /congree/api/Linguistic/v1/Check?ruleSet=rulesetName but the result is a task id.

In order to get the task status and results, use methods described in Tasks. The result is the same as for /congree/api/Linguistic/v1/Check

{
  "Id": "00000000-0000-0000-0000-000000000000"
}

{
  "Id": "514290f4-fc30-48e3-99b8-0973011bd2e5"
}

Linguistic: StyleGuide

StyleGuide can be specified as follows:

• Id (integer, optional): Id of style guide
• Name (string, optional): Name
• RulesConfiguration (integer, optional): Id of rules configuration
• SynonymsConfiguration (integer, optional): Id of synonyms configuration
• UserLexiconConfiguration (integer, optional): Id of user lexicon configuration
• TerminologyConfiguration (integer, optional): Id of terminology configuration

Linguistic: StyleGuide Configurations

Attributes for Configurations:

• Id (integer, optional): Id of existing configuration
• Name (string, optional): Configuration name

Parameters:

• culture (string)
• type (string): Rules, UserLexicon, Synonyms, Terminology
• request

The request should be included in the body in the following form:

{
  "Id": 0,
  "Name": "string",
  "Copy": true
}

Linguistic: StyleGuide Rules

Linguistic: StyleGuide Synonyms

Linguistic: StyleGuide Terminology

Linguistic: StyleGuide User Lexicon

Linguistic: StyleGuide User Lexicon Word forms