neuralseekui 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +163 -0
- package/docs/AddIntentBody.md +10 -0
- package/docs/AnswersApi.md +160 -0
- package/docs/CategoriesApi.md +58 -0
- package/docs/CategoryBody.md +8 -0
- package/docs/CurateBody.md +9 -0
- package/docs/CuratedDataApi.md +59 -0
- package/docs/DelAnswerBody.md +6 -0
- package/docs/DelQuestionBody.md +7 -0
- package/docs/DelUserDataBody.md +7 -0
- package/docs/EditAnswerBody.md +7 -0
- package/docs/ExploreFilesBody.md +6 -0
- package/docs/ExploreUploadBody.md +6 -0
- package/docs/FdelBody.md +7 -0
- package/docs/FindAnswerIdBody.md +6 -0
- package/docs/FlagBody.md +7 -0
- package/docs/GodocumentBody.md +9 -0
- package/docs/GomaistroBody.md +7 -0
- package/docs/GomaistrotokensBody.md +7 -0
- package/docs/GooverBody.md +9 -0
- package/docs/GoperfBody.md +7 -0
- package/docs/GosemanticBody.md +9 -0
- package/docs/GotokensBody.md +7 -0
- package/docs/GovernanceApi.md +410 -0
- package/docs/IntentsApi.md +364 -0
- package/docs/LoadUserResponseBody.md +7 -0
- package/docs/MAIstroApi.md +265 -0
- package/docs/MaistroFilesBody.md +8 -0
- package/docs/MaistroOCRBody.md +6 -0
- package/docs/MergeBody.md +7 -0
- package/docs/QuestionsApi.md +58 -0
- package/docs/RenBody.md +7 -0
- package/docs/UnmergeBody.md +6 -0
- package/git_push.sh +52 -0
- package/mocha.opts +1 -0
- package/package.json +55 -0
- package/src/ApiClient.js +585 -0
- package/src/api/AnswersApi.js +179 -0
- package/src/api/CategoriesApi.js +85 -0
- package/src/api/CuratedDataApi.js +82 -0
- package/src/api/GovernanceApi.js +408 -0
- package/src/api/IntentsApi.js +367 -0
- package/src/api/MAIstroApi.js +262 -0
- package/src/api/QuestionsApi.js +85 -0
- package/src/index.js +279 -0
- package/src/model/AddIntentBody.js +91 -0
- package/src/model/CategoryBody.js +71 -0
- package/src/model/CurateBody.js +75 -0
- package/src/model/DelAnswerBody.js +55 -0
- package/src/model/DelQuestionBody.js +64 -0
- package/src/model/DelUserDataBody.js +62 -0
- package/src/model/EditAnswerBody.js +64 -0
- package/src/model/ExploreFilesBody.js +55 -0
- package/src/model/ExploreUploadBody.js +53 -0
- package/src/model/FdelBody.js +62 -0
- package/src/model/FindAnswerIdBody.js +55 -0
- package/src/model/FlagBody.js +61 -0
- package/src/model/GodocumentBody.js +76 -0
- package/src/model/GomaistroBody.js +62 -0
- package/src/model/GomaistrotokensBody.js +62 -0
- package/src/model/GooverBody.js +76 -0
- package/src/model/GoperfBody.js +62 -0
- package/src/model/GosemanticBody.js +76 -0
- package/src/model/GotokensBody.js +62 -0
- package/src/model/LoadUserResponseBody.js +64 -0
- package/src/model/MaistroFilesBody.js +69 -0
- package/src/model/MaistroOCRBody.js +53 -0
- package/src/model/MergeBody.js +64 -0
- package/src/model/RenBody.js +62 -0
- package/src/model/UnmergeBody.js +53 -0
- package/test/api/AnswersApi.spec.js +95 -0
- package/test/api/CategoriesApi.spec.js +59 -0
- package/test/api/CuratedDataApi.spec.js +60 -0
- package/test/api/GovernanceApi.spec.js +185 -0
- package/test/api/IntentsApi.spec.js +167 -0
- package/test/api/MAIstroApi.spec.js +134 -0
- package/test/api/QuestionsApi.spec.js +59 -0
- package/test/assert-equals.js +81 -0
- package/test/model/AddIntentBody.spec.js +76 -0
- package/test/model/CategoryBody.spec.js +64 -0
- package/test/model/CurateBody.spec.js +70 -0
- package/test/model/DelAnswerBody.spec.js +52 -0
- package/test/model/DelQuestionBody.spec.js +58 -0
- package/test/model/DelUserDataBody.spec.js +58 -0
- package/test/model/EditAnswerBody.spec.js +58 -0
- package/test/model/ExploreFilesBody.spec.js +52 -0
- package/test/model/ExploreUploadBody.spec.js +52 -0
- package/test/model/FdelBody.spec.js +58 -0
- package/test/model/FindAnswerIdBody.spec.js +52 -0
- package/test/model/FlagBody.spec.js +58 -0
- package/test/model/GodocumentBody.spec.js +70 -0
- package/test/model/GomaistroBody.spec.js +58 -0
- package/test/model/GomaistrotokensBody.spec.js +58 -0
- package/test/model/GooverBody.spec.js +70 -0
- package/test/model/GoperfBody.spec.js +58 -0
- package/test/model/GosemanticBody.spec.js +70 -0
- package/test/model/GotokensBody.spec.js +58 -0
- package/test/model/LoadUserResponseBody.spec.js +58 -0
- package/test/model/MaistroFilesBody.spec.js +64 -0
- package/test/model/MaistroOCRBody.spec.js +52 -0
- package/test/model/MergeBody.spec.js +58 -0
- package/test/model/RenBody.spec.js +58 -0
- package/test/model/UnmergeBody.spec.js +52 -0
package/README.md
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# neuralSeekUI
|
|
2
|
+
|
|
3
|
+
NeuralSeekUi - JavaScript client for neuralSeekUI
|
|
4
|
+
NeuralSeek - The business LLM accelerator
|
|
5
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
6
|
+
|
|
7
|
+
- API version: 1.0.0
|
|
8
|
+
- Package version: 1.0.0
|
|
9
|
+
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
|
|
10
|
+
For more information, please visit [https://neuralseek.com](https://neuralseek.com)
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
### For [Node.js](https://nodejs.org/)
|
|
15
|
+
|
|
16
|
+
#### npm
|
|
17
|
+
|
|
18
|
+
To publish the library as a [npm](https://www.npmjs.com/),
|
|
19
|
+
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
|
|
20
|
+
|
|
21
|
+
Then install it via:
|
|
22
|
+
|
|
23
|
+
```shell
|
|
24
|
+
npm install neuralSeekUI --save
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
#### git
|
|
28
|
+
#
|
|
29
|
+
If the library is hosted at a git repository, e.g.
|
|
30
|
+
https://github.com/GIT_USER_ID/GIT_REPO_ID
|
|
31
|
+
then install it via:
|
|
32
|
+
|
|
33
|
+
```shell
|
|
34
|
+
npm install GIT_USER_ID/GIT_REPO_ID --save
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### For browser
|
|
38
|
+
|
|
39
|
+
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
|
|
40
|
+
the above steps with Node.js and installing browserify with `npm install -g browserify`,
|
|
41
|
+
perform the following (assuming *main.js* is your entry file):
|
|
42
|
+
|
|
43
|
+
```shell
|
|
44
|
+
browserify main.js > bundle.js
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Then include *bundle.js* in the HTML pages.
|
|
48
|
+
|
|
49
|
+
### Webpack Configuration
|
|
50
|
+
|
|
51
|
+
Using Webpack you may encounter the following error: "Module not found: Error:
|
|
52
|
+
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
|
|
53
|
+
the following section to your webpack config:
|
|
54
|
+
|
|
55
|
+
```javascript
|
|
56
|
+
module: {
|
|
57
|
+
rules: [
|
|
58
|
+
{
|
|
59
|
+
parser: {
|
|
60
|
+
amd: false
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
]
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Getting Started
|
|
68
|
+
|
|
69
|
+
Please follow the [installation](#installation) instruction and execute the following JS code:
|
|
70
|
+
|
|
71
|
+
```javascript
|
|
72
|
+
var NeuralSeekUi = require('neuralSeekUI');
|
|
73
|
+
var defaultClient = NeuralSeekUi.ApiClient.instance;
|
|
74
|
+
|
|
75
|
+
// Configure API key authorization: apiKey
|
|
76
|
+
var apiKey = defaultClient.authentications['apiKey'];
|
|
77
|
+
apiKey.apiKey = "YOUR API KEY"
|
|
78
|
+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
79
|
+
//apiKey.apiKeyPrefix['apikey'] = "Token"
|
|
80
|
+
|
|
81
|
+
var api = new NeuralSeekUi.AnswersApi()
|
|
82
|
+
var body = new NeuralSeekUi.DelAnswerBody(); // {DelAnswerBody} The request object.
|
|
83
|
+
|
|
84
|
+
var callback = function(error, data, response) {
|
|
85
|
+
if (error) {
|
|
86
|
+
console.error(error);
|
|
87
|
+
} else {
|
|
88
|
+
console.log('API called successfully.');
|
|
89
|
+
}
|
|
90
|
+
};
|
|
91
|
+
api.deleteAnswer(body, callback);
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Documentation for API Endpoints
|
|
95
|
+
|
|
96
|
+
All URIs are relative to *https://console.neuralseek.com/{instance}*
|
|
97
|
+
|
|
98
|
+
Class | Method | HTTP request | Description
|
|
99
|
+
------------ | ------------- | ------------- | -------------
|
|
100
|
+
*NeuralSeekUi.AnswersApi* | [**deleteAnswer**](docs/AnswersApi.md#deleteAnswer) | **POST** /delAnswer | Delete Answer
|
|
101
|
+
*NeuralSeekUi.AnswersApi* | [**editAnswer**](docs/AnswersApi.md#editAnswer) | **POST** /editAnswer | Edit Answer
|
|
102
|
+
*NeuralSeekUi.AnswersApi* | [**findAnswerId**](docs/AnswersApi.md#findAnswerId) | **POST** /findAnswerId | Find AnswerId
|
|
103
|
+
*NeuralSeekUi.CategoriesApi* | [**category**](docs/CategoriesApi.md#category) | **POST** /category | Update a Category
|
|
104
|
+
*NeuralSeekUi.CuratedDataApi* | [**getCuratedData**](docs/CuratedDataApi.md#getCuratedData) | **POST** /curate | Get Curated Data
|
|
105
|
+
*NeuralSeekUi.GovernanceApi* | [**aiPricing**](docs/GovernanceApi.md#aiPricing) | **POST** /aiPricing | AI Pricing
|
|
106
|
+
*NeuralSeekUi.GovernanceApi* | [**gomaistro**](docs/GovernanceApi.md#gomaistro) | **POST** /gomaistro | Governance - mAIstro Usage
|
|
107
|
+
*NeuralSeekUi.GovernanceApi* | [**gomaistrotokens**](docs/GovernanceApi.md#gomaistrotokens) | **POST** /gomaistrotokens | Governance - mAIstro Token Usage
|
|
108
|
+
*NeuralSeekUi.GovernanceApi* | [**gotokens**](docs/GovernanceApi.md#gotokens) | **POST** /gotokens | Governance - Token Usage
|
|
109
|
+
*NeuralSeekUi.GovernanceApi* | [**governanceDocumentationDetails**](docs/GovernanceApi.md#governanceDocumentationDetails) | **POST** /godocument | Governance - Documentation Details
|
|
110
|
+
*NeuralSeekUi.GovernanceApi* | [**governanceOverview**](docs/GovernanceApi.md#governanceOverview) | **POST** /goover | Governance Overview
|
|
111
|
+
*NeuralSeekUi.GovernanceApi* | [**governancePerformanceDetails**](docs/GovernanceApi.md#governancePerformanceDetails) | **POST** /goperf | Governance - Performance Details
|
|
112
|
+
*NeuralSeekUi.GovernanceApi* | [**governanceSemanticDetails**](docs/GovernanceApi.md#governanceSemanticDetails) | **POST** /gosemantic | Governance - Semantic Details
|
|
113
|
+
*NeuralSeekUi.IntentsApi* | [**add**](docs/IntentsApi.md#add) | **POST** /addIntent | Add an Intent
|
|
114
|
+
*NeuralSeekUi.IntentsApi* | [**callDelete**](docs/IntentsApi.md#callDelete) | **POST** /delUserData | Delete Intents / Data
|
|
115
|
+
*NeuralSeekUi.IntentsApi* | [**examples**](docs/IntentsApi.md#examples) | **POST** /loadUserResponse | Add Intent Examples
|
|
116
|
+
*NeuralSeekUi.IntentsApi* | [**flag**](docs/IntentsApi.md#flag) | **POST** /flag | Flag an Intent
|
|
117
|
+
*NeuralSeekUi.IntentsApi* | [**merge**](docs/IntentsApi.md#merge) | **POST** /merge | Merge Intents
|
|
118
|
+
*NeuralSeekUi.IntentsApi* | [**rename**](docs/IntentsApi.md#rename) | **POST** /ren | Rename an Intent
|
|
119
|
+
*NeuralSeekUi.IntentsApi* | [**unMerge**](docs/IntentsApi.md#unMerge) | **POST** /unmerge | UnMerge Intents
|
|
120
|
+
*NeuralSeekUi.MAIstroApi* | [**exploreFiles**](docs/MAIstroApi.md#exploreFiles) | **POST** /exploreFiles | List Maistro Files
|
|
121
|
+
*NeuralSeekUi.MAIstroApi* | [**exploreUpload**](docs/MAIstroApi.md#exploreUpload) | **POST** /exploreUpload | Upload a file to mAIstro
|
|
122
|
+
*NeuralSeekUi.MAIstroApi* | [**fdel**](docs/MAIstroApi.md#fdel) | **POST** /fdel | Delete Maistro File(s)
|
|
123
|
+
*NeuralSeekUi.MAIstroApi* | [**maistroFiles**](docs/MAIstroApi.md#maistroFiles) | **POST** /maistroFiles | List Maistro Files (paginated)
|
|
124
|
+
*NeuralSeekUi.MAIstroApi* | [**maistroOCR**](docs/MAIstroApi.md#maistroOCR) | **POST** /maistroOCR | OCR upload to mAIstro
|
|
125
|
+
*NeuralSeekUi.QuestionsApi* | [**deleteQuestion**](docs/QuestionsApi.md#deleteQuestion) | **POST** /delQuestion | Delete Question
|
|
126
|
+
|
|
127
|
+
## Documentation for Models
|
|
128
|
+
|
|
129
|
+
- [NeuralSeekUi.AddIntentBody](docs/AddIntentBody.md)
|
|
130
|
+
- [NeuralSeekUi.CategoryBody](docs/CategoryBody.md)
|
|
131
|
+
- [NeuralSeekUi.CurateBody](docs/CurateBody.md)
|
|
132
|
+
- [NeuralSeekUi.DelAnswerBody](docs/DelAnswerBody.md)
|
|
133
|
+
- [NeuralSeekUi.DelQuestionBody](docs/DelQuestionBody.md)
|
|
134
|
+
- [NeuralSeekUi.DelUserDataBody](docs/DelUserDataBody.md)
|
|
135
|
+
- [NeuralSeekUi.EditAnswerBody](docs/EditAnswerBody.md)
|
|
136
|
+
- [NeuralSeekUi.ExploreFilesBody](docs/ExploreFilesBody.md)
|
|
137
|
+
- [NeuralSeekUi.ExploreUploadBody](docs/ExploreUploadBody.md)
|
|
138
|
+
- [NeuralSeekUi.FdelBody](docs/FdelBody.md)
|
|
139
|
+
- [NeuralSeekUi.FindAnswerIdBody](docs/FindAnswerIdBody.md)
|
|
140
|
+
- [NeuralSeekUi.FlagBody](docs/FlagBody.md)
|
|
141
|
+
- [NeuralSeekUi.GodocumentBody](docs/GodocumentBody.md)
|
|
142
|
+
- [NeuralSeekUi.GomaistroBody](docs/GomaistroBody.md)
|
|
143
|
+
- [NeuralSeekUi.GomaistrotokensBody](docs/GomaistrotokensBody.md)
|
|
144
|
+
- [NeuralSeekUi.GooverBody](docs/GooverBody.md)
|
|
145
|
+
- [NeuralSeekUi.GoperfBody](docs/GoperfBody.md)
|
|
146
|
+
- [NeuralSeekUi.GosemanticBody](docs/GosemanticBody.md)
|
|
147
|
+
- [NeuralSeekUi.GotokensBody](docs/GotokensBody.md)
|
|
148
|
+
- [NeuralSeekUi.LoadUserResponseBody](docs/LoadUserResponseBody.md)
|
|
149
|
+
- [NeuralSeekUi.MaistroFilesBody](docs/MaistroFilesBody.md)
|
|
150
|
+
- [NeuralSeekUi.MaistroOCRBody](docs/MaistroOCRBody.md)
|
|
151
|
+
- [NeuralSeekUi.MergeBody](docs/MergeBody.md)
|
|
152
|
+
- [NeuralSeekUi.RenBody](docs/RenBody.md)
|
|
153
|
+
- [NeuralSeekUi.UnmergeBody](docs/UnmergeBody.md)
|
|
154
|
+
|
|
155
|
+
## Documentation for Authorization
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### apiKey
|
|
159
|
+
|
|
160
|
+
- **Type**: API key
|
|
161
|
+
- **API key parameter name**: apikey
|
|
162
|
+
- **Location**: HTTP header
|
|
163
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# NeuralSeekUi.AddIntentBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**intent** | **String** | The new Intent name | [optional] [default to '']
|
|
7
|
+
**question** | **String** | The example user question | [optional] [default to '']
|
|
8
|
+
**category** | **String** | The category ID | [optional] [default to '']
|
|
9
|
+
**answer** | **String** | The answer response if for a seek-led intent (omit this for maistro-led) | [optional] [default to '']
|
|
10
|
+
**maistro** | **String** | The maistro template name if a maistro-led intent (omit this for seek-led) | [optional] [default to '']
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# NeuralSeekUi.AnswersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://console.neuralseek.com/{instance}*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**deleteAnswer**](AnswersApi.md#deleteAnswer) | **POST** /delAnswer | Delete Answer
|
|
8
|
+
[**editAnswer**](AnswersApi.md#editAnswer) | **POST** /editAnswer | Edit Answer
|
|
9
|
+
[**findAnswerId**](AnswersApi.md#findAnswerId) | **POST** /findAnswerId | Find AnswerId
|
|
10
|
+
|
|
11
|
+
<a name="deleteAnswer"></a>
|
|
12
|
+
# **deleteAnswer**
|
|
13
|
+
> deleteAnswer(body)
|
|
14
|
+
|
|
15
|
+
Delete Answer
|
|
16
|
+
|
|
17
|
+
Delete Answer
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
```javascript
|
|
21
|
+
import {NeuralSeekUi} from 'neuralSeekUI';
|
|
22
|
+
let defaultClient = NeuralSeekUi.ApiClient.instance;
|
|
23
|
+
|
|
24
|
+
// Configure API key authorization: apiKey
|
|
25
|
+
let apiKey = defaultClient.authentications['apiKey'];
|
|
26
|
+
apiKey.apiKey = 'YOUR API KEY';
|
|
27
|
+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
28
|
+
//apiKey.apiKeyPrefix = 'Token';
|
|
29
|
+
|
|
30
|
+
let apiInstance = new NeuralSeekUi.AnswersApi();
|
|
31
|
+
let body = new NeuralSeekUi.DelAnswerBody(); // DelAnswerBody | The request object.
|
|
32
|
+
|
|
33
|
+
apiInstance.deleteAnswer(body, (error, data, response) => {
|
|
34
|
+
if (error) {
|
|
35
|
+
console.error(error);
|
|
36
|
+
} else {
|
|
37
|
+
console.log('API called successfully.');
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
|
|
44
|
+
Name | Type | Description | Notes
|
|
45
|
+
------------- | ------------- | ------------- | -------------
|
|
46
|
+
**body** | [**DelAnswerBody**](DelAnswerBody.md)| The request object. |
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
null (empty response body)
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
[apiKey](../README.md#apiKey)
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: application/json
|
|
59
|
+
- **Accept**: Not defined
|
|
60
|
+
|
|
61
|
+
<a name="editAnswer"></a>
|
|
62
|
+
# **editAnswer**
|
|
63
|
+
> editAnswer(body)
|
|
64
|
+
|
|
65
|
+
Edit Answer
|
|
66
|
+
|
|
67
|
+
Edit Answer
|
|
68
|
+
|
|
69
|
+
### Example
|
|
70
|
+
```javascript
|
|
71
|
+
import {NeuralSeekUi} from 'neuralSeekUI';
|
|
72
|
+
let defaultClient = NeuralSeekUi.ApiClient.instance;
|
|
73
|
+
|
|
74
|
+
// Configure API key authorization: apiKey
|
|
75
|
+
let apiKey = defaultClient.authentications['apiKey'];
|
|
76
|
+
apiKey.apiKey = 'YOUR API KEY';
|
|
77
|
+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
78
|
+
//apiKey.apiKeyPrefix = 'Token';
|
|
79
|
+
|
|
80
|
+
let apiInstance = new NeuralSeekUi.AnswersApi();
|
|
81
|
+
let body = new NeuralSeekUi.EditAnswerBody(); // EditAnswerBody | The request object.
|
|
82
|
+
|
|
83
|
+
apiInstance.editAnswer(body, (error, data, response) => {
|
|
84
|
+
if (error) {
|
|
85
|
+
console.error(error);
|
|
86
|
+
} else {
|
|
87
|
+
console.log('API called successfully.');
|
|
88
|
+
}
|
|
89
|
+
});
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
Name | Type | Description | Notes
|
|
95
|
+
------------- | ------------- | ------------- | -------------
|
|
96
|
+
**body** | [**EditAnswerBody**](EditAnswerBody.md)| The request object. |
|
|
97
|
+
|
|
98
|
+
### Return type
|
|
99
|
+
|
|
100
|
+
null (empty response body)
|
|
101
|
+
|
|
102
|
+
### Authorization
|
|
103
|
+
|
|
104
|
+
[apiKey](../README.md#apiKey)
|
|
105
|
+
|
|
106
|
+
### HTTP request headers
|
|
107
|
+
|
|
108
|
+
- **Content-Type**: application/json
|
|
109
|
+
- **Accept**: Not defined
|
|
110
|
+
|
|
111
|
+
<a name="findAnswerId"></a>
|
|
112
|
+
# **findAnswerId**
|
|
113
|
+
> findAnswerId(body)
|
|
114
|
+
|
|
115
|
+
Find AnswerId
|
|
116
|
+
|
|
117
|
+
Find AnswerId
|
|
118
|
+
|
|
119
|
+
### Example
|
|
120
|
+
```javascript
|
|
121
|
+
import {NeuralSeekUi} from 'neuralSeekUI';
|
|
122
|
+
let defaultClient = NeuralSeekUi.ApiClient.instance;
|
|
123
|
+
|
|
124
|
+
// Configure API key authorization: apiKey
|
|
125
|
+
let apiKey = defaultClient.authentications['apiKey'];
|
|
126
|
+
apiKey.apiKey = 'YOUR API KEY';
|
|
127
|
+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
128
|
+
//apiKey.apiKeyPrefix = 'Token';
|
|
129
|
+
|
|
130
|
+
let apiInstance = new NeuralSeekUi.AnswersApi();
|
|
131
|
+
let body = new NeuralSeekUi.FindAnswerIdBody(); // FindAnswerIdBody | The request object.
|
|
132
|
+
|
|
133
|
+
apiInstance.findAnswerId(body, (error, data, response) => {
|
|
134
|
+
if (error) {
|
|
135
|
+
console.error(error);
|
|
136
|
+
} else {
|
|
137
|
+
console.log('API called successfully.');
|
|
138
|
+
}
|
|
139
|
+
});
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
Name | Type | Description | Notes
|
|
145
|
+
------------- | ------------- | ------------- | -------------
|
|
146
|
+
**body** | [**FindAnswerIdBody**](FindAnswerIdBody.md)| The request object. |
|
|
147
|
+
|
|
148
|
+
### Return type
|
|
149
|
+
|
|
150
|
+
null (empty response body)
|
|
151
|
+
|
|
152
|
+
### Authorization
|
|
153
|
+
|
|
154
|
+
[apiKey](../README.md#apiKey)
|
|
155
|
+
|
|
156
|
+
### HTTP request headers
|
|
157
|
+
|
|
158
|
+
- **Content-Type**: application/json
|
|
159
|
+
- **Accept**: Not defined
|
|
160
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# NeuralSeekUi.CategoriesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://console.neuralseek.com/{instance}*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**category**](CategoriesApi.md#category) | **POST** /category | Update a Category
|
|
8
|
+
|
|
9
|
+
<a name="category"></a>
|
|
10
|
+
# **category**
|
|
11
|
+
> category(body)
|
|
12
|
+
|
|
13
|
+
Update a Category
|
|
14
|
+
|
|
15
|
+
Update a Category
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```javascript
|
|
19
|
+
import {NeuralSeekUi} from 'neuralSeekUI';
|
|
20
|
+
let defaultClient = NeuralSeekUi.ApiClient.instance;
|
|
21
|
+
|
|
22
|
+
// Configure API key authorization: apiKey
|
|
23
|
+
let apiKey = defaultClient.authentications['apiKey'];
|
|
24
|
+
apiKey.apiKey = 'YOUR API KEY';
|
|
25
|
+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
26
|
+
//apiKey.apiKeyPrefix = 'Token';
|
|
27
|
+
|
|
28
|
+
let apiInstance = new NeuralSeekUi.CategoriesApi();
|
|
29
|
+
let body = new NeuralSeekUi.CategoryBody(); // CategoryBody | The request object.
|
|
30
|
+
|
|
31
|
+
apiInstance.category(body, (error, data, response) => {
|
|
32
|
+
if (error) {
|
|
33
|
+
console.error(error);
|
|
34
|
+
} else {
|
|
35
|
+
console.log('API called successfully.');
|
|
36
|
+
}
|
|
37
|
+
});
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
Name | Type | Description | Notes
|
|
43
|
+
------------- | ------------- | ------------- | -------------
|
|
44
|
+
**body** | [**CategoryBody**](CategoryBody.md)| The request object. |
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
null (empty response body)
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[apiKey](../README.md#apiKey)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: application/json
|
|
57
|
+
- **Accept**: Not defined
|
|
58
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# NeuralSeekUi.CategoryBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**intent** | **String** | The intent to update the category of | [optional] [default to '']
|
|
7
|
+
**intents** | **[String]** | Optional array of intents to update to the same category | [optional]
|
|
8
|
+
**category** | **Number** | The category number | [optional]
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# NeuralSeekUi.CurateBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**limit** | **Number** | Max 300 | [optional]
|
|
7
|
+
**skip** | **Number** | | [optional]
|
|
8
|
+
**search** | **String** | | [optional]
|
|
9
|
+
**filters** | **Object** | | [optional]
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# NeuralSeekUi.CuratedDataApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://console.neuralseek.com/{instance}*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**getCuratedData**](CuratedDataApi.md#getCuratedData) | **POST** /curate | Get Curated Data
|
|
8
|
+
|
|
9
|
+
<a name="getCuratedData"></a>
|
|
10
|
+
# **getCuratedData**
|
|
11
|
+
> getCuratedData(opts)
|
|
12
|
+
|
|
13
|
+
Get Curated Data
|
|
14
|
+
|
|
15
|
+
Get curated data with pagination/search/filter support
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```javascript
|
|
19
|
+
import {NeuralSeekUi} from 'neuralSeekUI';
|
|
20
|
+
let defaultClient = NeuralSeekUi.ApiClient.instance;
|
|
21
|
+
|
|
22
|
+
// Configure API key authorization: apiKey
|
|
23
|
+
let apiKey = defaultClient.authentications['apiKey'];
|
|
24
|
+
apiKey.apiKey = 'YOUR API KEY';
|
|
25
|
+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
26
|
+
//apiKey.apiKeyPrefix = 'Token';
|
|
27
|
+
|
|
28
|
+
let apiInstance = new NeuralSeekUi.CuratedDataApi();
|
|
29
|
+
let opts = {
|
|
30
|
+
'body': new NeuralSeekUi.CurateBody() // CurateBody |
|
|
31
|
+
};
|
|
32
|
+
apiInstance.getCuratedData(opts, (error, data, response) => {
|
|
33
|
+
if (error) {
|
|
34
|
+
console.error(error);
|
|
35
|
+
} else {
|
|
36
|
+
console.log('API called successfully.');
|
|
37
|
+
}
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Parameters
|
|
42
|
+
|
|
43
|
+
Name | Type | Description | Notes
|
|
44
|
+
------------- | ------------- | ------------- | -------------
|
|
45
|
+
**body** | [**CurateBody**](CurateBody.md)| | [optional]
|
|
46
|
+
|
|
47
|
+
### Return type
|
|
48
|
+
|
|
49
|
+
null (empty response body)
|
|
50
|
+
|
|
51
|
+
### Authorization
|
|
52
|
+
|
|
53
|
+
[apiKey](../README.md#apiKey)
|
|
54
|
+
|
|
55
|
+
### HTTP request headers
|
|
56
|
+
|
|
57
|
+
- **Content-Type**: application/json
|
|
58
|
+
- **Accept**: Not defined
|
|
59
|
+
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# NeuralSeekUi.DelQuestionBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**question** | **String** | The question to delete. Send the exact text. | [optional] [default to '']
|
|
7
|
+
**intent** | **String** | The intent that this question is part of. Send the intent name. | [optional] [default to '']
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# NeuralSeekUi.DelUserDataBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**toDel** | **[String]** | | [optional]
|
|
7
|
+
**delal** | **String** | The delete operation. false deletes only toDel; all deletes all data; analytics deletes analytics; uea deletes unedited answers; other deletes Other category. | [optional] [default to '']
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# NeuralSeekUi.EditAnswerBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**timestamp** | **String** | The timestamp of the answer | [optional] [default to '']
|
|
7
|
+
**a** | **String** | The edited answer | [optional] [default to '']
|
package/docs/FdelBody.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# NeuralSeekUi.FdelBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Single filename to delete | [optional]
|
|
7
|
+
**names** | **[String]** | Array of filenames to delete (max 100) | [optional]
|
package/docs/FlagBody.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# NeuralSeekUi.GodocumentBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**startDate** | **String** | UTC date | [optional]
|
|
7
|
+
**endDate** | **String** | UTC date | [optional]
|
|
8
|
+
**intent** | **String** | | [optional]
|
|
9
|
+
**category** | **String** | | [optional]
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# NeuralSeekUi.GooverBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**startDate** | **String** | UTC date | [optional]
|
|
7
|
+
**endDate** | **String** | UTC date | [optional]
|
|
8
|
+
**intent** | **String** | | [optional]
|
|
9
|
+
**category** | **String** | | [optional]
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# NeuralSeekUi.GosemanticBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**startDate** | **String** | UTC date | [optional]
|
|
7
|
+
**endDate** | **String** | UTC date | [optional]
|
|
8
|
+
**intent** | **String** | | [optional]
|
|
9
|
+
**category** | **String** | | [optional]
|