xfloor-memory-sdk 1.0.13
Floor Memory
License: MIT
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, Floor Memory

# xfloor-memory-sdk
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. 
- Memory and 
- 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.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.13
- Generator version: 7.18.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://xfloor.ai/ipomo/blog1551084548304/](https://xfloor.ai/ipomo/blog1551084548304/)

### Requirements.

Python 3.9+

### Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import xfloor_memory_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import xfloor_memory_sdk
```

### Tests

Execute `pytest` to run the tests.

### Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import xfloor_memory_sdk
from xfloor_memory_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = xfloor_memory_sdk.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with xfloor_memory_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = xfloor_memory_sdk.DefaultApi(api_client)
    input_info = 'input_info_example' # str | 
    icon = None # bytearray |  (optional)

    try:
        # Create App
        api_response = api_instance.api_developer_create_app_post(input_info, icon=icon)
        print("The response of DefaultApi->api_developer_create_app_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->api_developer_create_app_post: %s\n" % e)

```

### Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class

| Method | HTTP request |

Description
------------

| ------------- | ------------- |

-------------
*DefaultApi*

| [**api_developer_create_app_post**](docs/DefaultApi.md#api_developer_create_app_post) | **POST** /api/developer/create/app |

Create App
*DefaultApi*

| [**api_developer_modify_app_post**](docs/DefaultApi.md#api_developer_modify_app_post) | **POST** /api/developer/modify/app |

Modify Floorpod App
*DefaultApi*

| [**change_email**](docs/DefaultApi.md#change_email) | **POST** /auth-service/change/email |

Change email ID
*DefaultApi*

| [**change_mobile_number**](docs/DefaultApi.md#change_mobile_number) | **POST** /auth-service/change/mobile |

Change Mobile number
*DefaultApi*

| [**change_password**](docs/DefaultApi.md#change_password) | **POST** /auth-service/password/change |

Change Password
*DefaultApi*

| [**conversation_threads**](docs/DefaultApi.md#conversation_threads) | **GET** /agent/memory/threads |

Get the conversational threads
*DefaultApi*

| [**get_conversations**](docs/DefaultApi.md#get_conversations) | **GET** /agent/memory/conversations |

Conversations
*DefaultApi*

| [**make_floor_private**](docs/DefaultApi.md#make_floor_private) | **POST** /api/memory/make/floor/private |

Make floor Private
*DefaultApi*

| [**make_floor_public**](docs/DefaultApi.md#make_floor_public) | **POST** /api/memory/make/floor/public |

Make floor public
*DefaultApi*

| [**register_external_user_identity**](docs/DefaultApi.md#register_external_user_identity) | **POST** /memory/identity/external-user |

External User Registration
*DefaultApi*

| [**rename_floor**](docs/DefaultApi.md#rename_floor) | **POST** /api/memory/change/floor/id |

Rename floor
*DefaultApi*

| [**reset_password**](docs/DefaultApi.md#reset_password) | **POST** /auth-service/password/reset |

Reset Password
*DefaultApi*

| [**send_sign_in_validation_code**](docs/DefaultApi.md#send_sign_in_validation_code) | **POST** /auth-service/send/sign/in/validation/code |

Send Sign-In Validation Code (OTP)
*DefaultApi*

| [**send_validation_code**](docs/DefaultApi.md#send_validation_code) | **POST** /auth-service/send/validation/code |

Send Validation code
*DefaultApi*

| [**sign_in_with_email**](docs/DefaultApi.md#sign_in_with_email) | **POST** /auth-service/sign/in/with/email |

Sign In with email ID
*DefaultApi*

| [**sign_in_with_mobile_number**](docs/DefaultApi.md#sign_in_with_mobile_number) | **POST** /auth-service/sign/in/with/mobile/number |

Sign In with Mobile number
*DefaultApi*

| [**sign_up**](docs/DefaultApi.md#sign_up) | **POST** /auth-service/sign/up |

Sign Up
*DefaultApi*

| [**validate_code**](docs/DefaultApi.md#validate_code) | **POST** /auth-service/validate/activation/code |

Validation
*EditFloorApi*

| [**edit_floor**](docs/EditFloorApi.md#edit_floor) | **POST** /api/memory/edit/floor/{floor_id} |

Edit floor
*EventApi*

| [**event**](docs/EventApi.md#event) | **POST** /api/memory/events |

Create Event (Post Content)
*GetFloorInformationApi*

| [**get_floor_information**](docs/GetFloorInformationApi.md#get_floor_information) | **GET** /api/memory/floor/info/{floor_id} |

Basic information of a floor
*GetRecentEventsApi*

| [**get_recent_events**](docs/GetRecentEventsApi.md#get_recent_events) | **GET** /api/memory/recent/events |

Recent Events
*QueryApi*

| [**query**](docs/QueryApi.md#query) | **POST** /agent/memory/query |

Query (Primary API)


### Documentation

For Models

 - [BlockDetails](docs/BlockDetails.md)
 - [ChangePassword200Response](docs/ChangePassword200Response.md)
 - [ConversationThreads200Response](docs/ConversationThreads200Response.md)
 - [ConversationThreads200ResponseThreadsInner](docs/ConversationThreads200ResponseThreadsInner.md)
 - [EditFloor400Response](docs/EditFloor400Response.md)
 - [EditFloor400ResponseError](docs/EditFloor400ResponseError.md)
 - [Event400Response](docs/Event400Response.md)
 - [Event400ResponseError](docs/Event400ResponseError.md)
 - [EventResponse](docs/EventResponse.md)
 - [FloorInfo](docs/FloorInfo.md)
 - [GetConversations200Response](docs/GetConversations200Response.md)
 - [GetConversations200ResponseConversationInner](docs/GetConversations200ResponseConversationInner.md)
 - [GetConversations200ResponseConversationInnerAssistant](docs/GetConversations200ResponseConversationInnerAssistant.md)
 - [GetConversations200ResponseConversationInnerAssistantChoicesInner](docs/GetConversations200ResponseConversationInnerAssistantChoicesInner.md)
 - [GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerAiModelDetails.md)
 - [GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerMessage.md)
 - [GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails](docs/GetConversations200ResponseConversationInnerAssistantChoicesInnerPromptDetails.md)
 - [GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts](docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePosts.md)
 - [GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner](docs/GetConversations200ResponseConversationInnerAssistantFetchMultiplePostsResultsInner.md)
 - [GetConversations200ResponseConversationInnerUser](docs/GetConversations200ResponseConversationInnerUser.md)
 - [GetConversations200ResponseConversationInnerUserContext](docs/GetConversations200ResponseConversationInnerUserContext.md)
 - [GetFloorInformation200Response](docs/GetFloorInformation200Response.md)
 - [GetRecentEvents200Response](docs/GetRecentEvents200Response.md)
 - [GetRecentEvents200ResponseItemsInner](docs/GetRecentEvents200ResponseItemsInner.md)
 - [GetRecentEvents200ResponseItemsInnerAuthor](docs/GetRecentEvents200ResponseItemsInnerAuthor.md)
 - [GetRecentEvents400Response](docs/GetRecentEvents400Response.md)
 - [GetRecentEvents400ResponseError](docs/GetRecentEvents400ResponseError.md)
 - [Media](docs/Media.md)
 - [Model400ErrorCode](docs/Model400ErrorCode.md)
 - [PostAdd](docs/PostAdd.md)
 - [Query422Response](docs/Query422Response.md)
 - [Query422ResponseError](docs/Query422ResponseError.md)
 - [QueryRequest](docs/QueryRequest.md)
 - [QueryRequestFilters](docs/QueryRequestFilters.md)
 - [QueryResponse](docs/QueryResponse.md)
 - [QueryResponseItemsInner](docs/QueryResponseItemsInner.md)
 - [ResetPassword200Response](docs/ResetPassword200Response.md)
 - [ResetPassword400Response](docs/ResetPassword400Response.md)
 - [SendSignInValidationCode200Response](docs/SendSignInValidationCode200Response.md)
 - [SendValidationCode200Response](docs/SendValidationCode200Response.md)
 - [SendValidationCodeRequest](docs/SendValidationCodeRequest.md)
 - [SignInWithEmail200Response](docs/SignInWithEmail200Response.md)
 - [SignInWithEmail200ResponsePodInfo](docs/SignInWithEmail200ResponsePodInfo.md)
 - [SignInWithEmail200ResponseProfile](docs/SignInWithEmail200ResponseProfile.md)
 - [SignInWithEmail200ResponseProfileAvatar](docs/SignInWithEmail200ResponseProfileAvatar.md)
 - [SignUp200Response](docs/SignUp200Response.md)
 - [SignUpResponse](docs/SignUpResponse.md)
 - [Threads](docs/Threads.md)
 - [UserDetails](docs/UserDetails.md)
 - [ValidateCode400Response](docs/ValidateCode400Response.md)
 - [ValidateCode400ResponseError](docs/ValidateCode400ResponseError.md)
 - [ValidateCode412Response](docs/ValidateCode412Response.md)
 - [ValidateCodeRequest](docs/ValidateCodeRequest.md)


<a id="documentation-for-authorization"></a>
### Documentation

For Authorization


Authentication schemes defined for the API:
<a id="bearer"></a>
### bearer

- **Type**: Bearer authentication


### Author

contact@ipomo.in




<!-- xfloor:platform-notes:start -->
## Platform Notes (macOS, Linux, Windows)

### macOS / Linux
Use `python3` for Python commands:

```bash
python3 -m pip install --upgrade pip
python3 -m pip install .
python3 setup.py install --user
```

### Windows (PowerShell or CMD)
Use `python` for Python commands:

```powershell
python -m pip install --upgrade pip
python -m pip install .
python setup.py install --user
```

If `python` is not available on your Windows PATH, use `py` instead.
<!-- xfloor:platform-notes:end -->