ai-assistant-server-connector

Mentortools service for ai interactions

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 1.2.0+2265297833
• Generator version: 7.18.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:

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

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

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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.AccessesApi(api_client)
    portal_id = 56 # int | 

    try:
        # Access Get
        api_response = await api_instance.ai_assistant_api_access_get(portal_id)
        print("The response of AccessesApi->ai_assistant_api_access_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccessesApi->ai_assistant_api_access_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /ai_assistant_api

Documentation For Models

• AIAssistantReponseStreamRequest
• AIAssistantSessionStart
• AiAssistantGet
• AiAssistantGoalCreate
• AiAssistantGoalCreateUpdate
• AiAssistantGoalGet
• AiAssistantListGet
• AiAssistantNew
• AiAssistantUpdate
• AssistantFunction
• AvatarOptionGet
• ChatHistoryChatContent
• ChatHistoryItem
• ChatRole
• CollectionState
• CollectionStatus
• ConversationStyle
• CourseModulePublic
• CoursePaymentTypeStrEnum
• CoursePublic
• EmphemeralCredentials
• GoalEngagementPresetGet
• GoalInteractionsSummary
• HTTPValidationError
• InteractionType
• KnowledgebaseState
• LanguageStrEnum
• ModuleLessonPublic
• PortalToSharedAiAssistantAccessGet
• PortalToSharedAiAssistantAccessNewOrUpdate
• PortalToSharedAiAssistantAccessUpdateGroup
• RagQueryResponse
• ResponseChunk
• ResponseChunkType
• ResponseWrapper
• ResponseWrapperAIAssistantSessionStart
• ResponseWrapperAiAssistantGet
• ResponseWrapperBool
• ResponseWrapperInt
• ResponseWrapperListAiAssistantGoalGet
• ResponseWrapperListAiAssistantListGet
• ResponseWrapperListAvatarOptionGet
• ResponseWrapperListGoalEngagementPresetGet
• ResponseWrapperListPortalToSharedAiAssistantAccessGet
• ResponseWrapperListVoiceOptionGet
• ResponseWrapperPortalToSharedAiAssistantAccessGet
• ResponseWrapperRagQueryResponse
• Result
• Score
• SearchResult
• UsageDetails
• UserGoalInteractionCreate
• ValidationError
• ValidationErrorLocInner
• VoiceOptionGet

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

APIKeyHeader

• Type: API key
• API key parameter name: server_name
• Location: HTTP header

Author