# ai-assistant-server-connector
Mentortools service for ai interactions

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

- API version: 0.1.0
- Package version: 1.3.1+2484675028
- Generator version: 7.21.0
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

## Requirements.

Python 3.7+

## 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 ai_assistant_server_connector
```

### 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 ai_assistant_server_connector
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import time
import ai_assistant_server_connector
from ai_assistant_server_connector.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKeyHeader
configuration.api_key['APIKeyHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyHeader'] = 'Bearer'

# Configure Bearer authorization: HTTPBearer
configuration = ai_assistant_server_connector.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with ai_assistant_server_connector.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ai_assistant_server_connector.AiAssistantApiApi(api_client)
    ai_assistant_new = ai_assistant_server_connector.AiAssistantNew() # AiAssistantNew | 

    try:
        # Assistant Add
        api_response = await api_instance.ai_assistant_api_assistant_add(ai_assistant_new)
        print("The response of AiAssistantApiApi->ai_assistant_api_assistant_add:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AiAssistantApiApi->ai_assistant_api_assistant_add: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to */ai_assistant_api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AiAssistantApiApi* | [**ai_assistant_api_assistant_add**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_add) | **POST** /assistants/v1/ | Assistant Add
*AiAssistantApiApi* | [**ai_assistant_api_assistant_delete**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_delete) | **DELETE** /assistants/v1/{assistant_id} | Assistant Delete
*AiAssistantApiApi* | [**ai_assistant_api_assistant_get**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_get) | **GET** /assistants/v1/{assistant_id} | Assistant Get
*AiAssistantApiApi* | [**ai_assistant_api_assistant_primary_get**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_primary_get) | **GET** /assistants/v1/primary | Assistant Primary Get
*AiAssistantApiApi* | [**ai_assistant_api_assistant_primary_goals_engagement_add**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_primary_goals_engagement_add) | **POST** /assistants/v1/primary/engagement | Assistant Primary Goals Engagement Add
*AiAssistantApiApi* | [**ai_assistant_api_assistant_primary_goals_get**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_primary_goals_get) | **GET** /assistants/v1/primary/goals | Assistant Primary Goals Get
*AiAssistantApiApi* | [**ai_assistant_api_assistant_primary_update**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_primary_update) | **PUT** /assistants/v1/primary | Assistant Primary Update
*AiAssistantApiApi* | [**ai_assistant_api_assistant_response_stream**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_response_stream) | **POST** /assistants/v1/{assistant_id}/response/stream | Assistant Response Stream
*AiAssistantApiApi* | [**ai_assistant_api_assistant_run_cancel**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_run_cancel) | **POST** /assistants/v1/{assistant_id}/run/{run_id}/cancel | Assistant Run Cancel
*AiAssistantApiApi* | [**ai_assistant_api_assistant_session_start**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_session_start) | **POST** /assistants/v1/{assistant_id}/session/start | Assistant Session Start
*AiAssistantApiApi* | [**ai_assistant_api_assistant_shared_primary_get**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_shared_primary_get) | **GET** /assistants/v1/shared/primary | Assistant Shared Primary Get
*AiAssistantApiApi* | [**ai_assistant_api_assistant_shared_primary_update**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_shared_primary_update) | **PUT** /assistants/v1/shared/primary | Assistant Shared Primary Update
*AiAssistantApiApi* | [**ai_assistant_api_assistant_update**](docs/AiAssistantApiApi.md#ai_assistant_api_assistant_update) | **PUT** /assistants/v1/{assistant_id} | Assistant Update
*AiAssistantApiApi* | [**ai_assistant_api_assitants_list**](docs/AiAssistantApiApi.md#ai_assistant_api_assitants_list) | **GET** /assistants/v1/ | Assitants List
*AiAssistantApiApi* | [**ai_assistant_api_avatars_list**](docs/AiAssistantApiApi.md#ai_assistant_api_avatars_list) | **GET** /avatars/v1/ | Avatars List
*AiAssistantApiApi* | [**ai_assistant_api_engagement_preset_list**](docs/AiAssistantApiApi.md#ai_assistant_api_engagement_preset_list) | **GET** /goal_engagement_presets/v1/ | Engagement Preset List
*AiAssistantApiApi* | [**ai_assistant_api_rag_query**](docs/AiAssistantApiApi.md#ai_assistant_api_rag_query) | **GET** /rag/v1/query | Rag Query
*AiAssistantApiApi* | [**ai_assistant_api_server_assistant_list**](docs/AiAssistantApiApi.md#ai_assistant_api_server_assistant_list) | **GET** /server/assistants/v1/ | Server Assistant List
*AiAssistantApiApi* | [**ai_assistant_api_server_assistant_setup_from_root**](docs/AiAssistantApiApi.md#ai_assistant_api_server_assistant_setup_from_root) | **POST** /server/assistants/v1/tss/setup | Server Assistant Setup From Root
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_custom_skill_create**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_custom_skill_create) | **POST** /assistants/v1/shared/primary/settings/custom_skills | Shared Primary Custom Skill Create
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_custom_skill_delete**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_custom_skill_delete) | **DELETE** /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Delete
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_custom_skill_patch**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_custom_skill_patch) | **PATCH** /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Patch
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_custom_skill_update**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_custom_skill_update) | **PUT** /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Update
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_custom_skills_get**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_custom_skills_get) | **GET** /assistants/v1/shared/primary/settings/custom_skills | Shared Primary Custom Skills Get
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_skill_settings_get**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_skill_settings_get) | **GET** /assistants/v1/shared/primary/settings/skills | Shared Primary Skill Settings Get
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_skill_toggle**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_skill_toggle) | **PATCH** /assistants/v1/shared/primary/settings/skills | Shared Primary Skill Toggle
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_tool_settings_get**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_tool_settings_get) | **GET** /assistants/v1/shared/primary/settings/tools | Shared Primary Tool Settings Get
*AiAssistantApiApi* | [**ai_assistant_api_shared_primary_tool_toggle**](docs/AiAssistantApiApi.md#ai_assistant_api_shared_primary_tool_toggle) | **PATCH** /assistants/v1/shared/primary/settings/tools | Shared Primary Tool Toggle
*AiAssistantApiApi* | [**ai_assistant_api_voices_list**](docs/AiAssistantApiApi.md#ai_assistant_api_voices_list) | **GET** /voices/v1/ | Voices List
*AssistantsApi* | [**ai_assistant_api_assistant_add**](docs/AssistantsApi.md#ai_assistant_api_assistant_add) | **POST** /assistants/v1/ | Assistant Add
*AssistantsApi* | [**ai_assistant_api_assistant_delete**](docs/AssistantsApi.md#ai_assistant_api_assistant_delete) | **DELETE** /assistants/v1/{assistant_id} | Assistant Delete
*AssistantsApi* | [**ai_assistant_api_assistant_get**](docs/AssistantsApi.md#ai_assistant_api_assistant_get) | **GET** /assistants/v1/{assistant_id} | Assistant Get
*AssistantsApi* | [**ai_assistant_api_assistant_primary_get**](docs/AssistantsApi.md#ai_assistant_api_assistant_primary_get) | **GET** /assistants/v1/primary | Assistant Primary Get
*AssistantsApi* | [**ai_assistant_api_assistant_primary_goals_engagement_add**](docs/AssistantsApi.md#ai_assistant_api_assistant_primary_goals_engagement_add) | **POST** /assistants/v1/primary/engagement | Assistant Primary Goals Engagement Add
*AssistantsApi* | [**ai_assistant_api_assistant_primary_goals_get**](docs/AssistantsApi.md#ai_assistant_api_assistant_primary_goals_get) | **GET** /assistants/v1/primary/goals | Assistant Primary Goals Get
*AssistantsApi* | [**ai_assistant_api_assistant_primary_update**](docs/AssistantsApi.md#ai_assistant_api_assistant_primary_update) | **PUT** /assistants/v1/primary | Assistant Primary Update
*AssistantsApi* | [**ai_assistant_api_assistant_response_stream**](docs/AssistantsApi.md#ai_assistant_api_assistant_response_stream) | **POST** /assistants/v1/{assistant_id}/response/stream | Assistant Response Stream
*AssistantsApi* | [**ai_assistant_api_assistant_run_cancel**](docs/AssistantsApi.md#ai_assistant_api_assistant_run_cancel) | **POST** /assistants/v1/{assistant_id}/run/{run_id}/cancel | Assistant Run Cancel
*AssistantsApi* | [**ai_assistant_api_assistant_session_start**](docs/AssistantsApi.md#ai_assistant_api_assistant_session_start) | **POST** /assistants/v1/{assistant_id}/session/start | Assistant Session Start
*AssistantsApi* | [**ai_assistant_api_assistant_shared_primary_get**](docs/AssistantsApi.md#ai_assistant_api_assistant_shared_primary_get) | **GET** /assistants/v1/shared/primary | Assistant Shared Primary Get
*AssistantsApi* | [**ai_assistant_api_assistant_shared_primary_update**](docs/AssistantsApi.md#ai_assistant_api_assistant_shared_primary_update) | **PUT** /assistants/v1/shared/primary | Assistant Shared Primary Update
*AssistantsApi* | [**ai_assistant_api_assistant_update**](docs/AssistantsApi.md#ai_assistant_api_assistant_update) | **PUT** /assistants/v1/{assistant_id} | Assistant Update
*AssistantsApi* | [**ai_assistant_api_assitants_list**](docs/AssistantsApi.md#ai_assistant_api_assitants_list) | **GET** /assistants/v1/ | Assitants List
*AssistantsApi* | [**ai_assistant_api_shared_primary_custom_skill_create**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_custom_skill_create) | **POST** /assistants/v1/shared/primary/settings/custom_skills | Shared Primary Custom Skill Create
*AssistantsApi* | [**ai_assistant_api_shared_primary_custom_skill_delete**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_custom_skill_delete) | **DELETE** /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Delete
*AssistantsApi* | [**ai_assistant_api_shared_primary_custom_skill_patch**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_custom_skill_patch) | **PATCH** /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Patch
*AssistantsApi* | [**ai_assistant_api_shared_primary_custom_skill_update**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_custom_skill_update) | **PUT** /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Update
*AssistantsApi* | [**ai_assistant_api_shared_primary_custom_skills_get**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_custom_skills_get) | **GET** /assistants/v1/shared/primary/settings/custom_skills | Shared Primary Custom Skills Get
*AssistantsApi* | [**ai_assistant_api_shared_primary_skill_settings_get**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_skill_settings_get) | **GET** /assistants/v1/shared/primary/settings/skills | Shared Primary Skill Settings Get
*AssistantsApi* | [**ai_assistant_api_shared_primary_skill_toggle**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_skill_toggle) | **PATCH** /assistants/v1/shared/primary/settings/skills | Shared Primary Skill Toggle
*AssistantsApi* | [**ai_assistant_api_shared_primary_tool_settings_get**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_tool_settings_get) | **GET** /assistants/v1/shared/primary/settings/tools | Shared Primary Tool Settings Get
*AssistantsApi* | [**ai_assistant_api_shared_primary_tool_toggle**](docs/AssistantsApi.md#ai_assistant_api_shared_primary_tool_toggle) | **PATCH** /assistants/v1/shared/primary/settings/tools | Shared Primary Tool Toggle
*AssistantsServerApi* | [**ai_assistant_api_server_assistant_list**](docs/AssistantsServerApi.md#ai_assistant_api_server_assistant_list) | **GET** /server/assistants/v1/ | Server Assistant List
*AssistantsServerApi* | [**ai_assistant_api_server_assistant_setup_from_root**](docs/AssistantsServerApi.md#ai_assistant_api_server_assistant_setup_from_root) | **POST** /server/assistants/v1/tss/setup | Server Assistant Setup From Root
*AvatarsApi* | [**ai_assistant_api_avatars_list**](docs/AvatarsApi.md#ai_assistant_api_avatars_list) | **GET** /avatars/v1/ | Avatars List
*DefaultApi* | [**default_health_check**](docs/DefaultApi.md#default_health_check) | **GET** / | Health Check
*GoalEngagementPresetsApi* | [**ai_assistant_api_engagement_preset_list**](docs/GoalEngagementPresetsApi.md#ai_assistant_api_engagement_preset_list) | **GET** /goal_engagement_presets/v1/ | Engagement Preset List
*RagApi* | [**ai_assistant_api_rag_query**](docs/RagApi.md#ai_assistant_api_rag_query) | **GET** /rag/v1/query | Rag Query
*ServerApi* | [**ai_assistant_api_server_assistant_list**](docs/ServerApi.md#ai_assistant_api_server_assistant_list) | **GET** /server/assistants/v1/ | Server Assistant List
*ServerApi* | [**ai_assistant_api_server_assistant_setup_from_root**](docs/ServerApi.md#ai_assistant_api_server_assistant_setup_from_root) | **POST** /server/assistants/v1/tss/setup | Server Assistant Setup From Root
*VoicesApi* | [**ai_assistant_api_voices_list**](docs/VoicesApi.md#ai_assistant_api_voices_list) | **GET** /voices/v1/ | Voices List


## Documentation For Models

 - [AIAssistantReponseStreamRequest](docs/AIAssistantReponseStreamRequest.md)
 - [AIAssistantSessionStart](docs/AIAssistantSessionStart.md)
 - [AiAssistantCustomSkillCreate](docs/AiAssistantCustomSkillCreate.md)
 - [AiAssistantCustomSkillGet](docs/AiAssistantCustomSkillGet.md)
 - [AiAssistantCustomSkillPatch](docs/AiAssistantCustomSkillPatch.md)
 - [AiAssistantCustomSkillUpdate](docs/AiAssistantCustomSkillUpdate.md)
 - [AiAssistantGet](docs/AiAssistantGet.md)
 - [AiAssistantGoalCreate](docs/AiAssistantGoalCreate.md)
 - [AiAssistantGoalCreateUpdate](docs/AiAssistantGoalCreateUpdate.md)
 - [AiAssistantGoalGet](docs/AiAssistantGoalGet.md)
 - [AiAssistantLexiconItem](docs/AiAssistantLexiconItem.md)
 - [AiAssistantLexiconItemCreateOrUpdate](docs/AiAssistantLexiconItemCreateOrUpdate.md)
 - [AiAssistantLexiconItemNew](docs/AiAssistantLexiconItemNew.md)
 - [AiAssistantListGet](docs/AiAssistantListGet.md)
 - [AiAssistantNew](docs/AiAssistantNew.md)
 - [AiAssistantSettingToggle](docs/AiAssistantSettingToggle.md)
 - [AiAssistantSetupFromRoot](docs/AiAssistantSetupFromRoot.md)
 - [AiAssistantSkillSettingGet](docs/AiAssistantSkillSettingGet.md)
 - [AiAssistantToolSettingGet](docs/AiAssistantToolSettingGet.md)
 - [AiAssistantUpdate](docs/AiAssistantUpdate.md)
 - [AssistantFunction](docs/AssistantFunction.md)
 - [AvatarOptionGet](docs/AvatarOptionGet.md)
 - [ChatHistoryChatContent](docs/ChatHistoryChatContent.md)
 - [ChatHistoryItem](docs/ChatHistoryItem.md)
 - [ChatMessageAttachment](docs/ChatMessageAttachment.md)
 - [ChatMessageAttachmentType](docs/ChatMessageAttachmentType.md)
 - [ChatRole](docs/ChatRole.md)
 - [CollectionState](docs/CollectionState.md)
 - [CollectionStatus](docs/CollectionStatus.md)
 - [ConversationStyle](docs/ConversationStyle.md)
 - [CourseModulePublic](docs/CourseModulePublic.md)
 - [CoursePaymentTypeStrEnum](docs/CoursePaymentTypeStrEnum.md)
 - [CoursePublic](docs/CoursePublic.md)
 - [EmphemeralCredentials](docs/EmphemeralCredentials.md)
 - [GoalEngagementPresetGet](docs/GoalEngagementPresetGet.md)
 - [GoalInteractionsSummary](docs/GoalInteractionsSummary.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [InteractionType](docs/InteractionType.md)
 - [KnowledgebaseState](docs/KnowledgebaseState.md)
 - [LanguageStrEnum](docs/LanguageStrEnum.md)
 - [LocationInner](docs/LocationInner.md)
 - [ModuleLessonPublic](docs/ModuleLessonPublic.md)
 - [PortalInfoRequest](docs/PortalInfoRequest.md)
 - [PortalOwnerInfo](docs/PortalOwnerInfo.md)
 - [RagQueryResponse](docs/RagQueryResponse.md)
 - [ResponseChunk](docs/ResponseChunk.md)
 - [ResponseChunkType](docs/ResponseChunkType.md)
 - [ResponseWrapper](docs/ResponseWrapper.md)
 - [ResponseWrapperAIAssistantSessionStart](docs/ResponseWrapperAIAssistantSessionStart.md)
 - [ResponseWrapperAiAssistantGet](docs/ResponseWrapperAiAssistantGet.md)
 - [ResponseWrapperBool](docs/ResponseWrapperBool.md)
 - [ResponseWrapperInt](docs/ResponseWrapperInt.md)
 - [ResponseWrapperListAiAssistantCustomSkillGet](docs/ResponseWrapperListAiAssistantCustomSkillGet.md)
 - [ResponseWrapperListAiAssistantGoalGet](docs/ResponseWrapperListAiAssistantGoalGet.md)
 - [ResponseWrapperListAiAssistantListGet](docs/ResponseWrapperListAiAssistantListGet.md)
 - [ResponseWrapperListAiAssistantSkillSettingGet](docs/ResponseWrapperListAiAssistantSkillSettingGet.md)
 - [ResponseWrapperListAiAssistantToolSettingGet](docs/ResponseWrapperListAiAssistantToolSettingGet.md)
 - [ResponseWrapperListAvatarOptionGet](docs/ResponseWrapperListAvatarOptionGet.md)
 - [ResponseWrapperListGoalEngagementPresetGet](docs/ResponseWrapperListGoalEngagementPresetGet.md)
 - [ResponseWrapperListVoiceOptionGet](docs/ResponseWrapperListVoiceOptionGet.md)
 - [ResponseWrapperRagQueryResponse](docs/ResponseWrapperRagQueryResponse.md)
 - [Result](docs/Result.md)
 - [Score](docs/Score.md)
 - [SearchResult](docs/SearchResult.md)
 - [UsageDetails](docs/UsageDetails.md)
 - [UserGoalInteractionCreate](docs/UserGoalInteractionCreate.md)
 - [ValidationError](docs/ValidationError.md)
 - [VoiceOptionGet](docs/VoiceOptionGet.md)


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


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

- **Type**: API key
- **API key parameter name**: server_name
- **Location**: HTTP header

<a id="HTTPBearer"></a>
### HTTPBearer

- **Type**: Bearer authentication


## Author




