@semantha/sdk 9.8.0 → 10.1.0

package/README.md

@@ -1,3 +1,5 @@
 ![](https://www.semantha.de/wp-content/uploads/semantha-inverted.svg)
 
-# 💜 semantha SDK
+# semantha SDK
+
+This is the TypeScript SDK for the semantha platform

package/dist/index.d.mts

@@ -629,7 +629,6 @@ interface Reference {
     type?: string;
     color?: string;
     comment?: string;
-    hasOppositeMeaning?: boolean;
 }
 
 /**
@@ -851,7 +850,6 @@ interface DocumentTypeConfig {
     doAutoSplitting?: boolean;
     autoSplitDistance?: number;
     useSimilarityModelForExtraction?: boolean;
-    doContradictionDetection?: boolean;
     doParagraphMergingForTextFiles?: boolean;
 }
 
@@ -877,7 +875,6 @@ interface DocumentType {
 interface DocumentTypeChange {
     name?: string;
     doObjectDetection?: boolean;
-    doContradictionDetection?: boolean;
     doSubDocumentSplitting?: boolean;
     splitModus?: string;
     splitByType?: string;
@@ -993,7 +990,7 @@ interface ErrorContainer {
  *
  * This is a generated file do not change manually!
  */
-declare const ErrorFieldCodeEnumValues: readonly ["BAD_REQUEST", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "CONTENT_TOO_LARGE", "INTERNAL_SERVER_ERROR", "GATEWAY_TIMEOUT", "DOCUMENTTYPE_NOT_FOUND", "DOCUMENTTYPE_NAME_EXISTS", "DOCUMENTTYPE_NOT_EDITABLE", "COMPARE_DOC_IS_EMPTY", "COMPARE_WRONG_LANGUAGE", "COMPARE_NO_REFERENCES", "DOMAIN_NOT_FOUND", "TOO_MANY_TOKENS", "NO_FILE_FOUND", "FILE_TYPE_NOT_SUPPORTED", "FILE_PASSWORDPROTECTED", "MISSING_SERVICE_DEFINITION", "SERVICE_CALL_ERROR", "GENERATIVE_MODEL_ERROR", "USED_AS_LINKED_EXTRACTOR", "CYCLICAL_DEPENDENCY_LINKED_EXTRACTOR", "FILE_TOO_BIG", "TOO_MANY_ROWS", "REGEX_INVALID", "GENERATIVE_MODEL_CONTEXT_EXCEEDED", "PROMPT_NOT_DELETABLE", "JPEG2000_NOT_SUPPORTED", "RESOURCE_NOT_FOUND", "PARENT_RESOURCE_NOT_FOUND", "RESOURCE_PARAMETER_CONSTRAINT_VIOLATION", "PLATFORM_UNREACHABLE", "FILE_SIZE_TOOBIG", "USER_REPOSITORY_NOT_CONFIGURED", "PDF_NOT_CONFIGURED", "INVALID_USER_PASSWORD", "UNKNOWN_FINGERPRINTER_ID", "JSON_ARRAY_EMPTY", "TOKENS_ILLEGAL_TYPE", "NO_JSON", "INVALID_JSON_FORMAT", "JSON_OBJECT_HAS_NO_DOCUMENTS", "DOCUMENTS_ARE_NO_JSON_ARRAY", "DOCUMENTS_JSON_ARRAY_EMPTY", "DOCUMENTS_VALUE_ERROR", "DOCUMENTS_TYPE_ERROR", "DOCUMENTS_TOO_FEW_DOCUMENTS", "REQ_NO_JSON_ARRAY", "SENTENCE_LIST_NOT_TWO", "IMAGE_NOT_PROVIDED", "IMAGE_INVALID_FORMAT", "MODEL_NAME_INVALID", "THRESHOLD_INVALID", "IMAGE_BUFFER_EMPTY", "INVALID_MODEL_ID", "IMAGE_NOT_PROVIDED_IFP", "IMAGE_INVALID_DATA", "IMAGE_INVALID_FORMAT_IFP"];
+declare const ErrorFieldCodeEnumValues: readonly ["BAD_REQUEST", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "CONTENT_TOO_LARGE", "INTERNAL_SERVER_ERROR", "GATEWAY_TIMEOUT", "DOCUMENTTYPE_NOT_FOUND", "DOCUMENTTYPE_NAME_EXISTS", "DOCUMENTTYPE_NOT_EDITABLE", "COMPARE_DOC_IS_EMPTY", "COMPARE_WRONG_LANGUAGE", "COMPARE_NO_REFERENCES", "DOMAIN_NOT_FOUND", "TOO_MANY_TOKENS", "NO_FILE_FOUND", "FILE_TYPE_NOT_SUPPORTED", "FILE_PASSWORDPROTECTED", "MISSING_SERVICE_DEFINITION", "SERVICE_CALL_ERROR", "GENERATIVE_MODEL_ERROR", "USED_AS_LINKED_EXTRACTOR", "CYCLICAL_DEPENDENCY_LINKED_EXTRACTOR", "FILE_TOO_BIG", "TOO_MANY_ROWS", "REGEX_INVALID", "GENERATIVE_MODEL_CONTEXT_EXCEEDED", "PROMPT_NOT_DELETABLE", "JPEG2000_NOT_SUPPORTED", "TRANSLATION_ERROR", "RESOURCE_NOT_FOUND", "PARENT_RESOURCE_NOT_FOUND", "RESOURCE_PARAMETER_CONSTRAINT_VIOLATION", "PLATFORM_UNREACHABLE", "FILE_SIZE_TOOBIG", "USER_REPOSITORY_NOT_CONFIGURED", "PDF_NOT_CONFIGURED", "INVALID_USER_PASSWORD", "UNKNOWN_FINGERPRINTER_ID", "JSON_ARRAY_EMPTY", "TOKENS_ILLEGAL_TYPE", "NO_JSON", "INVALID_JSON_FORMAT", "JSON_OBJECT_HAS_NO_DOCUMENTS", "DOCUMENTS_ARE_NO_JSON_ARRAY", "DOCUMENTS_JSON_ARRAY_EMPTY", "DOCUMENTS_VALUE_ERROR", "DOCUMENTS_TYPE_ERROR", "DOCUMENTS_TOO_FEW_DOCUMENTS", "REQ_NO_JSON_ARRAY", "SENTENCE_LIST_NOT_TWO", "IMAGE_NOT_PROVIDED", "IMAGE_INVALID_FORMAT", "MODEL_NAME_INVALID", "THRESHOLD_INVALID", "IMAGE_BUFFER_EMPTY", "INVALID_MODEL_ID", "IMAGE_NOT_PROVIDED_IFP", "IMAGE_INVALID_DATA", "IMAGE_INVALID_FORMAT_IFP"];
 type ErrorFieldCodeEnum = (typeof ErrorFieldCodeEnumValues)[number];
 declare function isErrorFieldCodeEnumValue(value: any): value is ErrorFieldCodeEnum;
 
@@ -1251,17 +1248,6 @@ declare const MatcherTypeEnumValues: readonly ["REGEX", "ANDREGEX", "ANDNOTREGEX
 type MatcherTypeEnum = (typeof MatcherTypeEnumValues)[number];
 declare function isMatcherTypeEnumValue(value: any): value is MatcherTypeEnum;
 
-/**
- * @author semantha
- *
- * This is a generated file do not change manually!
- */
-interface MatrixRow {
-    documentId?: string;
-    documentName?: string;
-    references?: Reference[];
-}
-
 /**
  * @author semantha
  *
@@ -1855,7 +1841,7 @@ declare class AnswersEndpoint {
      * "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
      * "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
      * "sv", "tr", "zh"
-     * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
+     * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND). Groups (single AND or OR-groups) can be negated using an "!"
      */
     post(data: {
         question?: string;
@@ -2168,8 +2154,12 @@ declare class BulkdomainsDocumentclassesEndpoint {
     constructor(restClient: RestClient, parentEndpoint: string);
     /**
      * Get all document classesThis is the quiet version of  'get /api/domains/{domainname}/documentclasses'
+     *
+     * @param withdocids boolean? -
      */
-    get(): Promise<DocumentClassBulk[]>;
+    get(params?: {
+        withdocids?: boolean;
+    }): Promise<DocumentClassBulk[]>;
     /**
      * Create one or more document classesThis is the quiet version of  'post /api/domains/{domainname}/documentclasses'
      *
@@ -2594,7 +2584,7 @@ declare class DocclassDocumentclassesEndpoint {
      */
     patch(body: string[]): Promise<DocumentClass[]>;
     /**
-     * Create one or more subclasses for a document class identified by name
+     * Create one subclass for a document class identified by name
      *
      * @param body DocumentClass? -
      */
@@ -2747,7 +2737,7 @@ declare class DocumentclassesEndpoint {
      */
     delete(): Promise<RestResponse<void>>;
     /**
-     * Create one or more document classes
+     * Create one document class
      *
      * @param body DocumentClass? -
      */
@@ -3356,13 +3346,13 @@ declare class ReferencedocumentsEndpoint {
     /**
      * Get all reference documents a.k.a. library items.Supports server side pagination and filtering for <strong>application/json</strong> media type only by using <strong>offset</strong> and <strong>limit</strong> query parameter.<br><strong>Filter parameters:</strong> name, createdbefore, createdafter, tags, documentclassids, metadata.<br>Without <strong>offset</strong> and <strong>limit</strong> parameter, data can be filtered only by <strong>tags</strong> and <strong>documentclassids</strong>.
      *
-     * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
      * @param documentids string? - List of document Ids for target. The limit here is 65000 IDs. The IDs can be passed as a comma separated string.
      * @param name string? - Filter documents for a given name
      * @param createdafter number? - Filter for documents which are created after a given UNIX timestamp. The createdafter filter only works when also using the parameters offset and limit.
      * @param createdbefore number? - Filter for documents which are created before a given UNIX timestamp. The createdbefore filter only works when also using the parameters offset and limit.
      * @param updatedafter number? - Filter for documents which are updated after a given UNIX timestamp. The updatedafter filter only works when also using the parameters offset and limit.
      * @param updatedbefore number? - Filter for documents which are updated before a given UNIX timestamp. The updatedbefore filter only works when also using the parameters offset and limit.
+     * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
      * @param documentclassids string? - List of documentclass IDs for the target. The limit here is 1000 IDs. The IDs are passed as a comma separated list.
      * @param withoutdocumentclass boolean? - Filters the returned reference documents to include only documents that are not linked to a documentclass. The parameter is of type boolean and is set to false by default.
      * @param mincharacters number? - Filters the returned reference documents to include only documents that have a minimum of characters
@@ -3376,13 +3366,13 @@ declare class ReferencedocumentsEndpoint {
      * @param fields string? - Define which fields should be returned by the /referencedocuments endpoints. The following values can be sent as a comma-separated list: 'id', 'name', 'tags', 'derivedtags', 'metadata', 'filename', 'created', 'processed', 'lang', 'updated, color, derivedcolor, comment, derivedcomment, documentclass, contentpreview'. If empty or null all fields will be returned. Example: "id,name,contentpreview,tags"
      */
     get(params?: {
-        tags?: string;
         documentids?: string;
         name?: string;
         createdafter?: number;
         createdbefore?: number;
         updatedafter?: number;
         updatedbefore?: number;
+        tags?: string;
         documentclassids?: string;
         withoutdocumentclass?: boolean;
         mincharacters?: number;
@@ -3398,13 +3388,13 @@ declare class ReferencedocumentsEndpoint {
     /**
      * Get all reference documents a.k.a. library items.Supports server side pagination and filtering for <strong>application/json</strong> media type only by using <strong>offset</strong> and <strong>limit</strong> query parameter.<br><strong>Filter parameters:</strong> name, createdbefore, createdafter, tags, documentclassids, metadata.<br>Without <strong>offset</strong> and <strong>limit</strong> parameter, data can be filtered only by <strong>tags</strong> and <strong>documentclassids</strong>.
      *
-     * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
      * @param documentids string? - List of document Ids for target. The limit here is 65000 IDs. The IDs can be passed as a comma separated string.
      * @param name string? - Filter documents for a given name
      * @param createdafter number? - Filter for documents which are created after a given UNIX timestamp. The createdafter filter only works when also using the parameters offset and limit.
      * @param createdbefore number? - Filter for documents which are created before a given UNIX timestamp. The createdbefore filter only works when also using the parameters offset and limit.
      * @param updatedafter number? - Filter for documents which are updated after a given UNIX timestamp. The updatedafter filter only works when also using the parameters offset and limit.
      * @param updatedbefore number? - Filter for documents which are updated before a given UNIX timestamp. The updatedbefore filter only works when also using the parameters offset and limit.
+     * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
      * @param documentclassids string? - List of documentclass IDs for the target. The limit here is 1000 IDs. The IDs are passed as a comma separated list.
      * @param withoutdocumentclass boolean? - Filters the returned reference documents to include only documents that are not linked to a documentclass. The parameter is of type boolean and is set to false by default.
      * @param mincharacters number? - Filters the returned reference documents to include only documents that have a minimum of characters
@@ -3418,13 +3408,13 @@ declare class ReferencedocumentsEndpoint {
      * @param fields string? - Define which fields should be returned by the /referencedocuments endpoints. The following values can be sent as a comma-separated list: 'id', 'name', 'tags', 'derivedtags', 'metadata', 'filename', 'created', 'processed', 'lang', 'updated, color, derivedcolor, comment, derivedcomment, documentclass, contentpreview'. If empty or null all fields will be returned. Example: "id,name,contentpreview,tags"
      */
     getAsXlsx(params?: {
-        tags?: string;
         documentids?: string;
         name?: string;
         createdafter?: number;
         createdbefore?: number;
         updatedafter?: number;
         updatedbefore?: number;
+        tags?: string;
         documentclassids?: string;
         withoutdocumentclass?: boolean;
         mincharacters?: number;
@@ -3503,8 +3493,7 @@ declare class ReferencesEndpoint {
      *
      * @param file Blob? - Input document (left document).
      * @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
-     * @param referencedocumentids string[]? - To filter for document IDs. The limit here is 65000 IDs.
-     * The IDs are passed as a JSON array.
+     * @param referencedocumentids string[]? - To filter for document IDs. The limit here is 65000 IDs. The IDs are passed as a JSON array.
      * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
      * @param documentclassids string[]? - List of documentclass IDs for the target. The limit here is 1000 IDs.
      * The IDs are passed as a JSON array.
@@ -3556,8 +3545,7 @@ declare class ReferencesEndpoint {
      *
      * @param file Blob? - Input document (left document).
      * @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
-     * @param referencedocumentids string[]? - To filter for document IDs. The limit here is 65000 IDs.
-     * The IDs are passed as a JSON array.
+     * @param referencedocumentids string[]? - To filter for document IDs. The limit here is 65000 IDs. The IDs are passed as a JSON array.
      * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
      * @param documentclassids string[]? - List of documentclass IDs for the target. The limit here is 1000 IDs.
      * The IDs are passed as a JSON array.
@@ -3609,8 +3597,7 @@ declare class ReferencesEndpoint {
      *
      * @param file Blob? - Input document (left document).
      * @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
-     * @param referencedocumentids string[]? - To filter for document IDs. The limit here is 65000 IDs.
-     * The IDs are passed as a JSON array.
+     * @param referencedocumentids string[]? - To filter for document IDs. The limit here is 65000 IDs. The IDs are passed as a JSON array.
      * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
      * @param documentclassids string[]? - List of documentclass IDs for the target. The limit here is 1000 IDs.
      * The IDs are passed as a JSON array.
@@ -3662,8 +3649,7 @@ declare class ReferencesEndpoint {
      *
      * @param file Blob? - Input document (left document).
      * @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
-     * @param referencedocumentids string[]? - To filter for document IDs. The limit here is 65000 IDs.
-     * The IDs are passed as a JSON array.
+     * @param referencedocumentids string[]? - To filter for document IDs. The limit here is 65000 IDs. The IDs are passed as a JSON array.
      * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
      * @param documentclassids string[]? - List of documentclass IDs for the target. The limit here is 1000 IDs.
      * The IDs are passed as a JSON array.
@@ -3739,107 +3725,6 @@ declare class SettingsEndpoint {
     patch(body: Settings): Promise<Settings>;
 }
 
-/**
- * @author semantha
- *
- * Class to access resource "/api/domains/{domainname}/similaritymatrix/cluster"
- * This is a generated file do not change manually!
- */
-declare class SimilaritymatrixClusterEndpoint {
-    private readonly restClient;
-    private readonly parentEndpoint;
-    private readonly ENDPOINT;
-    constructor(restClient: RestClient, parentEndpoint: string);
-    /**
-     * Get document clustersConsolidate the documents to clusters based on the results of `post post /api/domains/{domainname}/similaritymatrix`
-     *
-     * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
-     * @param documentids string[]? - List of document Ids for target. The limit here is 65000 IDs.
-     * The IDs are passed as a JSON array.
-     * @param documentclassids string[]? - List of documentclass IDs for the target. The limit here is 1000 IDs.
-     * The IDs are passed as a JSON array.
-     * This does not apply on the GET referencedocuments call. Here the ids are separated with a comma.
-     * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
-     * In general, the higher the threshold, the more precise the results.
-     * @param mode ModeEnum? - When using the references endpoint: Use mode to determine the type of search semantha should perform.
-     * fingerprint: semantic search based on sentences;
-     * keyword: keyword: search based on sentences;
-     * document: a bag-of-words search that ranks a set of documents based on the query terms appearing in each document, regardless of their proximity within the document. Higher scores indicate higher similarity. Please note that the similarity score has no upper limit and is not normalized;
-     * document_fingerprint: a bag-of-words search that ranks a set of documents based on the query terms appearing in each document, regardless of their proximity within the document. The results are then reranked based on a semantic search. This reranking results in normalized scores and as such represents an enhancement of the mode document;
-     * fingerprint_keyword (formerly auto): semantic search, if no results are found a keyword search is performed
-     * Creating document model: It also defines what structure should be considered for what operator (similarity or extraction).
-     * @param considertexttype boolean? - Use this parameter to ensure that only paragraphs of the same type are compared with each other. The parameter is of type boolean and is set to false by default.
-     */
-    post(data: {
-        tags?: string;
-        documentids?: string[];
-        documentclassids?: string[];
-        similaritythreshold?: number;
-        mode?: ModeEnum;
-        considertexttype?: boolean;
-    }): Promise<MatrixRow[]>;
-    /**
-     * Get document clustersConsolidate the documents to clusters based on the results of `post post /api/domains/{domainname}/similaritymatrix`
-     *
-     * @param body MatrixRow[]? -
-     */
-    postJson(body?: MatrixRow[]): Promise<MatrixRow[]>;
-}
-
-/**
- * @author semantha
- *
- * Class to access resource "/api/domains/{domainname}/similaritymatrix"
- * This is a generated file do not change manually!
- */
-declare class SimilaritymatrixEndpoint {
-    private readonly restClient;
-    private readonly parentEndpoint;
-    private readonly ENDPOINT;
-    constructor(restClient: RestClient, parentEndpoint: string);
-    cluster(): SimilaritymatrixClusterEndpoint;
-    /**
-     * Get a similarity matrix
-     *
-     * @param file Blob? - Input document (left document).
-     * @param tags string? - List of tags to filter the reference library. You can combine the tags using a comma (OR) and using a plus sign (AND).
-     * @param sourcetags string? - Filters the input library by tags
-     * @param documentids string[]? - List of document Ids for target. The limit here is 65000 IDs.
-     * The IDs are passed as a JSON array.
-     * @param sourcedocumentids string[]? - List of document IDs for source. The limit here is 65000 IDs.
-     * The IDs are passed as a JSON array.
-     * @param documentclassids string[]? - List of documentclass IDs for the target. The limit here is 1000 IDs.
-     * The IDs are passed as a JSON array.
-     * This does not apply on the GET referencedocuments call. Here the ids are separated with a comma.
-     * @param sourcedocumentclassids string[]? - List of documentclass IDs for the source. The limit here is 1000 IDs.
-     * The IDs are passed as a JSON array.
-     * @param similaritythreshold number? - Threshold for the similarity score. semantha will not deliver results with a sentence score lower than the threshold.
-     * In general, the higher the threshold, the more precise the results.
-     * @param mode ModeEnum? - When using the references endpoint: Use mode to determine the type of search semantha should perform.
-     * fingerprint: semantic search based on sentences;
-     * keyword: keyword: search based on sentences;
-     * document: a bag-of-words search that ranks a set of documents based on the query terms appearing in each document, regardless of their proximity within the document. Higher scores indicate higher similarity. Please note that the similarity score has no upper limit and is not normalized;
-     * document_fingerprint: a bag-of-words search that ranks a set of documents based on the query terms appearing in each document, regardless of their proximity within the document. The results are then reranked based on a semantic search. This reranking results in normalized scores and as such represents an enhancement of the mode document;
-     * fingerprint_keyword (formerly auto): semantic search, if no results are found a keyword search is performed
-     * Creating document model: It also defines what structure should be considered for what operator (similarity or extraction).
-     * @param documenttype string? - Specifies the document type that is to be used by semantha when reading the uploaded document.
-     * @param considertexttype boolean? - Use this parameter to ensure that only paragraphs of the same type are compared with each other. The parameter is of type boolean and is set to false by default.
-     */
-    post(data: {
-        file?: Blob;
-        tags?: string;
-        sourcetags?: string;
-        documentids?: string[];
-        sourcedocumentids?: string[];
-        documentclassids?: string[];
-        sourcedocumentclassids?: string[];
-        similaritythreshold?: number;
-        mode?: ModeEnum;
-        documenttype?: string;
-        considertexttype?: boolean;
-    }): Promise<MatrixRow[]>;
-}
-
 /**
  * @author semantha
  *
@@ -3990,7 +3875,7 @@ declare class ValidationEndpoint {
     private readonly ENDPOINT;
     constructor(restClient: RestClient, parentEndpoint: string);
     /**
-     * Validate existing data in a documentThe coordinates come back, if data is found
+     * Validate existing data in a document. The coordinates come back, if data is found
      *
      * @param file Blob? - Input document (left document).
      */
@@ -4026,7 +3911,6 @@ declare class DomainEndpoint {
     referencedocuments(documentid: string): ReferencedocumentEndpoint;
     references(): ReferencesEndpoint;
     settings(): SettingsEndpoint;
-    similaritymatrix(): SimilaritymatrixEndpoint;
     summarizations(): SummarizationsEndpoint;
     tags(): TagsEndpoint;
     tags(tagname: string): TagEndpoint;
@@ -4631,7 +4515,7 @@ declare class ModelRulefunctionsEndpoint {
     private readonly ENDPOINT;
     constructor(restClient: RestClient, parentEndpoint: string);
     /**
-     * Get all rulecfunctions
+     * Get all rulefunctions
      */
     get(): Promise<RuleFunction[]>;
 }
@@ -5003,7 +4887,7 @@ declare class ModelDomainEndpoint {
     /**
      * Update a domain by domainname
      *
-     * @param file Blob - Input document (left document).
+     * @param file Blob -
      */
     patch(file: Blob): Promise<Blob>;
 }
@@ -5132,4 +5016,4 @@ declare class SemanthaAPI {
     model(): ModelEndpoint;
 }
 
-export { type AnnotationCell, type AnnotationPage, type Answer, type AnswerReference, AnswersEndpoint, type Area, type Argument, type Attachment, type Attribute, type AttributeDatatypeEnum, AttributeDatatypeEnumValues, type AttributeOverview, type AttributeOverviewDatatypeEnum, AttributeOverviewDatatypeEnumValues, type BoostWord, BulkDomainsEndpoint, BulkEndpoint, BulkModelEndpoint, BulkdomainsDocumentclassesEndpoint, BulkdomainsDocumenttypesEndpoint, BulkdomainsDomainEndpoint, BulkdomainsReferencedocumentsEndpoint, BulkdomainsReferencesEndpoint, BulkmodelBoostwordsEndpoint, BulkmodelClassEndpoint, BulkmodelClassesEndpoint, BulkmodelDatapropertiesEndpoint, BulkmodelDomainEndpoint, BulkmodelDomainsEndpoint, BulkmodelInstancesEndpoint, BulkmodelMetadataEndpoint, BulkmodelNamedentitiesEndpoint, BulkmodelRulesEndpoint, BulkmodelStopwordsEndpoint, BulkmodelSynonymsEndpoint, BulkmodelclassInstancesEndpoint, type CellType, CelltypesEndpoint, type Char, type Chat, ChatEndpoint, type ChatResponse, ChatsEndpoint, ChildExtractorclassesEndpoint, type Class, type ClassBulk, type ClassBulkDatatypeEnum, ClassBulkDatatypeEnumValues, type ClassesOverview, CloneEndpoint, type ClusteredDocument, type ClusteringResponse, type ClusteringstructureEnum, ClusteringstructureEnumValues, ClustersEndpoint, type ComplexProperty, type Condition, type ConditionValue, ConversionsEndpoint, type CurrentUser, CurrentuserEndpoint, type CustomField, type DataProperty, DiffEndpoint, type Difference, type DifferenceOperationEnum, DifferenceOperationEnumValues, type Distance, DocclassCustomfieldsEndpoint, DocclassDocumentclassesEndpoint, DocclassReferencedocumentsEndpoint, DocclassTagsEndpoint, type Document, type DocumentClass, type DocumentClassBulk, type DocumentClassNode, type DocumentCluster, type DocumentInformation, type DocumentMetaData, type DocumentNamedEntity, type DocumentTable, type DocumentType, type DocumentTypeChange, type DocumentTypeConfig, DocumentannotationsEndpoint, DocumentclassEndpoint, DocumentclassesEndpoint, type DocumentmodeEnum, DocumentmodeEnumValues, DocumentsEndpoint, DocumenttypeEndpoint, DocumenttypesEndpoint, type Domain, DomainEndpoint, type DomainInfo, DomainsEndpoint, type Entity, type ErrorContainer, type ErrorField, type ErrorFieldCodeEnum, ErrorFieldCodeEnumValues, type Expression, type ExtractionArea, type ExtractionFile, type ExtractionReference, type Extractor, type ExtractorAttribute, type ExtractorAttributeDatatypeEnum, ExtractorAttributeDatatypeEnumValues, type ExtractorClass, type ExtractorClassOverview, type ExtractorTypeEnum, ExtractorTypeEnumValues, type Features, type Field, type FieldTypeEnum, FieldTypeEnumValues, type FileReference, type Finding, type FormatInformation, type Formatter, ImageEndpoint, ImagesEndpoint, type Info, InfoEndpoint, type Instance, type InstanceChild, type InstanceOverview, type Label, type LanguageDetection, LanguagesEndpoint, type Link, type LinkedInstance, type LinkedValue, type Matcher, type MatcherTypeEnum, MatcherTypeEnumValues, type MatrixRow, MediaType, type Message, type MessageRoleEnum, MessageRoleEnumValues, type MetaInfoPage, type Metadata, type MetadataValue, type ModeEnum, ModeEnumValues, ModelAttributesEndpoint, ModelBackupsEndpoint, ModelBoostwordEndpoint, ModelBoostwordsEndpoint, type ModelClass, ModelDatapropertiesEndpoint, ModelDatapropertyEndpoint, ModelDatatypesEndpoint, ModelDomainEndpoint, ModelDomainsEndpoint, ModelEndpoint, ModelExtractorclassEndpoint, ModelExtractorclassesEndpoint, ModelExtractorsEndpoint, ModelExtractortypesEndpoint, ModelFormattersEndpoint, type ModelInstance, type ModelMetadata, ModelMetadataEndpoint, ModelMetadatatypesEndpoint, ModelNamedentitiesEndpoint, ModelNamedentityEndpoint, ModelObjectpropertiesEndpoint, ModelOnemetadataEndpoint, ModelRegexEndpoint, ModelRegexesEndpoint, ModelRelationEndpoint, ModelRelationsEndpoint, ModelRuleEndpoint, ModelRulefunctionsEndpoint, ModelRulesEndpoint, ModelStopwordEndpoint, ModelStopwordsEndpoint, ModelSynonymEndpoint, ModelSynonymsEndpoint, ModelclassesEndpoint, ModelinstancesEndpoint, ModelontAttributeEndpoint, ModelontAttributesEndpoint, ModelontClassEndpoint, ModelontClassesEndpoint, ModelontInstanceEndpoint, ModelontInstancesEndpoint, ModelontclassInstancesEndpoint, type Name, type NamedEntity, NamedentitiesEndpoint, type Overview, type Page, type PageContent, type Paragraph, ParagraphEndpoint, type ParagraphUpdate, ParagraphsEndpoint, type PlotlyChart, type ProcessInformation, type Prompt, PromptEndpoint, type PromptExecution, type PromptOverview, type PromptOverviewPromptLabelEnum, PromptOverviewPromptLabelEnumValues, type PromptPromptLabelEnum, PromptPromptLabelEnumValues, type PromptResponse, PromptsEndpoint, type Range, type RangeEnum, RangeEnumValues, type Rect, type Reference, type ReferenceDocumentsResponseContainer, ReferencedocumentEndpoint, ReferencedocumentsEndpoint, ReferencesEndpoint, type Regex, type Relation, type RelationCondition, type ResponseMetaInfo, RestClient, RestResponse, RolesEndpoint, type Row, type Rule, type RuleFunction, type RuleFunctionTypeEnum, RuleFunctionTypeEnumValues, type RuleOverview, SemanthaAPI, type SemanticModel, type SemiSuperVisedDocument, type Sentence, SentenceEndpoint, SentencesEndpoint, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, SimilaritymatrixClusterEndpoint, SimilaritymatrixEndpoint, type SimpleProperty, type SmartClusterResponseContainer, type SmartClusterSemiSupervisedRequest, type SmartClusterSemiSupervisedRequestClusteringStructureEnum, SmartClusterSemiSupervisedRequestClusteringStructureEnumValues, type SmartClusterSemiSupervisedRequestTopicOverTimeRangeEnum, SmartClusterSemiSupervisedRequestTopicOverTimeRangeEnumValues, type SourceDocument, type Statistic, StatisticEndpoint, type StopWord, type Summarization, SummarizationsEndpoint, type SummarylengthEnum, SummarylengthEnumValues, type Synonym, type TableCell, type TableInstance, type TagDocs, TagEndpoint, TagReferencedocumentsEndpoint, TagsEndpoint, type TextType, TexttypesEndpoint, type TransactionSummary, TransactionsEndpoint, type TypeEnum, TypeEnumValues, ValidationEndpoint, type Version, isAttributeDatatypeEnumValue, isAttributeOverviewDatatypeEnumValue, isClassBulkDatatypeEnumValue, isClusteringstructureEnumValue, isDifferenceOperationEnumValue, isDocumentmodeEnumValue, isErrorFieldCodeEnumValue, isExtractorAttributeDatatypeEnumValue, isExtractorTypeEnumValue, isFieldTypeEnumValue, isMatcherTypeEnumValue, isMessageRoleEnumValue, isModeEnumValue, isPromptOverviewPromptLabelEnumValue, isPromptPromptLabelEnumValue, isRangeEnumValue, isRuleFunctionTypeEnumValue, isSettingsDefaultSimilarityModeEnumValue, isSettingsExtractionStrategyEnumValue, isSettingsTaggingStrategyEnumValue, isSmartClusterSemiSupervisedRequestClusteringStructureEnumValue, isSmartClusterSemiSupervisedRequestTopicOverTimeRangeEnumValue, isSummarylengthEnumValue, isTypeEnumValue };
+export { type AnnotationCell, type AnnotationPage, type Answer, type AnswerReference, AnswersEndpoint, type Area, type Argument, type Attachment, type Attribute, type AttributeDatatypeEnum, AttributeDatatypeEnumValues, type AttributeOverview, type AttributeOverviewDatatypeEnum, AttributeOverviewDatatypeEnumValues, type BoostWord, BulkDomainsEndpoint, BulkEndpoint, BulkModelEndpoint, BulkdomainsDocumentclassesEndpoint, BulkdomainsDocumenttypesEndpoint, BulkdomainsDomainEndpoint, BulkdomainsReferencedocumentsEndpoint, BulkdomainsReferencesEndpoint, BulkmodelBoostwordsEndpoint, BulkmodelClassEndpoint, BulkmodelClassesEndpoint, BulkmodelDatapropertiesEndpoint, BulkmodelDomainEndpoint, BulkmodelDomainsEndpoint, BulkmodelInstancesEndpoint, BulkmodelMetadataEndpoint, BulkmodelNamedentitiesEndpoint, BulkmodelRulesEndpoint, BulkmodelStopwordsEndpoint, BulkmodelSynonymsEndpoint, BulkmodelclassInstancesEndpoint, type CellType, CelltypesEndpoint, type Char, type Chat, ChatEndpoint, type ChatResponse, ChatsEndpoint, ChildExtractorclassesEndpoint, type Class, type ClassBulk, type ClassBulkDatatypeEnum, ClassBulkDatatypeEnumValues, type ClassesOverview, CloneEndpoint, type ClusteredDocument, type ClusteringResponse, type ClusteringstructureEnum, ClusteringstructureEnumValues, ClustersEndpoint, type ComplexProperty, type Condition, type ConditionValue, ConversionsEndpoint, type CurrentUser, CurrentuserEndpoint, type CustomField, type DataProperty, DiffEndpoint, type Difference, type DifferenceOperationEnum, DifferenceOperationEnumValues, type Distance, DocclassCustomfieldsEndpoint, DocclassDocumentclassesEndpoint, DocclassReferencedocumentsEndpoint, DocclassTagsEndpoint, type Document, type DocumentClass, type DocumentClassBulk, type DocumentClassNode, type DocumentCluster, type DocumentInformation, type DocumentMetaData, type DocumentNamedEntity, type DocumentTable, type DocumentType, type DocumentTypeChange, type DocumentTypeConfig, DocumentannotationsEndpoint, DocumentclassEndpoint, DocumentclassesEndpoint, type DocumentmodeEnum, DocumentmodeEnumValues, DocumentsEndpoint, DocumenttypeEndpoint, DocumenttypesEndpoint, type Domain, DomainEndpoint, type DomainInfo, DomainsEndpoint, type Entity, type ErrorContainer, type ErrorField, type ErrorFieldCodeEnum, ErrorFieldCodeEnumValues, type Expression, type ExtractionArea, type ExtractionFile, type ExtractionReference, type Extractor, type ExtractorAttribute, type ExtractorAttributeDatatypeEnum, ExtractorAttributeDatatypeEnumValues, type ExtractorClass, type ExtractorClassOverview, type ExtractorTypeEnum, ExtractorTypeEnumValues, type Features, type Field, type FieldTypeEnum, FieldTypeEnumValues, type FileReference, type Finding, type FormatInformation, type Formatter, ImageEndpoint, ImagesEndpoint, type Info, InfoEndpoint, type Instance, type InstanceChild, type InstanceOverview, type Label, type LanguageDetection, LanguagesEndpoint, type Link, type LinkedInstance, type LinkedValue, type Matcher, type MatcherTypeEnum, MatcherTypeEnumValues, MediaType, type Message, type MessageRoleEnum, MessageRoleEnumValues, type MetaInfoPage, type Metadata, type MetadataValue, type ModeEnum, ModeEnumValues, ModelAttributesEndpoint, ModelBackupsEndpoint, ModelBoostwordEndpoint, ModelBoostwordsEndpoint, type ModelClass, ModelDatapropertiesEndpoint, ModelDatapropertyEndpoint, ModelDatatypesEndpoint, ModelDomainEndpoint, ModelDomainsEndpoint, ModelEndpoint, ModelExtractorclassEndpoint, ModelExtractorclassesEndpoint, ModelExtractorsEndpoint, ModelExtractortypesEndpoint, ModelFormattersEndpoint, type ModelInstance, type ModelMetadata, ModelMetadataEndpoint, ModelMetadatatypesEndpoint, ModelNamedentitiesEndpoint, ModelNamedentityEndpoint, ModelObjectpropertiesEndpoint, ModelOnemetadataEndpoint, ModelRegexEndpoint, ModelRegexesEndpoint, ModelRelationEndpoint, ModelRelationsEndpoint, ModelRuleEndpoint, ModelRulefunctionsEndpoint, ModelRulesEndpoint, ModelStopwordEndpoint, ModelStopwordsEndpoint, ModelSynonymEndpoint, ModelSynonymsEndpoint, ModelclassesEndpoint, ModelinstancesEndpoint, ModelontAttributeEndpoint, ModelontAttributesEndpoint, ModelontClassEndpoint, ModelontClassesEndpoint, ModelontInstanceEndpoint, ModelontInstancesEndpoint, ModelontclassInstancesEndpoint, type Name, type NamedEntity, NamedentitiesEndpoint, type Overview, type Page, type PageContent, type Paragraph, ParagraphEndpoint, type ParagraphUpdate, ParagraphsEndpoint, type PlotlyChart, type ProcessInformation, type Prompt, PromptEndpoint, type PromptExecution, type PromptOverview, type PromptOverviewPromptLabelEnum, PromptOverviewPromptLabelEnumValues, type PromptPromptLabelEnum, PromptPromptLabelEnumValues, type PromptResponse, PromptsEndpoint, type Range, type RangeEnum, RangeEnumValues, type Rect, type Reference, type ReferenceDocumentsResponseContainer, ReferencedocumentEndpoint, ReferencedocumentsEndpoint, ReferencesEndpoint, type Regex, type Relation, type RelationCondition, type ResponseMetaInfo, RestClient, RestResponse, RolesEndpoint, type Row, type Rule, type RuleFunction, type RuleFunctionTypeEnum, RuleFunctionTypeEnumValues, type RuleOverview, SemanthaAPI, type SemanticModel, type SemiSuperVisedDocument, type Sentence, SentenceEndpoint, SentencesEndpoint, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, type SmartClusterResponseContainer, type SmartClusterSemiSupervisedRequest, type SmartClusterSemiSupervisedRequestClusteringStructureEnum, SmartClusterSemiSupervisedRequestClusteringStructureEnumValues, type SmartClusterSemiSupervisedRequestTopicOverTimeRangeEnum, SmartClusterSemiSupervisedRequestTopicOverTimeRangeEnumValues, type SourceDocument, type Statistic, StatisticEndpoint, type StopWord, type Summarization, SummarizationsEndpoint, type SummarylengthEnum, SummarylengthEnumValues, type Synonym, type TableCell, type TableInstance, type TagDocs, TagEndpoint, TagReferencedocumentsEndpoint, TagsEndpoint, type TextType, TexttypesEndpoint, type TransactionSummary, TransactionsEndpoint, type TypeEnum, TypeEnumValues, ValidationEndpoint, type Version, isAttributeDatatypeEnumValue, isAttributeOverviewDatatypeEnumValue, isClassBulkDatatypeEnumValue, isClusteringstructureEnumValue, isDifferenceOperationEnumValue, isDocumentmodeEnumValue, isErrorFieldCodeEnumValue, isExtractorAttributeDatatypeEnumValue, isExtractorTypeEnumValue, isFieldTypeEnumValue, isMatcherTypeEnumValue, isMessageRoleEnumValue, isModeEnumValue, isPromptOverviewPromptLabelEnumValue, isPromptPromptLabelEnumValue, isRangeEnumValue, isRuleFunctionTypeEnumValue, isSettingsDefaultSimilarityModeEnumValue, isSettingsExtractionStrategyEnumValue, isSettingsTaggingStrategyEnumValue, isSmartClusterSemiSupervisedRequestClusteringStructureEnumValue, isSmartClusterSemiSupervisedRequestTopicOverTimeRangeEnumValue, isSummarylengthEnumValue, isTypeEnumValue };