/
detectLanguageResult.ts
56 lines (49 loc) · 1.49 KB
/
detectLanguageResult.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import {
makeTextAnalyticsSuccessResult,
TextAnalyticsSuccessResult,
TextAnalyticsErrorResult,
makeTextAnalyticsErrorResult
} from "./textAnalyticsResult";
import {
DetectedLanguage,
TextDocumentStatistics,
TextAnalyticsError,
TextAnalyticsWarning
} from "./generated/models";
/**
* The result of the detect language operation on a single document.
*/
export type DetectLanguageResult = DetectLanguageSuccessResult | DetectLanguageErrorResult;
/**
* The result of the detect language operation on a single document,
* containing a prediction of what language the document is written in.
*/
export interface DetectLanguageSuccessResult extends TextAnalyticsSuccessResult {
/**
* The top detected language by confidence score.
*/
readonly primaryLanguage: DetectedLanguage;
}
/**
* An error result from the detect languge operation on a single document.
*/
export type DetectLanguageErrorResult = TextAnalyticsErrorResult;
export function makeDetectLanguageResult(
id: string,
detectedLanguage: DetectedLanguage,
warnings: TextAnalyticsWarning[],
statistics?: TextDocumentStatistics
): DetectLanguageSuccessResult {
return {
...makeTextAnalyticsSuccessResult(id, warnings, statistics),
primaryLanguage: detectedLanguage
};
}
export function makeDetectLanguageErrorResult(
id: string,
error: TextAnalyticsError
): DetectLanguageErrorResult {
return makeTextAnalyticsErrorResult(id, error);
}