pip install git+https://github.com/byteleaphq/athena-python.gitimportathenacopilotsdkfromathenacopilotsdk.modelsimportcomponents, operationss=athenacopilotsdk.AthenaCopilotSDK(
security=components.Security(
username="<YOUR_USERNAME_HERE>",
password="<YOUR_PASSWORD_HERE>",
),
)
res=s.brain.create_new_brain(request=operations.CreateNewBrainRequestBody(
name='Test - brain',
))
ifres.brainisnotNone:
# handle responsepass- create_new_brain - Create Brain
- get_all_brains - Get All Brains
- update_brain - Update Brain
- get_brain_by_id - Get Brain by ID
- delete_brain - Delete Brain
- create_text_document - Create Text Document
- create_url_document - Create Document by URL
- download_document - Download
- get_all_documents - List Documents
- get_document_by_id - Get Document
- delete_document - Delete Document
- upload_document - Upload Document
- search_documents - Search documents
- create_document_review - Create document review
- list_document_reviews - List document reviews
- create_new_chat - Create New Chat
- list_chats - List Chats
- get_chat_by_id - Get Chat
- update_chat - Update Chat
- delete_chat - Delete Chat
- create_new_chat_with_msg - Create New Chat With Message
- get_response - Get Response
- list_interactions - List Interactions
- post_chatbot_create - Create Chatbot
- get_chatbot_list - List Chatbots
- post_chatbot_get - Get Chatbot
- get_chatbot_analytics - Get Chatbot analytics
- get_chatbot_get_messages - Get Chatbot messages
- post_chatbot_update - Update Chatbot
- post_chatbot_delete - Delete Chatbot
- post_chatbot_reset - Reset Token
- postintegration_integration_name_connect - Connect
- postintegration_integration_name_disconnect - Disconnect
- get_integration_integration_name_list - List
- post_integration_integration_name_add - Add To Brain
- getorganisation - get user org
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.CreateNewBrainResponseBody | 401 | application/json |
| errors.CreateNewBrainBrainResponseBody | 500 | application/json |
| errors.SDKError | 4xx-5xx | / |
importathenacopilotsdkfromathenacopilotsdk.modelsimportcomponents, errors, operationss=athenacopilotsdk.AthenaCopilotSDK(
security=components.Security(
username="<YOUR_USERNAME_HERE>",
password="<YOUR_PASSWORD_HERE>",
),
)
res=Nonetry:
res=s.brain.create_new_brain(request=operations.CreateNewBrainRequestBody(
name='Test - brain',
))
excepterrors.CreateNewBrainResponseBodyase:
# handle exceptionraise(e)
excepterrors.CreateNewBrainBrainResponseBodyase:
# handle exceptionraise(e)
excepterrors.SDKErrorase:
# handle exceptionraise(e)
ifres.brainisnotNone:
# handle responsepassYou can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://backend.athenacopilot.ai | None |
importathenacopilotsdkfromathenacopilotsdk.modelsimportcomponents, operationss=athenacopilotsdk.AthenaCopilotSDK(
server_idx=0,
security=components.Security(
username="<YOUR_USERNAME_HERE>",
password="<YOUR_PASSWORD_HERE>",
),
)
res=s.brain.create_new_brain(request=operations.CreateNewBrainRequestBody(
name='Test - brain',
))
ifres.brainisnotNone:
# handle responsepassThe default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
importathenacopilotsdkfromathenacopilotsdk.modelsimportcomponents, operationss=athenacopilotsdk.AthenaCopilotSDK(
server_url="https://backend.athenacopilot.ai",
security=components.Security(
username="<YOUR_USERNAME_HERE>",
password="<YOUR_PASSWORD_HERE>",
),
)
res=s.brain.create_new_brain(request=operations.CreateNewBrainRequestBody(
name='Test - brain',
))
ifres.brainisnotNone:
# handle responsepassThe Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.
For example, you could specify a header for every request that this sdk makes as follows:
importathenacopilotsdkimportrequestshttp_client=requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s=athenacopilotsdk.AthenaCopilotSDK(client=http_client)This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
password | http | HTTP Basic |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:
importathenacopilotsdkfromathenacopilotsdk.modelsimportcomponents, operationss=athenacopilotsdk.AthenaCopilotSDK(
security=components.Security(
username="<YOUR_USERNAME_HERE>",
password="<YOUR_PASSWORD_HERE>",
),
)
res=s.brain.create_new_brain(request=operations.CreateNewBrainRequestBody(
name='Test - brain',
))
ifres.brainisnotNone:
# handle responsepasspip install git+<UNSET>.gitThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!