Skip to main content

No project description provided

Project description

KitchenAIWrapper SDK

The KitchenAIWrapper SDK is a Python wrapper around the kitchenai-python-sdk, providing a simplified interface for interacting with the KitchenAI API. This wrapper handles common tasks and offers additional functionality, such as streaming queries.

Requirements

  • Python 3.11+

Installation

Using pip

If the package is hosted on a repository, you can install it directly using:

pip install kitchenai-py

Using Setuptools

Alternatively, you can install the package using Setuptools:

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Usage

Importing the Package

After installation, import the package in your Python script:

from kitchenai_py import KitchenAIWrapper

Getting Started

Here's a quick example to get you started with the KitchenAIWrapper:

from kitchenai_py import KitchenAIWrapper

# Initialize the wrapper
wrapper = KitchenAIWrapper(host="http://localhost")

# Perform a query
response = wrapper.query("example_label", "example_query", stream=True)

# Print the response
print(response)

API Methods

query(label, query, stream=False, metadata=None)

  • label: The label for the query.
  • query: The query string.
  • stream: (Optional) Boolean flag to enable streaming. Default is False.
  • metadata: (Optional) Additional metadata for the query.

Error Handling

The wrapper includes basic error handling for API exceptions. If an error occurs during an API call, it will print an error message to the console.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.

License

This project is licensed under the MIT License.

Author

Your Name or Organization

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kitchenai_py-0.0.1.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kitchenai_py-0.0.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file kitchenai_py-0.0.1.tar.gz.

File metadata

  • Download URL: kitchenai_py-0.0.1.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for kitchenai_py-0.0.1.tar.gz
Algorithm Hash digest
SHA256 1c173a4b17643dc996276876ea6fde378bff18682d9ba36e12a7a31e98d5bf64
MD5 34885431dbee87f2ea9224fbc6a70f7f
BLAKE2b-256 d4277307fbc21daca104206ad25a0cb213445abb076cf37648110edd8ad86975

See more details on using hashes here.

File details

Details for the file kitchenai_py-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: kitchenai_py-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.2

File hashes

Hashes for kitchenai_py-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 07905f91554d23fdf7ce27c259c22940bcd3c93fe70fcb9348d4088ff0c9fa4b
MD5 579df49c4a085ba2158404d52fa4d578
BLAKE2b-256 f5980dae576f1e76ac8108e15005b9c291642bfe8c9637701506850ef3bec2e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page