@semantha/product-sdk 9.2.1

package/dist/modeEnum-CSw6xLrL.d.mts

@@ -0,0 +1,600 @@
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface AnalysisStats {
+    countIdenticalMatches?: number;
+    countTotalResults?: number;
+    countGoodMatches?: number;
+    countSimiliarMatches?: number;
+    countNoMatches?: number;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface AnalysisReport {
+    id?: string;
+    name?: string;
+    created?: number;
+    type?: AnalysisReportTypeEnum;
+    stats?: AnalysisStats;
+    tags?: string;
+    documentClassIds?: string[];
+    projectId?: string;
+    space?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface AnalysesReport {
+    analysisReports?: AnalysisReport[];
+    statsSummary?: AnalysisStats;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Analysis {
+    id?: string;
+    name?: string;
+    strategy?: string;
+    maxReferences?: number;
+    similarityThreshold?: number;
+    created?: number;
+    tags?: string;
+    documentClassIds?: string[];
+    status?: AnalysisStatusEnum;
+    progressState?: number;
+    goodMatchesThreshold?: number;
+    matchAllReferences?: boolean;
+    showDocumentScore?: boolean;
+    minDocumentScore?: number;
+    source?: AnalysisSourceEnum;
+    type?: AnalysisTypeEnum;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Attachment {
+    name?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Entity {
+    name: string;
+    id?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface FormatInformation {
+    id?: number;
+    textType?: string;
+    fontsize?: number;
+    bold?: boolean;
+    italic?: boolean;
+    count?: number;
+    targetTextType?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Distance {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Features {
+    distance?: Distance;
+    fontSize?: number;
+    bold?: boolean;
+    italic?: boolean;
+    page?: number;
+    pageRev?: number;
+    pageWidth?: number;
+    pageAspectRatio?: number;
+    uppercase?: boolean;
+    startsWith?: string;
+    containsText?: boolean;
+    language?: string;
+    relativeFontsize?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    page: number;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface AnnotationCell {
+    bbox?: Rect;
+    type?: string;
+    features?: Features;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface AnnotationPage {
+    height?: number;
+    width?: number;
+    pageNumber?: number;
+    ignorePage?: boolean;
+    cells?: AnnotationCell[];
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface TableCell {
+    text?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Row {
+    cells?: TableCell[];
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface DocumentTable {
+    rows?: Row[];
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Link {
+    documentId?: string;
+    documentName?: string;
+    paragraphId?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Reference {
+    documentId?: string;
+    documentName?: string;
+    pageNumber?: number;
+    paragraphId?: string;
+    sentenceId?: string;
+    similarity?: number;
+    text?: string;
+    context?: {
+        [key: string]: string;
+    };
+    dataUrlImage?: string;
+    type?: string;
+    color?: string;
+    comment?: string;
+    hasOppositeMeaning?: boolean;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Char {
+    character: string;
+    area?: Rect;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface DocumentNamedEntity {
+    name?: string;
+    text?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Sentence {
+    id?: string;
+    text?: string;
+    documentName?: string;
+    namedEntities?: DocumentNamedEntity[];
+    references?: Reference[];
+    areas?: Rect[];
+    characters?: Char[];
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Paragraph {
+    text?: string;
+    type?: string;
+    id?: string;
+    documentName?: string;
+    sentences?: Sentence[];
+    references?: Reference[];
+    context?: {
+        [key: string]: string;
+    };
+    areas?: Rect[];
+    links?: Link[];
+    name?: string;
+    tags?: string[];
+    comment?: string;
+    verified?: boolean;
+    dataUrlImage?: string;
+    formatId?: number;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface PageContent {
+    paragraphs?: Paragraph[];
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Page {
+    contents?: PageContent[];
+    paragraphs?: Paragraph[];
+    tables?: DocumentTable[];
+    annotationPage?: AnnotationPage;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface AnalysisInput {
+    id?: string;
+    name?: string;
+    tags?: string[];
+    metadata?: string;
+    filename?: string;
+    created?: number;
+    updated?: number;
+    ignored?: boolean;
+    processed?: boolean;
+    lang?: string;
+    content?: string;
+    documentClass?: Entity;
+    derivedTags?: string[];
+    color?: string;
+    derivedColor?: string;
+    comment?: string;
+    derivedComment?: string;
+    contentPreview?: string;
+    mimeType?: string;
+    attachments?: Attachment[];
+    pages?: Page[];
+    references?: Reference[];
+    imagePages?: string[];
+    formatInformations?: FormatInformation[];
+    context?: {
+        [key: string]: string;
+    };
+    additionalInfo?: string;
+    documentClassId?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+declare const AnalysisReportTypeEnumValues: readonly ["EXCEL", "PDF", "POLARION", "STRUCTURE_NAVIGATOR"];
+type AnalysisReportTypeEnum = (typeof AnalysisReportTypeEnumValues)[number];
+declare function isAnalysisReportTypeEnumValue(value: any): value is AnalysisReportTypeEnum;
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Document {
+    id?: string;
+    name?: string;
+    tags?: string[];
+    metadata?: string;
+    filename?: string;
+    created?: number;
+    updated?: number;
+    ignored?: boolean;
+    processed?: boolean;
+    lang?: string;
+    content?: string;
+    documentClass?: Entity;
+    derivedTags?: string[];
+    color?: string;
+    derivedColor?: string;
+    comment?: string;
+    derivedComment?: string;
+    contentPreview?: string;
+    mimeType?: string;
+    attachments?: Attachment[];
+    pages?: Page[];
+    references?: Reference[];
+    imagePages?: string[];
+    formatInformations?: FormatInformation[];
+    documentClassId?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface EvaluationOverview {
+    id?: string;
+    score?: number;
+    withoutTags?: boolean;
+    tag?: string;
+    underThreshold?: boolean;
+    contextDiff?: boolean;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface AnalysisResult {
+    id?: string;
+    name?: string;
+    status?: string;
+    classification?: string;
+    evaluations?: EvaluationOverview[];
+    edited?: boolean;
+    analysis?: string;
+    comment?: string;
+    text?: string;
+    context?: {
+        [key: string]: string;
+    };
+    document?: Document;
+    referenceDocumentId?: string;
+    referenceDocumentName?: string;
+    referenceParagraphId?: string;
+    referenceText?: string;
+    referenceContext?: {
+        [key: string]: string;
+    };
+    referenceDocument?: Document;
+    referenceMetadata?: string;
+    documentClass?: Entity;
+    hasAdditionalMatches?: boolean;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface AnalysisResultComment {
+    text: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+declare const AnalysisSourceEnumValues: readonly ["EXCEL", "PDF", "POLARION", "STRUCTURE_NAVIGATOR"];
+type AnalysisSourceEnum = (typeof AnalysisSourceEnumValues)[number];
+declare function isAnalysisSourceEnumValue(value: any): value is AnalysisSourceEnum;
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+declare const AnalysisStatusEnumValues: readonly ["INITIALIZING", "QUEUED", "IN_PROGRESS", "FINISHED", "UPDATING_RESULTS", "ERROR", "UNKNOWN", "CANCELLED", "EMPTY", "LIMIT_EXCEEDED"];
+type AnalysisStatusEnum = (typeof AnalysisStatusEnumValues)[number];
+declare function isAnalysisStatusEnumValue(value: any): value is AnalysisStatusEnum;
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+declare const AnalysisTypeEnumValues: readonly ["SIMILARITY", "PROMPT"];
+type AnalysisTypeEnum = (typeof AnalysisTypeEnumValues)[number];
+declare function isAnalysisTypeEnumValue(value: any): value is AnalysisTypeEnum;
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Classification {
+    id?: string;
+    name?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface CurrentUser {
+    name: string;
+    validUntil: number;
+    roles?: string[];
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface ExtendedReference {
+    documentId?: string;
+    documentName?: string;
+    pageNumber?: number;
+    paragraphId?: string;
+    sentenceId?: string;
+    similarity?: number;
+    text?: string;
+    context?: {
+        [key: string]: string;
+    };
+    dataUrlImage?: string;
+    type?: string;
+    color?: string;
+    comment?: string;
+    hasOppositeMeaning?: boolean;
+    tags?: string[];
+    metadata?: string;
+    used?: boolean;
+    documentClass?: Entity;
+    contextDiff?: boolean;
+    referenceText?: string;
+    id?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface Evaluation {
+    id?: string;
+    score?: number;
+    withoutTags?: boolean;
+    tag?: string;
+    underThreshold?: boolean;
+    contextDiff?: boolean;
+    references?: ExtendedReference[];
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface ExcelTemplateColumnConfig {
+    columnHeaderId: string;
+    defaultColumnName?: string;
+    customColumnName?: string;
+    order?: number;
+    headerType?: ExcelTemplateColumnConfigHeaderTypeEnum;
+    hidden?: boolean;
+    sampleData?: string[];
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+declare const ExcelTemplateColumnConfigHeaderTypeEnumValues: readonly ["DEFAULT_COLUMN", "PLACEHOLDER_COLUMN", "EDITABLE_PLACEHOLDER_COLUMN"];
+type ExcelTemplateColumnConfigHeaderTypeEnum = (typeof ExcelTemplateColumnConfigHeaderTypeEnumValues)[number];
+declare function isExcelTemplateColumnConfigHeaderTypeEnumValue(value: any): value is ExcelTemplateColumnConfigHeaderTypeEnum;
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface ExcelTemplateDetails {
+    name: string;
+    columnConfigs: ExcelTemplateColumnConfig[];
+    id?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+interface FormDataContentDisposition {
+    type?: string;
+    parameters?: {
+        [key: string]: string;
+    };
+    fileName?: string;
+    creationDate?: string;
+    modificationDate?: string;
+    readDate?: string;
+    size?: number;
+    name?: string;
+}
+
+/**
+ * @author semantha
+ *
+ * This is a generated file do not change manually!
+ */
+declare const ModeEnumValues: readonly ["fingerprint", "keyword", "document", "document_fingerprint", "fingerprint_keyword", "auto"];
+type ModeEnum = (typeof ModeEnumValues)[number];
+declare function isModeEnumValue(value: any): value is ModeEnum;
+
+export { type AnalysesReport as A, type Entity as B, type Char as C, type Distance as D, type EvaluationOverview as E, type Evaluation as F, type ExcelTemplateColumnConfig as G, ExcelTemplateColumnConfigHeaderTypeEnumValues as H, type ExcelTemplateColumnConfigHeaderTypeEnum as I, isExcelTemplateColumnConfigHeaderTypeEnumValue as J, type ExcelTemplateDetails as K, type ExtendedReference as L, type Features as M, type FormDataContentDisposition as N, type FormatInformation as O, type Link as P, ModeEnumValues as Q, type ModeEnum as R, isModeEnumValue as S, type Page as T, type PageContent as U, type Paragraph as V, type Rect as W, type Reference as X, type Row as Y, type Sentence as Z, type TableCell as _, type Analysis as a, type AnalysisInput as b, type AnalysisReport as c, AnalysisReportTypeEnumValues as d, type AnalysisReportTypeEnum as e, type AnalysisResult as f, type AnalysisResultComment as g, AnalysisSourceEnumValues as h, isAnalysisReportTypeEnumValue as i, type AnalysisSourceEnum as j, isAnalysisSourceEnumValue as k, type AnalysisStats as l, AnalysisStatusEnumValues as m, type AnalysisStatusEnum as n, isAnalysisStatusEnumValue as o, AnalysisTypeEnumValues as p, type AnalysisTypeEnum as q, isAnalysisTypeEnumValue as r, type AnnotationCell as s, type AnnotationPage as t, type Attachment as u, type Classification as v, type CurrentUser as w, type Document as x, type DocumentNamedEntity as y, type DocumentTable as z };