mentortools/libs/: ai-assistant-server-connector-v2-1.3.1+2522384408 metadata and description
Mentortools AI API
| author | OpenAPI Generator community |
| author_email | OpenAPI Generator Community <team@openapitools.org> |
| description_content_type | text/markdown |
| keywords | OpenAPI, OpenAPI-Generator, Mentortools AI API |
| project_urls |
|
| requires_dist |
|
| requires_python | >=3.9 |
| File | Tox results | History |
|---|---|---|
ai_assistant_server_connector_v2-1.3.1+2522384408-py3-none-any.whl
|
|
|
ai_assistant_server_connector_v2-1.3.1+2522384408.tar.gz
|
|
ai-assistant-server-connector-v2
Mentortools service for ai interactions
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.1.0
- Package version: 1.3.1+2522384408
- Generator version: 7.22.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.10+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
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:
import ai_assistant_server_connector_v2
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import ai_assistant_server_connector_v2
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import ai_assistant_server_connector_v2
from ai_assistant_server_connector_v2.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_v2.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_v2.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
async with ai_assistant_server_connector_v2.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ai_assistant_server_connector_v2.AiAssistantApiApi(api_client)
ai_assistant_new = ai_assistant_server_connector_v2.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 | POST /assistants/v1/ | Assistant Add |
| AiAssistantApiApi | ai_assistant_api_assistant_delete | DELETE /assistants/v1/{assistant_id} | Assistant Delete |
| AiAssistantApiApi | ai_assistant_api_assistant_get | GET /assistants/v1/{assistant_id} | Assistant Get |
| AiAssistantApiApi | ai_assistant_api_assistant_landing_primary_get | GET /assistants/v1/landing/primary | Assistant Landing Primary Get |
| AiAssistantApiApi | ai_assistant_api_assistant_landing_primary_update | PUT /assistants/v1/landing/primary | Assistant Landing Primary Update |
| AiAssistantApiApi | ai_assistant_api_assistant_primary_get | GET /assistants/v1/primary | Assistant Primary Get |
| AiAssistantApiApi | 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 | GET /assistants/v1/primary/goals | Assistant Primary Goals Get |
| AiAssistantApiApi | ai_assistant_api_assistant_primary_update | PUT /assistants/v1/primary | Assistant Primary Update |
| AiAssistantApiApi | ai_assistant_api_assistant_response_stream | POST /assistants/v1/{assistant_id}/response/stream | Assistant Response Stream |
| AiAssistantApiApi | 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 | POST /assistants/v1/{assistant_id}/session/start | Assistant Session Start |
| AiAssistantApiApi | ai_assistant_api_assistant_shared_primary_get | GET /assistants/v1/shared/primary | Assistant Shared Primary Get |
| AiAssistantApiApi | ai_assistant_api_assistant_shared_primary_update | PUT /assistants/v1/shared/primary | Assistant Shared Primary Update |
| AiAssistantApiApi | ai_assistant_api_assistant_update | PUT /assistants/v1/{assistant_id} | Assistant Update |
| AiAssistantApiApi | ai_assistant_api_assitants_list | GET /assistants/v1/ | Assitants List |
| AiAssistantApiApi | ai_assistant_api_avatars_list | GET /avatars/v1/ | Avatars List |
| AiAssistantApiApi | ai_assistant_api_clear_all_facts | DELETE /memory/v1/facts | Clear All Facts |
| AiAssistantApiApi | ai_assistant_api_clear_profile | DELETE /memory/v1/profile | Clear Profile |
| AiAssistantApiApi | ai_assistant_api_count_facts | GET /memory/v1/facts/count | Count Facts |
| AiAssistantApiApi | ai_assistant_api_delete_fact | DELETE /memory/v1/facts/{fact_id} | Delete Fact |
| AiAssistantApiApi | ai_assistant_api_delete_profile_key | DELETE /memory/v1/profile/keys/{key} | Delete Profile Key |
| AiAssistantApiApi | ai_assistant_api_engagement_preset_list | GET /goal_engagement_presets/v1/ | Engagement Preset List |
| AiAssistantApiApi | ai_assistant_api_get_profile | GET /memory/v1/profile | Get Profile |
| AiAssistantApiApi | ai_assistant_api_list_facts | GET /memory/v1/facts | List Facts |
| AiAssistantApiApi | ai_assistant_api_memory_forget_facts | POST /memory/v1/facts/forget | Memory Forget Facts |
| AiAssistantApiApi | ai_assistant_api_memory_ingest | POST /memory/v1/ingest | Memory Ingest |
| AiAssistantApiApi | ai_assistant_api_memory_record_fact | POST /memory/v1/facts/record | Memory Record Fact |
| AiAssistantApiApi | ai_assistant_api_portal_ai_info_get | GET /portal_ai_info/v1/ | Portal Ai Info Get |
| AiAssistantApiApi | ai_assistant_api_portal_ai_info_update | PUT /portal_ai_info/v1/ | Portal Ai Info Update |
| AiAssistantApiApi | ai_assistant_api_rag_query | GET /rag/v1/query | Rag Query |
| AiAssistantApiApi | ai_assistant_api_server_assistant_list | GET /server/assistants/v1/ | Server Assistant List |
| AiAssistantApiApi | ai_assistant_api_server_assistant_setup_from_root | POST /server/assistants/v1/tss/setup | Server Assistant Setup From Root |
| AiAssistantApiApi | ai_assistant_api_server_usage_logs_get_by_sessions | POST /server/assistants/v1/usage_logs/get_by_sessions | Server Usage Logs Get By Sessions |
| AiAssistantApiApi | 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 | DELETE /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Delete |
| AiAssistantApiApi | 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 | PUT /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Update |
| AiAssistantApiApi | 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 | GET /assistants/v1/shared/primary/settings/skills | Shared Primary Skill Settings Get |
| AiAssistantApiApi | 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 | GET /assistants/v1/shared/primary/settings/tools | Shared Primary Tool Settings Get |
| AiAssistantApiApi | ai_assistant_api_shared_primary_tool_toggle | PATCH /assistants/v1/shared/primary/settings/tools | Shared Primary Tool Toggle |
| AiAssistantApiApi | ai_assistant_api_voices_list | GET /voices/v1/ | Voices List |
| AssistantsApi | ai_assistant_api_assistant_add | POST /assistants/v1/ | Assistant Add |
| AssistantsApi | ai_assistant_api_assistant_delete | DELETE /assistants/v1/{assistant_id} | Assistant Delete |
| AssistantsApi | ai_assistant_api_assistant_get | GET /assistants/v1/{assistant_id} | Assistant Get |
| AssistantsApi | ai_assistant_api_assistant_landing_primary_get | GET /assistants/v1/landing/primary | Assistant Landing Primary Get |
| AssistantsApi | ai_assistant_api_assistant_landing_primary_update | PUT /assistants/v1/landing/primary | Assistant Landing Primary Update |
| AssistantsApi | ai_assistant_api_assistant_primary_get | GET /assistants/v1/primary | Assistant Primary Get |
| AssistantsApi | 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 | GET /assistants/v1/primary/goals | Assistant Primary Goals Get |
| AssistantsApi | ai_assistant_api_assistant_primary_update | PUT /assistants/v1/primary | Assistant Primary Update |
| AssistantsApi | ai_assistant_api_assistant_response_stream | POST /assistants/v1/{assistant_id}/response/stream | Assistant Response Stream |
| AssistantsApi | 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 | POST /assistants/v1/{assistant_id}/session/start | Assistant Session Start |
| AssistantsApi | ai_assistant_api_assistant_shared_primary_get | GET /assistants/v1/shared/primary | Assistant Shared Primary Get |
| AssistantsApi | ai_assistant_api_assistant_shared_primary_update | PUT /assistants/v1/shared/primary | Assistant Shared Primary Update |
| AssistantsApi | ai_assistant_api_assistant_update | PUT /assistants/v1/{assistant_id} | Assistant Update |
| AssistantsApi | ai_assistant_api_assitants_list | GET /assistants/v1/ | Assitants List |
| AssistantsApi | 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 | DELETE /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Delete |
| AssistantsApi | 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 | PUT /assistants/v1/shared/primary/settings/custom_skills/{skill_id} | Shared Primary Custom Skill Update |
| AssistantsApi | 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 | GET /assistants/v1/shared/primary/settings/skills | Shared Primary Skill Settings Get |
| AssistantsApi | 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 | GET /assistants/v1/shared/primary/settings/tools | Shared Primary Tool Settings Get |
| AssistantsApi | 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 | GET /server/assistants/v1/ | Server Assistant List |
| AssistantsServerApi | ai_assistant_api_server_assistant_setup_from_root | POST /server/assistants/v1/tss/setup | Server Assistant Setup From Root |
| AssistantsServerApi | ai_assistant_api_server_usage_logs_get_by_sessions | POST /server/assistants/v1/usage_logs/get_by_sessions | Server Usage Logs Get By Sessions |
| AvatarsApi | ai_assistant_api_avatars_list | GET /avatars/v1/ | Avatars List |
| DefaultApi | default_health_check | GET / | Health Check |
| GoalEngagementPresetsApi | ai_assistant_api_engagement_preset_list | GET /goal_engagement_presets/v1/ | Engagement Preset List |
| MemoryApi | ai_assistant_api_clear_all_facts | DELETE /memory/v1/facts | Clear All Facts |
| MemoryApi | ai_assistant_api_clear_profile | DELETE /memory/v1/profile | Clear Profile |
| MemoryApi | ai_assistant_api_count_facts | GET /memory/v1/facts/count | Count Facts |
| MemoryApi | ai_assistant_api_delete_fact | DELETE /memory/v1/facts/{fact_id} | Delete Fact |
| MemoryApi | ai_assistant_api_delete_profile_key | DELETE /memory/v1/profile/keys/{key} | Delete Profile Key |
| MemoryApi | ai_assistant_api_get_profile | GET /memory/v1/profile | Get Profile |
| MemoryApi | ai_assistant_api_list_facts | GET /memory/v1/facts | List Facts |
| MemoryApi | ai_assistant_api_memory_forget_facts | POST /memory/v1/facts/forget | Memory Forget Facts |
| MemoryApi | ai_assistant_api_memory_ingest | POST /memory/v1/ingest | Memory Ingest |
| MemoryApi | ai_assistant_api_memory_record_fact | POST /memory/v1/facts/record | Memory Record Fact |
| PortalAiInfoApi | ai_assistant_api_portal_ai_info_get | GET /portal_ai_info/v1/ | Portal Ai Info Get |
| PortalAiInfoApi | ai_assistant_api_portal_ai_info_update | PUT /portal_ai_info/v1/ | Portal Ai Info Update |
| RagApi | ai_assistant_api_rag_query | GET /rag/v1/query | Rag Query |
| ServerApi | ai_assistant_api_server_assistant_list | GET /server/assistants/v1/ | Server Assistant List |
| ServerApi | ai_assistant_api_server_assistant_setup_from_root | POST /server/assistants/v1/tss/setup | Server Assistant Setup From Root |
| ServerApi | ai_assistant_api_server_usage_logs_get_by_sessions | POST /server/assistants/v1/usage_logs/get_by_sessions | Server Usage Logs Get By Sessions |
| VoicesApi | ai_assistant_api_voices_list | GET /voices/v1/ | Voices List |
Documentation For Models
- AIAssistantReponseStreamRequest
- AIAssistantSessionStart
- AiAssistantCustomSkillCreate
- AiAssistantCustomSkillGet
- AiAssistantCustomSkillPatch
- AiAssistantCustomSkillUpdate
- AiAssistantGet
- AiAssistantGoalCreate
- AiAssistantGoalCreateUpdate
- AiAssistantGoalGet
- AiAssistantLexiconItem
- AiAssistantLexiconItemCreateOrUpdate
- AiAssistantLexiconItemNew
- AiAssistantListGet
- AiAssistantNew
- AiAssistantSettingToggle
- AiAssistantSetupFromRoot
- AiAssistantSkillSettingGet
- AiAssistantToolSettingGet
- AiAssistantUpdate
- AiAssistantUsageLogRead
- AiAssistantUsageLogsBySessionsRequest
- AssistantFunction
- AssistantType
- AssistantUsageType
- AvatarOptionGet
- ChatHistoryChatContent
- ChatHistoryItem
- ChatMessageAttachment
- ChatMessageAttachmentType
- ChatRole
- CollectionState
- CollectionStatus
- ConversationStyle
- CourseModulePublic
- CoursePaymentTypeStrEnum
- CoursePublic
- EmphemeralCredentials
- FactType
- GoalEngagementPresetGet
- GoalInteractionsSummary
- HTTPValidationError
- InteractionType
- KnowledgebaseState
- LanguageStrEnum
- LocationInner
- MemoryFactForgetRequest
- MemoryFactRecordRequest
- MemoryIngestRequest
- ModuleLessonPublic
- PortalAiInfoGet
- PortalAiInfoUpdate
- PortalInfoRequest
- PortalOwnerInfo
- RagQueryResponse
- ResponseChunk
- ResponseChunkType
- ResponseWrapper
- ResponseWrapperAIAssistantSessionStart
- ResponseWrapperAiAssistantGet
- ResponseWrapperBool
- ResponseWrapperInt
- ResponseWrapperListAiAssistantCustomSkillGet
- ResponseWrapperListAiAssistantGoalGet
- ResponseWrapperListAiAssistantListGet
- ResponseWrapperListAiAssistantSkillSettingGet
- ResponseWrapperListAiAssistantToolSettingGet
- ResponseWrapperListAiAssistantUsageLogRead
- ResponseWrapperListAvatarOptionGet
- ResponseWrapperListGoalEngagementPresetGet
- ResponseWrapperListUserMemoryFactGet
- ResponseWrapperListVoiceOptionGet
- ResponseWrapperPortalAiInfoGet
- ResponseWrapperRagQueryResponse
- ResponseWrapperUserMemoryProfileGet
- Result
- Score
- SearchResult
- UsageDetails
- UserGoalInteractionCreate
- UserMemoryFactGet
- UserMemoryProfileGet
- ValidationError
- VoiceOptionGet
Documentation For Authorization
Authentication schemes defined for the API:
APIKeyHeader
- Type: API key
- API key parameter name: server_name
- Location: HTTP header
HTTPBearer
- Type: Bearer authentication