@xfloor/floor-memory-sdk-js 1.0.4 → 1.0.6
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 +155 -36
- package/dist/ApiClient.js +5 -3
- package/dist/api/DefaultApi.js +277 -38
- package/dist/api/EditFloorApi.js +4 -2
- package/dist/api/EventApi.js +5 -3
- package/dist/api/GetFloorInformationApi.js +12 -6
- package/dist/api/GetRecentEventsApi.js +11 -5
- package/dist/api/QueryApi.js +4 -2
- package/dist/index.js +112 -0
- package/dist/model/BlockDetails.js +16 -14
- package/dist/model/ChangePassword200Response.js +4 -2
- package/dist/model/ConversationThreads200Response.js +146 -0
- package/dist/model/ConversationThreads200ResponseThreadsInner.js +142 -0
- package/dist/model/EditFloor400Response.js +4 -2
- package/dist/model/EditFloor400ResponseError.js +4 -2
- package/dist/model/Event400Response.js +4 -2
- package/dist/model/Event400ResponseError.js +4 -2
- package/dist/model/EventResponse.js +4 -2
- package/dist/model/FloorInfo.js +4 -2
- package/dist/model/GetConversations200Response.js +160 -0
- package/dist/model/GetConversations200ResponseConversationInner.js +107 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistant.js +228 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInner.js +141 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.js +212 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.js +128 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.js +128 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.js +188 -0
- package/dist/model/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.js +218 -0
- package/dist/model/GetConversations200ResponseConversationInnerUser.js +172 -0
- package/dist/model/GetConversations200ResponseConversationInnerUserContext.js +170 -0
- package/dist/model/GetFloorInformation200Response.js +4 -2
- package/dist/model/GetRecentEvents200Response.js +4 -2
- package/dist/model/GetRecentEvents200ResponseItemsInner.js +4 -2
- package/dist/model/GetRecentEvents200ResponseItemsInnerAuthor.js +4 -2
- package/dist/model/GetRecentEvents400Response.js +4 -2
- package/dist/model/GetRecentEvents400ResponseError.js +4 -2
- package/dist/model/Media.js +4 -2
- package/dist/model/Model400ErrorCode.js +4 -2
- package/dist/model/PostAdd.js +175 -0
- package/dist/model/Query422Response.js +4 -2
- package/dist/model/Query422ResponseError.js +4 -2
- package/dist/model/QueryRequest.js +10 -6
- package/dist/model/QueryRequestFilters.js +4 -2
- package/dist/model/QueryResponse.js +4 -2
- package/dist/model/QueryResponseItemsInner.js +4 -2
- package/dist/model/ResetPassword200Response.js +4 -2
- package/dist/model/ResetPassword400Response.js +4 -2
- package/dist/model/SendSignInValidationCode200Response.js +143 -0
- package/dist/model/SendValidationCode200Response.js +4 -2
- package/dist/model/SendValidationCodeRequest.js +4 -2
- package/dist/model/SignInWithEmail200Response.js +4 -2
- package/dist/model/SignInWithEmail200ResponsePodInfo.js +4 -2
- package/dist/model/SignInWithEmail200ResponseProfile.js +4 -2
- package/dist/model/SignInWithEmail200ResponseProfileAvatar.js +4 -2
- package/dist/model/SignUp200Response.js +4 -2
- package/dist/model/SignUpResponse.js +4 -2
- package/dist/model/Threads.js +142 -0
- package/dist/model/UserDetails.js +4 -2
- package/dist/model/ValidateCode400Response.js +4 -2
- package/dist/model/ValidateCode400ResponseError.js +4 -2
- package/dist/model/ValidateCode412Response.js +4 -2
- package/dist/model/ValidateCodeRequest.js +4 -2
- package/package.json +1 -1
package/dist/api/DefaultApi.js
CHANGED
|
@@ -6,11 +6,14 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
8
|
var _ChangePassword200Response = _interopRequireDefault(require("../model/ChangePassword200Response"));
|
|
9
|
+
var _ConversationThreads200Response = _interopRequireDefault(require("../model/ConversationThreads200Response"));
|
|
9
10
|
var _EditFloor400Response = _interopRequireDefault(require("../model/EditFloor400Response"));
|
|
11
|
+
var _GetConversations200Response = _interopRequireDefault(require("../model/GetConversations200Response"));
|
|
10
12
|
var _GetFloorInformation200Response = _interopRequireDefault(require("../model/GetFloorInformation200Response"));
|
|
11
13
|
var _GetRecentEvents400Response = _interopRequireDefault(require("../model/GetRecentEvents400Response"));
|
|
12
14
|
var _ResetPassword200Response = _interopRequireDefault(require("../model/ResetPassword200Response"));
|
|
13
15
|
var _ResetPassword400Response = _interopRequireDefault(require("../model/ResetPassword400Response"));
|
|
16
|
+
var _SendSignInValidationCode200Response = _interopRequireDefault(require("../model/SendSignInValidationCode200Response"));
|
|
14
17
|
var _SendValidationCode200Response = _interopRequireDefault(require("../model/SendValidationCode200Response"));
|
|
15
18
|
var _SendValidationCodeRequest = _interopRequireDefault(require("../model/SendValidationCodeRequest"));
|
|
16
19
|
var _SignInWithEmail200Response = _interopRequireDefault(require("../model/SignInWithEmail200Response"));
|
|
@@ -27,7 +30,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
27
30
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
28
31
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
29
32
|
* Floor Memory
|
|
30
|
-
* The set APIs are used to develop Floor pds which can be used as their personal assistants.
|
|
33
|
+
* The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts.
|
|
34
|
+
* - Memory and
|
|
35
|
+
* - Registration. The developer has two ways of using the APIs for the app development. Developer can choose to the Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
|
|
31
36
|
*
|
|
32
37
|
* The version of the OpenAPI document: 1.0.0
|
|
33
38
|
* Contact: contact@ipomo.in
|
|
@@ -40,7 +45,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
40
45
|
/**
|
|
41
46
|
* Default service.
|
|
42
47
|
* @module api/DefaultApi
|
|
43
|
-
* @version 1.0.
|
|
48
|
+
* @version 1.0.6
|
|
44
49
|
*/
|
|
45
50
|
var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
46
51
|
/**
|
|
@@ -56,22 +61,102 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
56
61
|
}
|
|
57
62
|
|
|
58
63
|
/**
|
|
59
|
-
* Callback function to receive the result of the
|
|
60
|
-
* @callback module:api/DefaultApi~
|
|
64
|
+
* Callback function to receive the result of the apiDeveloperCreateAppPost operation.
|
|
65
|
+
* @callback module:api/DefaultApi~apiDeveloperCreateAppPostCallback
|
|
61
66
|
* @param {String} error Error message, if any.
|
|
62
67
|
* @param {Object} data The data returned by the service call.
|
|
63
68
|
* @param {String} response The complete HTTP response.
|
|
64
69
|
*/
|
|
65
70
|
|
|
66
71
|
/**
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* @param {String}
|
|
70
|
-
* @param {
|
|
71
|
-
* @param {
|
|
72
|
+
* Create App
|
|
73
|
+
* Create a custom app using APIs. A 13 digit app ID gets created which takes title and description the app. An icon of specified size needs to be uploaded.
|
|
74
|
+
* @param {String} inputInfo
|
|
75
|
+
* @param {Object} opts Optional parameters
|
|
76
|
+
* @param {File} [icon]
|
|
77
|
+
* @param {module:api/DefaultApi~apiDeveloperCreateAppPostCallback} callback The callback function, accepting three arguments: error, data, response
|
|
72
78
|
* data is of type: {@link Object}
|
|
73
79
|
*/
|
|
74
80
|
return _createClass(DefaultApi, [{
|
|
81
|
+
key: "apiDeveloperCreateAppPost",
|
|
82
|
+
value: function apiDeveloperCreateAppPost(inputInfo, opts, callback) {
|
|
83
|
+
opts = opts || {};
|
|
84
|
+
var postBody = null;
|
|
85
|
+
// verify the required parameter 'inputInfo' is set
|
|
86
|
+
if (inputInfo === undefined || inputInfo === null) {
|
|
87
|
+
throw new Error("Missing the required parameter 'inputInfo' when calling apiDeveloperCreateAppPost");
|
|
88
|
+
}
|
|
89
|
+
var pathParams = {};
|
|
90
|
+
var queryParams = {};
|
|
91
|
+
var headerParams = {};
|
|
92
|
+
var formParams = {
|
|
93
|
+
'input_info': inputInfo,
|
|
94
|
+
'icon': opts['icon']
|
|
95
|
+
};
|
|
96
|
+
var authNames = [];
|
|
97
|
+
var contentTypes = ['multipart/form-data'];
|
|
98
|
+
var accepts = ['application/json'];
|
|
99
|
+
var returnType = Object;
|
|
100
|
+
return this.apiClient.callApi('/api/developer/create/app', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Callback function to receive the result of the apiDeveloperModifyAppPost operation.
|
|
105
|
+
* @callback module:api/DefaultApi~apiDeveloperModifyAppPostCallback
|
|
106
|
+
* @param {String} error Error message, if any.
|
|
107
|
+
* @param {Object} data The data returned by the service call.
|
|
108
|
+
* @param {String} response The complete HTTP response.
|
|
109
|
+
*/
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Modify Floorpod App
|
|
113
|
+
* Modify title, details or the app icon
|
|
114
|
+
* @param {String} inputInfo User ID, App ID, Title, Details. User ID and App ID are required parameters. Title/details are optional.
|
|
115
|
+
* @param {Object} opts Optional parameters
|
|
116
|
+
* @param {File} [file] Upload the new PNG icon file.
|
|
117
|
+
* @param {module:api/DefaultApi~apiDeveloperModifyAppPostCallback} callback The callback function, accepting three arguments: error, data, response
|
|
118
|
+
* data is of type: {@link Object}
|
|
119
|
+
*/
|
|
120
|
+
}, {
|
|
121
|
+
key: "apiDeveloperModifyAppPost",
|
|
122
|
+
value: function apiDeveloperModifyAppPost(inputInfo, opts, callback) {
|
|
123
|
+
opts = opts || {};
|
|
124
|
+
var postBody = null;
|
|
125
|
+
// verify the required parameter 'inputInfo' is set
|
|
126
|
+
if (inputInfo === undefined || inputInfo === null) {
|
|
127
|
+
throw new Error("Missing the required parameter 'inputInfo' when calling apiDeveloperModifyAppPost");
|
|
128
|
+
}
|
|
129
|
+
var pathParams = {};
|
|
130
|
+
var queryParams = {};
|
|
131
|
+
var headerParams = {};
|
|
132
|
+
var formParams = {
|
|
133
|
+
'input_info': inputInfo,
|
|
134
|
+
'file': opts['file']
|
|
135
|
+
};
|
|
136
|
+
var authNames = [];
|
|
137
|
+
var contentTypes = ['multipart/form-data'];
|
|
138
|
+
var accepts = ['application/json'];
|
|
139
|
+
var returnType = Object;
|
|
140
|
+
return this.apiClient.callApi('/api/developer/modify/app', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Callback function to receive the result of the changeEmail operation.
|
|
145
|
+
* @callback module:api/DefaultApi~changeEmailCallback
|
|
146
|
+
* @param {String} error Error message, if any.
|
|
147
|
+
* @param {Object} data The data returned by the service call.
|
|
148
|
+
* @param {String} response The complete HTTP response.
|
|
149
|
+
*/
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Change email ID
|
|
153
|
+
* Updates the email ID associated with an existing user account after validating a one-time activation code sent to the **new email address**. This operation can only be performed by a **logged-in user**. When a user initiates an email change, an activation code is sent to the newly provided email ID. The email update takes effect only after the activation code is successfully validated. If the activation code validation fails, the email ID remains unchanged. --- ### **Authentication** This endpoint requires **Bearer Token authentication**. ``` Authorization: Bearer <access_token> ``` --- ### **Request Body** ```json { \"user_id\": \"string\", \"new_email_id\": \"string\", \"activation_code\": \"string\", \"app_id\":\"string\" } ``` **Field Description** * `user_id` – Unique identifier of the logged-in user * `new_email_id` – New email address to be associated with the account * `activation_code` – One-time activation code sent to the new email ID for verification --- ### **Flow Summary** 1. User is authenticated and logged in 2. User requests to change email ID 3. System sends an activation code to the **new email address** 4. User submits the activation code via this API 5. On successful validation, the email ID is updated --- ### **Successful Response** On successful validation: * The activation code is verified * The user’s email ID is updated immediately * A `success` string is returned confirming the email change --- ### **Error Response** The API returns an error response if: * The activation code is invalid or expired * The activation code does not match the user or email * The new email ID is already in use * Authorization fails or the bearer token is missing or invalid In all error cases, the existing email ID remains unchanged. --- ### **Behavior Notes** * Requires a prior call to `/auth-service/send/validation/code` with the proper mode. --- ### **Security Notes (Recommended)** * Activation codes are single-use and time-bound * Email changes require prior authentication * Rate limiting may be applied to prevent abuse --- ### **One-Line Summary** > Changes a user’s email ID after validating an activation code sent to the new email address.
|
|
154
|
+
* @param {String} newEmailId New Email ID
|
|
155
|
+
* @param {String} activationCode Validation code
|
|
156
|
+
* @param {module:api/DefaultApi~changeEmailCallback} callback The callback function, accepting three arguments: error, data, response
|
|
157
|
+
* data is of type: {@link Object}
|
|
158
|
+
*/
|
|
159
|
+
}, {
|
|
75
160
|
key: "changeEmail",
|
|
76
161
|
value: function changeEmail(newEmailId, activationCode, callback) {
|
|
77
162
|
var postBody = null;
|
|
@@ -177,6 +262,84 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
177
262
|
return this.apiClient.callApi('/auth-service/password/change', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
178
263
|
}
|
|
179
264
|
|
|
265
|
+
/**
|
|
266
|
+
* Callback function to receive the result of the conversationThreads operation.
|
|
267
|
+
* @callback module:api/DefaultApi~conversationThreadsCallback
|
|
268
|
+
* @param {String} error Error message, if any.
|
|
269
|
+
* @param {module:model/ConversationThreads200Response} data The data returned by the service call.
|
|
270
|
+
* @param {String} response The complete HTTP response.
|
|
271
|
+
*/
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Get the conversational threads
|
|
275
|
+
* ### Conversation Model - A **Thread** represents a single conversational context. - A **Conversation** is the ordered exchange of messages within a thread. - Threads are scoped per user and per floor. This API retrieves the list of **conversational threads** associated with a specific **user** within a specific **floor**. A **thread** represents a persistent conversation context between the user and the system (agent/assistant) inside a floor. Each thread maintains its own history and state, allowing users to resume previous conversations without losing context. The API returns **only thread metadata**, not the message content itself. This makes it suitable for: * Displaying a conversation list or sidebar * Allowing users to select and resume past conversations * Managing conversational memory per floor --- ## Key Concepts * **Thread**: A long-lived conversational context tied to a user and a floor * **Floor-scoped memory**: Conversations are isolated per floor; threads from one floor are not visible in another * **User-specific**: Threads are private to the requesting user --- ## Request Method `GET` --- ## Request Parameters (Query Parameters) | Parameter Name | Type | Required | Description | | -------------- | ------ | -------- | ---------------------------------------------------------------------------- | | `user_id` | String | **Yes** | Unique identifier of the user whose conversation threads are being requested | | `floor_id` | String | **Yes** | Identifier of the floor in which the conversations exist | --- ## Authorization & Access Rules * The caller must be authenticated as the given `user_id` * A user can retrieve **only their own threads** * Threads are scoped to the provided `floor_id` * Threads from other floors or other users are not accessible --- ## Response Format `application/json` --- ## Response Description The response contains: * The `user_id` for which threads were fetched * A list of thread metadata objects, sorted by **most recently updated first** --- ## Response Structure ### Top-Level Fields | Field | Type | Description | | --------- | ------ | ------------------------------------------------------------------------- | | `user_id` | String | Identifier of the user | | `threads` | Array | List of conversation threads belonging to the user in the specified floor | --- ### Thread Object (`threads[]`) | Field | Type | Description | | -------------- | ------------------- | ------------------------------------------------- | | `thread_id` | String | Unique identifier of the conversation thread | | `title` | String | Human-readable title summarizing the conversation | | `last_updated` | String (YYYY-MM-DD) | Date when the thread was last updated | --- ## Sample Success Response ```json { \"user_id\": \"59\", \"threads\": [ { \"thread_id\": \"55\", \"title\": \"elegant potentially hopelessly ambitious sneak\", \"last_updated\": \"2025-04-26\" }, { \"thread_id\": \"79\", \"title\": \"sans profitable alienated by even overstay miserly practical\", \"last_updated\": \"2025-04-24\" }, { \"thread_id\": \"89\", \"title\": \"although light uh-huh despite instead vol sorrowful\", \"last_updated\": \"2025-02-16\" } ] } ``` --- ## Typical Use Cases * Show a **list of past conversations** in a chat UI * Allow users to **resume a previous thread** * Display conversation history grouped by floor * Build agent dashboards with user-specific memory --- ## Notes * This API returns **metadata only**; message history is retrieved using a separate thread-messages API * If no threads exist, the `threads` array will be empty * Thread titles may be system-generated or user-editable depending on implementation --- ## Common Error Responses (Examples) ### Missing Parameters ```json { \"status\": \"ERROR\", \"message\": \"user_id and floor_id are required\" } ``` ### Unauthorised Access ```json { \"status\": \"ERROR\", \"message\": \"Unauthorized access to conversation threads\" } ```
|
|
276
|
+
* @param {String} userId User ID
|
|
277
|
+
* @param {String} floorId Floor ID
|
|
278
|
+
* @param {module:api/DefaultApi~conversationThreadsCallback} callback The callback function, accepting three arguments: error, data, response
|
|
279
|
+
* data is of type: {@link module:model/ConversationThreads200Response}
|
|
280
|
+
*/
|
|
281
|
+
}, {
|
|
282
|
+
key: "conversationThreads",
|
|
283
|
+
value: function conversationThreads(userId, floorId, callback) {
|
|
284
|
+
var postBody = null;
|
|
285
|
+
// verify the required parameter 'userId' is set
|
|
286
|
+
if (userId === undefined || userId === null) {
|
|
287
|
+
throw new Error("Missing the required parameter 'userId' when calling conversationThreads");
|
|
288
|
+
}
|
|
289
|
+
// verify the required parameter 'floorId' is set
|
|
290
|
+
if (floorId === undefined || floorId === null) {
|
|
291
|
+
throw new Error("Missing the required parameter 'floorId' when calling conversationThreads");
|
|
292
|
+
}
|
|
293
|
+
var pathParams = {};
|
|
294
|
+
var queryParams = {
|
|
295
|
+
'user_id': userId,
|
|
296
|
+
'floor_id': floorId
|
|
297
|
+
};
|
|
298
|
+
var headerParams = {};
|
|
299
|
+
var formParams = {};
|
|
300
|
+
var authNames = ['bearer'];
|
|
301
|
+
var contentTypes = [];
|
|
302
|
+
var accepts = ['application/json'];
|
|
303
|
+
var returnType = _ConversationThreads200Response["default"];
|
|
304
|
+
return this.apiClient.callApi('/agent/memory/threads', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Callback function to receive the result of the getConversations operation.
|
|
309
|
+
* @callback module:api/DefaultApi~getConversationsCallback
|
|
310
|
+
* @param {String} error Error message, if any.
|
|
311
|
+
* @param {module:model/GetConversations200Response} data The data returned by the service call.
|
|
312
|
+
* @param {String} response The complete HTTP response.
|
|
313
|
+
*/
|
|
314
|
+
|
|
315
|
+
/**
|
|
316
|
+
* Conversations
|
|
317
|
+
* This API returns the **full conversation history** for a specific **thread** belonging to a user within a floor. A **thread** represents a persistent conversation session. Each item in the returned `conversation` array contains: * The **user request payload** (user query + context) * The **assistant response payload** (full LLM completion object) * The **retrieval trace** (metadata of posts fetched/used for the answer, including scores and identifiers) This endpoint is intended for **developers** building custom conversational UIs and tooling that require: * Full conversation replay * Debug visibility into the assistant output object (`choices`, model info, etc.) * RAG explainability via `fetch_multiple_posts.results[]` --- ## Request Method `GET` --- ## Query Parameters | Parameter | Type | Required | Description | | ----------- | ------ | -------- | --------------------------------------------------------------------------- | | `user_id` | String | **Yes** | Owner of the conversation thread. The thread must belong to this user. | | `floor_id` | String | **Yes** | Floor identifier in which the thread exists. Threads are scoped to a floor. | | `thread_id` | String | **Yes** | Thread identifier whose conversations should be returned. | --- ## Authorization & Access Rules * The caller must be authenticated as the given `user_id` (or have equivalent developer/system permission). * A user can access **only their own threads**. * Cross-user or cross-floor access must be rejected. --- ## Response Format `application/json` --- ## Response Description Returns the thread-level conversation payload: * `user_id`: the user who owns the thread * `thread_id`: the requested thread * `conversation`: ordered list of conversation entries (each entry = user object + assistant object) --- ## Response Schema ### Top-Level Fields | Field | Type | Description | | -------------- | ------ | ---------------------------- | | `user_id` | String | Owner of the thread | | `thread_id` | String | Thread identifier | | `conversation` | Array | List of conversation entries | --- ## `conversation[]` Entry Structure Each entry contains two objects: `user` and `assistant`. --- ### `user` Object | Field | Type | Description | | ------------------ | ------ | ------------------------------------------------------------------- | | `context` | Object | Context used when processing the query (floor metadata, mode, etc.) | | `user_query` | String | The user’s query message | | `user_id` | String | User identifier (should match top-level `user_id`) | | `user_thread` | String | Thread identifier (should match top-level `thread_id`) | | `recorded_content` | String | Persisted user content (often same as `user_query`) | #### `user.context` | Field | Type | Description | | ---------------- | ------ | ---------------------------------------------- | | `floor_id` | String | Floor UID/slug where the conversation occurred | | `title` | String | Floor title at the time of the query | | `fid` | String | Immutable internal floor ID | | `floor_category` | String | Floor category identifier | | `floor_mode` | String | Floor mode indicator (example: `\"1\"`) | --- ### `assistant` Object This contains the **full completion response** plus retrieval details. | Field | Type | Description | | ---------------------- | ------ | --------------------------------------------------- | | `id` | String | Completion id (e.g., `chatcmpl-*`) | | `object` | String | Response type (e.g., `chat.completion`) | | `created` | Number | Timestamp when response was created (epoch seconds) | | `floor_mode` | String | Floor mode applied for generation | | `model` | String | Model identifier used | | `choices` | Array | Generated outputs and metadata | | `fetch_multiple_posts` | Object | Retrieval trace (if retrieval was performed) | | `content_type` | String | Retrieved content type (e.g., `post`) | --- ## `assistant.choices[]` | Field | Type | Description | | ------------------ | ------ | -------------------------------------------------------------------------- | | `index` | Number | Choice index | | `message` | Object | Assistant message content | | `finish_reason` | String | Why generation stopped (`stop`, `length`, etc.) | | `ai_model_details` | Object | Model runtime parameters (temperature, top_p, max_tokens, penalties, etc.) | | `prompt_details` | Object | Prompt configuration used (system prompt, system_prompt_id, etc.) | > **Note:** `prompt_details.system_prompt` may be large and is returned as-is for developer inspection. --- ## `assistant.fetch_multiple_posts` Describes the retrieval operation performed for the query. | Field | Type | Description | | -------------- | ------ | -------------------------------------- | | `content_type` | String | Type of retrieved content (`post`) | | `query` | String | Query used for retrieval | | `status` | String | Retrieval status (`success`, `failed`) | | `message` | String | Retrieval message | | `results` | Array | List of matched posts and metadata | --- ## `assistant.fetch_multiple_posts.results[]` | Field | Type | Description | | ------------ | ------ | ----------------------------------------------------------------- | | `from_floor` | String | Indicates source floor relation (e.g., same floor / linked floor) | | `content` | String | Raw JSON string of the matched post metadata/content | | `author` | String | Author id of the matched post | | `block_type` | Number | Block type of the matched post | | `pid` | String | Post/document id | | `bid` | String | Block id containing the post | | `fid` | String | Floor internal id where the post belongs | | `score` | Number | Similarity score | | `match_type` | String | Match type (`text`, etc.) | --- ## Sample Success Response Your provided payload is the canonical example. It includes: * the user query and floor context * the full assistant completion object * the full retrieval results with post metadata * the response shown covers a few important items. --- ## Common Error Responses ### Missing Parameters ```json { \"status\": \"ERROR\", \"message\": \"user_id, floor_id, and thread_id are required\" } ``` ### Unauthorized Access ```json { \"status\": \"ERROR\", \"message\": \"Unauthorized access to thread\" } ``` ### Thread Not Found ```json { \"status\": \"ERROR\", \"message\": \"Thread not found\" } ``` --- ## Developer Notes (Important) * The `content` field inside retrieval results is a **stringified JSON**. Developers may parse it to access fields such as `post_title`, `post_details`, etc. * `choices` may contain multiple outputs depending on backend configuration. * This API returns a “full debug payload” suitable for developers. If you later create a lightweight UI endpoint, it should strip execution details and return only `user_query`, `assistant.content`, and curated post references.
|
|
318
|
+
* @param {Object} opts Optional parameters
|
|
319
|
+
* @param {String} [userId]
|
|
320
|
+
* @param {String} [threadId]
|
|
321
|
+
* @param {module:api/DefaultApi~getConversationsCallback} callback The callback function, accepting three arguments: error, data, response
|
|
322
|
+
* data is of type: {@link module:model/GetConversations200Response}
|
|
323
|
+
*/
|
|
324
|
+
}, {
|
|
325
|
+
key: "getConversations",
|
|
326
|
+
value: function getConversations(opts, callback) {
|
|
327
|
+
opts = opts || {};
|
|
328
|
+
var postBody = null;
|
|
329
|
+
var pathParams = {};
|
|
330
|
+
var queryParams = {
|
|
331
|
+
'user_id': opts['userId'],
|
|
332
|
+
'thread_id': opts['threadId']
|
|
333
|
+
};
|
|
334
|
+
var headerParams = {};
|
|
335
|
+
var formParams = {};
|
|
336
|
+
var authNames = ['bearer'];
|
|
337
|
+
var contentTypes = [];
|
|
338
|
+
var accepts = ['application/json'];
|
|
339
|
+
var returnType = _GetConversations200Response["default"];
|
|
340
|
+
return this.apiClient.callApi('/agent/memory/conversations', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
341
|
+
}
|
|
342
|
+
|
|
180
343
|
/**
|
|
181
344
|
* Callback function to receive the result of the makeFloorPrivate operation.
|
|
182
345
|
* @callback module:api/DefaultApi~makeFloorPrivateCallback
|
|
@@ -188,23 +351,33 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
188
351
|
/**
|
|
189
352
|
* Make floor Private
|
|
190
353
|
* This API changes a floor’s visibility to **PRIVATE**. It is used when a floor owner wants to **restrict access** to a floor that is currently public. After the update, the floor becomes private and is no longer accessible to non-authorized users (based on your platform’s access rules). This endpoint is **state-changing**: * If the floor is **PUBLIC**, it will be converted to **PRIVATE** * If the floor is already **PRIVATE**, the API returns success (idempotent) or an “already private” response depending on implementation This API is commonly used in: * Floor settings → “Privacy” toggle * Developer-managed pod workflows (app_id context) * Admin tools (if applicable) --- ## Request Method `POST` --- ## Content-Type `application/x-www-form-urlencoded` (or `multipart/form-data` if your system uses form-data) *(Document whichever you actually accept; below assumes standard form fields.)* --- ## Request Parameters (Form Fields) | Field | Type | Required | Description | | ---------- | ------ | -------- | -------------------------------------------------------------------- | | `user_id` | String | **Yes** | User requesting the change. Must be the **owner** of the floor. | | `floor_id` | String | **Yes** | Public identifier of the floor to update. | | `app_id` | String | No | Calling application identifier (used for developer/pod integration). | --- ## Authorization Rules (Critical) * The caller must be authenticated as `user_id` * **Only the floor owner** can change floor visibility * If the user is not the owner, the request must be rejected --- ## Behavior Rules * Converts visibility from **PUBLIC → PRIVATE** * Does not modify floor content or blocks * Access enforcement for private floors is applied immediately after the change **Idempotency** * Calling this API multiple times should not cause repeated changes * If already private, the API should either: * return success with a message like `\"already private\"`, or * return a specific error/status indicating no-op --- ## Response Format `application/json` --- ## Sample Success Response *(Example — adjust to match your actual response format)* ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PRIVATE\", \"message\": \"Floor is now private\" } ``` --- ## Sample No-Op Response (Already Private) ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PRIVATE\", \"message\": \"Floor is already private\" } ``` --- ## Error Responses (Examples) ### Not Authorized (Not Owner) ```json { \"status\": \"ERROR\", \"message\": \"Only the floor owner can change floor visibility\" } ``` ### Floor Not Found ```json { \"status\": \"ERROR\", \"message\": \"Floor not found\" } ``` ### Invalid Request ```json { \"status\": \"ERROR\", \"message\": \"user_id and floor_id are required\" } ``` --- ## Notes * This API is intended to control floor visibility only; membership/invite rules (for private floors) are handled elsewhere. * `app_id` is provided for developer/pod applications and is optional unless enforced by your app model. * If you support floor types like `POD`, document whether pods are allowed to be private or not (some platforms restrict this).
|
|
191
|
-
* @param {
|
|
192
|
-
* @param {String}
|
|
193
|
-
* @param {String}
|
|
194
|
-
* @param {String} [appId] App ID
|
|
354
|
+
* @param {String} floorId Floor ID
|
|
355
|
+
* @param {String} userId User ID
|
|
356
|
+
* @param {String} appId App ID
|
|
195
357
|
* @param {module:api/DefaultApi~makeFloorPrivateCallback} callback The callback function, accepting three arguments: error, data, response
|
|
196
358
|
* data is of type: {@link module:model/GetFloorInformation200Response}
|
|
197
359
|
*/
|
|
198
360
|
}, {
|
|
199
361
|
key: "makeFloorPrivate",
|
|
200
|
-
value: function makeFloorPrivate(
|
|
201
|
-
opts = opts || {};
|
|
362
|
+
value: function makeFloorPrivate(floorId, userId, appId, callback) {
|
|
202
363
|
var postBody = null;
|
|
364
|
+
// verify the required parameter 'floorId' is set
|
|
365
|
+
if (floorId === undefined || floorId === null) {
|
|
366
|
+
throw new Error("Missing the required parameter 'floorId' when calling makeFloorPrivate");
|
|
367
|
+
}
|
|
368
|
+
// verify the required parameter 'userId' is set
|
|
369
|
+
if (userId === undefined || userId === null) {
|
|
370
|
+
throw new Error("Missing the required parameter 'userId' when calling makeFloorPrivate");
|
|
371
|
+
}
|
|
372
|
+
// verify the required parameter 'appId' is set
|
|
373
|
+
if (appId === undefined || appId === null) {
|
|
374
|
+
throw new Error("Missing the required parameter 'appId' when calling makeFloorPrivate");
|
|
375
|
+
}
|
|
203
376
|
var pathParams = {};
|
|
204
377
|
var queryParams = {
|
|
205
|
-
'floor_id':
|
|
206
|
-
'user_id':
|
|
207
|
-
'app_id':
|
|
378
|
+
'floor_id': floorId,
|
|
379
|
+
'user_id': userId,
|
|
380
|
+
'app_id': appId
|
|
208
381
|
};
|
|
209
382
|
var headerParams = {};
|
|
210
383
|
var formParams = {};
|
|
@@ -226,23 +399,33 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
226
399
|
/**
|
|
227
400
|
* Make floor public
|
|
228
401
|
* This API changes a floor’s visibility to **PUBLIC**. It is used when a floor owner wants to **make a private floor accessible to everyone**. After the update, the floor becomes public and can be viewed and discovered by any user, subject to platform rules (search, feeds, pods, etc.). This endpoint performs a **visibility state transition**: * **PRIVATE → PUBLIC** * If the floor is already public, the operation is treated as **idempotent** (no state change). This API is typically used from: * Floor settings → Privacy / Visibility controls * Owner or admin tools * Developer or pod-based applications using `app_id` --- ## Request Method `POST` --- ## Content-Type `application/x-www-form-urlencoded` (or `multipart/form-data`, depending on your implementation) --- ## Request Parameters (Form Fields) | Field | Type | Required | Description | | ---------- | ------ | -------- | ------------------------------------------------------------------------------- | | `user_id` | String | **Yes** | User requesting the change. Must be the **owner** of the floor. | | `floor_id` | String | **Yes** | Public identifier of the floor whose visibility is to be changed. | | `app_id` | String | No | Identifier of the calling application (used mainly for pod/developer contexts). | --- ## Authorization Rules (Critical) * The caller must be authenticated as `user_id` * **Only the floor owner** is allowed to change the floor’s visibility * Requests from non-owners must be rejected --- ## Behavior Rules * Converts floor visibility from **PRIVATE → PUBLIC** * Does not modify floor content, blocks, or ownership * Visibility change takes effect immediately ### Idempotency * If the floor is already public, the API should: * Return success with a message indicating no change, or * Return a specific “already public” status (implementation-dependent) --- ## Response Format `application/json` --- ## Sample Success Response ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PUBLIC\", \"message\": \"Floor is now public\" } ``` --- ## Sample No-Op Response (Already Public) ```json { \"status\": \"SUCCESS\", \"floor_id\": \"my_floor\", \"visibility\": \"PUBLIC\", \"message\": \"Floor is already public\" } ``` --- ## Error Responses (Examples) ### Not Authorized (Not Owner) ```json { \"status\": \"ERROR\", \"message\": \"Only the floor owner can change floor visibility\" } ``` --- ### Floor Not Found ```json { \"status\": \"ERROR\", \"message\": \"Floor not found\" } ``` --- ### Invalid Request ```json { \"status\": \"ERROR\", \"message\": \"user_id and floor_id are required\" } ``` --- ## Notes for Developers * This API controls **visibility only**. Membership, invitations, and moderation rules are handled by separate APIs. * `app_id` is optional and primarily used for developer-managed or pod floors. * Clients should refresh floor metadata (e.g., via `/api/floor/info`) after a successful visibility change. --- ### Mental Model (One Line) > **This API answers: “Make this floor visible to everyone.”**
|
|
229
|
-
* @param {
|
|
230
|
-
* @param {String}
|
|
231
|
-
* @param {String}
|
|
232
|
-
* @param {String} [appId] App ID
|
|
402
|
+
* @param {String} floorId Floor ID
|
|
403
|
+
* @param {String} userId User ID
|
|
404
|
+
* @param {String} appId App ID
|
|
233
405
|
* @param {module:api/DefaultApi~makeFloorPublicCallback} callback The callback function, accepting three arguments: error, data, response
|
|
234
406
|
* data is of type: {@link module:model/GetFloorInformation200Response}
|
|
235
407
|
*/
|
|
236
408
|
}, {
|
|
237
409
|
key: "makeFloorPublic",
|
|
238
|
-
value: function makeFloorPublic(
|
|
239
|
-
opts = opts || {};
|
|
410
|
+
value: function makeFloorPublic(floorId, userId, appId, callback) {
|
|
240
411
|
var postBody = null;
|
|
412
|
+
// verify the required parameter 'floorId' is set
|
|
413
|
+
if (floorId === undefined || floorId === null) {
|
|
414
|
+
throw new Error("Missing the required parameter 'floorId' when calling makeFloorPublic");
|
|
415
|
+
}
|
|
416
|
+
// verify the required parameter 'userId' is set
|
|
417
|
+
if (userId === undefined || userId === null) {
|
|
418
|
+
throw new Error("Missing the required parameter 'userId' when calling makeFloorPublic");
|
|
419
|
+
}
|
|
420
|
+
// verify the required parameter 'appId' is set
|
|
421
|
+
if (appId === undefined || appId === null) {
|
|
422
|
+
throw new Error("Missing the required parameter 'appId' when calling makeFloorPublic");
|
|
423
|
+
}
|
|
241
424
|
var pathParams = {};
|
|
242
425
|
var queryParams = {
|
|
243
|
-
'floor_id':
|
|
244
|
-
'user_id':
|
|
245
|
-
'app_id':
|
|
426
|
+
'floor_id': floorId,
|
|
427
|
+
'user_id': userId,
|
|
428
|
+
'app_id': appId
|
|
246
429
|
};
|
|
247
430
|
var headerParams = {};
|
|
248
431
|
var formParams = {};
|
|
@@ -304,25 +487,39 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
304
487
|
/**
|
|
305
488
|
* Rename floor
|
|
306
489
|
* This API renames a floor by changing knowing the **floor identifier (floor_id)**. It allows the **floor owner** to update the public-facing floor ID (slug/handle) from an old value to a new value. This is typically used when the owner wants to rebrand, reorganize, or correct the floor’s identifier. ⚠️ **This operation affects how the floor is accessed and referenced externally**, so it must be performed carefully. --- ## Ownership & Authorization (Critical) * The caller **must be authenticated** * **Only the floor owner** is allowed to rename a floor * Members, followers, or non-owners **cannot** perform this operation * Ownership is validated internally using `user_id` > If the user is not the owner, the request must be rejected. --- ## Request Method `POST` --- ## Content-Type `application/x-www-form-urlencoded` (or equivalent form-data encoding) --- ## Request Parameters (Form Fields) | Parameter | Type | Required | Description | | --------- | ------ | -------- | ------------------------------------------------------------------------------- | | `user_id` | String | **Yes** | User requesting the rename. Must be the **owner** of the floor. | | `from` | String | **Yes** | Existing floor ID (current identifier to be renamed). | | `to` | String | **Yes** | New floor ID to assign to the floor. | | `app_id` | String | No | Identifier of the calling application (used mainly for pod/developer contexts). | --- ## Rename Rules & Constraints * The `from` floor ID **must exist** * The `to` floor ID **must be unique** and not already in use * The rename operation updates **only the floor ID** * Floor ownership, blocks, posts, and internal `fid` remain unchanged * Any links or references using the old floor ID may no longer be valid after rename --- ## Behavior Summary | Scenario | Result | | ---------------------------- | ------------------------------------------------- | | Valid owner + unique new ID | Floor ID renamed successfully | | Non-owner user | Request rejected | | `from` floor ID not found | Error | | `to` floor ID already exists | Error | | `from` == `to` | No-op or validation error (implementation choice) | --- ## Response Format `application/json` --- ## Sample Success Response ```json { \"status\": \"SUCCESS\", \"old_floor_id\": \"oldfloorid\", \"new_floor_id\": \"newfloorid\", \"message\": \"Floor ID renamed successfully\" } ``` --- ## Sample Error Responses ### Not Floor Owner ```json { \"status\": \"ERROR\", \"message\": \"Only the floor owner can rename the floor\" } ``` --- ### Floor Not Found ```json { \"status\": \"ERROR\", \"message\": \"Source floor ID does not exist\" } ``` --- ### Floor ID Already Exists ```json { \"status\": \"ERROR\", \"message\": \"Target floor ID is already in use\" } ``` --- ### Invalid Request ```json { \"status\": \"ERROR\", \"message\": \"user_id, from, and to are required\" } ``` --- ## Notes for Developers * This API **renames the public identifier only**; the internal immutable floor ID (`fid`) is not affected. * Clients should refresh cached floor metadata after a successful rename. * If your platform supports deep links or bookmarks, consider redirect or alias handling for old floor IDs (if supported). --- ### One-Line Mental Model > **This API answers: “Change the public identity (ID) of a floor, owner-only.”**
|
|
307
|
-
* @param {
|
|
308
|
-
* @param {String}
|
|
309
|
-
* @param {String}
|
|
310
|
-
* @param {String}
|
|
311
|
-
* @param {String} [to] New floor ID
|
|
490
|
+
* @param {String} userId User ID
|
|
491
|
+
* @param {String} appId App ID
|
|
492
|
+
* @param {String} from Old floor ID
|
|
493
|
+
* @param {String} to New floor ID
|
|
312
494
|
* @param {module:api/DefaultApi~renameFloorCallback} callback The callback function, accepting three arguments: error, data, response
|
|
313
495
|
* data is of type: {@link module:model/GetFloorInformation200Response}
|
|
314
496
|
*/
|
|
315
497
|
}, {
|
|
316
498
|
key: "renameFloor",
|
|
317
|
-
value: function renameFloor(
|
|
318
|
-
opts = opts || {};
|
|
499
|
+
value: function renameFloor(userId, appId, from, to, callback) {
|
|
319
500
|
var postBody = null;
|
|
501
|
+
// verify the required parameter 'userId' is set
|
|
502
|
+
if (userId === undefined || userId === null) {
|
|
503
|
+
throw new Error("Missing the required parameter 'userId' when calling renameFloor");
|
|
504
|
+
}
|
|
505
|
+
// verify the required parameter 'appId' is set
|
|
506
|
+
if (appId === undefined || appId === null) {
|
|
507
|
+
throw new Error("Missing the required parameter 'appId' when calling renameFloor");
|
|
508
|
+
}
|
|
509
|
+
// verify the required parameter 'from' is set
|
|
510
|
+
if (from === undefined || from === null) {
|
|
511
|
+
throw new Error("Missing the required parameter 'from' when calling renameFloor");
|
|
512
|
+
}
|
|
513
|
+
// verify the required parameter 'to' is set
|
|
514
|
+
if (to === undefined || to === null) {
|
|
515
|
+
throw new Error("Missing the required parameter 'to' when calling renameFloor");
|
|
516
|
+
}
|
|
320
517
|
var pathParams = {};
|
|
321
518
|
var queryParams = {
|
|
322
|
-
'user_id':
|
|
323
|
-
'app_id':
|
|
324
|
-
'from':
|
|
325
|
-
'to':
|
|
519
|
+
'user_id': userId,
|
|
520
|
+
'app_id': appId,
|
|
521
|
+
'from': from,
|
|
522
|
+
'to': to
|
|
326
523
|
};
|
|
327
524
|
var headerParams = {};
|
|
328
525
|
var formParams = {};
|
|
@@ -377,6 +574,48 @@ var DefaultApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
377
574
|
return this.apiClient.callApi('/auth-service/password/reset', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
378
575
|
}
|
|
379
576
|
|
|
577
|
+
/**
|
|
578
|
+
* Callback function to receive the result of the sendSignInValidationCode operation.
|
|
579
|
+
* @callback module:api/DefaultApi~sendSignInValidationCodeCallback
|
|
580
|
+
* @param {String} error Error message, if any.
|
|
581
|
+
* @param {module:model/SendSignInValidationCode200Response} data The data returned by the service call.
|
|
582
|
+
* @param {String} response The complete HTTP response.
|
|
583
|
+
*/
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Send Sign-In Validation Code (OTP)
|
|
587
|
+
* This API initiates the **sign-in validation process** by sending a **one-time validation code (OTP)** to the user. The OTP is delivered to **either the mobile number or the email address** provided in the request. This endpoint is typically called **before completing sign-in**, to verify that the user owns the supplied contact identifier. The calling application is responsible for: * Collecting the OTP from the user * Submitting it to the OTP verification API (handled separately) --- ## **Use Case** * User attempts to sign in * User provides **mobile number or email** * System sends a **validation code (OTP)** * User enters OTP to complete sign-in --- ## **Request Method** `POST` --- ## **Formdata Parameters** | Parameter Name | Type | Required | Description | | --------------- | ------ | --------- | ------------------------------------------- | | `mobile_number` | String | Optional* | Mobile number to which the OTP will be sent | | `email_id` | String | Optional* | Email address to which the OTP will be sent | | `app_id` | String | Optional | Identifier of the calling application | * **Either `mobile_number` or `email_id` must be provided.** Providing both is allowed; the system may choose one based on configuration. --- ## **Request Rules** * At least **one** of `mobile_number` or `email_id` is mandatory * If both are missing, the request will be rejected * OTP delivery channel depends on the provided identifier --- ## **Response Format** `application/json` --- ## **Sample Success Response** ```json { \"status\": \"SUCCESS\", \"message\": \"Validation code sent successfully\" } ``` --- ## **Sample Error Responses** ### Missing Identifier ```json { \"status\": \"ERROR\", \"message\": \"Either mobile_number or email_id must be provided\" } ``` ### Invalid Identifier ```json { \"status\": \"ERROR\", \"message\": \"Invalid mobile number or email address\" } ``` --- ## **Notes** * This API **only sends** the validation code * OTP verification must be performed using the corresponding **verify validation code** API * Rate limiting and retry restrictions may apply to prevent abuse
|
|
588
|
+
* @param {String} appId App ID
|
|
589
|
+
* @param {Object} opts Optional parameters
|
|
590
|
+
* @param {String} [mobileNumber] Mobile number
|
|
591
|
+
* @param {String} [emailId] Email ID
|
|
592
|
+
* @param {module:api/DefaultApi~sendSignInValidationCodeCallback} callback The callback function, accepting three arguments: error, data, response
|
|
593
|
+
* data is of type: {@link module:model/SendSignInValidationCode200Response}
|
|
594
|
+
*/
|
|
595
|
+
}, {
|
|
596
|
+
key: "sendSignInValidationCode",
|
|
597
|
+
value: function sendSignInValidationCode(appId, opts, callback) {
|
|
598
|
+
opts = opts || {};
|
|
599
|
+
var postBody = null;
|
|
600
|
+
// verify the required parameter 'appId' is set
|
|
601
|
+
if (appId === undefined || appId === null) {
|
|
602
|
+
throw new Error("Missing the required parameter 'appId' when calling sendSignInValidationCode");
|
|
603
|
+
}
|
|
604
|
+
var pathParams = {};
|
|
605
|
+
var queryParams = {};
|
|
606
|
+
var headerParams = {};
|
|
607
|
+
var formParams = {
|
|
608
|
+
'mobile_number': opts['mobileNumber'],
|
|
609
|
+
'email_id': opts['emailId'],
|
|
610
|
+
'app_id': appId
|
|
611
|
+
};
|
|
612
|
+
var authNames = ['bearer'];
|
|
613
|
+
var contentTypes = ['multipart/form-data'];
|
|
614
|
+
var accepts = ['application/json'];
|
|
615
|
+
var returnType = _SendSignInValidationCode200Response["default"];
|
|
616
|
+
return this.apiClient.callApi('/auth-service/send/sign/in/validation/code', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
|
|
617
|
+
}
|
|
618
|
+
|
|
380
619
|
/**
|
|
381
620
|
* Callback function to receive the result of the sendValidationCode operation.
|
|
382
621
|
* @callback module:api/DefaultApi~sendValidationCodeCallback
|
package/dist/api/EditFloorApi.js
CHANGED
|
@@ -15,7 +15,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
15
15
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
16
16
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
17
17
|
* Floor Memory
|
|
18
|
-
* The set APIs are used to develop Floor pds which can be used as their personal assistants.
|
|
18
|
+
* The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts.
|
|
19
|
+
* - Memory and
|
|
20
|
+
* - Registration. The developer has two ways of using the APIs for the app development. Developer can choose to the Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
|
|
19
21
|
*
|
|
20
22
|
* The version of the OpenAPI document: 1.0.0
|
|
21
23
|
* Contact: contact@ipomo.in
|
|
@@ -28,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
28
30
|
/**
|
|
29
31
|
* EditFloor service.
|
|
30
32
|
* @module api/EditFloorApi
|
|
31
|
-
* @version 1.0.
|
|
33
|
+
* @version 1.0.6
|
|
32
34
|
*/
|
|
33
35
|
var EditFloorApi = exports["default"] = /*#__PURE__*/function () {
|
|
34
36
|
/**
|
package/dist/api/EventApi.js
CHANGED
|
@@ -15,7 +15,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
15
15
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
16
16
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
17
17
|
* Floor Memory
|
|
18
|
-
* The set APIs are used to develop Floor pds which can be used as their personal assistants.
|
|
18
|
+
* The set APIs are used to develop Floor pds which can be used as their personal assistants. This set of APIs are divided into two parts.
|
|
19
|
+
* - Memory and
|
|
20
|
+
* - Registration. The developer has two ways of using the APIs for the app development. Developer can choose to the Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.
|
|
19
21
|
*
|
|
20
22
|
* The version of the OpenAPI document: 1.0.0
|
|
21
23
|
* Contact: contact@ipomo.in
|
|
@@ -28,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
28
30
|
/**
|
|
29
31
|
* Event service.
|
|
30
32
|
* @module api/EventApi
|
|
31
|
-
* @version 1.0.
|
|
33
|
+
* @version 1.0.6
|
|
32
34
|
*/
|
|
33
35
|
var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
34
36
|
/**
|
|
@@ -53,7 +55,7 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
53
55
|
|
|
54
56
|
/**
|
|
55
57
|
* Create Event (Post Content)
|
|
56
|
-
* Posts into the
|
|
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\": \"post\", \"user_id\": \"145623907625\", \"title\": \"My note\", \"description\": \"Things I should remember\", \"app_id\": \"165434879028\" } ``` --- ## 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., `post`, `note`, `reminder`). 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
|
|
57
59
|
* @param {String} inputInfo Input parameters, bid is optional
|
|
58
60
|
* @param {Object} opts Optional parameters
|
|
59
61
|
* @param {File} [files] Attach relevant media here, which includes, jpg, mp3, pdf, mp4 files. More than one media can be selected
|