# kitchenai-python-sdk
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.9.0
- Package version: 1.0.0
- Generator version: 7.10.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## 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 kitchenai_python_sdk
```
### 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 kitchenai_python_sdk
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import kitchenai_python_sdk
from kitchenai_python_sdk.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 = kitchenai_python_sdk.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with kitchenai_python_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kitchenai_python_sdk.DefaultApi(api_client)
label = 'label_example' # str |
query_schema = kitchenai_python_sdk.QuerySchema() # QuerySchema |
try:
# Agent
api_response = api_instance.kitchenai_core_api_agent(label, query_schema)
print("The response of DefaultApi->kitchenai_core_api_agent:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->kitchenai_core_api_agent: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**kitchenai_core_api_agent**](docs/DefaultApi.md#kitchenai_core_api_agent) | **POST** /api/core/agent/{label} | Agent
*DefaultApi* | [**kitchenai_core_api_default**](docs/DefaultApi.md#kitchenai_core_api_default) | **GET** /api/core/health | Default
*DefaultApi* | [**kitchenai_core_api_embed_create**](docs/DefaultApi.md#kitchenai_core_api_embed_create) | **POST** /api/core/embed | Embed Create
*DefaultApi* | [**kitchenai_core_api_embed_delete**](docs/DefaultApi.md#kitchenai_core_api_embed_delete) | **DELETE** /api/core/embed/{pk} | Embed Delete
*DefaultApi* | [**kitchenai_core_api_embed_get**](docs/DefaultApi.md#kitchenai_core_api_embed_get) | **GET** /api/core/embed/{pk} | Embed Get
*DefaultApi* | [**kitchenai_core_api_embeds_get**](docs/DefaultApi.md#kitchenai_core_api_embeds_get) | **GET** /api/core/embed | Embeds Get
*DefaultApi* | [**kitchenai_core_api_file_delete**](docs/DefaultApi.md#kitchenai_core_api_file_delete) | **DELETE** /api/core/file/{pk} | File Delete
*DefaultApi* | [**kitchenai_core_api_file_get**](docs/DefaultApi.md#kitchenai_core_api_file_get) | **GET** /api/core/file/{pk} | File Get
*DefaultApi* | [**kitchenai_core_api_file_upload**](docs/DefaultApi.md#kitchenai_core_api_file_upload) | **POST** /api/core/file | File Upload
*DefaultApi* | [**kitchenai_core_api_files_get**](docs/DefaultApi.md#kitchenai_core_api_files_get) | **GET** /api/core/file | Files Get
*DefaultApi* | [**kitchenai_core_api_labels**](docs/DefaultApi.md#kitchenai_core_api_labels) | **GET** /api/core/labels | Labels
*DefaultApi* | [**kitchenai_core_api_query**](docs/DefaultApi.md#kitchenai_core_api_query) | **POST** /api/core/query/{label} | Query
## Documentation For Models
- [AgentResponseSchema](docs/AgentResponseSchema.md)
- [EmbedObjectResponse](docs/EmbedObjectResponse.md)
- [EmbedSchema](docs/EmbedSchema.md)
- [FileObjectResponse](docs/FileObjectResponse.md)
- [FileObjectSchema](docs/FileObjectSchema.md)
- [KitchenAIAppSchema](docs/KitchenAIAppSchema.md)
- [QueryResponseSchema](docs/QueryResponseSchema.md)
- [QuerySchema](docs/QuerySchema.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "kitchenai_python_sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, NinjaAPI",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/03/e1/125d0f7ae2614756650127d4ff69d96059c225447242d3b0d9d44dd417a3/kitchenai_python_sdk-1.3.0.tar.gz",
"platform": null,
"description": "# kitchenai-python-sdk\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.9.0\n- Package version: 1.0.0\n- Generator version: 7.10.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\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 kitchenai_python_sdk\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 kitchenai_python_sdk\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport kitchenai_python_sdk\nfrom kitchenai_python_sdk.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 = kitchenai_python_sdk.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith kitchenai_python_sdk.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = kitchenai_python_sdk.DefaultApi(api_client)\n label = 'label_example' # str | \n query_schema = kitchenai_python_sdk.QuerySchema() # QuerySchema | \n\n try:\n # Agent\n api_response = api_instance.kitchenai_core_api_agent(label, query_schema)\n print(\"The response of DefaultApi->kitchenai_core_api_agent:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->kitchenai_core_api_agent: %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*DefaultApi* | [**kitchenai_core_api_agent**](docs/DefaultApi.md#kitchenai_core_api_agent) | **POST** /api/core/agent/{label} | Agent\n*DefaultApi* | [**kitchenai_core_api_default**](docs/DefaultApi.md#kitchenai_core_api_default) | **GET** /api/core/health | Default\n*DefaultApi* | [**kitchenai_core_api_embed_create**](docs/DefaultApi.md#kitchenai_core_api_embed_create) | **POST** /api/core/embed | Embed Create\n*DefaultApi* | [**kitchenai_core_api_embed_delete**](docs/DefaultApi.md#kitchenai_core_api_embed_delete) | **DELETE** /api/core/embed/{pk} | Embed Delete\n*DefaultApi* | [**kitchenai_core_api_embed_get**](docs/DefaultApi.md#kitchenai_core_api_embed_get) | **GET** /api/core/embed/{pk} | Embed Get\n*DefaultApi* | [**kitchenai_core_api_embeds_get**](docs/DefaultApi.md#kitchenai_core_api_embeds_get) | **GET** /api/core/embed | Embeds Get\n*DefaultApi* | [**kitchenai_core_api_file_delete**](docs/DefaultApi.md#kitchenai_core_api_file_delete) | **DELETE** /api/core/file/{pk} | File Delete\n*DefaultApi* | [**kitchenai_core_api_file_get**](docs/DefaultApi.md#kitchenai_core_api_file_get) | **GET** /api/core/file/{pk} | File Get\n*DefaultApi* | [**kitchenai_core_api_file_upload**](docs/DefaultApi.md#kitchenai_core_api_file_upload) | **POST** /api/core/file | File Upload\n*DefaultApi* | [**kitchenai_core_api_files_get**](docs/DefaultApi.md#kitchenai_core_api_files_get) | **GET** /api/core/file | Files Get\n*DefaultApi* | [**kitchenai_core_api_labels**](docs/DefaultApi.md#kitchenai_core_api_labels) | **GET** /api/core/labels | Labels\n*DefaultApi* | [**kitchenai_core_api_query**](docs/DefaultApi.md#kitchenai_core_api_query) | **POST** /api/core/query/{label} | Query\n\n\n## Documentation For Models\n\n - [AgentResponseSchema](docs/AgentResponseSchema.md)\n - [EmbedObjectResponse](docs/EmbedObjectResponse.md)\n - [EmbedSchema](docs/EmbedSchema.md)\n - [FileObjectResponse](docs/FileObjectResponse.md)\n - [FileObjectSchema](docs/FileObjectSchema.md)\n - [KitchenAIAppSchema](docs/KitchenAIAppSchema.md)\n - [QueryResponseSchema](docs/QueryResponseSchema.md)\n - [QuerySchema](docs/QuerySchema.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "NinjaAPI",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" ninjaapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c074be36cc1c59fb622db0cef55ecf8e01b0fb22f8965ebe9a31be1c45a8cfa",
"md5": "c71d8f9186334057b973fcd0cbddf1c7",
"sha256": "a49fe88885b16c649768039371e78e3e0ff92e16d5d4a84beef2d06672945e88"
},
"downloads": -1,
"filename": "kitchenai_python_sdk-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c71d8f9186334057b973fcd0cbddf1c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 35779,
"upload_time": "2024-12-06T01:40:23",
"upload_time_iso_8601": "2024-12-06T01:40:23.072108Z",
"url": "https://files.pythonhosted.org/packages/0c/07/4be36cc1c59fb622db0cef55ecf8e01b0fb22f8965ebe9a31be1c45a8cfa/kitchenai_python_sdk-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03e1125d0f7ae2614756650127d4ff69d96059c225447242d3b0d9d44dd417a3",
"md5": "a1d4595a777b1a3ecfe6d5a73c18948c",
"sha256": "af8c84d7d355fd7554b7e125b95d61b9fe41334c3a56dde57a5dd1d54775099f"
},
"downloads": -1,
"filename": "kitchenai_python_sdk-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "a1d4595a777b1a3ecfe6d5a73c18948c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 23590,
"upload_time": "2024-12-06T01:40:24",
"upload_time_iso_8601": "2024-12-06T01:40:24.930547Z",
"url": "https://files.pythonhosted.org/packages/03/e1/125d0f7ae2614756650127d4ff69d96059c225447242d3b0d9d44dd417a3/kitchenai_python_sdk-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 01:40:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "kitchenai_python_sdk"
}
JSON
