| Name | mantium-spec JSON |
| Version |
1.0.1108
JSON |
| download |
| home_page | |
| Summary | OpenAPI-generated Python client |
| upload_time | 2023-11-01 16:34:34 |
| maintainer | |
| docs_url | None |
| author | Mantium |
| requires_python | >=3.7 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mantium-spec
Mantium API Documentation
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.1108
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen
## Requirements.
Python 2.7 and 3.4+
## 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 mantium_spec
```
### 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 mantium_spec
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import mantium_spec
from mantium_spec.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 = mantium_spec.Configuration(
host = "http://localhost"
)
# 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 Bearer authorization: HTTPBearer
configuration = mantium_spec.Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with mantium_spec.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mantium_spec.ApplicationsApi(api_client)
application_id = 'application_id_example' # str |
body = None # object | (optional)
try:
# Get application details
api_response = api_instance.get_application_detail(application_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ApplicationsApi->get_application_detail: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApplicationsApi* | [**get_application_detail**](docs/ApplicationsApi.md#get_application_detail) | **GET** /applications/{application_id} | Get application details
*ApplicationsApi* | [**list_applications**](docs/ApplicationsApi.md#list_applications) | **GET** /applications/ | List applications.
*ApplicationsApi* | [**query_application**](docs/ApplicationsApi.md#query_application) | **POST** /applications/{application_id}/query | Interact with an application.
*ApplicationsApi* | [**query_chat_application**](docs/ApplicationsApi.md#query_chat_application) | **POST** /applications/{application_id}/chat | Interact with a chat application.
## Documentation For Models
- [APIDataSourceType](docs/APIDataSourceType.md)
- [Answer](docs/Answer.md)
- [AnswerMeta](docs/AnswerMeta.md)
- [ApplicationChatResponse](docs/ApplicationChatResponse.md)
- [ApplicationCredential](docs/ApplicationCredential.md)
- [ApplicationDetailResponse](docs/ApplicationDetailResponse.md)
- [ApplicationQueryRequest](docs/ApplicationQueryRequest.md)
- [ApplicationQueryResponse](docs/ApplicationQueryResponse.md)
- [ApplicationResponse](docs/ApplicationResponse.md)
- [ApplicationStatus](docs/ApplicationStatus.md)
- [ApplicationTopKQueryRequest](docs/ApplicationTopKQueryRequest.md)
- [ChatAnswer](docs/ChatAnswer.md)
- [ChatConfig](docs/ChatConfig.md)
- [ChatGPTPluginApplicationDetailResponse](docs/ChatGPTPluginApplicationDetailResponse.md)
- [Citation](docs/Citation.md)
- [ContentCreationTemplateOptions](docs/ContentCreationTemplateOptions.md)
- [ContentType](docs/ContentType.md)
- [CredentialType](docs/CredentialType.md)
- [CursorDatamodelPageApplicationResponse](docs/CursorDatamodelPageApplicationResponse.md)
- [CustomTemplateOptions](docs/CustomTemplateOptions.md)
- [CustomerSupportTemplateOptions](docs/CustomerSupportTemplateOptions.md)
- [DataSourceType](docs/DataSourceType.md)
- [DataSourcesInner](docs/DataSourcesInner.md)
- [Document](docs/Document.md)
- [DocumentMetadata](docs/DocumentMetadata.md)
- [EventPlanningTemplateOptions](docs/EventPlanningTemplateOptions.md)
- [GitlabDataSourceDetails](docs/GitlabDataSourceDetails.md)
- [GitlabProjectInfo](docs/GitlabProjectInfo.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [LegalDocumentsTemplateOptions](docs/LegalDocumentsTemplateOptions.md)
- [LocationInner](docs/LocationInner.md)
- [MantiumRetrieverTool](docs/MantiumRetrieverTool.md)
- [MantiumRetrieverToolConfig](docs/MantiumRetrieverToolConfig.md)
- [MeetingInfoTemplateOptions](docs/MeetingInfoTemplateOptions.md)
- [Moderation](docs/Moderation.md)
- [ModerationConfig](docs/ModerationConfig.md)
- [ModerationLevel](docs/ModerationLevel.md)
- [PersonalKnowledgeManagementTemplateOptions](docs/PersonalKnowledgeManagementTemplateOptions.md)
- [ProductDocumentationTemplateOptions](docs/ProductDocumentationTemplateOptions.md)
- [RecipeManagementTemplateOptions](docs/RecipeManagementTemplateOptions.md)
- [ResponseGetApplicationDetail](docs/ResponseGetApplicationDetail.md)
- [ShopifyTemplateOptions](docs/ShopifyTemplateOptions.md)
- [Span](docs/Span.md)
- [Template](docs/Template.md)
- [Tools](docs/Tools.md)
- [ToolsConfig](docs/ToolsConfig.md)
- [ValidationError](docs/ValidationError.md)
## Documentation For Authorization
## HTTPBearer
- **Type**: Bearer authentication
## Author
Raw data
{
"_id": null,
"home_page": "",
"name": "mantium-spec",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Mantium",
"author_email": "support@mantiumai.com",
"download_url": "https://files.pythonhosted.org/packages/00/27/8431280b0cd44b9d91f3346b59b225540f603ed9ef11371434ddad6479e8/mantium_spec-1.0.1108.tar.gz",
"platform": null,
"description": "# mantium-spec\nMantium API Documentation\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.1108\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport mantium_spec\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport mantium_spec\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\n\nimport time\nimport mantium_spec\nfrom mantium_spec.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = mantium_spec.Configuration(\n host = \"http://localhost\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: HTTPBearer\nconfiguration = mantium_spec.Configuration(\n access_token = 'YOUR_BEARER_TOKEN'\n)\n\n\n# Enter a context with an instance of the API client\nwith mantium_spec.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = mantium_spec.ApplicationsApi(api_client)\n application_id = 'application_id_example' # str | \nbody = None # object | (optional)\n\n try:\n # Get application details\n api_response = api_instance.get_application_detail(application_id, body=body)\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ApplicationsApi->get_application_detail: %s\\n\" % e)\n \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ApplicationsApi* | [**get_application_detail**](docs/ApplicationsApi.md#get_application_detail) | **GET** /applications/{application_id} | Get application details\n*ApplicationsApi* | [**list_applications**](docs/ApplicationsApi.md#list_applications) | **GET** /applications/ | List applications.\n*ApplicationsApi* | [**query_application**](docs/ApplicationsApi.md#query_application) | **POST** /applications/{application_id}/query | Interact with an application.\n*ApplicationsApi* | [**query_chat_application**](docs/ApplicationsApi.md#query_chat_application) | **POST** /applications/{application_id}/chat | Interact with a chat application.\n\n\n## Documentation For Models\n\n - [APIDataSourceType](docs/APIDataSourceType.md)\n - [Answer](docs/Answer.md)\n - [AnswerMeta](docs/AnswerMeta.md)\n - [ApplicationChatResponse](docs/ApplicationChatResponse.md)\n - [ApplicationCredential](docs/ApplicationCredential.md)\n - [ApplicationDetailResponse](docs/ApplicationDetailResponse.md)\n - [ApplicationQueryRequest](docs/ApplicationQueryRequest.md)\n - [ApplicationQueryResponse](docs/ApplicationQueryResponse.md)\n - [ApplicationResponse](docs/ApplicationResponse.md)\n - [ApplicationStatus](docs/ApplicationStatus.md)\n - [ApplicationTopKQueryRequest](docs/ApplicationTopKQueryRequest.md)\n - [ChatAnswer](docs/ChatAnswer.md)\n - [ChatConfig](docs/ChatConfig.md)\n - [ChatGPTPluginApplicationDetailResponse](docs/ChatGPTPluginApplicationDetailResponse.md)\n - [Citation](docs/Citation.md)\n - [ContentCreationTemplateOptions](docs/ContentCreationTemplateOptions.md)\n - [ContentType](docs/ContentType.md)\n - [CredentialType](docs/CredentialType.md)\n - [CursorDatamodelPageApplicationResponse](docs/CursorDatamodelPageApplicationResponse.md)\n - [CustomTemplateOptions](docs/CustomTemplateOptions.md)\n - [CustomerSupportTemplateOptions](docs/CustomerSupportTemplateOptions.md)\n - [DataSourceType](docs/DataSourceType.md)\n - [DataSourcesInner](docs/DataSourcesInner.md)\n - [Document](docs/Document.md)\n - [DocumentMetadata](docs/DocumentMetadata.md)\n - [EventPlanningTemplateOptions](docs/EventPlanningTemplateOptions.md)\n - [GitlabDataSourceDetails](docs/GitlabDataSourceDetails.md)\n - [GitlabProjectInfo](docs/GitlabProjectInfo.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [LegalDocumentsTemplateOptions](docs/LegalDocumentsTemplateOptions.md)\n - [LocationInner](docs/LocationInner.md)\n - [MantiumRetrieverTool](docs/MantiumRetrieverTool.md)\n - [MantiumRetrieverToolConfig](docs/MantiumRetrieverToolConfig.md)\n - [MeetingInfoTemplateOptions](docs/MeetingInfoTemplateOptions.md)\n - [Moderation](docs/Moderation.md)\n - [ModerationConfig](docs/ModerationConfig.md)\n - [ModerationLevel](docs/ModerationLevel.md)\n - [PersonalKnowledgeManagementTemplateOptions](docs/PersonalKnowledgeManagementTemplateOptions.md)\n - [ProductDocumentationTemplateOptions](docs/ProductDocumentationTemplateOptions.md)\n - [RecipeManagementTemplateOptions](docs/RecipeManagementTemplateOptions.md)\n - [ResponseGetApplicationDetail](docs/ResponseGetApplicationDetail.md)\n - [ShopifyTemplateOptions](docs/ShopifyTemplateOptions.md)\n - [Span](docs/Span.md)\n - [Template](docs/Template.md)\n - [Tools](docs/Tools.md)\n - [ToolsConfig](docs/ToolsConfig.md)\n - [ValidationError](docs/ValidationError.md)\n\n\n## Documentation For Authorization\n\n\n## HTTPBearer\n\n- **Type**: Bearer authentication\n\n\n## Author\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "OpenAPI-generated Python client",
"version": "1.0.1108",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0456b95903dfa364c28a4c0fab80eb71a9c04d206766ce456d985eda1c260ed0",
"md5": "ae4a509e14846b6ffec5e38811c7401c",
"sha256": "5fc07ffc1b489ed6b99148ea5d2683e01c52f3b80cfd0c668953305db6020e61"
},
"downloads": -1,
"filename": "mantium_spec-1.0.1108-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae4a509e14846b6ffec5e38811c7401c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 106686,
"upload_time": "2023-11-01T16:34:33",
"upload_time_iso_8601": "2023-11-01T16:34:33.258752Z",
"url": "https://files.pythonhosted.org/packages/04/56/b95903dfa364c28a4c0fab80eb71a9c04d206766ce456d985eda1c260ed0/mantium_spec-1.0.1108-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "00278431280b0cd44b9d91f3346b59b225540f603ed9ef11371434ddad6479e8",
"md5": "1e395281b682a80208e219ea9dc0c5d8",
"sha256": "b5a9c549163507c2c850fdb7e0a40c43e511aa503ce4b101c48db9a81268bd69"
},
"downloads": -1,
"filename": "mantium_spec-1.0.1108.tar.gz",
"has_sig": false,
"md5_digest": "1e395281b682a80208e219ea9dc0c5d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 45914,
"upload_time": "2023-11-01T16:34:34",
"upload_time_iso_8601": "2023-11-01T16:34:34.571243Z",
"url": "https://files.pythonhosted.org/packages/00/27/8431280b0cd44b9d91f3346b59b225540f603ed9ef11371434ddad6479e8/mantium_spec-1.0.1108.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-01 16:34:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mantium-spec"
}
