@semantha/sdk 10.4.0 → 10.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -679,7 +679,6 @@ interface DocumentClassNode {
679
679
  name: string;
680
680
  id?: string;
681
681
  parentId?: string;
682
- metadata?: string;
683
682
  documentsCount?: number;
684
683
  customFields?: CustomField[];
685
684
  }
@@ -693,7 +692,6 @@ interface DocumentClass {
693
692
  name: string;
694
693
  id?: string;
695
694
  parentId?: string;
696
- metadata?: string;
697
695
  documentsCount?: number;
698
696
  subClasses?: DocumentClassNode[];
699
697
  customFields?: CustomField[];
@@ -705,7 +703,6 @@ interface DocumentClass {
705
703
  derivedComment?: string;
706
704
  created?: number;
707
705
  updated?: number;
708
- derivedMetadata?: string;
709
706
  }
710
707
 
711
708
  /**
@@ -723,7 +720,6 @@ interface DocumentClassBulk {
723
720
  comment?: string;
724
721
  created?: number;
725
722
  updated?: number;
726
- metadata?: string;
727
723
  customFields?: CustomField[];
728
724
  }
729
725
 
@@ -1667,7 +1663,8 @@ declare enum MediaType {
1667
1663
  ZIP = "application/zip",
1668
1664
  REQIFZ = "application/reqifz",
1669
1665
  PNG = "image/png",
1670
- BINARY = "application/octet-stream"
1666
+ BINARY = "application/octet-stream",
1667
+ TEXT_PLAIN = "text/plain"
1671
1668
  }
1672
1669
  declare class RestClient {
1673
1670
  private readonly serverUrl;
@@ -1713,7 +1710,8 @@ declare class AnswersEndpoint {
1713
1710
  private readonly ENDPOINT;
1714
1711
  constructor(restClient: RestClient, parentEndpoint: string);
1715
1712
  /**
1716
- * Finds references in library for a given question and uses references to generate an answer.The 'maxReferences' parameter determines how many library items are used. The language of the answer can be changed via the 'language' parameter.
1713
+ * Finds references in library for a given question and uses references to generate an answer.
1714
+ * The 'maxReferences' parameter determines how many library items are used. The language of the answer can be changed via the 'language' parameter.
1717
1715
  *
1718
1716
  * @param question string? - The text to find in the library.
1719
1717
  * @param maxreferences number? - Number of references found in library to base the answer on.
@@ -1723,7 +1721,7 @@ declare class AnswersEndpoint {
1723
1721
  * Supported Languages:
1724
1722
  * "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
1725
1723
  * "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
1726
- * "sv", "tr", "zh-CN", "zh-TW"
1724
+ * "sv", "tr", "zh"
1727
1725
  * @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 "!"
1728
1726
  */
1729
1727
  post(data: {
@@ -1761,7 +1759,8 @@ declare class BulkmodelBoostwordsEndpoint {
1761
1759
  private readonly ENDPOINT;
1762
1760
  constructor(restClient: RestClient, parentEndpoint: string);
1763
1761
  /**
1764
- * Create one or more boostwordsThis is the quiet version of 'post /api/domains/{domainname}/boostwords'
1762
+ * Create one or more boostwords
1763
+ * This is the quiet version of 'post /api/domains/{domainname}/boostwords'
1765
1764
  *
1766
1765
  * @param body BoostWord[]? -
1767
1766
  */
@@ -1780,7 +1779,8 @@ declare class BulkmodelclassInstancesEndpoint {
1780
1779
  private readonly ENDPOINT;
1781
1780
  constructor(restClient: RestClient, parentEndpoint: string);
1782
1781
  /**
1783
- * Get all instances of the classes by class idThis is the quiet version of 'get /api/model/domains/{domainname}/classes/{id}/instances'
1782
+ * Get all instances of the classes by class id
1783
+ * This is the quiet version of 'get /api/model/domains/{domainname}/classes/{id}/instances'
1784
1784
  */
1785
1785
  get(): Promise<Instance[]>;
1786
1786
  }
@@ -1812,11 +1812,13 @@ declare class BulkmodelClassesEndpoint {
1812
1812
  private readonly ENDPOINT;
1813
1813
  constructor(restClient: RestClient, parentEndpoint: string);
1814
1814
  /**
1815
- * Get all classesThis is the quiet version of 'get /api/domains/{domainname}/classes'
1815
+ * Get all classes
1816
+ * This is the quiet version of 'get /api/domains/{domainname}/classes'
1816
1817
  */
1817
1818
  get(): Promise<ClassBulk[]>;
1818
1819
  /**
1819
- * Create one or more classesThis is the quiet version of 'post /api/domains/{domainname}/classes'
1820
+ * Create one or more classes
1821
+ * This is the quiet version of 'post /api/domains/{domainname}/classes'
1820
1822
  *
1821
1823
  * @param body ClassBulk[]? -
1822
1824
  */
@@ -1835,11 +1837,13 @@ declare class BulkmodelDatapropertiesEndpoint {
1835
1837
  private readonly ENDPOINT;
1836
1838
  constructor(restClient: RestClient, parentEndpoint: string);
1837
1839
  /**
1838
- * Get all datapropertiesThis is the quiet version of 'get /api/domains/{domainname}/dataproperties'
1840
+ * Get all dataproperties
1841
+ * This is the quiet version of 'get /api/domains/{domainname}/dataproperties'
1839
1842
  */
1840
1843
  get(): Promise<DataProperty[]>;
1841
1844
  /**
1842
- * Create one or more datapropertiesThis is the quiet version of 'post /api/domains/{domainname}/dataproperties'
1845
+ * Create one or more dataproperties
1846
+ * This is the quiet version of 'post /api/domains/{domainname}/dataproperties'
1843
1847
  *
1844
1848
  * @param body DataProperty[]? -
1845
1849
  */
@@ -1858,11 +1862,13 @@ declare class BulkmodelInstancesEndpoint {
1858
1862
  private readonly ENDPOINT;
1859
1863
  constructor(restClient: RestClient, parentEndpoint: string);
1860
1864
  /**
1861
- * Get all instancesThis is the quiet version of 'get /api/domains/{domainname}/instances'
1865
+ * Get all instances
1866
+ * This is the quiet version of 'get /api/domains/{domainname}/instances'
1862
1867
  */
1863
1868
  get(): Promise<Instance[]>;
1864
1869
  /**
1865
- * Create an instanceThis is the quiet version of 'post /api/model/domains/{domainname}/instances'
1870
+ * Create an instance
1871
+ * This is the quiet version of 'post /api/model/domains/{domainname}/instances'
1866
1872
  *
1867
1873
  * @param body Instance[]? -
1868
1874
  */
@@ -1881,11 +1887,13 @@ declare class BulkmodelMetadataEndpoint {
1881
1887
  private readonly ENDPOINT;
1882
1888
  constructor(restClient: RestClient, parentEndpoint: string);
1883
1889
  /**
1884
- * Get all metadataThis is the quiet version of 'get /api/domains/{domainname}/metadata'
1890
+ * Get all metadata
1891
+ * This is the quiet version of 'get /api/domains/{domainname}/metadata'
1885
1892
  */
1886
1893
  get(): Promise<ModelMetadata[]>;
1887
1894
  /**
1888
- * Create one or more metadataThis is the quiet version of 'post /api/domains/{domainname}/metadata'
1895
+ * Create one or more metadata
1896
+ * This is the quiet version of 'post /api/domains/{domainname}/metadata'
1889
1897
  *
1890
1898
  * @param body ModelMetadata[]? -
1891
1899
  */
@@ -1904,7 +1912,8 @@ declare class BulkmodelNamedentitiesEndpoint {
1904
1912
  private readonly ENDPOINT;
1905
1913
  constructor(restClient: RestClient, parentEndpoint: string);
1906
1914
  /**
1907
- * Create one or more named entitiesThis is the quiet version of 'post /api/domains/{domainname}/namedentities'
1915
+ * Create one or more named entities
1916
+ * This is the quiet version of 'post /api/domains/{domainname}/namedentities'
1908
1917
  *
1909
1918
  * @param body NamedEntity[]? -
1910
1919
  */
@@ -1923,11 +1932,13 @@ declare class BulkmodelRulesEndpoint {
1923
1932
  private readonly ENDPOINT;
1924
1933
  constructor(restClient: RestClient, parentEndpoint: string);
1925
1934
  /**
1926
- * Get a ruleThis is the quiet version of 'get /api/model/domains/{domainname}/rules'
1935
+ * Get a rule
1936
+ * This is the quiet version of 'get /api/model/domains/{domainname}/rules'
1927
1937
  */
1928
1938
  get(): Promise<Rule[]>;
1929
1939
  /**
1930
- * Create a ruleThis is the quiet version of 'post /api/model/domains/{domainname}/rules'
1940
+ * Create a rule
1941
+ * This is the quiet version of 'post /api/model/domains/{domainname}/rules'
1931
1942
  *
1932
1943
  * @param body Rule[]? -
1933
1944
  */
@@ -1965,7 +1976,8 @@ declare class BulkmodelSynonymsEndpoint {
1965
1976
  private readonly ENDPOINT;
1966
1977
  constructor(restClient: RestClient, parentEndpoint: string);
1967
1978
  /**
1968
- * Create one or more synonymsThis is the quiet version of 'post /api/domains/{domainname}/synonyms'
1979
+ * Create one or more synonyms
1980
+ * This is the quiet version of 'post /api/domains/{domainname}/synonyms'
1969
1981
  *
1970
1982
  * @param body Synonym[]? -
1971
1983
  */
@@ -2036,7 +2048,8 @@ declare class BulkdomainsDocumentclassesEndpoint {
2036
2048
  private readonly ENDPOINT;
2037
2049
  constructor(restClient: RestClient, parentEndpoint: string);
2038
2050
  /**
2039
- * Get all document classesThis is the quiet version of 'get /api/domains/{domainname}/documentclasses'
2051
+ * Get all document classes
2052
+ * This is the quiet version of 'get /api/domains/{domainname}/documentclasses'
2040
2053
  *
2041
2054
  * @param withdocids boolean? -
2042
2055
  */
@@ -2044,7 +2057,8 @@ declare class BulkdomainsDocumentclassesEndpoint {
2044
2057
  withdocids?: boolean;
2045
2058
  }): Promise<DocumentClassBulk[]>;
2046
2059
  /**
2047
- * Create one or more document classesThis is the quiet version of 'post /api/domains/{domainname}/documentclasses'
2060
+ * Create one or more document classes
2061
+ * This is the quiet version of 'post /api/domains/{domainname}/documentclasses'
2048
2062
  *
2049
2063
  * @param body DocumentClassBulk[]? -
2050
2064
  */
@@ -2081,7 +2095,8 @@ declare class BulkdomainsReferencedocumentsEndpoint {
2081
2095
  private readonly ENDPOINT;
2082
2096
  constructor(restClient: RestClient, parentEndpoint: string);
2083
2097
  /**
2084
- * Get all reference documentsThis is the quiet version of 'get /api/domains/{domainname}/referencedocuments'
2098
+ * Get all reference documents
2099
+ * This is the quiet version of 'get /api/domains/{domainname}/referencedocuments'
2085
2100
  *
2086
2101
  * @param withsentences boolean? - Gives back the sentences of a paragraph.
2087
2102
  */
@@ -2093,7 +2108,8 @@ declare class BulkdomainsReferencedocumentsEndpoint {
2093
2108
  */
2094
2109
  delete(body: string[]): Promise<RestResponse<void>>;
2095
2110
  /**
2096
- * Upload reference documentThis is the quiet version of 'post /api/domains/{domainname}/referencedocuments'
2111
+ * Upload reference document
2112
+ * This is the quiet version of 'post /api/domains/{domainname}/referencedocuments'
2097
2113
  *
2098
2114
  * @param name string? - The document name in your library (in contrast to the file name being used during upload).
2099
2115
  * @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).
@@ -2122,7 +2138,8 @@ declare class BulkdomainsReferencedocumentsEndpoint {
2122
2138
  linkclasses?: boolean;
2123
2139
  }): Promise<void>;
2124
2140
  /**
2125
- * Upload reference documentThis is the quiet version of 'post /api/domains/{domainname}/referencedocuments'
2141
+ * Upload reference document
2142
+ * This is the quiet version of 'post /api/domains/{domainname}/referencedocuments'
2126
2143
  *
2127
2144
  * @param body Document[]? -
2128
2145
  */
@@ -2144,7 +2161,8 @@ declare class BulkdomainsReferencesEndpoint {
2144
2161
  private readonly ENDPOINT;
2145
2162
  constructor(restClient: RestClient, parentEndpoint: string);
2146
2163
  /**
2147
- * Determine references with several input documentsMatches several input documents ('file' parameter, as an alternative 'text' can be used) to a set of 'referencedocument' if set or internal library. If you match against internal library the 'tags' parameter can be used to filter the library.
2164
+ * Determine references with several input documents
2165
+ * Matches several input documents ('file' parameter, as an alternative 'text' can be used) to a set of 'referencedocument' if set or internal library. If you match against internal library the 'tags' parameter can be used to filter the library.
2148
2166
  *
2149
2167
  * @param body Document[]? -
2150
2168
  */
@@ -2227,7 +2245,8 @@ declare class ChatEndpoint {
2227
2245
  private readonly ENDPOINT;
2228
2246
  constructor(restClient: RestClient, parentEndpoint: string, id: string);
2229
2247
  /**
2230
- * Chat with the generative modelThe chat endpoint allows you to interact with the generative model in a conversational manner.
2248
+ * Chat with the generative model
2249
+ * The chat endpoint allows you to interact with the generative model in a conversational manner.
2231
2250
  *
2232
2251
  * @param body Chat? -
2233
2252
  */
@@ -2295,7 +2314,8 @@ declare class ConversionsEndpoint {
2295
2314
  private readonly ENDPOINT;
2296
2315
  constructor(restClient: RestClient, parentEndpoint: string);
2297
2316
  /**
2298
- * Converts docx files into pdf format.
2317
+ *
2318
+ * Converts vsdx/docx/pptx files into pdf format.
2299
2319
  *
2300
2320
  * @param file Blob? - The document to convert.
2301
2321
  */
@@ -2539,6 +2559,22 @@ declare class DocumentclassEndpoint {
2539
2559
  put(body: DocumentClass): Promise<DocumentClass>;
2540
2560
  }
2541
2561
 
2562
+ /**
2563
+ * @author semantha
2564
+ *
2565
+ * Class to access resource "/api/domains/{domainname}/documentclasses/tree"
2566
+ * This is a generated file do not change manually!
2567
+ */
2568
+ declare class TreeEndpoint {
2569
+ private readonly restClient;
2570
+ private readonly parentEndpoint;
2571
+ private readonly ENDPOINT;
2572
+ constructor(restClient: RestClient, parentEndpoint: string);
2573
+ get(params?: {
2574
+ fields?: string;
2575
+ }): Promise<DocumentClassNode[]>;
2576
+ }
2577
+
2542
2578
  /**
2543
2579
  * @author semantha
2544
2580
  *
@@ -2550,6 +2586,7 @@ declare class DocumentclassesEndpoint {
2550
2586
  private readonly parentEndpoint;
2551
2587
  private readonly ENDPOINT;
2552
2588
  constructor(restClient: RestClient, parentEndpoint: string);
2589
+ tree(): TreeEndpoint;
2553
2590
  /**
2554
2591
  * Get all document classes
2555
2592
  */
@@ -2578,7 +2615,8 @@ declare class DocumentsEndpoint {
2578
2615
  private readonly ENDPOINT;
2579
2616
  constructor(restClient: RestClient, parentEndpoint: string);
2580
2617
  /**
2581
- * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2618
+ * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
2619
+ * This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2582
2620
  *
2583
2621
  * @param file Blob? - Input document
2584
2622
  * @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
@@ -2616,7 +2654,8 @@ declare class DocumentsEndpoint {
2616
2654
  withsentences?: boolean;
2617
2655
  }): Promise<Document[]>;
2618
2656
  /**
2619
- * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2657
+ * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
2658
+ * This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2620
2659
  *
2621
2660
  * @param file Blob? - Input document
2622
2661
  * @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
@@ -2654,7 +2693,8 @@ declare class DocumentsEndpoint {
2654
2693
  withsentences?: boolean;
2655
2694
  }): Promise<Blob>;
2656
2695
  /**
2657
- * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2696
+ * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
2697
+ * This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2658
2698
  *
2659
2699
  * @param file Blob? - Input document
2660
2700
  * @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
@@ -2692,7 +2732,8 @@ declare class DocumentsEndpoint {
2692
2732
  withsentences?: boolean;
2693
2733
  }): Promise<Blob>;
2694
2734
  /**
2695
- * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2735
+ * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
2736
+ * This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2696
2737
  *
2697
2738
  * @param file Blob? - Input document
2698
2739
  * @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
@@ -2730,7 +2771,8 @@ declare class DocumentsEndpoint {
2730
2771
  withsentences?: boolean;
2731
2772
  }): Promise<Blob>;
2732
2773
  /**
2733
- * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2774
+ * Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
2775
+ * This service can be used with different accept headers which return the document model as json, pdf or docx. You can send a docx and return it as pdf which is based on the document model.
2734
2776
  *
2735
2777
  * @param file Blob? - Input document
2736
2778
  * @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
@@ -2934,7 +2976,8 @@ declare class PromptEndpoint {
2934
2976
  */
2935
2977
  put(body: Prompt): Promise<Prompt>;
2936
2978
  /**
2937
- * Executes a saved prompt against the configured generative model.The 'id' parameter determines which prompt is executed.
2979
+ * Executes a saved prompt against the configured generative model.
2980
+ * The 'id' parameter determines which prompt is executed.
2938
2981
  *
2939
2982
  * @param body PromptExecution? -
2940
2983
  */
@@ -2999,6 +3042,23 @@ declare class ImagesEndpoint {
2999
3042
  constructor(restClient: RestClient, parentEndpoint: string);
3000
3043
  }
3001
3044
 
3045
+ /**
3046
+ * @author semantha
3047
+ *
3048
+ * Class to access resource "/api/domains/{domainname}/referencedocuments/{documentid}/markdown"
3049
+ * This is a generated file do not change manually!
3050
+ */
3051
+ declare class MarkdownEndpoint {
3052
+ private readonly restClient;
3053
+ private readonly parentEndpoint;
3054
+ private readonly ENDPOINT;
3055
+ constructor(restClient: RestClient, parentEndpoint: string);
3056
+ /**
3057
+ * Returns one reference document by ID as markdown
3058
+ */
3059
+ getAsPlainText(): Promise<string>;
3060
+ }
3061
+
3002
3062
  /**
3003
3063
  * @author semantha
3004
3064
  *
@@ -3085,6 +3145,7 @@ declare class ReferencedocumentEndpoint {
3085
3145
  constructor(restClient: RestClient, parentEndpoint: string, documentid: string);
3086
3146
  images(): ImagesEndpoint;
3087
3147
  images(id: string): ImageEndpoint;
3148
+ markdown(): MarkdownEndpoint;
3088
3149
  paragraphs(): ParagraphsEndpoint;
3089
3150
  paragraphs(id: string): ParagraphEndpoint;
3090
3151
  sentences(): SentencesEndpoint;
@@ -3121,7 +3182,8 @@ declare class NamedentitiesEndpoint {
3121
3182
  private readonly ENDPOINT;
3122
3183
  constructor(restClient: RestClient, parentEndpoint: string);
3123
3184
  /**
3124
- * Get all named entities (a.k.a custom entities) from reference documents.Can be filtered by tags or documentclassids.
3185
+ * Get all named entities (a.k.a custom entities) from reference documents.
3186
+ * Can be filtered by tags or documentclassids.
3125
3187
  *
3126
3188
  * @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).
3127
3189
  * @param documentclassids string? - List of documentclass IDs for the target. The limit here is 1000 IDs.
@@ -3165,7 +3227,8 @@ declare class ReferencedocumentsEndpoint {
3165
3227
  namedentities(): NamedentitiesEndpoint;
3166
3228
  statistic(): StatisticEndpoint;
3167
3229
  /**
3168
- * 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>.
3230
+ * Get all reference documents a.k.a. library items.
3231
+ * 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>.
3169
3232
  *
3170
3233
  * @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.
3171
3234
  * @param name string? - Filter documents for a given name
@@ -3207,7 +3270,8 @@ declare class ReferencedocumentsEndpoint {
3207
3270
  fields?: string;
3208
3271
  }): Promise<ReferenceDocumentsResponseContainer>;
3209
3272
  /**
3210
- * 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>.
3273
+ * Get all reference documents a.k.a. library items.
3274
+ * 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>.
3211
3275
  *
3212
3276
  * @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.
3213
3277
  * @param name string? - Filter documents for a given name
@@ -3310,7 +3374,8 @@ declare class ReferencesEndpoint {
3310
3374
  private readonly ENDPOINT;
3311
3375
  constructor(restClient: RestClient, parentEndpoint: string);
3312
3376
  /**
3313
- * Determine references with one input documentReturns the input document (file) with its references. Depending on the 'Accept' header different output formats are supported. For 'application/json' we return the document with references. For xlsx we return an Excel sheet with each reference as rows. If input and output is docx or pdf we return the document with comments on paragraphs.
3377
+ * Determine references with one input document
3378
+ * Returns the input document (file) with its references. Depending on the 'Accept' header different output formats are supported. For 'application/json' we return the document with references. For xlsx we return an Excel sheet with each reference as rows. If input and output is docx or pdf we return the document with comments on paragraphs.
3314
3379
  *
3315
3380
  * @param file Blob? - Input document (left document).
3316
3381
  * @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
@@ -3363,7 +3428,8 @@ declare class ReferencesEndpoint {
3363
3428
  maxreferences?: number;
3364
3429
  }): Promise<Document>;
3365
3430
  /**
3366
- * Determine references with one input documentReturns the input document (file) with its references. Depending on the 'Accept' header different output formats are supported. For 'application/json' we return the document with references. For xlsx we return an Excel sheet with each reference as rows. If input and output is docx or pdf we return the document with comments on paragraphs.
3431
+ * Determine references with one input document
3432
+ * Returns the input document (file) with its references. Depending on the 'Accept' header different output formats are supported. For 'application/json' we return the document with references. For xlsx we return an Excel sheet with each reference as rows. If input and output is docx or pdf we return the document with comments on paragraphs.
3367
3433
  *
3368
3434
  * @param file Blob? - Input document (left document).
3369
3435
  * @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
@@ -3416,7 +3482,8 @@ declare class ReferencesEndpoint {
3416
3482
  maxreferences?: number;
3417
3483
  }): Promise<Blob>;
3418
3484
  /**
3419
- * Determine references with one input documentReturns the input document (file) with its references. Depending on the 'Accept' header different output formats are supported. For 'application/json' we return the document with references. For xlsx we return an Excel sheet with each reference as rows. If input and output is docx or pdf we return the document with comments on paragraphs.
3485
+ * Determine references with one input document
3486
+ * Returns the input document (file) with its references. Depending on the 'Accept' header different output formats are supported. For 'application/json' we return the document with references. For xlsx we return an Excel sheet with each reference as rows. If input and output is docx or pdf we return the document with comments on paragraphs.
3420
3487
  *
3421
3488
  * @param file Blob? - Input document (left document).
3422
3489
  * @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
@@ -3469,7 +3536,8 @@ declare class ReferencesEndpoint {
3469
3536
  maxreferences?: number;
3470
3537
  }): Promise<Blob>;
3471
3538
  /**
3472
- * Determine references with one input documentReturns the input document (file) with its references. Depending on the 'Accept' header different output formats are supported. For 'application/json' we return the document with references. For xlsx we return an Excel sheet with each reference as rows. If input and output is docx or pdf we return the document with comments on paragraphs.
3539
+ * Determine references with one input document
3540
+ * Returns the input document (file) with its references. Depending on the 'Accept' header different output formats are supported. For 'application/json' we return the document with references. For xlsx we return an Excel sheet with each reference as rows. If input and output is docx or pdf we return the document with comments on paragraphs.
3473
3541
  *
3474
3542
  * @param file Blob? - Input document (left document).
3475
3543
  * @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
@@ -3570,7 +3638,7 @@ declare class SummarizationsEndpoint {
3570
3638
  * Supported Languages:
3571
3639
  * "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
3572
3640
  * "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
3573
- * "sv", "tr", "zh-CN", "zh-TW"
3641
+ * "sv", "tr", "zh"
3574
3642
  * @param temperature number? - Temperature regulates the unpredictability of a language model's output. With higher temperature settings, outputs become more creative and less predictable.
3575
3643
  * @param summarylength SummarylengthEnum? - Influences the length of the returned summary. Values are 'SHORT, 'MEDIUM', 'LONG'
3576
3644
  * @param promptid string? - Id of the prompt to generate a summary, other parameters are ignored.
@@ -3678,6 +3746,10 @@ declare class TranslationsEndpoint {
3678
3746
  constructor(restClient: RestClient, parentEndpoint: string);
3679
3747
  /**
3680
3748
  * Translates a single text to a target language, optionally from a source language.
3749
+ * Supported Languages:
3750
+ * "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
3751
+ * "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
3752
+ * "sv", "tr", "zh-CN", "zh-TW"
3681
3753
  *
3682
3754
  * @param body Translation? -
3683
3755
  */
@@ -3696,7 +3768,8 @@ declare class ValidationEndpoint {
3696
3768
  private readonly ENDPOINT;
3697
3769
  constructor(restClient: RestClient, parentEndpoint: string);
3698
3770
  /**
3699
- * Validate existing data in a document.The coordinates come back, if data is found
3771
+ * Validate existing data in a document.
3772
+ * The coordinates come back, if data is found
3700
3773
  *
3701
3774
  * @param file Blob? - Input document (left document).
3702
3775
  */
@@ -3790,14 +3863,15 @@ declare class LanguagesEndpoint {
3790
3863
  private readonly ENDPOINT;
3791
3864
  constructor(restClient: RestClient, parentEndpoint: string);
3792
3865
  /**
3793
- * Identifies the language of the document and sends it backInput: Support of all input formats (pdf, docx, txt, json (DocumentModel)
3866
+ * Identifies the language of the document and sends it back
3867
+ * Input: Support of all input formats (pdf, docx, txt, json (DocumentModel)
3794
3868
  *
3795
3869
  * Output: Detected Language
3796
3870
  *
3797
3871
  * Supported Languages:
3798
3872
  * "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
3799
3873
  * "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
3800
- * "sv", "tr", "zh-CN", "zh-TW"
3874
+ * "sv", "tr", "zh"
3801
3875
  *
3802
3876
  * @param file Blob? - Input document (left document).
3803
3877
  */
@@ -4819,4 +4893,4 @@ declare class SemanthaAPI {
4819
4893
  model(): ModelEndpoint;
4820
4894
  }
4821
4895
 
4822
- 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 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 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, 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 ProcessInformation, type Prompt, PromptEndpoint, type PromptExecution, type PromptOverview, type PromptOverviewPromptLabelEnum, PromptOverviewPromptLabelEnumValues, type PromptPromptLabelEnum, PromptPromptLabelEnumValues, type PromptResponse, PromptsEndpoint, type Range, 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 Sentence, SentenceEndpoint, SentencesEndpoint, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, 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 Translation, type TranslationResponse, TranslationsEndpoint, type TypeEnum, TypeEnumValues, ValidationEndpoint, type Version, isAttributeDatatypeEnumValue, isAttributeOverviewDatatypeEnumValue, isClassBulkDatatypeEnumValue, isDifferenceOperationEnumValue, isDocumentmodeEnumValue, isErrorFieldCodeEnumValue, isExtractorAttributeDatatypeEnumValue, isExtractorTypeEnumValue, isFieldTypeEnumValue, isMatcherTypeEnumValue, isMessageRoleEnumValue, isModeEnumValue, isPromptOverviewPromptLabelEnumValue, isPromptPromptLabelEnumValue, isRuleFunctionTypeEnumValue, isSettingsDefaultSimilarityModeEnumValue, isSettingsExtractionStrategyEnumValue, isSettingsTaggingStrategyEnumValue, isSummarylengthEnumValue, isTypeEnumValue };
4896
+ 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 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 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, MarkdownEndpoint, type Matcher, type MatcherTypeEnum, MatcherTypeEnumValues, MediaType, type Message, type MessageRoleEnum, MessageRoleEnumValues, type MetaInfoPage, type Metadata, type MetadataValue, type ModeEnum, ModeEnumValues, ModelAttributesEndpoint, 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 ProcessInformation, type Prompt, PromptEndpoint, type PromptExecution, type PromptOverview, type PromptOverviewPromptLabelEnum, PromptOverviewPromptLabelEnumValues, type PromptPromptLabelEnum, PromptPromptLabelEnumValues, type PromptResponse, PromptsEndpoint, type Range, 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 Sentence, SentenceEndpoint, SentencesEndpoint, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, 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 Translation, type TranslationResponse, TranslationsEndpoint, TreeEndpoint, type TypeEnum, TypeEnumValues, ValidationEndpoint, type Version, isAttributeDatatypeEnumValue, isAttributeOverviewDatatypeEnumValue, isClassBulkDatatypeEnumValue, isDifferenceOperationEnumValue, isDocumentmodeEnumValue, isErrorFieldCodeEnumValue, isExtractorAttributeDatatypeEnumValue, isExtractorTypeEnumValue, isFieldTypeEnumValue, isMatcherTypeEnumValue, isMessageRoleEnumValue, isModeEnumValue, isPromptOverviewPromptLabelEnumValue, isPromptPromptLabelEnumValue, isRuleFunctionTypeEnumValue, isSettingsDefaultSimilarityModeEnumValue, isSettingsExtractionStrategyEnumValue, isSettingsTaggingStrategyEnumValue, isSummarylengthEnumValue, isTypeEnumValue };