@sap/async-xsjs 1.0.2

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.
Files changed (178) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/LICENSE +37 -0
  3. package/README.md +445 -0
  4. package/differences.md +162 -0
  5. package/docs/$.Application.html +262 -0
  6. package/docs/$.Session.html +674 -0
  7. package/docs/$.db.CallableStatement.html +2524 -0
  8. package/docs/$.db.Connection.html +511 -0
  9. package/docs/$.db.ParameterMetaData.html +805 -0
  10. package/docs/$.db.PreparedStatement.html +1796 -0
  11. package/docs/$.db.ResultSet.html +1308 -0
  12. package/docs/$.db.ResultSetMetaData.html +800 -0
  13. package/docs/$.db.SQLException.html +259 -0
  14. package/docs/$.db.html +773 -0
  15. package/docs/$.hdb.ColumnMetadata.html +438 -0
  16. package/docs/$.hdb.Connection.html +663 -0
  17. package/docs/$.hdb.ProcedureResult.html +280 -0
  18. package/docs/$.hdb.ResultSet.html +324 -0
  19. package/docs/$.hdb.ResultSetIterator.html +315 -0
  20. package/docs/$.hdb.ResultSetMetaData.html +259 -0
  21. package/docs/$.hdb.SQLException.html +259 -0
  22. package/docs/$.hdb.html +557 -0
  23. package/docs/$.html +471 -0
  24. package/docs/$.jobs.Job.html +783 -0
  25. package/docs/$.jobs.JobLog.html +380 -0
  26. package/docs/$.jobs.JobSchedules.html +852 -0
  27. package/docs/$.jobs.html +238 -0
  28. package/docs/$.net.Destination.html +304 -0
  29. package/docs/$.net.Mail.Part.html +510 -0
  30. package/docs/$.net.Mail.html +504 -0
  31. package/docs/$.net.SMTPConnection.html +347 -0
  32. package/docs/$.net.html +749 -0
  33. package/docs/$.net.http.Client.html +562 -0
  34. package/docs/$.net.http.Destination.html +237 -0
  35. package/docs/$.net.http.Request.html +567 -0
  36. package/docs/$.net.http.html +292 -0
  37. package/docs/$.security.AntiVirus.html +361 -0
  38. package/docs/$.security.Store.html +636 -0
  39. package/docs/$.security.crypto.html +414 -0
  40. package/docs/$.security.html +247 -0
  41. package/docs/$.security.x509.html +373 -0
  42. package/docs/$.text.analysis.Session.html +983 -0
  43. package/docs/$.text.analysis.html +242 -0
  44. package/docs/$.text.html +246 -0
  45. package/docs/$.text.mining.Session.html +2018 -0
  46. package/docs/$.text.mining.html +242 -0
  47. package/docs/$.trace.html +525 -0
  48. package/docs/$.util.SAXParser.html +955 -0
  49. package/docs/$.util.Zip.html +474 -0
  50. package/docs/$.util.codec.html +414 -0
  51. package/docs/$.util.compression.html +357 -0
  52. package/docs/$.util.html +325 -0
  53. package/docs/$.util.sql.html +290 -0
  54. package/docs/$.web.Body.html +333 -0
  55. package/docs/$.web.EntityList.html +296 -0
  56. package/docs/$.web.TupelList.html +496 -0
  57. package/docs/$.web.WebEntityRequest.html +393 -0
  58. package/docs/$.web.WebEntityResponse.html +392 -0
  59. package/docs/$.web.WebRequest.html +560 -0
  60. package/docs/$.web.WebResponse.html +609 -0
  61. package/docs/$.web.html +246 -0
  62. package/docs/Copyright-SAP.html +39 -0
  63. package/docs/Disclaimer-SAP.html +55 -0
  64. package/docs/index.html +232 -0
  65. package/docs/styles/jsdoc-default.css +382 -0
  66. package/lib/AppConfig.js +36 -0
  67. package/lib/AuditLogger.js +41 -0
  68. package/lib/cacert.js +26 -0
  69. package/lib/ctypes.js +153 -0
  70. package/lib/destinations/dest-provider.js +57 -0
  71. package/lib/index.js +235 -0
  72. package/lib/jobs/Action.js +40 -0
  73. package/lib/jobs/Job.js +100 -0
  74. package/lib/jobs/JobManager.js +150 -0
  75. package/lib/jobs/JobsRuntime.js +133 -0
  76. package/lib/jobs/SqlScriptJobRunner.js +36 -0
  77. package/lib/jobs/XsjsJobRunner.js +78 -0
  78. package/lib/jobs/index.js +11 -0
  79. package/lib/logging.js +16 -0
  80. package/lib/middleware.js +125 -0
  81. package/lib/odata/ODataService.js +125 -0
  82. package/lib/odata/index.js +7 -0
  83. package/lib/odata/service-factory.js +26 -0
  84. package/lib/passport-noauth.js +17 -0
  85. package/lib/routes.js +115 -0
  86. package/lib/runtime.js +740 -0
  87. package/lib/sandbox.js +40 -0
  88. package/lib/utils/XsJsFunctionRunner.js +57 -0
  89. package/lib/utils/XsJsLibFunctionRunner.js +57 -0
  90. package/lib/utils/buffer-utils.js +77 -0
  91. package/lib/utils/compression-utils.js +14 -0
  92. package/lib/utils/date-utils.js +104 -0
  93. package/lib/utils/errors/HttpError.js +20 -0
  94. package/lib/utils/errors/wrap-app-error.js +18 -0
  95. package/lib/utils/index.js +17 -0
  96. package/lib/utils/xs-function-runner.js +51 -0
  97. package/lib/utils/xs-types.js +21 -0
  98. package/lib/utils/xspath.js +36 -0
  99. package/lib/utils/xsstack.js +28 -0
  100. package/lib/views/error.html +28 -0
  101. package/lib/xsjs/Application.js +28 -0
  102. package/lib/xsjs/Locale.js +53 -0
  103. package/lib/xsjs/Session.js +31 -0
  104. package/lib/xsjs/constants.js +71 -0
  105. package/lib/xsjs/db/common/DbBase.js +85 -0
  106. package/lib/xsjs/db/common/DbOptions.js +163 -0
  107. package/lib/xsjs/db/common/arguments-validation.js +102 -0
  108. package/lib/xsjs/db/common/connection.js +12 -0
  109. package/lib/xsjs/db/common/enums.js +93 -0
  110. package/lib/xsjs/db/common/execute-batch.js +38 -0
  111. package/lib/xsjs/db/common/parse-time.js +139 -0
  112. package/lib/xsjs/db/dbapi/CallableStatement.js +192 -0
  113. package/lib/xsjs/db/dbapi/Connection.js +78 -0
  114. package/lib/xsjs/db/dbapi/DB.js +39 -0
  115. package/lib/xsjs/db/dbapi/ParameterMetaData.js +118 -0
  116. package/lib/xsjs/db/dbapi/PreparedStatement.js +78 -0
  117. package/lib/xsjs/db/dbapi/ResultSet.js +220 -0
  118. package/lib/xsjs/db/dbapi/ResultSetMetaData.js +116 -0
  119. package/lib/xsjs/db/dbapi/Statement.js +514 -0
  120. package/lib/xsjs/db/dbapi/conversions.js +113 -0
  121. package/lib/xsjs/db/dbapi/fetch-rows.js +32 -0
  122. package/lib/xsjs/db/hdbapi/Connection.js +525 -0
  123. package/lib/xsjs/db/hdbapi/HDB.js +32 -0
  124. package/lib/xsjs/db/hdbapi/ResultSetIterator.js +40 -0
  125. package/lib/xsjs/db/hdbapi/convert.js +77 -0
  126. package/lib/xsjs/db/hdbapi/table-string-parser.js +52 -0
  127. package/lib/xsjs/db/index.js +4 -0
  128. package/lib/xsjs/index.js +13 -0
  129. package/lib/xsjs/jobs/Job.js +228 -0
  130. package/lib/xsjs/jobs/Jobs.js +11 -0
  131. package/lib/xsjs/jobs/Logs.js +127 -0
  132. package/lib/xsjs/jobs/Schedule.js +110 -0
  133. package/lib/xsjs/jobs/Schedules.js +108 -0
  134. package/lib/xsjs/net/Destination.js +43 -0
  135. package/lib/xsjs/net/http/Client.js +220 -0
  136. package/lib/xsjs/net/http/HTTP.js +72 -0
  137. package/lib/xsjs/net/index.js +5 -0
  138. package/lib/xsjs/net/smtp/Mail.js +38 -0
  139. package/lib/xsjs/net/smtp/Part.js +30 -0
  140. package/lib/xsjs/net/smtp/SMTPConnection.js +39 -0
  141. package/lib/xsjs/net/smtp/index.js +18 -0
  142. package/lib/xsjs/net/smtp/nodemailer-util.js +77 -0
  143. package/lib/xsjs/require.js +39 -0
  144. package/lib/xsjs/security/AntiVirus.js +31 -0
  145. package/lib/xsjs/security/Store.js +119 -0
  146. package/lib/xsjs/security/crypto.js +23 -0
  147. package/lib/xsjs/security/index.js +5 -0
  148. package/lib/xsjs/security/x509.js +12 -0
  149. package/lib/xsjs/text/analysis/Session.js +128 -0
  150. package/lib/xsjs/text/index.js +30 -0
  151. package/lib/xsjs/text/mining/Session.js +82 -0
  152. package/lib/xsjs/trace/trace.js +41 -0
  153. package/lib/xsjs/util/SAXParser.js +174 -0
  154. package/lib/xsjs/util/Zip.js +220 -0
  155. package/lib/xsjs/util/codec.js +33 -0
  156. package/lib/xsjs/util/compression.js +24 -0
  157. package/lib/xsjs/util/index.js +22 -0
  158. package/lib/xsjs/web/BasicWebEntity.js +41 -0
  159. package/lib/xsjs/web/EntityList.js +11 -0
  160. package/lib/xsjs/web/TupelLists/CookiesTupelList.js +47 -0
  161. package/lib/xsjs/web/TupelLists/HeadersTupelList.js +55 -0
  162. package/lib/xsjs/web/TupelLists/ParametersTupelList.js +83 -0
  163. package/lib/xsjs/web/TupelLists/TupelListBase.js +45 -0
  164. package/lib/xsjs/web/WebBody.js +135 -0
  165. package/lib/xsjs/web/WebEntityRequest.js +40 -0
  166. package/lib/xsjs/web/WebEntityResponse.js +26 -0
  167. package/lib/xsjs/web/WebRequest.js +209 -0
  168. package/lib/xsjs/web/WebResponse.js +183 -0
  169. package/lib/xsjs/web/index.js +4 -0
  170. package/lib/xsjs/web/utils/HeadersParser.js +53 -0
  171. package/lib/xsjs/web/utils/HttpRequestParser.js +93 -0
  172. package/lib/xsjs/web/utils/MultipartParser.js +163 -0
  173. package/lib/xsjs/web/utils/MultipartResponseBuilder.js +73 -0
  174. package/lib/xsjs/web/utils/SetCookieParser.js +32 -0
  175. package/lib/xsjslib/TextBundleWrapper.js +46 -0
  176. package/lib/xsjslib/index.js +11 -0
  177. package/npm-shrinkwrap.json +11540 -0
  178. package/package.json +84 -0
package/docs/$.text.mining.Session.html ADDED
@@ -0,0 +1,2018 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>JSDoc: Class: Session</title>
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
10
+
11
+
12
+ <script src="scripts/launch-8b3c5ca29b9e.min.js"></script>
13
+ <script src="scripts/highlight.js"></script>
14
+ <link rel="canonical" href="$.text.mining.Session.html">
15
+ </head>
16
+ <body>
17
+ <div id="main">
18
+ <h1 class="page-title">Class: Session</h1>
19
+ <section>
20
+ <header>
21
+ <h2>
22
+ <span class="ancestors"><a href="$.html">$</a><a href="$.text.html">.text</a><a
23
+ href="$.text.mining.html">.mining</a>.</span>
24
+ Session
25
+ </h2>
26
+ <div class="class-description">$.text.mining.Session represents a Text Mining session.
27
+ <p class="message warning"><b>Caution</b><br>
28
+ The information in this section applies to a feature that is included in the component
29
+ SAP HANA Advanced Data Processing. To make use of this feature, you must have purchased a license
30
+ to use SAP HANA Advanced Data Processing.
31
+ </p></div>
32
+ </header>
33
+ <article>
34
+ <div class="container-overview">
35
+ <dt>
36
+ <h4 class="name" id="Session"><span class="type-signature"></span>new Session<span
37
+ class="signature">(p)</span><span class="type-signature"> &rarr; {<a
38
+ href="$.text.mining.Session.html">$.text.mining.Session</a>}</span></h4>
39
+ </dt>
40
+ <dd>
41
+ <div class="description">
42
+ The Session object represents a Text Mining session.
43
+ <br>
44
+ This constructor function creates a Text Mining session object linked to the given reference
45
+ table and column.
46
+ Text Mining functions can subsequently be invoked using this object and they will use this
47
+ linked
48
+ reference data and the configuration parameters it was initialized with.
49
+ Multiple such objects can be created to handle multiple sets of reference data.
50
+ <br>
51
+ This function does not initialize Text Mining for the reference table and column.
52
+ Initialization is done separately, typically when the full text index is created for the table
53
+ and column.
54
+ <br>
55
+ Note that it is possible to use a custom XS SQL connection to access the Text Mining reference
56
+ table
57
+ as a different user (see "Creating Custom XS SQL Connections" in the SAP HANA Developer Guide).
58
+ <br>
59
+ </div>
60
+ <h5>Parameters:</h5>
61
+ <table class="params">
62
+ <thead>
63
+ <tr>
64
+ <th>Name</th>
65
+ <th>Type</th>
66
+ <th class="last">Description</th>
67
+ </tr>
68
+ </thead>
69
+ <tbody>
70
+ <tr>
71
+ <td class="name"><code>p</code></td>
72
+ <td class="type">
73
+ <span class="param-type">object</span>
74
+ </td>
75
+ <td class="description last">Encapsulates constructor parameters.
76
+ <h6>Properties</h6>
77
+ <table class="params">
78
+ <thead>
79
+ <tr>
80
+ <th>Name</th>
81
+ <th>Type</th>
82
+ <th>Argument</th>
83
+ <th class="last">Description</th>
84
+ </tr>
85
+ </thead>
86
+ <tbody>
87
+ <tr>
88
+ <td class="name"><code>referenceTable</code></td>
89
+ <td class="type">
90
+ <span class="param-type">string</span>
91
+ </td>
92
+ <td class="attributes">
93
+ </td>
94
+ <td class="description last">The table in which the reference documents are
95
+ stored.
96
+ </td>
97
+ </tr>
98
+ <tr>
99
+ <td class="name"><code>referenceColumn</code></td>
100
+ <td class="type">
101
+ <span class="param-type">string</span>
102
+ </td>
103
+ <td class="attributes">
104
+ </td>
105
+ <td class="description last">The column in which the reference documents' text
106
+ content is stored.
107
+ </td>
108
+ </tr>
109
+ <tr>
110
+ <td class="name"><code>connection</code></td>
111
+ <td class="type">
112
+ <span class="param-type"><a href="$.db.Connection.html">$.db.Connection</a></span>
113
+ </td>
114
+ <td class="attributes">
115
+ &lt;optional><br>
116
+ </td>
117
+ <td class="description last">A database connection object that will be used to
118
+ authenticate
119
+ Text Mining database access. By default the credentials of the caller are
120
+ used.
121
+ </td>
122
+ </tr>
123
+ </tbody>
124
+ </table>
125
+ </td>
126
+ </tr>
127
+ </tbody>
128
+ </table>
129
+ <dl class="details">
130
+ </dl>
131
+ <h5>Returns:</h5>
132
+ <div class="param-desc">
133
+ A Text Mining session object that holds context for the session
134
+ and is used to call the Text Mining method functions.
135
+ </div>
136
+ <dl>
137
+ <dt>
138
+ Type
139
+ </dt>
140
+ <dd>
141
+ <span class="param-type"><a
142
+ href="$.text.mining.Session.html">$.text.mining.Session</a></span>
143
+ </dd>
144
+ </dl>
145
+ <h5>Example</h5>
146
+ <pre class="prettyprint"><code>var TM = new $.text.mining.Session({
147
+ referenceTable: "SYSTEM.TMDOCUMENTS",
148
+ referenceColumn: "FILECONTENT"
149
+ });</code></pre>
150
+ </dd>
151
+ </div>
152
+ <h3 class="subsection-title">Methods</h3>
153
+ <dl>
154
+ <dt>
155
+ <h4 class="name" id="categorizeKNN"><span class="type-signature">async </span>categorizeKNN<span
156
+ class="signature">(p)</span><span class="type-signature"> &rarr; {Array.&lt;<a
157
+ href="$.text.mining.Session.html#CategoryResult">$.text.mining.Session~CategoryResult</a>>}</span>
158
+ </h4>
159
+ </dt>
160
+ <dd>
161
+ <div class="description">
162
+ Given an input document, this function returns the top-ranked category values for the given
163
+ category set columns in the reference data, using the KNN (K Nearest Neighbors) method.
164
+ <p>
165
+ <div style="padding:0px 10px;background-color:light pink;border-radius:5px;border:1px solid red">
166
+ <p>
167
+ <b><span style="background-color:Yellow"><big>!</big></span>&nbsp; &nbsp; Security note</b>
168
+ <p>
169
+ For this and the subsequent text mining functions.
170
+ <p>
171
+ The following 4 parameters are SQL expressions. The user application needs to
172
+ take responsibility for blocking any potentially malicious values from being used:
173
+ <ul>
174
+ <li>inputDocumentSubquery</li>
175
+ <li>inputDocumentCondition</li>
176
+ <li>documentRestriction</li>
177
+ <li>termTypeRestriction</li>
178
+ </ul>
179
+ <p>
180
+ </div>
181
+ </div>
182
+ <h5>Parameters:</h5>
183
+ <table class="params">
184
+ <thead>
185
+ <tr>
186
+ <th>Name</th>
187
+ <th>Type</th>
188
+ <th class="last">Description</th>
189
+ </tr>
190
+ </thead>
191
+ <tbody>
192
+ <tr>
193
+ <td class="name"><code>p</code></td>
194
+ <td class="type">
195
+ <span class="param-type">object</span>
196
+ </td>
197
+ <td class="description last">Encapsulates categorizeKNN parameters.
198
+ <h6>Properties</h6>
199
+ <table class="params">
200
+ <thead>
201
+ <tr>
202
+ <th>Name</th>
203
+ <th>Type</th>
204
+ <th>Argument</th>
205
+ <th class="last">Description</th>
206
+ </tr>
207
+ </thead>
208
+ <tbody>
209
+ <tr>
210
+ <td class="name"><code>inputDocumentText|<br/>inputDocumentSubquery|<br/>inputDocumentCondition|<br/>inputDocumentIDs</code>
211
+ </td>
212
+ <td class="type">
213
+ <span class="param-type">string</span>
214
+ </td>
215
+ <td class="attributes">
216
+ </td>
217
+ <td class="description last">Input document to process. One and only one of the
218
+ following:
219
+ <table>
220
+ <tr>
221
+ <td>inputDocumentText</td>
222
+ <td>This literal text</td>
223
+ </tr>
224
+ <tr>
225
+ <td>inputDocumentSubquery</td>
226
+ <td>Text returned by this SQL subquery</td>
227
+ </tr>
228
+ <tr>
229
+ <td>inputDocumentCondition</td>
230
+ <td>Text returned from reference table rows for which this
231
+ SQL "where" clause is true
232
+ </td>
233
+ </tr>
234
+ <tr>
235
+ <td>inputDocumentIDs</td>
236
+ <td>Text returned from reference table rows with this (these)
237
+ internal document ID number(s)
238
+ </td>
239
+ </tr>
240
+ </table>
241
+ </td>
242
+ </tr>
243
+ <tr>
244
+ <td class="name"><code>language</code></td>
245
+ <td class="type">
246
+ <span class="param-type">string</span>
247
+ </td>
248
+ <td class="attributes">
249
+ &lt;optional><br>
250
+ </td>
251
+ <td class="description last">Language code of input text, e.g. "EN", "DE" (""
252
+ for all).
253
+ </td>
254
+ </tr>
255
+ <tr>
256
+ <td class="name"><code>mimeType</code></td>
257
+ <td class="type">
258
+ <span class="param-type">string</span>
259
+ </td>
260
+ <td class="attributes">
261
+ &lt;optional><br>
262
+ </td>
263
+ <td class="description last">Mime type of input text, e.g. "text/plain" ("" for
264
+ unspecified).
265
+ </td>
266
+ </tr>
267
+ <tr>
268
+ <td class="name"><code>categorySets</code></td>
269
+ <td class="type">
270
+ <span class="param-type">Array.&lt;string></span>
271
+ </td>
272
+ <td class="attributes">
273
+ </td>
274
+ <td class="description last">Category set column names in the reference table
275
+ that have been assigned
276
+ category values.
277
+ </td>
278
+ </tr>
279
+ <tr>
280
+ <td class="name"><code>kNN</code></td>
281
+ <td class="type">
282
+ <span class="param-type">integer</span>
283
+ </td>
284
+ <td class="attributes">
285
+ &lt;optional><br>
286
+ </td>
287
+ <td class="description last">The number of nearest neighbors to be considered.
288
+ </td>
289
+ </tr>
290
+ <tr>
291
+ <td class="name"><code>top</code></td>
292
+ <td class="type">
293
+ <span class="param-type">integer</span>
294
+ </td>
295
+ <td class="attributes">
296
+ &lt;optional><br>
297
+ </td>
298
+ <td class="description last">Maximum number of returned results.</td>
299
+ </tr>
300
+ <tr>
301
+ <td class="name"><code>threshold</code></td>
302
+ <td class="type">
303
+ <span class="param-type">number</span>
304
+ </td>
305
+ <td class="attributes">
306
+ &lt;optional><br>
307
+ </td>
308
+ <td class="description last">Restricts the returned results to those displaying
309
+ a score greater than
310
+ or equal to this numeric value in the range [0,1] (0 to allow all).
311
+ </td>
312
+ </tr>
313
+ <tr>
314
+ <td class="name"><code>documentRestriction</code></td>
315
+ <td class="type">
316
+ <span class="param-type">string</span>
317
+ </td>
318
+ <td class="attributes">
319
+ &lt;optional><br>
320
+ </td>
321
+ <td class="description last">Specified condition (SQL "where" clause) to be met
322
+ for reference
323
+ document rows to be considered in the computation ("" for all).
324
+ </td>
325
+ </tr>
326
+ <tr>
327
+ <td class="name"><code>termTypeRestriction</code></td>
328
+ <td class="type">
329
+ <span class="param-type">string</span>
330
+ </td>
331
+ <td class="attributes">
332
+ &lt;optional><br>
333
+ </td>
334
+ <td class="description last">Comma-separated list of term types to consider (""
335
+ for all).
336
+ </td>
337
+ </tr>
338
+ </tbody>
339
+ </table>
340
+ </td>
341
+ </tr>
342
+ </tbody>
343
+ </table>
344
+ <dl class="details">
345
+ </dl>
346
+ <h5>Throws:</h5>
347
+ <div class="param-desc">
348
+ Throws an error if the parameters object is not valid or the execution fails.
349
+ </div>
350
+ <h5>Returns:</h5>
351
+ <div class="param-desc">
352
+ Array of CategoryResult objects.
353
+ </div>
354
+ <dl>
355
+ <dt>
356
+ Type
357
+ </dt>
358
+ <dd>
359
+ <span class="param-type">Array.&lt;<a href="$.text.mining.Session.html#CategoryResult">$.text.mining.Session~CategoryResult</a>></span>
360
+ </dd>
361
+ </dl>
362
+ <h5>Example</h5>
363
+ <pre class="prettyprint"><code>var categoryResults = <b>await </b>TM.categorizeKNN({
364
+ inputDocumentSubquery: "SELECT CONTENT FROM TWEETS WHERE ID = 132",
365
+ categorySets: ["SUBJECT", "REGION"], top: 15
366
+ });</code></pre>
367
+ </dd>
368
+ <dt>
369
+ <h4 class="name" id="getRelatedDocuments"><span
370
+ class="type-signature">async </span>getRelatedDocuments<span class="signature">(p)</span><span
371
+ class="type-signature"> &rarr; {Array.&lt;<a
372
+ href="$.text.mining.Session.html#DocumentResult">$.text.mining.Session~DocumentResult</a>>}</span>
373
+ </h4>
374
+ </dt>
375
+ <dd>
376
+ <div class="description">
377
+ Given an input document, this function returns the top-ranked related documents from the
378
+ reference data, based on
379
+ co-occurrence statistics of terms.
380
+ </div>
381
+ <h5>Parameters:</h5>
382
+ <table class="params">
383
+ <thead>
384
+ <tr>
385
+ <th>Name</th>
386
+ <th>Type</th>
387
+ <th class="last">Description</th>
388
+ </tr>
389
+ </thead>
390
+ <tbody>
391
+ <tr>
392
+ <td class="name"><code>p</code></td>
393
+ <td class="type">
394
+ <span class="param-type">object</span>
395
+ </td>
396
+ <td class="description last">Encapsulates getRelatedDocuments parameters.
397
+ <h6>Properties</h6>
398
+ <table class="params">
399
+ <thead>
400
+ <tr>
401
+ <th>Name</th>
402
+ <th>Type</th>
403
+ <th>Argument</th>
404
+ <th class="last">Description</th>
405
+ </tr>
406
+ </thead>
407
+ <tbody>
408
+ <tr>
409
+ <td class="name"><code>inputDocumentText|<br/>inputDocumentSubquery|<br/>inputDocumentCondition|<br/>inputDocumentIDs</code>
410
+ </td>
411
+ <td class="type">
412
+ <span class="param-type">string</span>
413
+ </td>
414
+ <td class="attributes">
415
+ </td>
416
+ <td class="description last">Input document to process. One and only one of the
417
+ following:
418
+ <table>
419
+ <tr>
420
+ <td>inputDocumentText</td>
421
+ <td>This literal text</td>
422
+ </tr>
423
+ <tr>
424
+ <td>inputDocumentSubquery</td>
425
+ <td>Text returned by this SQL subquery</td>
426
+ </tr>
427
+ <tr>
428
+ <td>inputDocumentCondition</td>
429
+ <td>Text returned from reference table rows for which this
430
+ SQL "where" clause is true
431
+ </td>
432
+ </tr>
433
+ <tr>
434
+ <td>inputDocumentIDs</td>
435
+ <td>Text returned from reference table rows with this (these)
436
+ internal document ID number(s)
437
+ </td>
438
+ </tr>
439
+ </table>
440
+ </td>
441
+ </tr>
442
+ <tr>
443
+ <td class="name"><code>language</code></td>
444
+ <td class="type">
445
+ <span class="param-type">string</span>
446
+ </td>
447
+ <td class="attributes">
448
+ &lt;optional><br>
449
+ </td>
450
+ <td class="description last">Language code of input text, e.g. "EN", "DE" (""
451
+ for all).
452
+ </td>
453
+ </tr>
454
+ <tr>
455
+ <td class="name"><code>mimeType</code></td>
456
+ <td class="type">
457
+ <span class="param-type">string</span>
458
+ </td>
459
+ <td class="attributes">
460
+ &lt;optional><br>
461
+ </td>
462
+ <td class="description last">Mime type of input text, e.g. "text/plain" ("" for
463
+ unspecified).
464
+ </td>
465
+ </tr>
466
+ <tr>
467
+ <td class="name"><code>top</code></td>
468
+ <td class="type">
469
+ <span class="param-type">integer</span>
470
+ </td>
471
+ <td class="attributes">
472
+ &lt;optional><br>
473
+ </td>
474
+ <td class="description last">Maximum number of returned results.</td>
475
+ </tr>
476
+ <tr>
477
+ <td class="name"><code>threshold</code></td>
478
+ <td class="type">
479
+ <span class="param-type">number</span>
480
+ </td>
481
+ <td class="attributes">
482
+ &lt;optional><br>
483
+ </td>
484
+ <td class="description last">Restricts the returned results to those displaying
485
+ a score greater than
486
+ or equal to this numeric value in the range [0,1] (0 to allow all).
487
+ </td>
488
+ </tr>
489
+ <tr>
490
+ <td class="name"><code>documentRestriction</code></td>
491
+ <td class="type">
492
+ <span class="param-type">string</span>
493
+ </td>
494
+ <td class="attributes">
495
+ &lt;optional><br>
496
+ </td>
497
+ <td class="description last">Specified condition (SQL "where" clause) to be met
498
+ for reference
499
+ document rows to be considered in the computation ("" for all).
500
+ </td>
501
+ </tr>
502
+ <tr>
503
+ <td class="name"><code>termTypeRestriction</code></td>
504
+ <td class="type">
505
+ <span class="param-type">string</span>
506
+ </td>
507
+ <td class="attributes">
508
+ &lt;optional><br>
509
+ </td>
510
+ <td class="description last">Comma-separated list of term types to consider (""
511
+ for all).
512
+ </td>
513
+ </tr>
514
+ <tr>
515
+ <td class="name"><code>includeColumns</code></td>
516
+ <td class="type">
517
+ <span class="param-type">Array.&lt;string></span>
518
+ </td>
519
+ <td class="attributes">
520
+ &lt;optional><br>
521
+ </td>
522
+ <td class="description last">Specifies columns from the reference table that are
523
+ to be included in
524
+ the result table. This provides a way to obtain the content or other data
525
+ belonging to returned documents.
526
+ </td>
527
+ </tr>
528
+ <tr>
529
+ <td class="name"><code>correlationMatrix</code></td>
530
+ <td class="type">
531
+ <span class="param-type">boolean</span>
532
+ </td>
533
+ <td class="attributes">
534
+ &lt;optional><br>
535
+ </td>
536
+ <td class="description last">If specified and true, the returned result includes
537
+ a document
538
+ correlation matrix.
539
+ </td>
540
+ </tr>
541
+ <tr>
542
+ <td class="name"><code>principalComponents</code></td>
543
+ <td class="type">
544
+ <span class="param-type">integer</span>
545
+ </td>
546
+ <td class="attributes">
547
+ &lt;optional><br>
548
+ </td>
549
+ <td class="description last">If specified and non-zero, the returned result
550
+ includes the specified
551
+ number of principal components of the correlation matrix.
552
+ Must be in the range from 0 to 3.
553
+ </td>
554
+ </tr>
555
+ <tr>
556
+ <td class="name"><code>clustering</code></td>
557
+ <td class="type">
558
+ <span class="param-type">string</span>
559
+ </td>
560
+ <td class="attributes">
561
+ &lt;optional><br>
562
+ </td>
563
+ <td class="description last">If specified, the returned result includes
564
+ hierarchical clusters computed with
565
+ the method indicated. The possible values "COMPLETE_LINKAGE",
566
+ "SINGLE_LINKAGE",
567
+ "AVG_DISTANCE_WITHIN", "AVG_DISTANCE_BETWEEN", and "WARD" stand respectively
568
+ for
569
+ the methods Complete Linkage, Single Linkage, Average Distance Within,
570
+ Average Distance Between, and Ward's Method.
571
+ </td>
572
+ </tr>
573
+ </tbody>
574
+ </table>
575
+ </td>
576
+ </tr>
577
+ </tbody>
578
+ </table>
579
+ <dl class="details">
580
+ </dl>
581
+ <h5>Throws:</h5>
582
+ <div class="param-desc">
583
+ Throws an error if the parameters object is not valid or the execution fails.
584
+ </div>
585
+ <h5>Returns:</h5>
586
+ <div class="param-desc">
587
+ Array of DocumentResult objects.
588
+ </div>
589
+ <dl>
590
+ <dt>
591
+ Type
592
+ </dt>
593
+ <dd>
594
+ <span class="param-type">Array.&lt;<a href="$.text.mining.Session.html#DocumentResult">$.text.mining.Session~DocumentResult</a>></span>
595
+ </dd>
596
+ </dl>
597
+ <h5>Example</h5>
598
+ <pre class="prettyprint"><code>var documentResults = TM.getRelatedDocuments ({
599
+ top: 16,
600
+ inputDocumentText: "animals",
601
+ includeColumns: ["KEY", "FILECONTENT"],
602
+ });</code></pre>
603
+ </dd>
604
+ <dt>
605
+ <h4 class="name" id="getRelatedTerms"><span class="type-signature">async </span>getRelatedTerms<span
606
+ class="signature">(p)</span><span class="type-signature"> &rarr; {Array.&lt;<a
607
+ href="$.text.mining.Session.html#TermResult">$.text.mining.Session~TermResult</a>>}</span>
608
+ </h4>
609
+ </dt>
610
+ <dd>
611
+ <div class="description">
612
+ Given an input term, this function returns the top-ranked related terms from the reference data,
613
+ based on co-occurrence statistics.
614
+ </div>
615
+ <h5>Parameters:</h5>
616
+ <table class="params">
617
+ <thead>
618
+ <tr>
619
+ <th>Name</th>
620
+ <th>Type</th>
621
+ <th class="last">Description</th>
622
+ </tr>
623
+ </thead>
624
+ <tbody>
625
+ <tr>
626
+ <td class="name"><code>p</code></td>
627
+ <td class="type">
628
+ <span class="param-type">object</span>
629
+ </td>
630
+ <td class="description last">Encapsulates getRelatedTerms parameters.
631
+ <h6>Properties</h6>
632
+ <table class="params">
633
+ <thead>
634
+ <tr>
635
+ <th>Name</th>
636
+ <th>Type</th>
637
+ <th>Argument</th>
638
+ <th class="last">Description</th>
639
+ </tr>
640
+ </thead>
641
+ <tbody>
642
+ <tr>
643
+ <td class="name"><code>inputTermText|<br/>inputTermIDs</code></td>
644
+ <td class="type">
645
+ <span class="param-type">string</span>
646
+ </td>
647
+ <td class="attributes">
648
+ </td>
649
+ <td class="description last">Input term to process. One and only one of the
650
+ following:
651
+ <table>
652
+ <tr>
653
+ <td>inputTermText</td>
654
+ <td>This literal text.
655
+ Typically a single term, but can be multiple terms with optional
656
+ term types and wildcarding.
657
+ See SAP HANA SQL and System Views Reference for details.
658
+ </td>
659
+ </tr>
660
+ <tr>
661
+ <td>inputTermIDs</td>
662
+ <td>Text associated with reference table columns with this (these)
663
+ internal term ID number(s)
664
+ </td>
665
+ </tr>
666
+ </table>
667
+ </td>
668
+ </tr>
669
+ <tr>
670
+ <td class="name"><code>top</code></td>
671
+ <td class="type">
672
+ <span class="param-type">integer</span>
673
+ </td>
674
+ <td class="attributes">
675
+ &lt;optional><br>
676
+ </td>
677
+ <td class="description last">Maximum number of returned results.</td>
678
+ </tr>
679
+ <tr>
680
+ <td class="name"><code>threshold</code></td>
681
+ <td class="type">
682
+ <span class="param-type">number</span>
683
+ </td>
684
+ <td class="attributes">
685
+ &lt;optional><br>
686
+ </td>
687
+ <td class="description last">Restricts the returned results to those displaying
688
+ a score greater than
689
+ or equal to this numeric value in the range [0,1] (0 to allow all).
690
+ </td>
691
+ </tr>
692
+ <tr>
693
+ <td class="name"><code>documentRestriction</code></td>
694
+ <td class="type">
695
+ <span class="param-type">string</span>
696
+ </td>
697
+ <td class="attributes">
698
+ &lt;optional><br>
699
+ </td>
700
+ <td class="description last">Specified condition (SQL "where" clause) to be met
701
+ for reference
702
+ document rows to be considered in the computation ("" for all).
703
+ </td>
704
+ </tr>
705
+ <tr>
706
+ <td class="name"><code>termTypeRestriction</code></td>
707
+ <td class="type">
708
+ <span class="param-type">string</span>
709
+ </td>
710
+ <td class="attributes">
711
+ &lt;optional><br>
712
+ </td>
713
+ <td class="description last">Comma-separated list of term types to consider (""
714
+ for all).
715
+ </td>
716
+ </tr>
717
+ <tr>
718
+ <td class="name"><code>correlationMatrix</code></td>
719
+ <td class="type">
720
+ <span class="param-type">boolean</span>
721
+ </td>
722
+ <td class="attributes">
723
+ &lt;optional><br>
724
+ </td>
725
+ <td class="description last">If specified and true, the returned result includes
726
+ a term
727
+ correlation matrix.
728
+ </td>
729
+ </tr>
730
+ <tr>
731
+ <td class="name"><code>principalComponents</code></td>
732
+ <td class="type">
733
+ <span class="param-type">integer</span>
734
+ </td>
735
+ <td class="attributes">
736
+ &lt;optional><br>
737
+ </td>
738
+ <td class="description last">If specified and non-zero, the returned result
739
+ includes the specified
740
+ number of principal components of the correlation matrix.
741
+ Must be in the range from 0 to 3.
742
+ </td>
743
+ </tr>
744
+ <tr>
745
+ <td class="name"><code>clustering</code></td>
746
+ <td class="type">
747
+ <span class="param-type">string</span>
748
+ </td>
749
+ <td class="attributes">
750
+ &lt;optional><br>
751
+ </td>
752
+ <td class="description last">If specified, the returned result includes
753
+ hierarchical clusters computed with
754
+ the method indicated. The possible values "COMPLETE_LINKAGE",
755
+ "SINGLE_LINKAGE",
756
+ "AVG_DISTANCE_WITHIN", "AVG_DISTANCE_BETWEEN", and "WARD" stand respectively
757
+ for
758
+ the methods Complete Linkage, Single Linkage, Average Distance Within,
759
+ Average Distance Between, and Ward's Method.
760
+ </td>
761
+ </tr>
762
+ </tbody>
763
+ </table>
764
+ </td>
765
+ </tr>
766
+ </tbody>
767
+ </table>
768
+ <dl class="details">
769
+ </dl>
770
+ <h5>Throws:</h5>
771
+ <div class="param-desc">
772
+ Throws an error if the parameters object is not valid or the execution fails.
773
+ </div>
774
+ <h5>Returns:</h5>
775
+ <div class="param-desc">
776
+ Array of TermResult objects.
777
+ </div>
778
+ <dl>
779
+ <dt>
780
+ Type
781
+ </dt>
782
+ <dd>
783
+ <span class="param-type">Array.&lt;<a href="$.text.mining.Session.html#TermResult">$.text.mining.Session~TermResult</a>></span>
784
+ </dd>
785
+ </dl>
786
+ <h5>Example</h5>
787
+ <pre class="prettyprint"><code>var termResults = <b>await </b>TM.getRelatedTerms({
788
+ top: 16,
789
+ inputTermText: "animals",
790
+ });</code></pre>
791
+ </dd>
792
+ <dt>
793
+ <h4 class="name" id="getRelevantDocuments"><span
794
+ class="type-signature">async </span>getRelevantDocuments<span class="signature">(p)</span><span
795
+ class="type-signature"> &rarr; {Array.&lt;<a
796
+ href="$.text.mining.Session.html#DocumentResult">$.text.mining.Session~DocumentResult</a>>}</span>
797
+ </h4>
798
+ </dt>
799
+ <dd>
800
+ <div class="description">
801
+ Given an input term, this function returns the top-ranked documents from the reference data that
802
+ are deemed
803
+ relevant to the term.
804
+ </div>
805
+ <h5>Parameters:</h5>
806
+ <table class="params">
807
+ <thead>
808
+ <tr>
809
+ <th>Name</th>
810
+ <th>Type</th>
811
+ <th class="last">Description</th>
812
+ </tr>
813
+ </thead>
814
+ <tbody>
815
+ <tr>
816
+ <td class="name"><code>p</code></td>
817
+ <td class="type">
818
+ <span class="param-type">object</span>
819
+ </td>
820
+ <td class="description last">Encapsulates getRelevantDocuments parameters.
821
+ <h6>Properties</h6>
822
+ <table class="params">
823
+ <thead>
824
+ <tr>
825
+ <th>Name</th>
826
+ <th>Type</th>
827
+ <th>Argument</th>
828
+ <th class="last">Description</th>
829
+ </tr>
830
+ </thead>
831
+ <tbody>
832
+ <tr>
833
+ <td class="name"><code>inputTermText|<br/>inputTermIDs</code></td>
834
+ <td class="type">
835
+ <span class="param-type">string</span>
836
+ </td>
837
+ <td class="attributes">
838
+ </td>
839
+ <td class="description last">Input term to process. One and only one of the
840
+ following:
841
+ <table>
842
+ <tr>
843
+ <td>inputTermText</td>
844
+ <td>This literal text.
845
+ Typically a single term, but can be multiple terms with optional
846
+ term types and wildcarding.
847
+ See SAP HANA SQL and System Views Reference for details.
848
+ </td>
849
+ </tr>
850
+ <tr>
851
+ <td>inputTermIDs</td>
852
+ <td>Text associated with reference table columns with this (these)
853
+ internal term ID number(s)
854
+ </td>
855
+ </tr>
856
+ </table>
857
+ </td>
858
+ </tr>
859
+ <tr>
860
+ <td class="name"><code>top</code></td>
861
+ <td class="type">
862
+ <span class="param-type">integer</span>
863
+ </td>
864
+ <td class="attributes">
865
+ &lt;optional><br>
866
+ </td>
867
+ <td class="description last">Maximum number of returned results.</td>
868
+ </tr>
869
+ <tr>
870
+ <td class="name"><code>threshold</code></td>
871
+ <td class="type">
872
+ <span class="param-type">number</span>
873
+ </td>
874
+ <td class="attributes">
875
+ &lt;optional><br>
876
+ </td>
877
+ <td class="description last">Restricts the returned results to those displaying
878
+ a score greater than
879
+ or equal to this numeric value in the range [0,1] (0 to allow all).
880
+ </td>
881
+ </tr>
882
+ <tr>
883
+ <td class="name"><code>documentRestriction</code></td>
884
+ <td class="type">
885
+ <span class="param-type">string</span>
886
+ </td>
887
+ <td class="attributes">
888
+ &lt;optional><br>
889
+ </td>
890
+ <td class="description last">Specified condition (SQL "where" clause) to be met
891
+ for reference
892
+ document rows to be considered in the computation ("" for all).
893
+ </td>
894
+ </tr>
895
+ <tr>
896
+ <td class="name"><code>termTypeRestriction</code></td>
897
+ <td class="type">
898
+ <span class="param-type">string</span>
899
+ </td>
900
+ <td class="attributes">
901
+ &lt;optional><br>
902
+ </td>
903
+ <td class="description last">Comma-separated list of term types to consider (""
904
+ for all).
905
+ </td>
906
+ </tr>
907
+ <tr>
908
+ <td class="name"><code>includeColumns</code></td>
909
+ <td class="type">
910
+ <span class="param-type">Array.&lt;string></span>
911
+ </td>
912
+ <td class="attributes">
913
+ &lt;optional><br>
914
+ </td>
915
+ <td class="description last">Specifies columns from the reference table that are
916
+ to be included in
917
+ the result table. This provides a way to obtain the content or other data
918
+ belonging to returned documents.
919
+ </td>
920
+ </tr>
921
+ <tr>
922
+ <td class="name"><code>correlationMatrix</code></td>
923
+ <td class="type">
924
+ <span class="param-type">boolean</span>
925
+ </td>
926
+ <td class="attributes">
927
+ &lt;optional><br>
928
+ </td>
929
+ <td class="description last">If specified and true, the returned result includes
930
+ a document
931
+ correlation matrix.
932
+ </td>
933
+ </tr>
934
+ <tr>
935
+ <td class="name"><code>principalComponents</code></td>
936
+ <td class="type">
937
+ <span class="param-type">integer</span>
938
+ </td>
939
+ <td class="attributes">
940
+ &lt;optional><br>
941
+ </td>
942
+ <td class="description last">If specified and non-zero, the returned result
943
+ includes the specified
944
+ number of principal components of the correlation matrix.
945
+ Must be in the range from 0 to 3.
946
+ </td>
947
+ </tr>
948
+ <tr>
949
+ <td class="name"><code>clustering</code></td>
950
+ <td class="type">
951
+ <span class="param-type">string</span>
952
+ </td>
953
+ <td class="attributes">
954
+ &lt;optional><br>
955
+ </td>
956
+ <td class="description last">If specified, the returned result includes
957
+ hierarchical clusters computed with
958
+ the method indicated. The possible values "COMPLETE_LINKAGE",
959
+ "SINGLE_LINKAGE",
960
+ "AVG_DISTANCE_WITHIN", "AVG_DISTANCE_BETWEEN", and "WARD" stand respectively
961
+ for
962
+ the methods Complete Linkage, Single Linkage, Average Distance Within,
963
+ Average Distance Between, and Ward's Method.
964
+ </td>
965
+ </tr>
966
+ </tbody>
967
+ </table>
968
+ </td>
969
+ </tr>
970
+ </tbody>
971
+ </table>
972
+ <dl class="details">
973
+ </dl>
974
+ <h5>Throws:</h5>
975
+ <div class="param-desc">
976
+ Throws an error if the parameters object is not valid or the execution fails.
977
+ </div>
978
+ <h5>Returns:</h5>
979
+ <div class="param-desc">
980
+ Array of DocumentResult objects.
981
+ </div>
982
+ <dl>
983
+ <dt>
984
+ Type
985
+ </dt>
986
+ <dd>
987
+ <span class="param-type">Array.&lt;<a href="$.text.mining.Session.html#DocumentResult">$.text.mining.Session~DocumentResult</a>></span>
988
+ </dd>
989
+ </dl>
990
+ <h5>Example</h5>
991
+ <pre class="prettyprint"><code>var documentResults = <b>await </b>TM.getRelevantDocuments ({
992
+ top: 16,
993
+ inputTermText: "animals",
994
+ includeColumns: ["KEY", "FILECONTENT"],
995
+ });</code></pre>
996
+ </dd>
997
+ <dt>
998
+ <h4 class="name" id="getRelevantTerms"><span class="type-signature">async </span>getRelevantTerms<span
999
+ class="signature">(p)</span><span class="type-signature"> &rarr; {Array.&lt;<a
1000
+ href="$.text.mining.Session.html#TermResult">$.text.mining.Session~TermResult</a>>}</span>
1001
+ </h4>
1002
+ </dt>
1003
+ <dd>
1004
+ <div class="description">
1005
+ Given an input document, this function returns the top-ranked <i>keyphrases</i> or <i>relevant
1006
+ terms</i> from the
1007
+ reference data, i.e., the terms that saliently describe the document.
1008
+ <p>
1009
+ Keyphrases are used to summarize, characterize and provide thematic access to data.
1010
+ </div>
1011
+ <h5>Parameters:</h5>
1012
+ <table class="params">
1013
+ <thead>
1014
+ <tr>
1015
+ <th>Name</th>
1016
+ <th>Type</th>
1017
+ <th class="last">Description</th>
1018
+ </tr>
1019
+ </thead>
1020
+ <tbody>
1021
+ <tr>
1022
+ <td class="name"><code>p</code></td>
1023
+ <td class="type">
1024
+ <span class="param-type">object</span>
1025
+ </td>
1026
+ <td class="description last">Encapsulates getRelevantTerms parameters.
1027
+ <h6>Properties</h6>
1028
+ <table class="params">
1029
+ <thead>
1030
+ <tr>
1031
+ <th>Name</th>
1032
+ <th>Type</th>
1033
+ <th>Argument</th>
1034
+ <th class="last">Description</th>
1035
+ </tr>
1036
+ </thead>
1037
+ <tbody>
1038
+ <tr>
1039
+ <td class="name"><code>inputDocumentText|<br/>inputDocumentSubquery|<br/>inputDocumentCondition|<br/>inputDocumentIDs</code>
1040
+ </td>
1041
+ <td class="type">
1042
+ <span class="param-type">string</span>
1043
+ </td>
1044
+ <td class="attributes">
1045
+ </td>
1046
+ <td class="description last">Input document to process. One and only one of the
1047
+ following:
1048
+ <table>
1049
+ <tr>
1050
+ <td>inputDocumentText</td>
1051
+ <td>This literal text</td>
1052
+ </tr>
1053
+ <tr>
1054
+ <td>inputDocumentSubquery</td>
1055
+ <td>Text returned by this SQL subquery</td>
1056
+ </tr>
1057
+ <tr>
1058
+ <td>inputDocumentCondition</td>
1059
+ <td>Text returned from reference table rows for which this
1060
+ SQL "where" clause is true
1061
+ </td>
1062
+ </tr>
1063
+ <tr>
1064
+ <td>inputDocumentIDs</td>
1065
+ <td>Text returned from reference table rows with this (these)
1066
+ internal document ID number(s)
1067
+ </td>
1068
+ </tr>
1069
+ </table>
1070
+ </td>
1071
+ </tr>
1072
+ <tr>
1073
+ <td class="name"><code>language</code></td>
1074
+ <td class="type">
1075
+ <span class="param-type">string</span>
1076
+ </td>
1077
+ <td class="attributes">
1078
+ &lt;optional><br>
1079
+ </td>
1080
+ <td class="description last">Language code of input text, e.g. "EN", "DE" (""
1081
+ for all).
1082
+ </td>
1083
+ </tr>
1084
+ <tr>
1085
+ <td class="name"><code>mimeType</code></td>
1086
+ <td class="type">
1087
+ <span class="param-type">string</span>
1088
+ </td>
1089
+ <td class="attributes">
1090
+ &lt;optional><br>
1091
+ </td>
1092
+ <td class="description last">Mime type of input text, e.g. "text/plain" ("" for
1093
+ unspecified).
1094
+ </td>
1095
+ </tr>
1096
+ <tr>
1097
+ <td class="name"><code>top</code></td>
1098
+ <td class="type">
1099
+ <span class="param-type">integer</span>
1100
+ </td>
1101
+ <td class="attributes">
1102
+ &lt;optional><br>
1103
+ </td>
1104
+ <td class="description last">Maximum number of returned results.</td>
1105
+ </tr>
1106
+ <tr>
1107
+ <td class="name"><code>threshold</code></td>
1108
+ <td class="type">
1109
+ <span class="param-type">number</span>
1110
+ </td>
1111
+ <td class="attributes">
1112
+ &lt;optional><br>
1113
+ </td>
1114
+ <td class="description last">Restricts the returned results to those displaying
1115
+ a score greater than
1116
+ or equal to this numeric value in the range [0,1] (0 to allow all).
1117
+ </td>
1118
+ </tr>
1119
+ <tr>
1120
+ <td class="name"><code>documentRestriction</code></td>
1121
+ <td class="type">
1122
+ <span class="param-type">string</span>
1123
+ </td>
1124
+ <td class="attributes">
1125
+ &lt;optional><br>
1126
+ </td>
1127
+ <td class="description last">Specified condition (SQL "where" clause) to be met
1128
+ for reference
1129
+ document rows to be considered in the computation ("" for all).
1130
+ </td>
1131
+ </tr>
1132
+ <tr>
1133
+ <td class="name"><code>termTypeRestriction</code></td>
1134
+ <td class="type">
1135
+ <span class="param-type">string</span>
1136
+ </td>
1137
+ <td class="attributes">
1138
+ &lt;optional><br>
1139
+ </td>
1140
+ <td class="description last">Comma-separated list of term types to consider (""
1141
+ for all).
1142
+ </td>
1143
+ </tr>
1144
+ <tr>
1145
+ <td class="name"><code>correlationMatrix</code></td>
1146
+ <td class="type">
1147
+ <span class="param-type">boolean</span>
1148
+ </td>
1149
+ <td class="attributes">
1150
+ &lt;optional><br>
1151
+ </td>
1152
+ <td class="description last">If specified and true, the returned result includes
1153
+ a term
1154
+ correlation matrix.
1155
+ </td>
1156
+ </tr>
1157
+ <tr>
1158
+ <td class="name"><code>principalComponents</code></td>
1159
+ <td class="type">
1160
+ <span class="param-type">integer</span>
1161
+ </td>
1162
+ <td class="attributes">
1163
+ &lt;optional><br>
1164
+ </td>
1165
+ <td class="description last">If specified and non-zero, the returned result
1166
+ includes the specified
1167
+ number of principal components of the correlation matrix.
1168
+ Must be in the range from 0 to 3.
1169
+ </td>
1170
+ </tr>
1171
+ <tr>
1172
+ <td class="name"><code>clustering</code></td>
1173
+ <td class="type">
1174
+ <span class="param-type">string</span>
1175
+ </td>
1176
+ <td class="attributes">
1177
+ &lt;optional><br>
1178
+ </td>
1179
+ <td class="description last">If specified, the returned result includes
1180
+ hierarchical clusters computed with
1181
+ the method indicated. The possible values "COMPLETE_LINKAGE",
1182
+ "SINGLE_LINKAGE",
1183
+ "AVG_DISTANCE_WITHIN", "AVG_DISTANCE_BETWEEN", and "WARD" stand respectively
1184
+ for
1185
+ the methods Complete Linkage, Single Linkage, Average Distance Within,
1186
+ Average Distance Between, and Ward's Method.
1187
+ </td>
1188
+ </tr>
1189
+ </tbody>
1190
+ </table>
1191
+ </td>
1192
+ </tr>
1193
+ </tbody>
1194
+ </table>
1195
+ <dl class="details">
1196
+ </dl>
1197
+ <h5>Throws:</h5>
1198
+ <div class="param-desc">
1199
+ Throws an error if the parameters object is not valid or the execution fails.
1200
+ </div>
1201
+ <h5>Returns:</h5>
1202
+ <div class="param-desc">
1203
+ Array of TermResult objects.
1204
+ </div>
1205
+ <dl>
1206
+ <dt>
1207
+ Type
1208
+ </dt>
1209
+ <dd>
1210
+ <span class="param-type">Array.&lt;<a href="$.text.mining.Session.html#TermResult">$.text.mining.Session~TermResult</a>></span>
1211
+ </dd>
1212
+ </dl>
1213
+ <h5>Example</h5>
1214
+ <pre class="prettyprint"><code>var termResults = <b>await </b>TM.getRelevantTerms ({
1215
+ top: 16,
1216
+ inputDocumentText: "animals",
1217
+ });</code></pre>
1218
+ </dd>
1219
+ <dt>
1220
+ <h4 class="name" id="getSuggestedTerms"><span class="type-signature">async </span>getSuggestedTerms<span
1221
+ class="signature">(p)</span><span class="type-signature"> &rarr; {Array.&lt;<a
1222
+ href="$.text.mining.Session.html#TermResult">$.text.mining.Session~TermResult</a>>}</span>
1223
+ </h4>
1224
+ </dt>
1225
+ <dd>
1226
+ <div class="description">
1227
+ Given an input term initial substring, this function returns the top-ranked terms from the
1228
+ reference data that
1229
+ complete that initial substring.
1230
+ <p>
1231
+ Term suggestion is used to present a user with likely search terms as the user enters
1232
+ characters within a search
1233
+ application.
1234
+ </div>
1235
+ <h5>Parameters:</h5>
1236
+ <table class="params">
1237
+ <thead>
1238
+ <tr>
1239
+ <th>Name</th>
1240
+ <th>Type</th>
1241
+ <th class="last">Description</th>
1242
+ </tr>
1243
+ </thead>
1244
+ <tbody>
1245
+ <tr>
1246
+ <td class="name"><code>p</code></td>
1247
+ <td class="type">
1248
+ <span class="param-type">object</span>
1249
+ </td>
1250
+ <td class="description last">Encapsulates getSuggestedTerms parameters.
1251
+ <h6>Properties</h6>
1252
+ <table class="params">
1253
+ <thead>
1254
+ <tr>
1255
+ <th>Name</th>
1256
+ <th>Type</th>
1257
+ <th>Argument</th>
1258
+ <th class="last">Description</th>
1259
+ </tr>
1260
+ </thead>
1261
+ <tbody>
1262
+ <tr>
1263
+ <td class="name"><code>inputTermText|<br/>inputTermIDs</code></td>
1264
+ <td class="type">
1265
+ <span class="param-type">string</span>
1266
+ </td>
1267
+ <td class="attributes">
1268
+ </td>
1269
+ <td class="description last">Input term to process. One and only one of the
1270
+ following:
1271
+ <table>
1272
+ <tr>
1273
+ <td>inputTermText</td>
1274
+ <td>This literal text</td>
1275
+ </tr>
1276
+ <tr>
1277
+ <td>inputTermIDs</td>
1278
+ <td>Text associated with reference table columns with this (these)
1279
+ internal term ID number(s)
1280
+ </td>
1281
+ </tr>
1282
+ </table>
1283
+ </td>
1284
+ </tr>
1285
+ <tr>
1286
+ <td class="name"><code>top</code></td>
1287
+ <td class="type">
1288
+ <span class="param-type">integer</span>
1289
+ </td>
1290
+ <td class="attributes">
1291
+ &lt;optional><br>
1292
+ </td>
1293
+ <td class="description last">Maximum number of returned results.</td>
1294
+ </tr>
1295
+ <tr>
1296
+ <td class="name"><code>threshold</code></td>
1297
+ <td class="type">
1298
+ <span class="param-type">number</span>
1299
+ </td>
1300
+ <td class="attributes">
1301
+ &lt;optional><br>
1302
+ </td>
1303
+ <td class="description last">Restricts the returned results to those displaying
1304
+ a score greater than
1305
+ or equal to this numeric value in the range [0,1] (0 to allow all).
1306
+ </td>
1307
+ </tr>
1308
+ <tr>
1309
+ <td class="name"><code>documentRestriction</code></td>
1310
+ <td class="type">
1311
+ <span class="param-type">string</span>
1312
+ </td>
1313
+ <td class="attributes">
1314
+ &lt;optional><br>
1315
+ </td>
1316
+ <td class="description last">Specified condition (SQL "where" clause) to be met
1317
+ for reference
1318
+ document rows to be considered in the computation ("" for all).
1319
+ </td>
1320
+ </tr>
1321
+ <tr>
1322
+ <td class="name"><code>termTypeRestriction</code></td>
1323
+ <td class="type">
1324
+ <span class="param-type">string</span>
1325
+ </td>
1326
+ <td class="attributes">
1327
+ &lt;optional><br>
1328
+ </td>
1329
+ <td class="description last">Comma-separated list of term types to consider (""
1330
+ for all).
1331
+ </td>
1332
+ </tr>
1333
+ </tbody>
1334
+ </table>
1335
+ </td>
1336
+ </tr>
1337
+ </tbody>
1338
+ </table>
1339
+ <dl class="details">
1340
+ </dl>
1341
+ <h5>Throws:</h5>
1342
+ <div class="param-desc">
1343
+ Throws an error if the parameters object is not valid or the execution fails.
1344
+ </div>
1345
+ <h5>Returns:</h5>
1346
+ <div class="param-desc">
1347
+ Array of TermResult objects.
1348
+ </div>
1349
+ <dl>
1350
+ <dt>
1351
+ Type
1352
+ </dt>
1353
+ <dd>
1354
+ <span class="param-type">Array.&lt;<a href="$.text.mining.Session.html#TermResult">$.text.mining.Session~TermResult</a>></span>
1355
+ </dd>
1356
+ </dl>
1357
+ <h5>Example</h5>
1358
+ <pre class="prettyprint"><code>var termResults = <b>await </b>TM.getSuggestedTerms ({
1359
+ top: 16,
1360
+ inputTermText: "a",
1361
+ });</code></pre>
1362
+ </dd>
1363
+ <dt>
1364
+ <h4 class="name" id="initialize"><span class="type-signature">async </span>initialize<span
1365
+ class="signature">(p)</span><span class="type-signature"></span></h4>
1366
+ </dt>
1367
+ <dd>
1368
+ <div class="description">
1369
+ This function initializes (or re-initializes) Text Mining for the reference table and column
1370
+ linked to the
1371
+ TextMiningSession object. This creates the Term-Document matrix and other configuration context
1372
+ data that
1373
+ is needed for Text Mining functions. The Text Mining context is specific to the reference data,
1374
+ but it is
1375
+ persistent and global for all users. The configuration context specified at initialization time
1376
+ serves later
1377
+ as defaults for unspecified parameters when Text Mining functions are invoked on the given
1378
+ reference data.
1379
+ <p>
1380
+ <div style="padding:0px 10px;background-color:light pink;border-radius:5px;border:1px solid red">
1381
+ <p>
1382
+ <b><span style="background-color:Yellow"><big>!</big></span>&nbsp; &nbsp; Advanced
1383
+ function</b>
1384
+ <p>
1385
+ This function is typically not used. Initialization of Text Mining is normally done
1386
+ separately when the
1387
+ full text index is created for a given reference table and column. Since the Text Mining
1388
+ context is
1389
+ persistent and global for all users, that is the best way to assure consistent results
1390
+ and avoid confusion.
1391
+ <p>
1392
+ This initialize() function provides a way to directly initialize Text Mining for
1393
+ development purposes or
1394
+ special customer applications. If this function is used carelessly, it can unexpectedly
1395
+ affect other
1396
+ running applications.
1397
+ </div>
1398
+ </div>
1399
+ <h5>Parameters:</h5>
1400
+ <table class="params">
1401
+ <thead>
1402
+ <tr>
1403
+ <th>Name</th>
1404
+ <th>Type</th>
1405
+ <th class="last">Description</th>
1406
+ </tr>
1407
+ </thead>
1408
+ <tbody>
1409
+ <tr>
1410
+ <td class="name"><code>p</code></td>
1411
+ <td class="type">
1412
+ <span class="param-type">object</span>
1413
+ </td>
1414
+ <td class="description last">Encapsulates initialize parameters.
1415
+ <h6>Properties</h6>
1416
+ <table class="params">
1417
+ <thead>
1418
+ <tr>
1419
+ <th>Name</th>
1420
+ <th>Type</th>
1421
+ <th>Argument</th>
1422
+ <th class="last">Description</th>
1423
+ </tr>
1424
+ </thead>
1425
+ <tbody>
1426
+ <tr>
1427
+ <td class="name"><code>configuration</code></td>
1428
+ <td class="type">
1429
+ <span class="param-type">string</span>
1430
+ </td>
1431
+ <td class="attributes">
1432
+ &lt;optional><br>
1433
+ </td>
1434
+ <td class="description last">Repository path to the configuration.
1435
+ If omitted, the default configuration is used.
1436
+ </td>
1437
+ </tr>
1438
+ <tr>
1439
+ <td class="name"><code><i>list of parameters...</i></code></td>
1440
+ <td class="type">
1441
+ <span class="param-type">*</span>
1442
+ </td>
1443
+ <td class="attributes">
1444
+ &lt;optional><br>
1445
+ &lt;repeatable><br>
1446
+ </td>
1447
+ <td class="description last">Text Mining parameters and defaults to use for this
1448
+ reference table and column that override what is specified in the
1449
+ configuration.
1450
+ See the SAP HANA Text Mining Developer Guide for details.
1451
+ </td>
1452
+ </tr>
1453
+ </tbody>
1454
+ </table>
1455
+ </td>
1456
+ </tr>
1457
+ </tbody>
1458
+ </table>
1459
+ <dl class="details">
1460
+ </dl>
1461
+ <h5>Throws:</h5>
1462
+ <div class="param-desc">
1463
+ Throws an error if the parameters object is not valid or the execution fails.
1464
+ </div>
1465
+ <h5>Example</h5>
1466
+ <pre class="prettyprint"><code><b>await </b>TM.initialize({
1467
+ configuration: "acme.textmining::defaults.textminingconfig",
1468
+ minTermFrequency : 3,
1469
+ maxTermFrequency : 100,
1470
+ });</code></pre>
1471
+ </dd>
1472
+ </dl>
1473
+ <h3 class="subsection-title">Type Definitions</h3>
1474
+ <dl>
1475
+ <dt>
1476
+ <h4 class="name" id="CategoryResult">CategoryResult</h4>
1477
+ </dt>
1478
+ <dd>
1479
+ <div class="description">
1480
+ Represents a single category value result from Text Mining categorization.
1481
+ </div>
1482
+ <h5>Type:</h5>
1483
+ <ul>
1484
+ <li>
1485
+ <span class="param-type">object</span>
1486
+ </li>
1487
+ </ul>
1488
+ <dl class="details">
1489
+ <h5 class="subsection-title">Properties:</h5>
1490
+ <dl>
1491
+ <table class="props">
1492
+ <thead>
1493
+ <tr>
1494
+ <th>Name</th>
1495
+ <th>Type</th>
1496
+ <th class="last">Description</th>
1497
+ </tr>
1498
+ </thead>
1499
+ <tbody>
1500
+ <tr>
1501
+ <td class="name"><code>categorySet</code></td>
1502
+ <td class="type">
1503
+ <span class="param-type">string</span>
1504
+ </td>
1505
+ <td class="description last">The name of the category set column in which this
1506
+ category value occurs.
1507
+ </td>
1508
+ </tr>
1509
+ <tr>
1510
+ <td class="name"><code>category</code></td>
1511
+ <td class="type">
1512
+ <span class="param-type">string</span>
1513
+ </td>
1514
+ <td class="description last">The category value. One or more reference documents in
1515
+ the group of
1516
+ K nearest neighbors were assigned this category.
1517
+ </td>
1518
+ </tr>
1519
+ <tr>
1520
+ <td class="name"><code>documentCount</code></td>
1521
+ <td class="type">
1522
+ <span class="param-type">integer</span>
1523
+ </td>
1524
+ <td class="description last">The number of reference documents in the group of K
1525
+ nearest neighbors
1526
+ that were assigned this category value.
1527
+ </td>
1528
+ </tr>
1529
+ <tr>
1530
+ <td class="name"><code>score</code></td>
1531
+ <td class="type">
1532
+ <span class="param-type">number</span>
1533
+ </td>
1534
+ <td class="description last">The score of this category value in the range [0,1].
1535
+ </td>
1536
+ </tr>
1537
+ </tbody>
1538
+ </table>
1539
+ </dl>
1540
+ </dl>
1541
+ </dd>
1542
+ <dt>
1543
+ <h4 class="name" id="DocumentResult">DocumentResult</h4>
1544
+ </dt>
1545
+ <dd>
1546
+ <div class="description">
1547
+ Represents a single document result from certain Text Mining methods.
1548
+ </div>
1549
+ <h5>Type:</h5>
1550
+ <ul>
1551
+ <li>
1552
+ <span class="param-type">object</span>
1553
+ </li>
1554
+ </ul>
1555
+ <dl class="details">
1556
+ <h5 class="subsection-title">Properties:</h5>
1557
+ <dl>
1558
+ <table class="props">
1559
+ <thead>
1560
+ <tr>
1561
+ <th>Name</th>
1562
+ <th>Type</th>
1563
+ <th class="last">Description</th>
1564
+ </tr>
1565
+ </thead>
1566
+ <tbody>
1567
+ <tr>
1568
+ <td class="name"><code><i>includeColumns...</i></code></td>
1569
+ <td class="type">
1570
+ <span class="param-type">*</span>
1571
+ </td>
1572
+ <td class="description last">The requested columns from the reference table to be
1573
+ included in the
1574
+ result table, as specified via the includeColumns input parameter. These are
1575
+ returned as separate
1576
+ columns with the same names and types as the original specified include columns.
1577
+ </td>
1578
+ </tr>
1579
+ <tr>
1580
+ <td class="name"><code>id</code></td>
1581
+ <td class="type">
1582
+ <span class="param-type">integer</span>
1583
+ </td>
1584
+ <td class="description last">The document ID number used internally by Text Mining.
1585
+ This can be used in subsequent
1586
+ Text Mining method calls in the inputDocumentIDs parameter for faster
1587
+ performance.
1588
+ </td>
1589
+ </tr>
1590
+ <tr>
1591
+ <td class="name"><code>termCountTotal</code></td>
1592
+ <td class="type">
1593
+ <span class="param-type">integer</span>
1594
+ </td>
1595
+ <td class="description last">The total number of terms in this document, including
1596
+ duplicates.
1597
+ </td>
1598
+ </tr>
1599
+ <tr>
1600
+ <td class="name"><code>termCount</code></td>
1601
+ <td class="type">
1602
+ <span class="param-type">integer</span>
1603
+ </td>
1604
+ <td class="description last">The number of different terms in this document.</td>
1605
+ </tr>
1606
+ <tr>
1607
+ <td class="name"><code>correlation1...correlation<i>N</i></code></td>
1608
+ <td class="type">
1609
+ <span class="param-type">number</span>
1610
+ </td>
1611
+ <td class="description last">These appear if the document correlation matrix was
1612
+ requested.
1613
+ The columns of the document correlation matrix contain the correlation values
1614
+ for this document
1615
+ and each of the other returned documents. <i>N</i> is the number of returned
1616
+ documents.
1617
+ <p>
1618
+ The document correlation matrix is a square matrix where the rows and the
1619
+ columns each list
1620
+ all the returned documents in order. The matrix portrays every combination
1621
+ of the returned
1622
+ document pairs, with a duplicate reflection across the diagonal of the
1623
+ matrix.
1624
+ Each cell of the matrix contains the correlation value for the two documents
1625
+ at that row and
1626
+ column, based on the co-occurrence of their terms in the reference
1627
+ documents.</td>
1628
+ </tr>
1629
+ <tr>
1630
+ <td class="name">
1631
+ <code>factor1...factor<i>N</i><br/>rotation1...rotation<i>N</i></code></td>
1632
+ <td class="type">
1633
+ <span class="param-type">number</span>
1634
+ </td>
1635
+ <td class="description last">These appear if principal components
1636
+ analysis was requested.
1637
+ The factor and rotation values from principal component analysis (dimensionality
1638
+ reduction)
1639
+ for this document.
1640
+ <i>N</i> is the number of principal components requested via the
1641
+ principalComponents input parameter.
1642
+ </td>
1643
+ </tr>
1644
+ <tr>
1645
+ <td class="name"><code>clusteringLevel</code></td>
1646
+ <td class="type">
1647
+ <span class="param-type">number</span>
1648
+ </td>
1649
+ <td class="description last">This appears if clustering was requested.
1650
+ The clustering level for this document.
1651
+ </td>
1652
+ </tr>
1653
+ <tr>
1654
+ <td class="name"><code>clusteringLeft<br/>clusteringRight</code></td>
1655
+ <td class="type">
1656
+ <span class="param-type">integer</span>
1657
+ </td>
1658
+ <td class="description last">These appear if clustering was requested.
1659
+ The clustering left value and right value for this document.
1660
+ </td>
1661
+ </tr>
1662
+ <tr>
1663
+ <td class="name"><code>score</code></td>
1664
+ <td class="type">
1665
+ <span class="param-type">number</span>
1666
+ </td>
1667
+ <td class="description last">The score of this document in the range [0,1]</td>
1668
+ </tr>
1669
+ </tbody>
1670
+ </table>
1671
+ </dl>
1672
+ </dl>
1673
+ </dd>
1674
+ <dt>
1675
+ <h4 class="name" id="TermResult">TermResult</h4>
1676
+ </dt>
1677
+ <dd>
1678
+ <div class="description">
1679
+ Represents a single term result from certain Text Mining methods.
1680
+ </div>
1681
+ <h5>Type:</h5>
1682
+ <ul>
1683
+ <li>
1684
+ <span class="param-type">object</span>
1685
+ </li>
1686
+ </ul>
1687
+ <dl class="details">
1688
+ <h5 class="subsection-title">Properties:</h5>
1689
+ <dl>
1690
+ <table class="props">
1691
+ <thead>
1692
+ <tr>
1693
+ <th>Name</th>
1694
+ <th>Type</th>
1695
+ <th class="last">Description</th>
1696
+ </tr>
1697
+ </thead>
1698
+ <tbody>
1699
+ <tr>
1700
+ <td class="name"><code>term</code></td>
1701
+ <td class="type">
1702
+ <span class="param-type">string</span>
1703
+ </td>
1704
+ <td class="description last">The term.</td>
1705
+ </tr>
1706
+ <tr>
1707
+ <td class="name"><code>termNormalized</code></td>
1708
+ <td class="type">
1709
+ <span class="param-type">string</span>
1710
+ </td>
1711
+ <td class="description last">The normalized version of this term. Text Mining terms
1712
+ are normalized
1713
+ with respect to capitalization, whitespace, and accentuation.
1714
+ </td>
1715
+ </tr>
1716
+ <tr>
1717
+ <td class="name"><code>termType</code></td>
1718
+ <td class="type">
1719
+ <span class="param-type">string</span>
1720
+ </td>
1721
+ <td class="description last">The type of this term, an entity type or
1722
+ part-of-speech.
1723
+ </td>
1724
+ </tr>
1725
+ <tr>
1726
+ <td class="name"><code>id</code></td>
1727
+ <td class="type">
1728
+ <span class="param-type">integer</span>
1729
+ </td>
1730
+ <td class="description last">The term ID number used internally by Text Mining. This
1731
+ can be used in subsequent
1732
+ Text Mining method calls in the inputTermIDs parameter for faster performance.
1733
+ </td>
1734
+ </tr>
1735
+ <tr>
1736
+ <td class="name"><code>frequencyTotal</code></td>
1737
+ <td class="type">
1738
+ <span class="param-type">integer</span>
1739
+ </td>
1740
+ <td class="description last">The total number of times this term occurs in the
1741
+ reference documents.
1742
+ </td>
1743
+ </tr>
1744
+ <tr>
1745
+ <td class="name"><code>frequencyDocumentCount</code></td>
1746
+ <td class="type">
1747
+ <span class="param-type">integer</span>
1748
+ </td>
1749
+ <td class="description last">The number of reference documents in which this term
1750
+ occurs.
1751
+ </td>
1752
+ </tr>
1753
+ <tr>
1754
+ <td class="name"><code>correlation1...correlation<i>N</i></code></td>
1755
+ <td class="type">
1756
+ <span class="param-type">number</span>
1757
+ </td>
1758
+ <td class="description last">These appear if the term correlation matrix was
1759
+ requested
1760
+ (not available with the getSuggestedTerms method).
1761
+ The columns of the term correlation matrix contain the correlation values for
1762
+ this term
1763
+ and each of the other returned terms. <i>N</i> is the number of returned terms.
1764
+ <p>
1765
+ The term correlation matrix is a square matrix where the rows and the
1766
+ columns each list
1767
+ all the returned terms in order. The matrix portrays every combination of
1768
+ the returned
1769
+ term pairs, with a duplicate reflection across the diagonal of the matrix.
1770
+ Each cell of the matrix contains the correlation value for the two terms at
1771
+ that row and
1772
+ column, based on their co-occurrence in the reference documents.</td>
1773
+ </tr>
1774
+ <tr>
1775
+ <td class="name">
1776
+ <code>factor1...factor<i>N</i><br/>rotation1...rotation<i>N</i></code></td>
1777
+ <td class="type">
1778
+ <span class="param-type">number</span>
1779
+ </td>
1780
+ <td class="description last">These appear if principal components
1781
+ analysis was requested (not available with the getSuggestedTerms method).
1782
+ The factor and rotation values from principal component analysis (dimensionality
1783
+ reduction)
1784
+ for this term.
1785
+ <i>N</i> is the number of principal components requested via the
1786
+ principalComponents input parameter.
1787
+ </td>
1788
+ </tr>
1789
+ <tr>
1790
+ <td class="name"><code>clusteringLevel</code></td>
1791
+ <td class="type">
1792
+ <span class="param-type">number</span>
1793
+ </td>
1794
+ <td class="description last">This appears if clustering was requested
1795
+ (not available with the getSuggestedTerms method).
1796
+ The clustering level for this term.
1797
+ </td>
1798
+ </tr>
1799
+ <tr>
1800
+ <td class="name"><code>clusteringLeft<br/>clusteringRight</code></td>
1801
+ <td class="type">
1802
+ <span class="param-type">integer</span>
1803
+ </td>
1804
+ <td class="description last">These appear if clustering was requested
1805
+ (not available with the getSuggestedTerms method).
1806
+ The clustering left value and right value for this term.
1807
+ </td>
1808
+ </tr>
1809
+ <tr>
1810
+ <td class="name"><code>score</code></td>
1811
+ <td class="type">
1812
+ <span class="param-type">number</span>
1813
+ </td>
1814
+ <td class="description last">The score of this term in the range [0,1].</td>
1815
+ </tr>
1816
+ </tbody>
1817
+ </table>
1818
+ </dl>
1819
+ </dl>
1820
+ </dd>
1821
+ </dl>
1822
+ </article>
1823
+ </section>
1824
+ </div>
1825
+ <nav>
1826
+ <h2><a href="index.html">Index</a></h2>
1827
+ <h3>Classes</h3>
1828
+ <table>
1829
+ <tr>
1830
+ <td><a href="$.security.AntiVirus.html">AntiVirus</a></td>
1831
+ <td class="oblique">$.security</td>
1832
+ </tr>
1833
+ <tr>
1834
+ <td><a href="$.Application.html">Application</a></td>
1835
+ <td class="oblique">$</td>
1836
+ </tr>
1837
+ <tr>
1838
+ <td><a href="$.web.Body.html">Body</a></td>
1839
+ <td class="oblique">$.web</td>
1840
+ </tr>
1841
+ <tr>
1842
+ <td><a href="$.db.CallableStatement.html">CallableStatement</a></td>
1843
+ <td class="oblique">$.db</td>
1844
+ </tr>
1845
+ <tr>
1846
+ <td><a href="$.net.http.Client.html">Client</a></td>
1847
+ <td class="oblique">$.net.http</td>
1848
+ </tr>
1849
+ <tr>
1850
+ <td><a href="$.hdb.ColumnMetadata.html">ColumnMetadata</a></td>
1851
+ <td class="oblique">$.hdb</td>
1852
+ </tr>
1853
+ <tr>
1854
+ <td><a href="$.db.Connection.html">Connection</a></td>
1855
+ <td class="oblique">$.db</td>
1856
+ </tr>
1857
+ <tr>
1858
+ <td><a href="$.hdb.Connection.html">Connection</a></td>
1859
+ <td class="oblique">$.hdb</td>
1860
+ </tr>
1861
+ <tr>
1862
+ <td><a href="$.net.Destination.html">Destination</a></td>
1863
+ <td class="oblique">$.net</td>
1864
+ </tr>
1865
+ <tr>
1866
+ <td><a href="$.net.http.Destination.html">Destination</a></td>
1867
+ <td class="oblique">$.net.http</td>
1868
+ </tr>
1869
+ <tr>
1870
+ <td><a href="$.web.EntityList.html">EntityList</a></td>
1871
+ <td class="oblique">$.web</td>
1872
+ </tr>
1873
+ <tr>
1874
+ <td><a href="$.jobs.Job.html">Job</a></td>
1875
+ <td class="oblique">$.jobs</td>
1876
+ </tr>
1877
+ <tr>
1878
+ <td><a href="$.jobs.JobLog.html">JobLog</a></td>
1879
+ <td class="oblique">$.jobs</td>
1880
+ </tr>
1881
+ <tr>
1882
+ <td><a href="$.jobs.JobSchedules.html">JobSchedules</a></td>
1883
+ <td class="oblique">$.jobs</td>
1884
+ </tr>
1885
+ <tr>
1886
+ <td><a href="$.net.Mail.html">Mail</a></td>
1887
+ <td class="oblique">$.net</td>
1888
+ </tr>
1889
+ <tr>
1890
+ <td><a href="$.db.ParameterMetaData.html">ParameterMetaData</a></td>
1891
+ <td class="oblique">$.db</td>
1892
+ </tr>
1893
+ <tr>
1894
+ <td><a href="$.net.Mail.Part.html">Part</a></td>
1895
+ <td class="oblique">$.net.Mail</td>
1896
+ </tr>
1897
+ <tr>
1898
+ <td><a href="$.db.PreparedStatement.html">PreparedStatement</a></td>
1899
+ <td class="oblique">$.db</td>
1900
+ </tr>
1901
+ <tr>
1902
+ <td><a href="$.hdb.ProcedureResult.html">ProcedureResult</a></td>
1903
+ <td class="oblique">$.hdb</td>
1904
+ </tr>
1905
+ <tr>
1906
+ <td><a href="$.net.http.Request.html">Request</a></td>
1907
+ <td class="oblique">$.net.http</td>
1908
+ </tr>
1909
+ <tr>
1910
+ <td><a href="$.db.ResultSet.html">ResultSet</a></td>
1911
+ <td class="oblique">$.db</td>
1912
+ </tr>
1913
+ <tr>
1914
+ <td><a href="$.hdb.ResultSet.html">ResultSet</a></td>
1915
+ <td class="oblique">$.hdb</td>
1916
+ </tr>
1917
+ <tr>
1918
+ <td><a href="$.hdb.ResultSetIterator.html">ResultSetIterator</a></td>
1919
+ <td class="oblique">$.hdb</td>
1920
+ </tr>
1921
+ <tr>
1922
+ <td><a href="$.db.ResultSetMetaData.html">ResultSetMetaData</a></td>
1923
+ <td class="oblique">$.db</td>
1924
+ </tr>
1925
+ <tr>
1926
+ <td><a href="$.hdb.ResultSetMetaData.html">ResultSetMetaData</a></td>
1927
+ <td class="oblique">$.hdb</td>
1928
+ </tr>
1929
+ <tr>
1930
+ <td><a href="$.util.SAXParser.html">SAXParser</a></td>
1931
+ <td class="oblique">$.util</td>
1932
+ </tr>
1933
+ <tr>
1934
+ <td><a href="$.Session.html">Session</a></td>
1935
+ <td class="oblique">$</td>
1936
+ </tr>
1937
+ <tr>
1938
+ <td><a href="$.text.analysis.Session.html">Session</a></td>
1939
+ <td class="oblique">$.text.analysis</td>
1940
+ </tr>
1941
+ <tr>
1942
+ <td><a href="$.text.mining.Session.html">Session</a></td>
1943
+ <td class="oblique">$.text.mining</td>
1944
+ </tr>
1945
+ <tr>
1946
+ <td><a href="$.net.SMTPConnection.html">SMTPConnection</a></td>
1947
+ <td class="oblique">$.net</td>
1948
+ </tr>
1949
+ <tr>
1950
+ <td><a href="$.db.SQLException.html">SQLException</a></td>
1951
+ <td class="oblique">$.db</td>
1952
+ </tr>
1953
+ <tr>
1954
+ <td><a href="$.hdb.SQLException.html">SQLException</a></td>
1955
+ <td class="oblique">$.hdb</td>
1956
+ </tr>
1957
+ <tr>
1958
+ <td><a href="$.security.Store.html">Store</a></td>
1959
+ <td class="oblique">$.security</td>
1960
+ </tr>
1961
+ <tr>
1962
+ <td><a href="$.web.TupelList.html">TupelList</a></td>
1963
+ <td class="oblique">$.web</td>
1964
+ </tr>
1965
+ <tr>
1966
+ <td><a href="$.web.WebEntityRequest.html">WebEntityRequest</a></td>
1967
+ <td class="oblique">$.web</td>
1968
+ </tr>
1969
+ <tr>
1970
+ <td><a href="$.web.WebEntityResponse.html">WebEntityResponse</a></td>
1971
+ <td class="oblique">$.web</td>
1972
+ </tr>
1973
+ <tr>
1974
+ <td><a href="$.web.WebRequest.html">WebRequest</a></td>
1975
+ <td class="oblique">$.web</td>
1976
+ </tr>
1977
+ <tr>
1978
+ <td><a href="$.web.WebResponse.html">WebResponse</a></td>
1979
+ <td class="oblique">$.web</td>
1980
+ </tr>
1981
+ <tr>
1982
+ <td><a href="$.util.Zip.html">Zip</a></td>
1983
+ <td class="oblique">$.util</td>
1984
+ </tr>
1985
+ </table>
1986
+ <h3>Namespaces</h3>
1987
+ <ul>
1988
+ <li><a href="$.html"><span class="oblique"></span>$</a></li>
1989
+ <li><a href="$.db.html"><span class="oblique">$.</span>db</a></li>
1990
+ <li><a href="$.hdb.html"><span class="oblique">$.</span>hdb</a></li>
1991
+ <li><a href="$.jobs.html"><span class="oblique">$.</span>jobs</a></li>
1992
+ <li><a href="$.net.html"><span class="oblique">$.</span>net</a></li>
1993
+ <li><a href="$.net.http.html"><span class="oblique">$.net.</span>http</a></li>
1994
+ <li><a href="$.security.html"><span class="oblique">$.</span>security</a></li>
1995
+ <li><a href="$.security.crypto.html"><span class="oblique">$.security.</span>crypto</a></li>
1996
+ <li><a href="$.security.x509.html"><span class="oblique">$.security.</span>x509</a></li>
1997
+ <li><a href="$.text.html"><span class="oblique">$.</span>text</a></li>
1998
+ <li><a href="$.text.analysis.html"><span class="oblique">$.text.</span>analysis</a></li>
1999
+ <li><a href="$.text.mining.html"><span class="oblique">$.text.</span>mining</a></li>
2000
+ <li><a href="$.trace.html"><span class="oblique">$.</span>trace</a></li>
2001
+ <li><a href="$.util.html"><span class="oblique">$.</span>util</a></li>
2002
+ <li><a href="$.util.codec.html"><span class="oblique">$.util.</span>codec</a></li>
2003
+ <li><a href="$.util.compression.html"><span class="oblique">$.util.</span>compression</a></li>
2004
+ <li><a href="$.util.sql.html"><span class="oblique">$.util.</span>sql</a></li>
2005
+ <li><a href="$.web.html"><span class="oblique">$.</span>web</a></li>
2006
+ </ul>
2007
+ </nav>
2008
+ <br clear="both">
2009
+ <footer>
2010
+ <a href="Copyright-SAP.html">Copyright</a>
2011
+ &
2012
+ <a href="Disclaimer-SAP.html">Disclaimer</a>
2013
+ </footer>
2014
+ <script>prettyPrint();</script>
2015
+ <script src="scripts/linenumber.js"></script>
2016
+ </body>
2017
+
2018
+ </html>