/
Type definitions - IBulkCheckService - Linguistic-related types

Type definitions - IBulkCheckService - Linguistic-related types

Feb. 08, 2024

LinguisticCheckResult class

Class definition 
public class LinguisticCheckResult
{
    public string ResultXml { get; set; }
    public IEnumerable<ErrorInfo> Errors { get; set; }
    public IEnumerable<TermCandidate> TermCandidates { get; set; }
    public LinguisticReporting Reporting { get; set; }
}

Represents document check result.

PropertyMeaning
ResultXmlRepresents the input XML where found errors and terminology candidates ranges are marked with processing instructions. To distinguish range of the certain error or candidate Id property should be used.
ErrorsContains collection of found error details (e.g. error type, descriptions, proposals etc.).
TermCandidatesCollection of extracted terminology candidates.
ReportingLinguistic report

LinguisticCheckResult2 class

Class definition 
public class LinguisticCheckResult2
{
    public string ResultXml { get; set; }
    public IEnumerable<ErrorInfo2> Errors { get; set; }
    public IEnumerable<TermCandidate> TermCandidates { get; set; }
    public LinguisticReporting Reporting { get; set; }
}

Represents document check result with extended error reporting.

PropertyMeaning
ResultXmlRepresents the input XML where found errors and terminology candidates ranges are marked with processing instructions. To distinguish range of the certain error or candidate Id property should be used.
ErrorsContains collection of found error details (e.g. error type, descriptions, proposals etc.)
TermCandidatesCollection of extracted terminology candidates
ReportingLinguistic report

LinguisticCheckResult3 class

Class definition 
public class LinguisticCheckResult3 : LinguisticCheckResult2
{
    public FailedParagraphsInfo FailedParagraphsInfo { get; set; }
}

LinguisticCheckResult2 extended with information about failed paragraphs.

PropertyMeaning
FailedParagraphsInfoCollection of failed paragraphs information

ErrorInfo class 

Class definition 
public class ErrorInfo
{
    public string Id { get; set; }
    public int ContextId { get; set; }
    public LinguisticErrorType Type { get; set; }
    public ErrorDetailedDescription[] Descriptions { get; set; }
    public Proposal[] Proposals { get; set; }
    public TermInfo[] RelatedTerms { get; set; }
}

Represents description of an error.

PropertyMeaning
IdId of the error
ContextIdId of context
TypeError type
DescriptionsArray of available descriptions
ProposalsArray of proposals
RelatedTerms

Array of terms related to the error

ErrorInfo2 class 

Class definition 
public class ErrorInfo2
{
    public string Id { get; set; }
    public int ContextId { get; set; }
    public LinguisticErrorType Type { get; set; }
    public ErrorDetailedDescription[] Descriptions { get; set; }
    public Proposal2[] Proposals { get; set; }
    public TermInfo[] RelatedTerms { get; set; }
}

Represents description of an error with extended proposals.

PropertyMeaning
IdId of the error
ContextIdId of context
TypeError type
DescriptionsArray of available descriptions
ProposalsArray of proposals
RelatedTermsArray of terms related to the error

LinguisticErrorType enumeration 

Enum definition 
public enum LinguisticErrorType
{
    Abbreviation,
    Grammar,
    Spelling,
    Style,
    Terminology,
    ValidTerm
}

Represents category of an error.

ValueMeaning
Abbreviation
Grammar
Spelling
Style
Terminology
ValidTerm

ErrorDetailedDescription class 


Class definition 
public class ErrorDetailedDescription
{
    public string Code { get; set; }
    public ErrorDescription Description { get; set; }
    public ExplanationPart[] Explanation { get; set; }
    public ExplanationPart[] ExplanationRewrite { get; set; }
}

Represents detailed description of an error.

PropertyMeaning
CodeCode of the error
DescriptionDescription text
ExplanationNegative examples
ExplanationRewritePositive examples

ErrorDescription class

Class definition 
public class ErrorDescription
{
    public string Header { get; set; }
    public string Instruction { get; set; }
    public string Explanation { get; set; }
}

 Represents description of an error.

PropertyMeaning
HeaderError header
InstructionInstructions
ExplanationError explanation

ExplanationPart class

Class definition 
public class ExplanationPart
{
    public ExplanationPartType Type { get; set; }
    public string Text { get; set; }
}

Represents error explanation.

PropertyMeaning
TypeExplnanation part type
Text

Inner text

ExplanationPartType enumeration

Enum definition 
public enum ExplanationPartType
{
    Text,
    Explanation
}

 Represents type of explanation part.

PropertyMeaning
Text
Explanation


Proposal class

Class definition 
public class Proposal
{
    public string Text { get; set; }
    public string AdditionalInfo { get; set; }
    public string BaseTermForm { get; set; }
}

Represents proposal.

PropertyMeaning
TextProposal text
AdditionalInfoAdditional explanation
BaseTermFormBase form of the term

Proposal2 class

Class definition 
public class Proposal2
{
    public string Text { get; set; }
    public string AdditionalInfo { get; set; }
    public string BaseTermForm { get; set; }
    public int ConceptId { get; set; }
}

Represents proposal with concept.

PropertyMeaning
TextProposal text
AdditionalInfoAdditional explanation
BaseTermFormBase form of the term
ConceptIdConcept identifier

FailedParagraphsInfo class

Class definition 
public class FailedParagraphsInfo
{
    public int FailedParagraphsAmount { get; set; }
}

Provides information on failed paragraphs.

PropertyMeaning
FailedParagraphsAmountTotal count of paragraphs Congree was unable to check

LinguisticReporting class

Class definition 
public class LinguisticReporting
{
    public int TotalCheckedWords { get; set; }
    public double ReleaseLevel { get; set;}
    public double RelativeReleaseLevel { get; set;}
    public double SafeReleaseLevel { get; set;}
    public string SafeReleaseLevelTitle { get; set; }
    public double AcceptableReleaseLevel { get; set;}
    public string AcceptableReleaseLevelTitle { get; set; }
    public double UnsafeReleaseLevel { get; set;}
    public string UnsafeReleaseLevelTitle { get; set; }
    public IEnumerable<LinguisticReportingByType> ReportingByTypes { get; set; }
}

Represents linguistic report.

PropertyMeaning
TotalCheckedWordsTotal count of words checked
ReleaseLevelRelease level (0..100)
RelativeReleaseLevelRelative release level
SafeReleaseLevel"Safe" release level threshold
SafeReleaseLevelTitle"Safe" release level title
AcceptableReleaseLevel"Acceptable" release level threshold
AcceptableReleaseLevelTitle"Acceptable" release level title
UnsafeReleaseLevel"Unsafe" release level threshold
UnsafeReleaseLevelTitle"Unsafe" release level title
ReportingByTypesStatistics per error type

LinguisticReportingByType class

Class definition 
public class LinguisticReportingByType
{
    public LinguisticErrorType Type { get; set; }
    public int ErrorCount { get; set; }
    public double Severity { get; set; }
    public double RelativeSeverity { get; set; }
}

Repersents result per error type.

PropertyMeaning
TypeError type
ErrorCountCount of found errors of the type specified
SeveritySeverity
RelativeSeverityRelative severity

Options class

Class definition 
public class Options
{
    public bool IncludeValidTerms { get; set; }
    public bool IncludeReporting { get; set; }
}

Represents check options.

PropertyMeaning
IncludeValidTermsSpecifies whether to include valid terms in check result
IncludeReportingSpecifies whether to generate inguistic report for check result (Reporting property of LinguisticCheckResult*)

TermCandidate class

Class definition 
public class TermCandidate
{
    public string Id { get; set; }
    public string Text { get; set; }
    public string Context { get; set; }
    public bool IsExist { get; set; }
}

Represents a term candidate.

PropertyMeaning
IdIdentifier
TextTerm candidate text
ContextTerm candidate context
IsExistIndicates whether the specified term candidate exists in Congree DataGrooming DB