@semantha/sdk 10.4.0 → 10.4.1
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 +119 -46
- package/dist/index.d.ts +119 -46
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
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
|
|
|
@@ -1713,7 +1709,8 @@ declare class AnswersEndpoint {
|
|
|
1713
1709
|
private readonly ENDPOINT;
|
|
1714
1710
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1715
1711
|
/**
|
|
1716
|
-
* Finds references in library for a given question and uses references to generate an answer.
|
|
1712
|
+
* Finds references in library for a given question and uses references to generate an answer.
|
|
1713
|
+
* The 'maxReferences' parameter determines how many library items are used. The language of the answer can be changed via the 'language' parameter.
|
|
1717
1714
|
*
|
|
1718
1715
|
* @param question string? - The text to find in the library.
|
|
1719
1716
|
* @param maxreferences number? - Number of references found in library to base the answer on.
|
|
@@ -1723,7 +1720,7 @@ declare class AnswersEndpoint {
|
|
|
1723
1720
|
* Supported Languages:
|
|
1724
1721
|
* "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
|
|
1725
1722
|
* "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
|
|
1726
|
-
* "sv", "tr", "zh
|
|
1723
|
+
* "sv", "tr", "zh"
|
|
1727
1724
|
* @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
1725
|
*/
|
|
1729
1726
|
post(data: {
|
|
@@ -1761,7 +1758,8 @@ declare class BulkmodelBoostwordsEndpoint {
|
|
|
1761
1758
|
private readonly ENDPOINT;
|
|
1762
1759
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1763
1760
|
/**
|
|
1764
|
-
* Create one or more
|
|
1761
|
+
* Create one or more boostwords
|
|
1762
|
+
* This is the quiet version of 'post /api/domains/{domainname}/boostwords'
|
|
1765
1763
|
*
|
|
1766
1764
|
* @param body BoostWord[]? -
|
|
1767
1765
|
*/
|
|
@@ -1780,7 +1778,8 @@ declare class BulkmodelclassInstancesEndpoint {
|
|
|
1780
1778
|
private readonly ENDPOINT;
|
|
1781
1779
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1782
1780
|
/**
|
|
1783
|
-
* Get all instances of the classes by class
|
|
1781
|
+
* Get all instances of the classes by class id
|
|
1782
|
+
* This is the quiet version of 'get /api/model/domains/{domainname}/classes/{id}/instances'
|
|
1784
1783
|
*/
|
|
1785
1784
|
get(): Promise<Instance[]>;
|
|
1786
1785
|
}
|
|
@@ -1812,11 +1811,13 @@ declare class BulkmodelClassesEndpoint {
|
|
|
1812
1811
|
private readonly ENDPOINT;
|
|
1813
1812
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1814
1813
|
/**
|
|
1815
|
-
* Get all
|
|
1814
|
+
* Get all classes
|
|
1815
|
+
* This is the quiet version of 'get /api/domains/{domainname}/classes'
|
|
1816
1816
|
*/
|
|
1817
1817
|
get(): Promise<ClassBulk[]>;
|
|
1818
1818
|
/**
|
|
1819
|
-
* Create one or more
|
|
1819
|
+
* Create one or more classes
|
|
1820
|
+
* This is the quiet version of 'post /api/domains/{domainname}/classes'
|
|
1820
1821
|
*
|
|
1821
1822
|
* @param body ClassBulk[]? -
|
|
1822
1823
|
*/
|
|
@@ -1835,11 +1836,13 @@ declare class BulkmodelDatapropertiesEndpoint {
|
|
|
1835
1836
|
private readonly ENDPOINT;
|
|
1836
1837
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1837
1838
|
/**
|
|
1838
|
-
* Get all
|
|
1839
|
+
* Get all dataproperties
|
|
1840
|
+
* This is the quiet version of 'get /api/domains/{domainname}/dataproperties'
|
|
1839
1841
|
*/
|
|
1840
1842
|
get(): Promise<DataProperty[]>;
|
|
1841
1843
|
/**
|
|
1842
|
-
* Create one or more
|
|
1844
|
+
* Create one or more dataproperties
|
|
1845
|
+
* This is the quiet version of 'post /api/domains/{domainname}/dataproperties'
|
|
1843
1846
|
*
|
|
1844
1847
|
* @param body DataProperty[]? -
|
|
1845
1848
|
*/
|
|
@@ -1858,11 +1861,13 @@ declare class BulkmodelInstancesEndpoint {
|
|
|
1858
1861
|
private readonly ENDPOINT;
|
|
1859
1862
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1860
1863
|
/**
|
|
1861
|
-
* Get all
|
|
1864
|
+
* Get all instances
|
|
1865
|
+
* This is the quiet version of 'get /api/domains/{domainname}/instances'
|
|
1862
1866
|
*/
|
|
1863
1867
|
get(): Promise<Instance[]>;
|
|
1864
1868
|
/**
|
|
1865
|
-
* Create an
|
|
1869
|
+
* Create an instance
|
|
1870
|
+
* This is the quiet version of 'post /api/model/domains/{domainname}/instances'
|
|
1866
1871
|
*
|
|
1867
1872
|
* @param body Instance[]? -
|
|
1868
1873
|
*/
|
|
@@ -1881,11 +1886,13 @@ declare class BulkmodelMetadataEndpoint {
|
|
|
1881
1886
|
private readonly ENDPOINT;
|
|
1882
1887
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1883
1888
|
/**
|
|
1884
|
-
* Get all
|
|
1889
|
+
* Get all metadata
|
|
1890
|
+
* This is the quiet version of 'get /api/domains/{domainname}/metadata'
|
|
1885
1891
|
*/
|
|
1886
1892
|
get(): Promise<ModelMetadata[]>;
|
|
1887
1893
|
/**
|
|
1888
|
-
* Create one or more
|
|
1894
|
+
* Create one or more metadata
|
|
1895
|
+
* This is the quiet version of 'post /api/domains/{domainname}/metadata'
|
|
1889
1896
|
*
|
|
1890
1897
|
* @param body ModelMetadata[]? -
|
|
1891
1898
|
*/
|
|
@@ -1904,7 +1911,8 @@ declare class BulkmodelNamedentitiesEndpoint {
|
|
|
1904
1911
|
private readonly ENDPOINT;
|
|
1905
1912
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1906
1913
|
/**
|
|
1907
|
-
* Create one or more named
|
|
1914
|
+
* Create one or more named entities
|
|
1915
|
+
* This is the quiet version of 'post /api/domains/{domainname}/namedentities'
|
|
1908
1916
|
*
|
|
1909
1917
|
* @param body NamedEntity[]? -
|
|
1910
1918
|
*/
|
|
@@ -1923,11 +1931,13 @@ declare class BulkmodelRulesEndpoint {
|
|
|
1923
1931
|
private readonly ENDPOINT;
|
|
1924
1932
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1925
1933
|
/**
|
|
1926
|
-
* Get a
|
|
1934
|
+
* Get a rule
|
|
1935
|
+
* This is the quiet version of 'get /api/model/domains/{domainname}/rules'
|
|
1927
1936
|
*/
|
|
1928
1937
|
get(): Promise<Rule[]>;
|
|
1929
1938
|
/**
|
|
1930
|
-
* Create a
|
|
1939
|
+
* Create a rule
|
|
1940
|
+
* This is the quiet version of 'post /api/model/domains/{domainname}/rules'
|
|
1931
1941
|
*
|
|
1932
1942
|
* @param body Rule[]? -
|
|
1933
1943
|
*/
|
|
@@ -1965,7 +1975,8 @@ declare class BulkmodelSynonymsEndpoint {
|
|
|
1965
1975
|
private readonly ENDPOINT;
|
|
1966
1976
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1967
1977
|
/**
|
|
1968
|
-
* Create one or more
|
|
1978
|
+
* Create one or more synonyms
|
|
1979
|
+
* This is the quiet version of 'post /api/domains/{domainname}/synonyms'
|
|
1969
1980
|
*
|
|
1970
1981
|
* @param body Synonym[]? -
|
|
1971
1982
|
*/
|
|
@@ -2036,7 +2047,8 @@ declare class BulkdomainsDocumentclassesEndpoint {
|
|
|
2036
2047
|
private readonly ENDPOINT;
|
|
2037
2048
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2038
2049
|
/**
|
|
2039
|
-
* Get all document
|
|
2050
|
+
* Get all document classes
|
|
2051
|
+
* This is the quiet version of 'get /api/domains/{domainname}/documentclasses'
|
|
2040
2052
|
*
|
|
2041
2053
|
* @param withdocids boolean? -
|
|
2042
2054
|
*/
|
|
@@ -2044,7 +2056,8 @@ declare class BulkdomainsDocumentclassesEndpoint {
|
|
|
2044
2056
|
withdocids?: boolean;
|
|
2045
2057
|
}): Promise<DocumentClassBulk[]>;
|
|
2046
2058
|
/**
|
|
2047
|
-
* Create one or more document
|
|
2059
|
+
* Create one or more document classes
|
|
2060
|
+
* This is the quiet version of 'post /api/domains/{domainname}/documentclasses'
|
|
2048
2061
|
*
|
|
2049
2062
|
* @param body DocumentClassBulk[]? -
|
|
2050
2063
|
*/
|
|
@@ -2081,7 +2094,8 @@ declare class BulkdomainsReferencedocumentsEndpoint {
|
|
|
2081
2094
|
private readonly ENDPOINT;
|
|
2082
2095
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2083
2096
|
/**
|
|
2084
|
-
* Get all reference
|
|
2097
|
+
* Get all reference documents
|
|
2098
|
+
* This is the quiet version of 'get /api/domains/{domainname}/referencedocuments'
|
|
2085
2099
|
*
|
|
2086
2100
|
* @param withsentences boolean? - Gives back the sentences of a paragraph.
|
|
2087
2101
|
*/
|
|
@@ -2093,7 +2107,8 @@ declare class BulkdomainsReferencedocumentsEndpoint {
|
|
|
2093
2107
|
*/
|
|
2094
2108
|
delete(body: string[]): Promise<RestResponse<void>>;
|
|
2095
2109
|
/**
|
|
2096
|
-
* Upload reference
|
|
2110
|
+
* Upload reference document
|
|
2111
|
+
* This is the quiet version of 'post /api/domains/{domainname}/referencedocuments'
|
|
2097
2112
|
*
|
|
2098
2113
|
* @param name string? - The document name in your library (in contrast to the file name being used during upload).
|
|
2099
2114
|
* @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 +2137,8 @@ declare class BulkdomainsReferencedocumentsEndpoint {
|
|
|
2122
2137
|
linkclasses?: boolean;
|
|
2123
2138
|
}): Promise<void>;
|
|
2124
2139
|
/**
|
|
2125
|
-
* Upload reference
|
|
2140
|
+
* Upload reference document
|
|
2141
|
+
* This is the quiet version of 'post /api/domains/{domainname}/referencedocuments'
|
|
2126
2142
|
*
|
|
2127
2143
|
* @param body Document[]? -
|
|
2128
2144
|
*/
|
|
@@ -2144,7 +2160,8 @@ declare class BulkdomainsReferencesEndpoint {
|
|
|
2144
2160
|
private readonly ENDPOINT;
|
|
2145
2161
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2146
2162
|
/**
|
|
2147
|
-
* Determine references with several input
|
|
2163
|
+
* Determine references with several input documents
|
|
2164
|
+
* 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
2165
|
*
|
|
2149
2166
|
* @param body Document[]? -
|
|
2150
2167
|
*/
|
|
@@ -2227,7 +2244,8 @@ declare class ChatEndpoint {
|
|
|
2227
2244
|
private readonly ENDPOINT;
|
|
2228
2245
|
constructor(restClient: RestClient, parentEndpoint: string, id: string);
|
|
2229
2246
|
/**
|
|
2230
|
-
* Chat with the generative
|
|
2247
|
+
* Chat with the generative model
|
|
2248
|
+
* The chat endpoint allows you to interact with the generative model in a conversational manner.
|
|
2231
2249
|
*
|
|
2232
2250
|
* @param body Chat? -
|
|
2233
2251
|
*/
|
|
@@ -2295,7 +2313,8 @@ declare class ConversionsEndpoint {
|
|
|
2295
2313
|
private readonly ENDPOINT;
|
|
2296
2314
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2297
2315
|
/**
|
|
2298
|
-
*
|
|
2316
|
+
*
|
|
2317
|
+
* Converts vsdx/docx/pptx files into pdf format.
|
|
2299
2318
|
*
|
|
2300
2319
|
* @param file Blob? - The document to convert.
|
|
2301
2320
|
*/
|
|
@@ -2539,6 +2558,22 @@ declare class DocumentclassEndpoint {
|
|
|
2539
2558
|
put(body: DocumentClass): Promise<DocumentClass>;
|
|
2540
2559
|
}
|
|
2541
2560
|
|
|
2561
|
+
/**
|
|
2562
|
+
* @author semantha
|
|
2563
|
+
*
|
|
2564
|
+
* Class to access resource "/api/domains/{domainname}/documentclasses/tree"
|
|
2565
|
+
* This is a generated file do not change manually!
|
|
2566
|
+
*/
|
|
2567
|
+
declare class TreeEndpoint {
|
|
2568
|
+
private readonly restClient;
|
|
2569
|
+
private readonly parentEndpoint;
|
|
2570
|
+
private readonly ENDPOINT;
|
|
2571
|
+
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2572
|
+
get(params?: {
|
|
2573
|
+
fields?: string;
|
|
2574
|
+
}): Promise<DocumentClassNode[]>;
|
|
2575
|
+
}
|
|
2576
|
+
|
|
2542
2577
|
/**
|
|
2543
2578
|
* @author semantha
|
|
2544
2579
|
*
|
|
@@ -2550,6 +2585,7 @@ declare class DocumentclassesEndpoint {
|
|
|
2550
2585
|
private readonly parentEndpoint;
|
|
2551
2586
|
private readonly ENDPOINT;
|
|
2552
2587
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2588
|
+
tree(): TreeEndpoint;
|
|
2553
2589
|
/**
|
|
2554
2590
|
* Get all document classes
|
|
2555
2591
|
*/
|
|
@@ -2578,7 +2614,8 @@ declare class DocumentsEndpoint {
|
|
|
2578
2614
|
private readonly ENDPOINT;
|
|
2579
2615
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2580
2616
|
/**
|
|
2581
|
-
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2617
|
+
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2618
|
+
* 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
2619
|
*
|
|
2583
2620
|
* @param file Blob? - Input document
|
|
2584
2621
|
* @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
|
|
@@ -2616,7 +2653,8 @@ declare class DocumentsEndpoint {
|
|
|
2616
2653
|
withsentences?: boolean;
|
|
2617
2654
|
}): Promise<Document[]>;
|
|
2618
2655
|
/**
|
|
2619
|
-
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2656
|
+
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2657
|
+
* 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
2658
|
*
|
|
2621
2659
|
* @param file Blob? - Input document
|
|
2622
2660
|
* @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
|
|
@@ -2654,7 +2692,8 @@ declare class DocumentsEndpoint {
|
|
|
2654
2692
|
withsentences?: boolean;
|
|
2655
2693
|
}): Promise<Blob>;
|
|
2656
2694
|
/**
|
|
2657
|
-
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2695
|
+
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2696
|
+
* 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
2697
|
*
|
|
2659
2698
|
* @param file Blob? - Input document
|
|
2660
2699
|
* @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
|
|
@@ -2692,7 +2731,8 @@ declare class DocumentsEndpoint {
|
|
|
2692
2731
|
withsentences?: boolean;
|
|
2693
2732
|
}): Promise<Blob>;
|
|
2694
2733
|
/**
|
|
2695
|
-
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2734
|
+
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2735
|
+
* 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
2736
|
*
|
|
2697
2737
|
* @param file Blob? - Input document
|
|
2698
2738
|
* @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
|
|
@@ -2730,7 +2770,8 @@ declare class DocumentsEndpoint {
|
|
|
2730
2770
|
withsentences?: boolean;
|
|
2731
2771
|
}): Promise<Blob>;
|
|
2732
2772
|
/**
|
|
2733
|
-
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2773
|
+
* Creates a list of document models from an input document (pdf, docx, txt, zip, xlsx)
|
|
2774
|
+
* 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
2775
|
*
|
|
2735
2776
|
* @param file Blob? - Input document
|
|
2736
2777
|
* @param text string? - Plain text input (left document). If set, the parameter `file` will be ignored.
|
|
@@ -2934,7 +2975,8 @@ declare class PromptEndpoint {
|
|
|
2934
2975
|
*/
|
|
2935
2976
|
put(body: Prompt): Promise<Prompt>;
|
|
2936
2977
|
/**
|
|
2937
|
-
* Executes a saved prompt against the configured generative model.
|
|
2978
|
+
* Executes a saved prompt against the configured generative model.
|
|
2979
|
+
* The 'id' parameter determines which prompt is executed.
|
|
2938
2980
|
*
|
|
2939
2981
|
* @param body PromptExecution? -
|
|
2940
2982
|
*/
|
|
@@ -2999,6 +3041,23 @@ declare class ImagesEndpoint {
|
|
|
2999
3041
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
3000
3042
|
}
|
|
3001
3043
|
|
|
3044
|
+
/**
|
|
3045
|
+
* @author semantha
|
|
3046
|
+
*
|
|
3047
|
+
* Class to access resource "/api/domains/{domainname}/referencedocuments/{documentid}/markdown"
|
|
3048
|
+
* This is a generated file do not change manually!
|
|
3049
|
+
*/
|
|
3050
|
+
declare class MarkdownEndpoint {
|
|
3051
|
+
private readonly restClient;
|
|
3052
|
+
private readonly parentEndpoint;
|
|
3053
|
+
private readonly ENDPOINT;
|
|
3054
|
+
constructor(restClient: RestClient, parentEndpoint: string);
|
|
3055
|
+
/**
|
|
3056
|
+
* Returns one reference document by ID as markdown
|
|
3057
|
+
*/
|
|
3058
|
+
getAsPlainText(): Promise<string>;
|
|
3059
|
+
}
|
|
3060
|
+
|
|
3002
3061
|
/**
|
|
3003
3062
|
* @author semantha
|
|
3004
3063
|
*
|
|
@@ -3085,6 +3144,7 @@ declare class ReferencedocumentEndpoint {
|
|
|
3085
3144
|
constructor(restClient: RestClient, parentEndpoint: string, documentid: string);
|
|
3086
3145
|
images(): ImagesEndpoint;
|
|
3087
3146
|
images(id: string): ImageEndpoint;
|
|
3147
|
+
markdown(): MarkdownEndpoint;
|
|
3088
3148
|
paragraphs(): ParagraphsEndpoint;
|
|
3089
3149
|
paragraphs(id: string): ParagraphEndpoint;
|
|
3090
3150
|
sentences(): SentencesEndpoint;
|
|
@@ -3121,7 +3181,8 @@ declare class NamedentitiesEndpoint {
|
|
|
3121
3181
|
private readonly ENDPOINT;
|
|
3122
3182
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
3123
3183
|
/**
|
|
3124
|
-
* Get all named entities (a.k.a custom entities) from reference documents.
|
|
3184
|
+
* Get all named entities (a.k.a custom entities) from reference documents.
|
|
3185
|
+
* Can be filtered by tags or documentclassids.
|
|
3125
3186
|
*
|
|
3126
3187
|
* @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
3188
|
* @param documentclassids string? - List of documentclass IDs for the target. The limit here is 1000 IDs.
|
|
@@ -3165,7 +3226,8 @@ declare class ReferencedocumentsEndpoint {
|
|
|
3165
3226
|
namedentities(): NamedentitiesEndpoint;
|
|
3166
3227
|
statistic(): StatisticEndpoint;
|
|
3167
3228
|
/**
|
|
3168
|
-
* Get all reference documents a.k.a. library items.
|
|
3229
|
+
* Get all reference documents a.k.a. library items.
|
|
3230
|
+
* 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
3231
|
*
|
|
3170
3232
|
* @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
3233
|
* @param name string? - Filter documents for a given name
|
|
@@ -3207,7 +3269,8 @@ declare class ReferencedocumentsEndpoint {
|
|
|
3207
3269
|
fields?: string;
|
|
3208
3270
|
}): Promise<ReferenceDocumentsResponseContainer>;
|
|
3209
3271
|
/**
|
|
3210
|
-
* Get all reference documents a.k.a. library items.
|
|
3272
|
+
* Get all reference documents a.k.a. library items.
|
|
3273
|
+
* 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
3274
|
*
|
|
3212
3275
|
* @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
3276
|
* @param name string? - Filter documents for a given name
|
|
@@ -3310,7 +3373,8 @@ declare class ReferencesEndpoint {
|
|
|
3310
3373
|
private readonly ENDPOINT;
|
|
3311
3374
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
3312
3375
|
/**
|
|
3313
|
-
* Determine references with one input
|
|
3376
|
+
* Determine references with one input document
|
|
3377
|
+
* 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
3378
|
*
|
|
3315
3379
|
* @param file Blob? - Input document (left document).
|
|
3316
3380
|
* @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
|
|
@@ -3363,7 +3427,8 @@ declare class ReferencesEndpoint {
|
|
|
3363
3427
|
maxreferences?: number;
|
|
3364
3428
|
}): Promise<Document>;
|
|
3365
3429
|
/**
|
|
3366
|
-
* Determine references with one input
|
|
3430
|
+
* Determine references with one input document
|
|
3431
|
+
* 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
3432
|
*
|
|
3368
3433
|
* @param file Blob? - Input document (left document).
|
|
3369
3434
|
* @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
|
|
@@ -3416,7 +3481,8 @@ declare class ReferencesEndpoint {
|
|
|
3416
3481
|
maxreferences?: number;
|
|
3417
3482
|
}): Promise<Blob>;
|
|
3418
3483
|
/**
|
|
3419
|
-
* Determine references with one input
|
|
3484
|
+
* Determine references with one input document
|
|
3485
|
+
* 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
3486
|
*
|
|
3421
3487
|
* @param file Blob? - Input document (left document).
|
|
3422
3488
|
* @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
|
|
@@ -3469,7 +3535,8 @@ declare class ReferencesEndpoint {
|
|
|
3469
3535
|
maxreferences?: number;
|
|
3470
3536
|
}): Promise<Blob>;
|
|
3471
3537
|
/**
|
|
3472
|
-
* Determine references with one input
|
|
3538
|
+
* Determine references with one input document
|
|
3539
|
+
* 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
3540
|
*
|
|
3474
3541
|
* @param file Blob? - Input document (left document).
|
|
3475
3542
|
* @param referencedocument Blob? - Reference document(s) to be used instead of the documents in the domain's library.
|
|
@@ -3570,7 +3637,7 @@ declare class SummarizationsEndpoint {
|
|
|
3570
3637
|
* Supported Languages:
|
|
3571
3638
|
* "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
|
|
3572
3639
|
* "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
|
|
3573
|
-
* "sv", "tr", "zh
|
|
3640
|
+
* "sv", "tr", "zh"
|
|
3574
3641
|
* @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
3642
|
* @param summarylength SummarylengthEnum? - Influences the length of the returned summary. Values are 'SHORT, 'MEDIUM', 'LONG'
|
|
3576
3643
|
* @param promptid string? - Id of the prompt to generate a summary, other parameters are ignored.
|
|
@@ -3678,6 +3745,10 @@ declare class TranslationsEndpoint {
|
|
|
3678
3745
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
3679
3746
|
/**
|
|
3680
3747
|
* Translates a single text to a target language, optionally from a source language.
|
|
3748
|
+
* Supported Languages:
|
|
3749
|
+
* "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
|
|
3750
|
+
* "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
|
|
3751
|
+
* "sv", "tr", "zh-CN", "zh-TW"
|
|
3681
3752
|
*
|
|
3682
3753
|
* @param body Translation? -
|
|
3683
3754
|
*/
|
|
@@ -3696,7 +3767,8 @@ declare class ValidationEndpoint {
|
|
|
3696
3767
|
private readonly ENDPOINT;
|
|
3697
3768
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
3698
3769
|
/**
|
|
3699
|
-
* Validate existing data in a document.
|
|
3770
|
+
* Validate existing data in a document.
|
|
3771
|
+
* The coordinates come back, if data is found
|
|
3700
3772
|
*
|
|
3701
3773
|
* @param file Blob? - Input document (left document).
|
|
3702
3774
|
*/
|
|
@@ -3790,14 +3862,15 @@ declare class LanguagesEndpoint {
|
|
|
3790
3862
|
private readonly ENDPOINT;
|
|
3791
3863
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
3792
3864
|
/**
|
|
3793
|
-
* Identifies the language of the document and sends it
|
|
3865
|
+
* Identifies the language of the document and sends it back
|
|
3866
|
+
* Input: Support of all input formats (pdf, docx, txt, json (DocumentModel)
|
|
3794
3867
|
*
|
|
3795
3868
|
* Output: Detected Language
|
|
3796
3869
|
*
|
|
3797
3870
|
* Supported Languages:
|
|
3798
3871
|
* "ar", "cs", "da", "de", "en", "es", "el", "fr", "fi", "hu", "hr",
|
|
3799
3872
|
* "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sl",
|
|
3800
|
-
* "sv", "tr", "zh
|
|
3873
|
+
* "sv", "tr", "zh"
|
|
3801
3874
|
*
|
|
3802
3875
|
* @param file Blob? - Input document (left document).
|
|
3803
3876
|
*/
|
|
@@ -4819,4 +4892,4 @@ declare class SemanthaAPI {
|
|
|
4819
4892
|
model(): ModelEndpoint;
|
|
4820
4893
|
}
|
|
4821
4894
|
|
|
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 };
|
|
4895
|
+
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 };
|