@xfloor/floor-memory-sdk-js 1.0.6 → 1.0.8
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 +79 -182
- package/dist/ApiClient.js +6 -6
- package/dist/api/DefaultApi.js +1 -1
- package/dist/api/EditFloorApi.js +1 -1
- package/dist/api/EventApi.js +10 -4
- package/dist/api/GetFloorInformationApi.js +1 -1
- package/dist/api/GetRecentEventsApi.js +1 -1
- package/dist/api/QueryApi.js +2 -2
- package/dist/model/BlockDetails.js +1 -1
- package/dist/model/ChangePassword200Response.js +1 -1
- package/dist/model/ConversationThreads200Response.js +1 -1
- package/dist/model/ConversationThreads200ResponseThreadsInner.js +1 -1
- package/dist/model/EditFloor400Response.js +1 -1
- package/dist/model/EditFloor400ResponseError.js +1 -1
- package/dist/model/Event400Response.js +1 -1
- package/dist/model/Event400ResponseError.js +1 -1
- package/dist/model/EventResponse.js +1 -1
- package/dist/model/FloorInfo.js +13 -13
- package/dist/model/GetConversations200Response.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInner.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerAssistant.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInner.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerUser.js +1 -1
- package/dist/model/GetConversations200ResponseConversationInnerUserContext.js +1 -1
- package/dist/model/GetFloorInformation200Response.js +13 -13
- package/dist/model/GetRecentEvents200Response.js +1 -1
- package/dist/model/GetRecentEvents200ResponseItemsInner.js +1 -1
- package/dist/model/GetRecentEvents200ResponseItemsInnerAuthor.js +1 -1
- package/dist/model/GetRecentEvents400Response.js +1 -1
- package/dist/model/GetRecentEvents400ResponseError.js +1 -1
- package/dist/model/Media.js +3 -3
- package/dist/model/Model400ErrorCode.js +1 -1
- package/dist/model/PostAdd.js +1 -1
- package/dist/model/Query422Response.js +1 -1
- package/dist/model/Query422ResponseError.js +1 -1
- package/dist/model/QueryRequest.js +1 -1
- package/dist/model/QueryRequestFilters.js +1 -1
- package/dist/model/QueryResponse.js +1 -1
- package/dist/model/QueryResponseItemsInner.js +1 -1
- package/dist/model/ResetPassword200Response.js +1 -1
- package/dist/model/ResetPassword400Response.js +1 -1
- package/dist/model/SendSignInValidationCode200Response.js +1 -1
- package/dist/model/SendValidationCode200Response.js +1 -1
- package/dist/model/SendValidationCodeRequest.js +1 -1
- package/dist/model/SignInWithEmail200Response.js +1 -1
- package/dist/model/SignInWithEmail200ResponsePodInfo.js +1 -1
- package/dist/model/SignInWithEmail200ResponseProfile.js +1 -1
- package/dist/model/SignInWithEmail200ResponseProfileAvatar.js +1 -1
- package/dist/model/SignUp200Response.js +1 -1
- package/dist/model/SignUpResponse.js +1 -1
- package/dist/model/Threads.js +1 -1
- package/dist/model/UserDetails.js +1 -1
- package/dist/model/ValidateCode400Response.js +1 -1
- package/dist/model/ValidateCode400ResponseError.js +1 -1
- package/dist/model/ValidateCode412Response.js +1 -1
- package/dist/model/ValidateCodeRequest.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ The developer has two ways of using the APIs for the app development. Developer
|
|
|
11
11
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
12
12
|
|
|
13
13
|
- API version: 1.0.0
|
|
14
|
-
- Package version: 1.0.
|
|
14
|
+
- Package version: 1.0.8
|
|
15
15
|
- Generator version: 7.18.0
|
|
16
16
|
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
17
17
|
For more information, please visit [https://xfloor.ai/ipomo/blog1551084548304/](https://xfloor.ai/ipomo/blog1551084548304/)
|
|
@@ -127,190 +127,87 @@ api.apiDeveloperCreateAppPost(inputInfo, opts, callback);
|
|
|
127
127
|
|
|
128
128
|
### Documentation for API Endpoints
|
|
129
129
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
| [**
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
| [**
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
| [**
|
|
155
|
-
|
|
156
|
-
Change email ID
|
|
157
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
158
|
-
|
|
159
|
-
| [**changeMobileNumber**](docs/DefaultApi.md#changeMobileNumber) | **POST** /auth-service/change/mobile |
|
|
160
|
-
|
|
161
|
-
Change Mobile number
|
|
162
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
163
|
-
|
|
164
|
-
| [**changePassword**](docs/DefaultApi.md#changePassword) | **POST** /auth-service/password/change |
|
|
165
|
-
|
|
166
|
-
Change Password
|
|
167
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
168
|
-
|
|
169
|
-
| [**conversationThreads**](docs/DefaultApi.md#conversationThreads) | **GET** /agent/memory/threads |
|
|
170
|
-
|
|
171
|
-
Get the conversational threads
|
|
172
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
173
|
-
|
|
174
|
-
| [**getConversations**](docs/DefaultApi.md#getConversations) | **GET** /agent/memory/conversations |
|
|
175
|
-
|
|
176
|
-
Conversations
|
|
177
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
178
|
-
|
|
179
|
-
| [**makeFloorPrivate**](docs/DefaultApi.md#makeFloorPrivate) | **POST** /api/memory/make/floor/private |
|
|
180
|
-
|
|
181
|
-
Make floor Private
|
|
182
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
183
|
-
|
|
184
|
-
| [**makeFloorPublic**](docs/DefaultApi.md#makeFloorPublic) | **POST** /api/memory/make/floor/public |
|
|
185
|
-
|
|
186
|
-
Make floor public
|
|
187
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
188
|
-
|
|
189
|
-
| [**registerExternalUserIdentity**](docs/DefaultApi.md#registerExternalUserIdentity) | **POST** /memory/identity/external-user |
|
|
190
|
-
|
|
191
|
-
External User Registration
|
|
192
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
193
|
-
|
|
194
|
-
| [**renameFloor**](docs/DefaultApi.md#renameFloor) | **POST** /api/memory/change/floor/id |
|
|
195
|
-
|
|
196
|
-
Rename floor
|
|
197
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
198
|
-
|
|
199
|
-
| [**resetPassword**](docs/DefaultApi.md#resetPassword) | **POST** /auth-service/password/reset |
|
|
200
|
-
|
|
201
|
-
Reset Password
|
|
202
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
203
|
-
|
|
204
|
-
| [**sendSignInValidationCode**](docs/DefaultApi.md#sendSignInValidationCode) | **POST** /auth-service/send/sign/in/validation/code |
|
|
205
|
-
|
|
206
|
-
Send Sign-In Validation Code (OTP)
|
|
207
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
208
|
-
|
|
209
|
-
| [**sendValidationCode**](docs/DefaultApi.md#sendValidationCode) | **POST** /auth-service/send/validation/code |
|
|
210
|
-
|
|
211
|
-
Send Validation code
|
|
212
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
213
|
-
|
|
214
|
-
| [**signInWithEmail**](docs/DefaultApi.md#signInWithEmail) | **POST** /auth-service/sign/in/with/email |
|
|
215
|
-
|
|
216
|
-
Sign In with email ID
|
|
217
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
218
|
-
|
|
219
|
-
| [**signInWithMobileNumber**](docs/DefaultApi.md#signInWithMobileNumber) | **POST** /auth-service/sign/in/with/mobile/number |
|
|
220
|
-
|
|
221
|
-
Sign In with Mobile number
|
|
222
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
223
|
-
|
|
224
|
-
| [**signUp**](docs/DefaultApi.md#signUp) | **POST** /auth-service/sign/up |
|
|
225
|
-
|
|
226
|
-
Sign Up
|
|
227
|
-
*XfloorFloorMemorySdkJs.DefaultApi*
|
|
228
|
-
|
|
229
|
-
| [**validateCode**](docs/DefaultApi.md#validateCode) | **POST** /auth-service/validate/activation/code |
|
|
230
|
-
|
|
231
|
-
Validation
|
|
232
|
-
*XfloorFloorMemorySdkJs.EditFloorApi*
|
|
233
|
-
|
|
234
|
-
| [**editFloor**](docs/EditFloorApi.md#editFloor) | **POST** /api/memory/edit/floor/{floor_id} |
|
|
235
|
-
|
|
236
|
-
Edit floor
|
|
237
|
-
*XfloorFloorMemorySdkJs.EventApi*
|
|
238
|
-
|
|
239
|
-
| [**event**](docs/EventApi.md#event) | **POST** /api/memory/events |
|
|
240
|
-
|
|
241
|
-
Create Event (Post Content)
|
|
242
|
-
*XfloorFloorMemorySdkJs.GetFloorInformationApi*
|
|
243
|
-
|
|
244
|
-
| [**getFloorInformation**](docs/GetFloorInformationApi.md#getFloorInformation) | **GET** /api/memory/floor/info/{floor_id} |
|
|
245
|
-
|
|
246
|
-
Basic information of a floor
|
|
247
|
-
*XfloorFloorMemorySdkJs.GetRecentEventsApi*
|
|
248
|
-
|
|
249
|
-
| [**getRecentEvents**](docs/GetRecentEventsApi.md#getRecentEvents) | **GET** /api/memory/recent/events |
|
|
250
|
-
|
|
251
|
-
Recent Events
|
|
252
|
-
*XfloorFloorMemorySdkJs.QueryApi*
|
|
253
|
-
|
|
254
|
-
| [**query**](docs/QueryApi.md#query) | **POST** /agent/memory/query |
|
|
255
|
-
|
|
256
|
-
Query (Primary API)
|
|
257
|
-
|
|
130
|
+
| Class | Method | HTTP request | Description |
|
|
131
|
+
| --- | --- | --- | --- |
|
|
132
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**apiDeveloperCreateAppPost**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#apiDeveloperCreateAppPost) | **POST** /api/developer/create/app | Create App |
|
|
133
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**apiDeveloperModifyAppPost**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#apiDeveloperModifyAppPost) | **POST** /api/developer/modify/app | Modify Floorpod App |
|
|
134
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**changeEmail**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#changeEmail) | **POST** /auth-service/change/email | Change email ID |
|
|
135
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**changeMobileNumber**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#changeMobileNumber) | **POST** /auth-service/change/mobile | Change Mobile number |
|
|
136
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**changePassword**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#changePassword) | **POST** /auth-service/password/change | Change Password |
|
|
137
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**conversationThreads**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#conversationThreads) | **GET** /agent/memory/threads | Get the conversational threads |
|
|
138
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**getConversations**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#getConversations) | **GET** /agent/memory/conversations | Conversations |
|
|
139
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**makeFloorPrivate**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#makeFloorPrivate) | **POST** /api/memory/make/floor/private | Make floor Private |
|
|
140
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**makeFloorPublic**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#makeFloorPublic) | **POST** /api/memory/make/floor/public | Make floor public |
|
|
141
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**registerExternalUserIdentity**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#registerExternalUserIdentity) | **POST** /memory/identity/external-user | External User Registration |
|
|
142
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**renameFloor**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#renameFloor) | **POST** /api/memory/change/floor/id | Rename floor |
|
|
143
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**resetPassword**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#resetPassword) | **POST** /auth-service/password/reset | Reset Password |
|
|
144
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**sendSignInValidationCode**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#sendSignInValidationCode) | **POST** /auth-service/send/sign/in/validation/code | Send Sign-In Validation Code (OTP) |
|
|
145
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**sendValidationCode**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#sendValidationCode) | **POST** /auth-service/send/validation/code | Send Validation code |
|
|
146
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**signInWithEmail**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#signInWithEmail) | **POST** /auth-service/sign/in/with/email | Sign In with email ID |
|
|
147
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**signInWithMobileNumber**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#signInWithMobileNumber) | **POST** /auth-service/sign/in/with/mobile/number | Sign In with Mobile number |
|
|
148
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**signUp**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#signUp) | **POST** /auth-service/sign/up | Sign Up |
|
|
149
|
+
| `XfloorFloorMemorySdkJs.DefaultApi` | [**validateCode**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/DefaultApi.md#validateCode) | **POST** /auth-service/validate/activation/code | Validation |
|
|
150
|
+
| `XfloorFloorMemorySdkJs.EditFloorApi` | [**editFloor**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/EditFloorApi.md#editFloor) | **POST** /api/memory/edit/floor/{floor_id} | Edit floor |
|
|
151
|
+
| `XfloorFloorMemorySdkJs.EventApi` | [**event**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/EventApi.md#event) | **POST** /api/memory/events | Create Event (Post Content) |
|
|
152
|
+
| `XfloorFloorMemorySdkJs.GetFloorInformationApi` | [**getFloorInformation**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetFloorInformationApi.md#getFloorInformation) | **GET** /api/memory/floor/info/{floor_id} | Basic information of a floor |
|
|
153
|
+
| `XfloorFloorMemorySdkJs.GetRecentEventsApi` | [**getRecentEvents**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetRecentEventsApi.md#getRecentEvents) | **GET** /api/memory/recent/events | Recent Events |
|
|
154
|
+
| `XfloorFloorMemorySdkJs.QueryApi` | [**query**](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/QueryApi.md#query) | **POST** /agent/memory/query | Query (Primary API) |
|
|
258
155
|
|
|
259
156
|
### Documentation for Models
|
|
260
157
|
|
|
261
|
-
- [XfloorFloorMemorySdkJs.BlockDetails](docs/BlockDetails.md)
|
|
262
|
-
- [XfloorFloorMemorySdkJs.ChangePassword200Response](docs/ChangePassword200Response.md)
|
|
263
|
-
- [XfloorFloorMemorySdkJs.ConversationThreads200Response](docs/ConversationThreads200Response.md)
|
|
264
|
-
- [XfloorFloorMemorySdkJs.ConversationThreads200ResponseThreadsInner](docs/ConversationThreads200ResponseThreadsInner.md)
|
|
265
|
-
- [XfloorFloorMemorySdkJs.EditFloor400Response](docs/EditFloor400Response.md)
|
|
266
|
-
- [XfloorFloorMemorySdkJs.EditFloor400ResponseError](docs/EditFloor400ResponseError.md)
|
|
267
|
-
- [XfloorFloorMemorySdkJs.Event400Response](docs/Event400Response.md)
|
|
268
|
-
- [XfloorFloorMemorySdkJs.Event400ResponseError](docs/Event400ResponseError.md)
|
|
269
|
-
- [XfloorFloorMemorySdkJs.EventResponse](docs/EventResponse.md)
|
|
270
|
-
- [XfloorFloorMemorySdkJs.FloorInfo](docs/FloorInfo.md)
|
|
271
|
-
- [XfloorFloorMemorySdkJs.GetConversations200Response](docs/GetConversations200Response.md)
|
|
272
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInner](docs/GetConversations200ResponseConversationInner.md)
|
|
273
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistant](docs/GetConversations200ResponseConversationInnerAssistant.md)
|
|
274
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInner](docs/GetConversations200ResponseConversationInnerAssistantChoicesInner.md)
|
|
275
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.md)
|
|
276
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.md)
|
|
277
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.md)
|
|
278
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts](docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.md)
|
|
279
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner](docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.md)
|
|
280
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerUser](docs/GetConversations200ResponseConversationInnerUser.md)
|
|
281
|
-
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerUserContext](docs/GetConversations200ResponseConversationInnerUserContext.md)
|
|
282
|
-
- [XfloorFloorMemorySdkJs.GetFloorInformation200Response](docs/GetFloorInformation200Response.md)
|
|
283
|
-
- [XfloorFloorMemorySdkJs.GetRecentEvents200Response](docs/GetRecentEvents200Response.md)
|
|
284
|
-
- [XfloorFloorMemorySdkJs.GetRecentEvents200ResponseItemsInner](docs/GetRecentEvents200ResponseItemsInner.md)
|
|
285
|
-
- [XfloorFloorMemorySdkJs.GetRecentEvents200ResponseItemsInnerAuthor](docs/GetRecentEvents200ResponseItemsInnerAuthor.md)
|
|
286
|
-
- [XfloorFloorMemorySdkJs.GetRecentEvents400Response](docs/GetRecentEvents400Response.md)
|
|
287
|
-
- [XfloorFloorMemorySdkJs.GetRecentEvents400ResponseError](docs/GetRecentEvents400ResponseError.md)
|
|
288
|
-
- [XfloorFloorMemorySdkJs.Media](docs/Media.md)
|
|
289
|
-
- [XfloorFloorMemorySdkJs.Model400ErrorCode](docs/Model400ErrorCode.md)
|
|
290
|
-
- [XfloorFloorMemorySdkJs.PostAdd](docs/PostAdd.md)
|
|
291
|
-
- [XfloorFloorMemorySdkJs.Query422Response](docs/Query422Response.md)
|
|
292
|
-
- [XfloorFloorMemorySdkJs.Query422ResponseError](docs/Query422ResponseError.md)
|
|
293
|
-
- [XfloorFloorMemorySdkJs.QueryRequest](docs/QueryRequest.md)
|
|
294
|
-
- [XfloorFloorMemorySdkJs.QueryRequestFilters](docs/QueryRequestFilters.md)
|
|
295
|
-
- [XfloorFloorMemorySdkJs.QueryResponse](docs/QueryResponse.md)
|
|
296
|
-
- [XfloorFloorMemorySdkJs.QueryResponseItemsInner](docs/QueryResponseItemsInner.md)
|
|
297
|
-
- [XfloorFloorMemorySdkJs.ResetPassword200Response](docs/ResetPassword200Response.md)
|
|
298
|
-
- [XfloorFloorMemorySdkJs.ResetPassword400Response](docs/ResetPassword400Response.md)
|
|
299
|
-
- [XfloorFloorMemorySdkJs.SendSignInValidationCode200Response](docs/SendSignInValidationCode200Response.md)
|
|
300
|
-
- [XfloorFloorMemorySdkJs.SendValidationCode200Response](docs/SendValidationCode200Response.md)
|
|
301
|
-
- [XfloorFloorMemorySdkJs.SendValidationCodeRequest](docs/SendValidationCodeRequest.md)
|
|
302
|
-
- [XfloorFloorMemorySdkJs.SignInWithEmail200Response](docs/SignInWithEmail200Response.md)
|
|
303
|
-
- [XfloorFloorMemorySdkJs.SignInWithEmail200ResponsePodInfo](docs/SignInWithEmail200ResponsePodInfo.md)
|
|
304
|
-
- [XfloorFloorMemorySdkJs.SignInWithEmail200ResponseProfile](docs/SignInWithEmail200ResponseProfile.md)
|
|
305
|
-
- [XfloorFloorMemorySdkJs.SignInWithEmail200ResponseProfileAvatar](docs/SignInWithEmail200ResponseProfileAvatar.md)
|
|
306
|
-
- [XfloorFloorMemorySdkJs.SignUp200Response](docs/SignUp200Response.md)
|
|
307
|
-
- [XfloorFloorMemorySdkJs.SignUpResponse](docs/SignUpResponse.md)
|
|
308
|
-
- [XfloorFloorMemorySdkJs.Threads](docs/Threads.md)
|
|
309
|
-
- [XfloorFloorMemorySdkJs.UserDetails](docs/UserDetails.md)
|
|
310
|
-
- [XfloorFloorMemorySdkJs.ValidateCode400Response](docs/ValidateCode400Response.md)
|
|
311
|
-
- [XfloorFloorMemorySdkJs.ValidateCode400ResponseError](docs/ValidateCode400ResponseError.md)
|
|
312
|
-
- [XfloorFloorMemorySdkJs.ValidateCode412Response](docs/ValidateCode412Response.md)
|
|
313
|
-
- [XfloorFloorMemorySdkJs.ValidateCodeRequest](docs/ValidateCodeRequest.md)
|
|
158
|
+
- [XfloorFloorMemorySdkJs.BlockDetails](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/BlockDetails.md)
|
|
159
|
+
- [XfloorFloorMemorySdkJs.ChangePassword200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ChangePassword200Response.md)
|
|
160
|
+
- [XfloorFloorMemorySdkJs.ConversationThreads200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ConversationThreads200Response.md)
|
|
161
|
+
- [XfloorFloorMemorySdkJs.ConversationThreads200ResponseThreadsInner](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ConversationThreads200ResponseThreadsInner.md)
|
|
162
|
+
- [XfloorFloorMemorySdkJs.EditFloor400Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/EditFloor400Response.md)
|
|
163
|
+
- [XfloorFloorMemorySdkJs.EditFloor400ResponseError](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/EditFloor400ResponseError.md)
|
|
164
|
+
- [XfloorFloorMemorySdkJs.Event400Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/Event400Response.md)
|
|
165
|
+
- [XfloorFloorMemorySdkJs.Event400ResponseError](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/Event400ResponseError.md)
|
|
166
|
+
- [XfloorFloorMemorySdkJs.EventResponse](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/EventResponse.md)
|
|
167
|
+
- [XfloorFloorMemorySdkJs.FloorInfo](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/FloorInfo.md)
|
|
168
|
+
- [XfloorFloorMemorySdkJs.GetConversations200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200Response.md)
|
|
169
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInner](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInner.md)
|
|
170
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistant](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerAssistant.md)
|
|
171
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInner](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerAssistantChoicesInner.md)
|
|
172
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.md)
|
|
173
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.md)
|
|
174
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.md)
|
|
175
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.md)
|
|
176
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.md)
|
|
177
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerUser](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerUser.md)
|
|
178
|
+
- [XfloorFloorMemorySdkJs.GetConversations200ResponseConversationInnerUserContext](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetConversations200ResponseConversationInnerUserContext.md)
|
|
179
|
+
- [XfloorFloorMemorySdkJs.GetFloorInformation200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetFloorInformation200Response.md)
|
|
180
|
+
- [XfloorFloorMemorySdkJs.GetRecentEvents200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetRecentEvents200Response.md)
|
|
181
|
+
- [XfloorFloorMemorySdkJs.GetRecentEvents200ResponseItemsInner](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetRecentEvents200ResponseItemsInner.md)
|
|
182
|
+
- [XfloorFloorMemorySdkJs.GetRecentEvents200ResponseItemsInnerAuthor](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetRecentEvents200ResponseItemsInnerAuthor.md)
|
|
183
|
+
- [XfloorFloorMemorySdkJs.GetRecentEvents400Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetRecentEvents400Response.md)
|
|
184
|
+
- [XfloorFloorMemorySdkJs.GetRecentEvents400ResponseError](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/GetRecentEvents400ResponseError.md)
|
|
185
|
+
- [XfloorFloorMemorySdkJs.Media](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/Media.md)
|
|
186
|
+
- [XfloorFloorMemorySdkJs.Model400ErrorCode](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/Model400ErrorCode.md)
|
|
187
|
+
- [XfloorFloorMemorySdkJs.PostAdd](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/PostAdd.md)
|
|
188
|
+
- [XfloorFloorMemorySdkJs.Query422Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/Query422Response.md)
|
|
189
|
+
- [XfloorFloorMemorySdkJs.Query422ResponseError](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/Query422ResponseError.md)
|
|
190
|
+
- [XfloorFloorMemorySdkJs.QueryRequest](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/QueryRequest.md)
|
|
191
|
+
- [XfloorFloorMemorySdkJs.QueryRequestFilters](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/QueryRequestFilters.md)
|
|
192
|
+
- [XfloorFloorMemorySdkJs.QueryResponse](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/QueryResponse.md)
|
|
193
|
+
- [XfloorFloorMemorySdkJs.QueryResponseItemsInner](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/QueryResponseItemsInner.md)
|
|
194
|
+
- [XfloorFloorMemorySdkJs.ResetPassword200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ResetPassword200Response.md)
|
|
195
|
+
- [XfloorFloorMemorySdkJs.ResetPassword400Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ResetPassword400Response.md)
|
|
196
|
+
- [XfloorFloorMemorySdkJs.SendSignInValidationCode200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SendSignInValidationCode200Response.md)
|
|
197
|
+
- [XfloorFloorMemorySdkJs.SendValidationCode200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SendValidationCode200Response.md)
|
|
198
|
+
- [XfloorFloorMemorySdkJs.SendValidationCodeRequest](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SendValidationCodeRequest.md)
|
|
199
|
+
- [XfloorFloorMemorySdkJs.SignInWithEmail200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SignInWithEmail200Response.md)
|
|
200
|
+
- [XfloorFloorMemorySdkJs.SignInWithEmail200ResponsePodInfo](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SignInWithEmail200ResponsePodInfo.md)
|
|
201
|
+
- [XfloorFloorMemorySdkJs.SignInWithEmail200ResponseProfile](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SignInWithEmail200ResponseProfile.md)
|
|
202
|
+
- [XfloorFloorMemorySdkJs.SignInWithEmail200ResponseProfileAvatar](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SignInWithEmail200ResponseProfileAvatar.md)
|
|
203
|
+
- [XfloorFloorMemorySdkJs.SignUp200Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SignUp200Response.md)
|
|
204
|
+
- [XfloorFloorMemorySdkJs.SignUpResponse](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/SignUpResponse.md)
|
|
205
|
+
- [XfloorFloorMemorySdkJs.Threads](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/Threads.md)
|
|
206
|
+
- [XfloorFloorMemorySdkJs.UserDetails](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/UserDetails.md)
|
|
207
|
+
- [XfloorFloorMemorySdkJs.ValidateCode400Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ValidateCode400Response.md)
|
|
208
|
+
- [XfloorFloorMemorySdkJs.ValidateCode400ResponseError](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ValidateCode400ResponseError.md)
|
|
209
|
+
- [XfloorFloorMemorySdkJs.ValidateCode412Response](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ValidateCode412Response.md)
|
|
210
|
+
- [XfloorFloorMemorySdkJs.ValidateCodeRequest](https://github.com/xFloorllm/floor-memory-sdk-client/blob/main/js/docs/ValidateCodeRequest.md)
|
|
314
211
|
|
|
315
212
|
|
|
316
213
|
### Documentation for Authorization
|
package/dist/ApiClient.js
CHANGED
|
@@ -27,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
27
27
|
*/
|
|
28
28
|
/**
|
|
29
29
|
* @module ApiClient
|
|
30
|
-
* @version 1.0.
|
|
30
|
+
* @version 1.0.8
|
|
31
31
|
*/
|
|
32
32
|
/**
|
|
33
33
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
@@ -43,12 +43,12 @@ var ApiClient = /*#__PURE__*/function () {
|
|
|
43
43
|
* @param {String} basePath
|
|
44
44
|
*/
|
|
45
45
|
function ApiClient() {
|
|
46
|
-
var basePath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '
|
|
46
|
+
var basePath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'http://localhost';
|
|
47
47
|
_classCallCheck(this, ApiClient);
|
|
48
48
|
/**
|
|
49
49
|
* The base URL against which to resolve every API call's (relative) path.
|
|
50
50
|
* @type {String}
|
|
51
|
-
* @default
|
|
51
|
+
* @default http://localhost
|
|
52
52
|
*/
|
|
53
53
|
this.basePath = basePath.replace(/\/+$/, '');
|
|
54
54
|
|
|
@@ -68,7 +68,7 @@ var ApiClient = /*#__PURE__*/function () {
|
|
|
68
68
|
* @default {}
|
|
69
69
|
*/
|
|
70
70
|
this.defaultHeaders = {
|
|
71
|
-
'User-Agent': 'OpenAPI-Generator/1.0.
|
|
71
|
+
'User-Agent': 'OpenAPI-Generator/1.0.8/Javascript'
|
|
72
72
|
};
|
|
73
73
|
|
|
74
74
|
/**
|
|
@@ -524,8 +524,8 @@ var ApiClient = /*#__PURE__*/function () {
|
|
|
524
524
|
*/
|
|
525
525
|
function hostSettings() {
|
|
526
526
|
return [{
|
|
527
|
-
'url': "
|
|
528
|
-
'description': "
|
|
527
|
+
'url': "",
|
|
528
|
+
'description': "No description provided"
|
|
529
529
|
}];
|
|
530
530
|
}
|
|
531
531
|
}, {
|
package/dist/api/DefaultApi.js
CHANGED
package/dist/api/EditFloorApi.js
CHANGED
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
30
30
|
/**
|
|
31
31
|
* EditFloor service.
|
|
32
32
|
* @module api/EditFloorApi
|
|
33
|
-
* @version 1.0.
|
|
33
|
+
* @version 1.0.8
|
|
34
34
|
*/
|
|
35
35
|
var EditFloorApi = exports["default"] = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
package/dist/api/EventApi.js
CHANGED
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
30
30
|
/**
|
|
31
31
|
* Event service.
|
|
32
32
|
* @module api/EventApi
|
|
33
|
-
* @version 1.0.
|
|
33
|
+
* @version 1.0.8
|
|
34
34
|
*/
|
|
35
35
|
var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
@@ -55,8 +55,9 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
57
|
* Create Event (Post Content)
|
|
58
|
-
* ## Create Event (Content Ingestion) Posts content into the specified `floor_id`. This API performs **asynchronous ingestion** — a `200 OK` response means the content has been **accepted and queued**, not immediately retrievable. This API allows a user to **post personal content into their POD (Personal Object Database)**. The posted content is stored under a specified **floor**, embedded by the platform, and made available for **semantic querying, conversational retrieval, and memory-based interactions** once processing completes. It is primarily used to: * Save reminders, notes, write-ups, or personal knowledge * Upload content the user wants the system to remember * Add information that should later be discoverable via conversational queries The content may consist of **text only** or **text combined with one or more media files**. --- ## Key Capabilities * Stores user-generated content inside a specific floor * Supports **multi-modal inputs** (text + media) * Automatically embeds content for semantic search * Makes content available to: * `/agent/memory/query` * conversational agents * future recall and analytics * Associates content with **user**, **block**, and **application** context (when provided) --- ## Authentication * Requires a valid, authenticated `user_id` * The calling application is responsible for user authentication * `app_id` identifies the application context --- ## Request Type **Content-Type:** `multipart/form-data` --- ## Request Parameters ### 1. Files (Optional) | Field | Type | Required | Description | | ------- | -------- | -------- | --------------------------------------------------------------------- | | `files` | `file[]` | Optional | Media files to attach to the content. Multiple files may be uploaded. | **Supported formats include (but are not limited to):** * Images: `jpg`, `png` * Audio: `mp3` * Documents: `pdf` * Video: `mp4` These files are processed and embedded along with the textual content where applicable. --- ### 2. Input Information (Required) | Field | Type | Required | Description | | ------------ | --------------- | -------- | ----------------------------------------------------------------- | | `input_info` | `string (JSON)` | Yes | JSON string containing metadata and textual content for the post. | --- ## `input_info` Structure ```json { \"floor_id\": \"my_floor\", \"block_id\": \"17845683456\", \"block_type\": \"
|
|
58
|
+
* ## Create Event (Content Ingestion) Posts content into the specified `floor_id`. This API performs **asynchronous ingestion** — a `200 OK` response means the content has been **accepted and queued**, not immediately retrievable. This API allows a user to **post personal content into their POD (Personal Object Database)**. The posted content is stored under a specified **floor**, embedded by the platform, and made available for **semantic querying, conversational retrieval, and memory-based interactions** once processing completes. It is primarily used to: * Save reminders, notes, write-ups, or personal knowledge * Upload content the user wants the system to remember * Add information that should later be discoverable via conversational queries The content may consist of **text only** or **text combined with one or more media files**. --- ## Key Capabilities * Stores user-generated content inside a specific floor * Supports **multi-modal inputs** (text + media) * Automatically embeds content for semantic search * Makes content available to: * `/agent/memory/query` * conversational agents * future recall and analytics * Associates content with **user**, **block**, and **application** context (when provided) --- ## Authentication * Requires a valid, authenticated `user_id` * The calling application is responsible for user authentication * `app_id` identifies the application context --- ## Request Type **Content-Type:** `multipart/form-data` --- ## Request Parameters ### 1. Files (Optional) | Field | Type | Required | Description | | ------- | -------- | -------- | --------------------------------------------------------------------- | | `files` | `file[]` | Optional | Media files to attach to the content. Multiple files may be uploaded. | **Supported formats include (but are not limited to):** * Images: `jpg`, `png` * Audio: `mp3` * Documents: `pdf` * Video: `mp4` These files are processed and embedded along with the textual content where applicable. --- ### 2. Input Information (Required) | Field | Type | Required | Description | | ------------ | --------------- | -------- | ----------------------------------------------------------------- | | `input_info` | `string (JSON)` | Yes | JSON string containing metadata and textual content for the post. | --- ## `input_info` Structure ```json { \"floor_id\": \"my_floor\", \"block_id\": \"17845683456\", \"block_type\": \"1\", \"user_id\": \"145623907625\", \"title\": \"My note\", \"description\": \"Things I should remember\" } ``` --- ## Field Descriptions | Field | Type | Required | Description | | ------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------- | | `floor_id` | `string` | Yes | Identifier of the user’s floor (POD) where the content will be stored. | | `block_id` | `string` | Optional | Identifier of the block within the floor used to group or categorize content. | | `block_type` | `string` | Optional | Logical category of the content (e.g., `0 for post`, `1 for forum`). Used for routing and UI organization. | | `user_id` | `string` | Yes | Unique identifier of the user posting the content. | | `title` | `string` | Optional | Short title or heading for the content. | | `description` | `string` | Yes | Main textual content to be stored and embedded. | | `app_id` | `string` | Optional | Identifier of the calling application context. | --- ## Behavior 1. The API validates the user and floor context. 2. Textual content (`title` and `description`) is ingested. 3. Attached media files (if any) are processed and linked to the content. 4. Embeddings are generated for: * text * supported media (where applicable) 5. The content becomes part of the user’s **personal memory store (POD)**. 6. Once background processing completes, the content becomes available for: * semantic search * conversational retrieval * memory-based interactions --- ## Successful Response On success, the API confirms that: * The content has been **accepted** * Processing has been **queued** * Reference identifiers are returned > A successful response indicates **acceptance**, not immediate availability. --- ## Error Handling The API may return errors if: * Required fields are missing (`floor_id`, `user_id`, `description`) * Uploaded files use unsupported formats * The user does not have access to the specified floor * The request payload is malformed * Internal embedding or storage operations fail --- ## Typical Use Cases * Saving personal reminders * Posting notes or observations * Uploading documents for later recall * Building a personal knowledge base * Feeding content into conversational agents --- ## ⚠️ Asynchronous Ingestion Notice Content ingestion is **asynchronous**. A `200 OK` response means the request was **successfully queued**. Newly ingested content may take time to become searchable via the Query API. Use **Recent Events** or retry queries after a short delay to confirm availability. --- ## One-Line Summary > Stores user-generated text and media into a personal POD, embeds it asynchronously, and makes it available for semantic and conversational querying. If you want, next I can: * align this **exactly** with the OpenAPI schema fields * generate **JS / TS / Python / Java snippets** using this definition * add **state diagrams** (queued → processing → searchable) for docs
|
|
59
59
|
* @param {String} inputInfo Input parameters, bid is optional
|
|
60
|
+
* @param {String} appId App ID created in developer console.
|
|
60
61
|
* @param {Object} opts Optional parameters
|
|
61
62
|
* @param {File} [files] Attach relevant media here, which includes, jpg, mp3, pdf, mp4 files. More than one media can be selected
|
|
62
63
|
* @param {module:api/EventApi~eventCallback} callback The callback function, accepting three arguments: error, data, response
|
|
@@ -64,19 +65,24 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
64
65
|
*/
|
|
65
66
|
return _createClass(EventApi, [{
|
|
66
67
|
key: "event",
|
|
67
|
-
value: function event(inputInfo, opts, callback) {
|
|
68
|
+
value: function event(inputInfo, appId, opts, callback) {
|
|
68
69
|
opts = opts || {};
|
|
69
70
|
var postBody = null;
|
|
70
71
|
// verify the required parameter 'inputInfo' is set
|
|
71
72
|
if (inputInfo === undefined || inputInfo === null) {
|
|
72
73
|
throw new Error("Missing the required parameter 'inputInfo' when calling event");
|
|
73
74
|
}
|
|
75
|
+
// verify the required parameter 'appId' is set
|
|
76
|
+
if (appId === undefined || appId === null) {
|
|
77
|
+
throw new Error("Missing the required parameter 'appId' when calling event");
|
|
78
|
+
}
|
|
74
79
|
var pathParams = {};
|
|
75
80
|
var queryParams = {};
|
|
76
81
|
var headerParams = {};
|
|
77
82
|
var formParams = {
|
|
78
83
|
'files': opts['files'],
|
|
79
|
-
'input_info': inputInfo
|
|
84
|
+
'input_info': inputInfo,
|
|
85
|
+
'app_id': appId
|
|
80
86
|
};
|
|
81
87
|
var authNames = ['bearer'];
|
|
82
88
|
var contentTypes = ['multipart/form-data'];
|
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
30
30
|
/**
|
|
31
31
|
* GetFloorInformation service.
|
|
32
32
|
* @module api/GetFloorInformationApi
|
|
33
|
-
* @version 1.0.
|
|
33
|
+
* @version 1.0.8
|
|
34
34
|
*/
|
|
35
35
|
var GetFloorInformationApi = exports["default"] = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
30
30
|
/**
|
|
31
31
|
* GetRecentEvents service.
|
|
32
32
|
* @module api/GetRecentEventsApi
|
|
33
|
-
* @version 1.0.
|
|
33
|
+
* @version 1.0.8
|
|
34
34
|
*/
|
|
35
35
|
var GetRecentEventsApi = exports["default"] = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
package/dist/api/QueryApi.js
CHANGED
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
31
31
|
/**
|
|
32
32
|
* Query service.
|
|
33
33
|
* @module api/QueryApi
|
|
34
|
-
* @version 1.0.
|
|
34
|
+
* @version 1.0.8
|
|
35
35
|
*/
|
|
36
36
|
var QueryApi = exports["default"] = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -56,7 +56,7 @@ var QueryApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
56
56
|
|
|
57
57
|
/**
|
|
58
58
|
* Query (Primary API)
|
|
59
|
-
* # **Conversational Query API** This is the **core API** of xfloor. It accepts a natural language query and returns a conversational response derived from: - Content ingested into the specified Floor - The user’s prior conversation history (if provided) - Relevant metadata and context This API is designed for **multi-turn conversations** and can be used to build: - AI chatbots - Knowledge assistants - Floor-specific copilots This API enables **conversational, context-aware querying** over data stored within xfloor. It accepts a natural language query (for example, *“What options do I have in your institute?”*) and returns relevant information derived from the specified floors and their associated content. The API is designed for **multi-turn conversations**. Follow-up questions from the same user automatically build upon prior context, allowing the system to refine, expand, or clarify results across successive calls. --- ## **Core Capabilities** * Interprets **natural language queries** * Retrieves relevant information from one or more floors * Applies **time-, type-, and tag-based filters** * Supports **Top-K retrieval** for result control * Optionally includes metadata with responses * Can generate **summarized responses** when requested * Maintains **conversation continuity** across multiple queries from the same user --- ## **Authentication & Identity** * A valid `user_id` is **required** * User authentication is assumed to be completed **before** calling this API * `app_id` identifies the calling application context * Conversational continuity is maintained **per `user_id`** > **Note:** All queries from the same `user_id` are treated as part of a single conversational context unless explicitly reset by the application. --- ## **Request Contract** ### **HTTP Method** `POST` ### **Content-Type** ``` application/json ``` > **Important:** > This API accepts **JSON requests only**. > `multipart/form-data` is **not supported**. --- ## **Request Body (JSON)** ### **Field Descriptions** | Field | Type | Required | Description | | ------------------- | ----------------------- | -------- | ---------------------------------------------------------------------------------------------- | | `user_id` | string | Yes | Unique xfloor user identifier. Used to maintain conversational continuity and personalization. | | `query` | string | Yes | Natural language query provided by the user. | | `floor_ids` | array of strings | Yes | List of floor identifiers that define the search scope. Must be provided as a JSON array. | | `filters` | object | Optional | Additional constraints to narrow search results. | | `filters.time_from` | string (ISO-8601) | Optional | Start timestamp for filtering content by creation or update time. | | `filters.time_to` | string (ISO-8601) | Optional | End timestamp for filtering content by creation or update time. | | `filters.types` | array of strings | Optional | Content types to include (e.g., `post`, `blog`, `forum`). | | `filters.tags` | array of strings | Optional | Tags used to further refine results. | | `k` | integer | Optional | Maximum number of results to retrieve (Top-K). Defaults to system-defined behavior if omitted. | | `include_metadata` | string (`\"0\"` or `\"1\"`) | Optional | Whether to include metadata (source, timestamps, tags) in the response. Defaults to `\"0\"`. | | `summary_needed` | string (`\"0\"` or `\"1\"`) | Optional | Whether a summarized conversational answer should be generated. Defaults to `\"0\"`. | | `app_id` | string | Optional | Identifies the application invoking the API. Useful for multi-app integrations. | --- ### **Important Encoding Rules** * `floor_ids` **must** be provided as a JSON array ```json \"floor_ids\": [\"floor_1\", \"floor_2\"] ``` * Boolean-style flags (`include_metadata`, `summary_needed`) are encoded as **string values**: `\"0\"` or `\"1\"` * `filters` must be provided as a **JSON object**, not a string --- ### **Canonical Request Example** ```json { \"user_id\": \"xf_user_123\", \"query\": \"What options do I have in your institute?\", \"floor_ids\": [\"institute_floor\"], \"filters\": { \"types\": [\"post\", \"blog\"], \"tags\": [\"admissions\"] }, \"k\": 5, \"include_metadata\": \"1\", \"summary_needed\": \"1\", \"app_id\": \"student_portal\" } ``` --- ## **Behavior** 1. The query is analyzed using conversational and semantic understanding. 2. Relevant content is retrieved from the specified floors. 3. Filters (time, type, tags) are applied if provided. 4. Results are ranked and limited based on `k`. 5. If `summary_needed = \"1\"`, a synthesized conversational summary is generated. 6. If `include_metadata = \"1\"`, metadata is attached to each result item. 7. The response is returned in a conversational format suitable for follow-up questions. --- ## **Response Contract** ### **High-Level Response Structure** ```json { \"answer\": \"Assistant-generated conversational response\", \"items\": [ { \"id\": \"content_id\", \"type\": \"post\", \"text\": \"Original content snippet\", \"metadata\": { } } ] } ``` --- ### **Response Field Semantics** | Field | Always Present | Description | Rendering Guidance | | ------------------ | ------------------ | ------------------------------------------- | ---------------------- | | `answer` |
|
|
59
|
+
* # **Conversational Query API** This is the **core API** of xfloor. It accepts a natural language query and returns a conversational response derived from: - Content ingested into the specified Floor - The user’s prior conversation history (if provided) - Relevant metadata and context This API is designed for **multi-turn conversations** and can be used to build: - AI chatbots - Knowledge assistants - Floor-specific copilots This API enables **conversational, context-aware querying** over data stored within xfloor. It accepts a natural language query (for example, *“What options do I have in your institute?”*) and returns relevant information derived from the specified floors and their associated content. The API is designed for **multi-turn conversations**. Follow-up questions from the same user automatically build upon prior context, allowing the system to refine, expand, or clarify results across successive calls. --- ## **Core Capabilities** * Interprets **natural language queries** * Retrieves relevant information from one or more floors * Applies **time-, type-, and tag-based filters** * Supports **Top-K retrieval** for result control * Optionally includes metadata with responses * Can generate **summarized responses** when requested * Maintains **conversation continuity** across multiple queries from the same user --- ## **Authentication & Identity** * A valid `user_id` is **required** * User authentication is assumed to be completed **before** calling this API * `app_id` identifies the calling application context * Conversational continuity is maintained **per `user_id`** > **Note:** All queries from the same `user_id` are treated as part of a single conversational context unless explicitly reset by the application. --- ## **Request Contract** ### **HTTP Method** `POST` ### **Content-Type** ``` application/json ``` > **Important:** > This API accepts **JSON requests only**. > `multipart/form-data` is **not supported**. --- ## **Request Body (JSON)** ### **Field Descriptions** | Field | Type | Required | Description | | ------------------- | ----------------------- | -------- | ---------------------------------------------------------------------------------------------- | | `user_id` | string | Yes | Unique xfloor user identifier. Used to maintain conversational continuity and personalization. | | `query` | string | Yes | Natural language query provided by the user. | | `floor_ids` | array of strings | Yes | List of floor identifiers that define the search scope. Must be provided as a JSON array. | | `filters` | object | Optional | Additional constraints to narrow search results. | | `filters.time_from` | string (ISO-8601) | Optional | Start timestamp for filtering content by creation or update time. | | `filters.time_to` | string (ISO-8601) | Optional | End timestamp for filtering content by creation or update time. | | `filters.types` | array of strings | Optional | Content types to include (e.g., `post`, `blog`, `forum`). | | `filters.tags` | array of strings | Optional | Tags used to further refine results. | | `k` | integer | Optional | Maximum number of results to retrieve (Top-K). Defaults to system-defined behavior if omitted. | | `include_metadata` | string (`\"0\"` or `\"1\"`) | Optional | Whether to include metadata (source, timestamps, tags) in the response. Defaults to `\"0\"`. | | `summary_needed` | string (`\"0\"` or `\"1\"`) | Optional | Whether a summarized conversational answer should be generated. Defaults to `\"0\"`. | | `app_id` | string | Optional | Identifies the application invoking the API. Useful for multi-app integrations. | --- ### **Important Encoding Rules** * `floor_ids` **must** be provided as a JSON array ```json \"floor_ids\": [\"floor_1\", \"floor_2\"] ``` * Boolean-style flags (`include_metadata`, `summary_needed`) are encoded as **string values**: `\"0\"` or `\"1\"` * `filters` must be provided as a **JSON object**, not a string --- ### **Canonical Request Example** ```json { \"user_id\": \"xf_user_123\", \"query\": \"What options do I have in your institute?\", \"floor_ids\": [\"institute_floor\"], \"filters\": { \"types\": [\"post\", \"blog\"], \"tags\": [\"admissions\"] }, \"k\": 5, \"include_metadata\": \"1\", \"summary_needed\": \"1\", \"app_id\": \"student_portal\" } ``` --- ## **Behavior** 1. The query is analyzed using conversational and semantic understanding. 2. Relevant content is retrieved from the specified floors. 3. Filters (time, type, tags) are applied if provided. 4. Results are ranked and limited based on `k`. 5. If `summary_needed = \"1\"`, a synthesized conversational summary is generated. 6. If `include_metadata = \"1\"`, metadata is attached to each result item. 7. The response is returned in a conversational format suitable for follow-up questions. --- ## **Response Contract** ### **High-Level Response Structure** ```json { \"answer\": \"Assistant-generated conversational response\", \"items\": [ { \"id\": \"content_id\", \"type\": \"post\", \"text\": \"Original content snippet\", \"metadata\": { } } ] } ``` --- ### **Response Field Semantics** | Field | Always Present | Description | Rendering Guidance | | ------------------ | ------------------ | ------------------------------------------- | ---------------------- | | `answer` | No | Assistant-generated conversational response. Depends on summary_needed. Is present if summary_needed=1 | **Render prominently** | | `items` | Yes (may be empty) | List of matched content used for grounding | Render optionally | | `items[].metadata` | Conditional | Included only if `include_metadata = \"1\"` | Render on demand | > **No-Result Case:** > If no relevant content is found, `items` will be an empty array and `answer` will contain a conversational fallback response. --- ## **Conversation Continuity** * Conversation state is maintained **per `user_id`** * Follow-up queries automatically reference prior context * The API does not require explicit conversation IDs * Applications may reset conversation context by using a new `user_id` --- ## **Error Handling** The API may return errors in the following cases: * Missing or invalid `user_id` * Empty or unsupported `query` * Invalid or inaccessible `floor_ids` * Authorization or application context errors * Internal processing failures All errors are returned with appropriate HTTP status codes and descriptive messages. --- ## **Typical Use Case Flow** 1. User asks an initial question *“What options do I have in your institute?”* 2. Application calls `/agent/memory/query` 3. Results are displayed to the user 4. User asks a follow-up *“Which ones are available on weekends?”* 5. Application calls the same API again with the new query 6. Conversation continues seamlessly using prior context --- ## **One-Line Summary** > Executes a conversational query over xfloor content, returning context-aware, filtered, and optionally summarized results with support for multi-turn interactions.
|
|
60
60
|
* @param {module:model/QueryRequest} queryRequest
|
|
61
61
|
* @param {module:api/QueryApi~queryCallback} callback The callback function, accepting three arguments: error, data, response
|
|
62
62
|
* data is of type: {@link module:model/QueryResponse}
|
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
31
31
|
/**
|
|
32
32
|
* The ChangePassword200Response model module.
|
|
33
33
|
* @module model/ChangePassword200Response
|
|
34
|
-
* @version 1.0.
|
|
34
|
+
* @version 1.0.8
|
|
35
35
|
*/
|
|
36
36
|
var ChangePassword200Response = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -32,7 +32,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
32
32
|
/**
|
|
33
33
|
* The ConversationThreads200Response model module.
|
|
34
34
|
* @module model/ConversationThreads200Response
|
|
35
|
-
* @version 1.0.
|
|
35
|
+
* @version 1.0.8
|
|
36
36
|
*/
|
|
37
37
|
var ConversationThreads200Response = /*#__PURE__*/function () {
|
|
38
38
|
/**
|
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
31
31
|
/**
|
|
32
32
|
* The ConversationThreads200ResponseThreadsInner model module.
|
|
33
33
|
* @module model/ConversationThreads200ResponseThreadsInner
|
|
34
|
-
* @version 1.0.
|
|
34
|
+
* @version 1.0.8
|
|
35
35
|
*/
|
|
36
36
|
var ConversationThreads200ResponseThreadsInner = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -32,7 +32,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
32
32
|
/**
|
|
33
33
|
* The EditFloor400Response model module.
|
|
34
34
|
* @module model/EditFloor400Response
|
|
35
|
-
* @version 1.0.
|
|
35
|
+
* @version 1.0.8
|
|
36
36
|
*/
|
|
37
37
|
var EditFloor400Response = /*#__PURE__*/function () {
|
|
38
38
|
/**
|
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
31
31
|
/**
|
|
32
32
|
* The EditFloor400ResponseError model module.
|
|
33
33
|
* @module model/EditFloor400ResponseError
|
|
34
|
-
* @version 1.0.
|
|
34
|
+
* @version 1.0.8
|
|
35
35
|
*/
|
|
36
36
|
var EditFloor400ResponseError = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -32,7 +32,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
32
32
|
/**
|
|
33
33
|
* The Event400Response model module.
|
|
34
34
|
* @module model/Event400Response
|
|
35
|
-
* @version 1.0.
|
|
35
|
+
* @version 1.0.8
|
|
36
36
|
*/
|
|
37
37
|
var Event400Response = /*#__PURE__*/function () {
|
|
38
38
|
/**
|
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
31
31
|
/**
|
|
32
32
|
* The Event400ResponseError model module.
|
|
33
33
|
* @module model/Event400ResponseError
|
|
34
|
-
* @version 1.0.
|
|
34
|
+
* @version 1.0.8
|
|
35
35
|
*/
|
|
36
36
|
var Event400ResponseError = /*#__PURE__*/function () {
|
|
37
37
|
/**
|