Skip to main content

A library meant to be a wrapper for the CablyAI service.

Project description

cablyai

A simple Python client for interacting with the CablyAI API, allowing you to easily make requests for text, image, audio generation, and moderation.

Installation

To install the package, you can clone the repository and install it using pip:

git clone https://github.com/acattoXD/cablyai.git
cd cablyai
pip install .

Usage

Here’s a basic example of how to use the CablyAI client:

from cablyai import CablyAI

# Initialize the client with your API key
client = CablyAI("YOUR_API_KEY")

# Example: Chat request
response = client.chat.completions.create(
    model="MODEL_NAME",
    messages=[
        {"role": "user", "content": "Hello!"},
        {"role": "assistant", "content": "Hello! How can I assist you today?"}
    ]
)
print("Chat Response:", response.choices[0].message.content)

# Example: Image generation request
image_response = client.images.generate(
    prompt="A sunset over the mountains.",
    n=1,
    size="1024x1024",
    response_format="url",
    model="MODEL_NAME"
)
print("Image Response:", image_response.data[0].url)


# Example: Text-to-speech request
from pathlib import Path

speech_file_path = Path(__file__).parent / "speech.mp3"
audio_response = client.audio.speech.create(
    model="tts-1",
    voice="alloy",
    input="Today is a wonderful day to build something people love!"
)
audio_response.stream_to_file(speech_file_path)
print(f"Speech saved to {speech_file_path}")

# Example: Content moderation request
moderation_response = client.moderations.create(
    model="omni-moderation-latest",
    input="I hate you"
)
print("Moderation Response:", moderation_response)

API Methods

client.chat.completions.create(model: str, messages: list)

  • Description: Sends a chat prompt to the CablyAI API and returns the response.
  • Parameters:
    • model: The model to use for the chat.
    • messages: A list of messages in the conversation.

client.images.generate(prompt: str, n: int = 1, size: str = "1024x1024", response_format: str = "url", model: str)

  • Description: Generates an image based on the provided prompt.
  • Parameters:
    • prompt: The prompt for the image.
    • n: The number of images to generate (default is 1).
    • size: The size of the generated image (default is "1024x1024").
    • response_format: Format of the response (default is "url").
    • model: The model to use for image generation.

client.audio.speech.create(model: str, voice: str, input: str)

  • Description: Generates speech from the provided text input.
  • Parameters:
    • model: The model to use for text-to-speech conversion.
    • voice: The voice to use for the generated speech.
    • input: The text input to convert to speech.

client.moderations.create(model: str, input)

  • Description: Checks the content moderation for the provided input, which can be text or a combination of text and images.
  • Parameters:
    • model: The moderation model to use.
    • input: The input to moderate, can be text or a list containing both text and images.

License

This project is licensed under the ISC License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

Author

acatto

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

cablyai-0.0.2.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

cablyai-0.0.2-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file cablyai-0.0.2.tar.gz.

File metadata

  • Download URL: cablyai-0.0.2.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for cablyai-0.0.2.tar.gz
Algorithm Hash digest
SHA256 b706bd5538fa88d27c2d53c05d6b403fd3d0788dce0ce07363599f443f410bf5
MD5 3a6431723870daa9649679e9ca68859b
BLAKE2b-256 4871de6c67aa173eb4f7e0b44d30078b3ef53ddd05775f8fde330f0ab6f4722c

See more details on using hashes here.

File details

Details for the file cablyai-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: cablyai-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for cablyai-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5c6b55b305bc521f4bbdfb6bd8f327c5fc569dc7e2eb47a5d54fb41566598e5a
MD5 d44684987d8bc78f083be2ba239fd32d
BLAKE2b-256 82e0e5a8ee06972e5b6434ee5a01d1e51b66e279ee4ba3de0b7b4f64543b6c3d

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