<div style="text-align: left; margin-bottom: 20px;">
<img src="https://kiss-ai-stack.github.io/kissaistack.svg" alt="KISS AI Stack Banner" style="max-width: auto; height: 250px">
</div>
# KISS AI Stack - Client
The KISS AI Stack Client provides an easy-to-use interface for interacting with the KISS AI Stack Server,
supporting RESTful and WebSocket APIs to manage AI-agent session lifecycle and execute tasks.
---
## Features
- REST client for session management, query execution, and document storage.
- WebSocket client for real-time interactions with the AI agent.
---
## Getting Started
### Requirements
- Python 3.12
### Installation
1. Install the `kiss-ai-stack-client` package:
```bash
pip install kiss-ai-stack-client
```
2. Initialize the REST client:
```python
from kiss_ai_stack_client import RestEvent
client = RestEvent(hostname="your-server-hostname", secure_protocol=True)
```
---
## Usage
### 1. Authorize an Agent Session
Create or refresh an agent session:
```python
session = await client.authorize_agent(scope="temporary")
# or
session = await client.authorize_agent(client_id="your-client-id", client_secret="your-client-secret")
```
### 2. Bootstrap the Agent
Initialize the agent session for task execution:
```python
response = await client.bootstrap_agent(data="Hello, Agent!")
```
### 3. Generate an Answer
Send a query and receive the agent's response:
```python
response = await client.generate_answer(data="What is the weather today?")
```
### 4. Store Documents
Upload files with optional metadata for storage:
```python
files = ["path/to/document1.txt", "path/to/document2.pdf"]
metadata = {"category": "example"}
response = await client.store_data(files=files, metadata=metadata)
```
### 5. Destroy the Agent Session
Close the current session and clean up resources:
```python
response = await client.destroy_agent(data="Goodbye!")
```
---
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "kiss-ai-stack-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "ai, agent, machine-learning, llm, document-processing",
"author": "KISS AI Stack Python SDK, Lahiru Pathirage",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/54/90/78b04c1774f069461aa21b0385d63a33396d3b31a0f3954c938f6c387e90/kiss_ai_stack_client-0.1.0a2.tar.gz",
"platform": null,
"description": "<div style=\"text-align: left; margin-bottom: 20px;\">\n <img src=\"https://kiss-ai-stack.github.io/kissaistack.svg\" alt=\"KISS AI Stack Banner\" style=\"max-width: auto; height: 250px\">\n</div>\n\n\n\n# KISS AI Stack - Client\n\nThe KISS AI Stack Client provides an easy-to-use interface for interacting with the KISS AI Stack Server, \nsupporting RESTful and WebSocket APIs to manage AI-agent session lifecycle and execute tasks.\n\n---\n\n## Features\n\n- REST client for session management, query execution, and document storage.\n- WebSocket client for real-time interactions with the AI agent.\n\n---\n\n## Getting Started\n\n### Requirements\n\n- Python 3.12\n\n### Installation\n\n1. Install the `kiss-ai-stack-client` package:\n```bash\npip install kiss-ai-stack-client\n```\n\n2. Initialize the REST client:\n```python\nfrom kiss_ai_stack_client import RestEvent\n\nclient = RestEvent(hostname=\"your-server-hostname\", secure_protocol=True)\n```\n\n---\n\n## Usage\n\n### 1. Authorize an Agent Session\nCreate or refresh an agent session:\n```python\nsession = await client.authorize_agent(scope=\"temporary\")\n# or\nsession = await client.authorize_agent(client_id=\"your-client-id\", client_secret=\"your-client-secret\")\n```\n\n### 2. Bootstrap the Agent\nInitialize the agent session for task execution:\n```python\nresponse = await client.bootstrap_agent(data=\"Hello, Agent!\")\n```\n\n### 3. Generate an Answer\nSend a query and receive the agent's response:\n```python\nresponse = await client.generate_answer(data=\"What is the weather today?\")\n```\n\n### 4. Store Documents\nUpload files with optional metadata for storage:\n```python\nfiles = [\"path/to/document1.txt\", \"path/to/document2.pdf\"]\nmetadata = {\"category\": \"example\"}\nresponse = await client.store_data(files=files, metadata=metadata)\n```\n\n### 5. Destroy the Agent Session\nClose the current session and clean up resources:\n```python\nresponse = await client.destroy_agent(data=\"Goodbye!\")\n```\n\n---\n\n## License\n\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "KISS AI Stack's Python Client SDK - Simplify AI Agent Development",
"version": "0.1.0a2",
"project_urls": {
"Documentation": "https://github.com/kiss-ai-stack/kiss-ai-stack-core/main/README.md",
"Homepage": "https://github.com/kiss-ai-stack",
"Repository": "https://github.com/kiss-ai-stack"
},
"split_keywords": [
"ai",
" agent",
" machine-learning",
" llm",
" document-processing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b547215559e92d2145a2e200a02b5057727a7d8e29b521071fc65a2a2d86ed3",
"md5": "2096ff338041843069e29e69df6327fb",
"sha256": "58a77c02816726a87d93ec7a8fb18407fb1a578d458ef0ae9f810d6647857b51"
},
"downloads": -1,
"filename": "kiss_ai_stack_client-0.1.0a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2096ff338041843069e29e69df6327fb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 10957,
"upload_time": "2024-12-16T06:58:30",
"upload_time_iso_8601": "2024-12-16T06:58:30.769135Z",
"url": "https://files.pythonhosted.org/packages/6b/54/7215559e92d2145a2e200a02b5057727a7d8e29b521071fc65a2a2d86ed3/kiss_ai_stack_client-0.1.0a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "549078b04c1774f069461aa21b0385d63a33396d3b31a0f3954c938f6c387e90",
"md5": "b0bf3ca4dd41f63f6ea976acb218d32b",
"sha256": "d12756d25988c7b464c409d5742ee7d747f91756a021b8aa8913fce754b188fd"
},
"downloads": -1,
"filename": "kiss_ai_stack_client-0.1.0a2.tar.gz",
"has_sig": false,
"md5_digest": "b0bf3ca4dd41f63f6ea976acb218d32b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 8671,
"upload_time": "2024-12-16T06:58:34",
"upload_time_iso_8601": "2024-12-16T06:58:34.621952Z",
"url": "https://files.pythonhosted.org/packages/54/90/78b04c1774f069461aa21b0385d63a33396d3b31a0f3954c938f6c387e90/kiss_ai_stack_client-0.1.0a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 06:58:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kiss-ai-stack",
"github_project": "kiss-ai-stack-core",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "aiofiles",
"specs": [
[
"~=",
"24.1.0"
]
]
},
{
"name": "asyncio",
"specs": [
[
"~=",
"3.4.3"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"~=",
"6.0.2"
]
]
},
{
"name": "pydantic",
"specs": [
[
"~=",
"2.10.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
"~=",
"75.6.0"
]
]
},
{
"name": "unstructured",
"specs": [
[
"~=",
"0.16.8"
]
]
},
{
"name": "unstructured",
"specs": [
[
"~=",
"0.16.8"
]
]
},
{
"name": "unstructured",
"specs": [
[
"~=",
"0.16.8"
]
]
},
{
"name": "unstructured",
"specs": [
[
"~=",
"0.16.8"
]
]
},
{
"name": "unstructured",
"specs": [
[
"~=",
"0.16.8"
]
]
},
{
"name": "tiktoken",
"specs": [
[
"~=",
"0.8.0"
]
]
},
{
"name": "tokenizers",
"specs": [
[
"~=",
"0.20.3"
]
]
},
{
"name": "pandas",
"specs": [
[
"~=",
"2.2.3"
]
]
}
],
"lcname": "kiss-ai-stack-client"
}
JSON
