Skip to main content

Cloudflare AI Python SDK

Project description

Cloudflare AI Python Wrapper

This Python library provides a convenient way to interact with the Cloudflare AI API asynchronously, allowing you to leverage the power of Cloudflare's AI models in your applications. With this wrapper, you can easily integrate AI-driven features into your projects without the hassle of handling API requests and responses manually.

Installation

Install from PyPI:

pip install cloudflareai

Install from Github:

python -m pip install -U git+https://github.com/alexraskin/cloudflareai-py

Or build from source:

git clone
cd cloudflareai
python setup.py install

Usage

Import the CloudflareAI class and the desired model enums. Then, create an instance of the CloudflareAI class with your Cloudflare API key and account identifier. You can then use the instance to call the desired AI model.

import asyncio

from cloudflareai import (
    CloudflareAI,
    AiTextToImageModels,
    AiTextGenerationModels,
    AiImageClassificationModels,
)


async def main():
    ai = CloudflareAI(
        Cloudflare_API_Key=<Your Token>,
        Cloudflare_Account_Identifier=<Account ID>,
    )

    text = await ai.TextGeneration(
        prompt="You are helpful",
        system_prompt="Hello, my name is Alex",
        model_name=AiTextGenerationModels.CODE_LLAMA_7B,
    )
    image = await ai.TextToImage(
      prompt="a Cat",
      model_name=AiTextToImageModels.XL_BASE
    )
    print(text.text) # returns string
    print(image.image) # returns bytes

    ### Also get status codes
    print(text.status_code)
    print(image.status_code)

asyncio.run(main())

Models

This wrapper also includes enums for AI models, making it easier to select the desired model for your tasks. Available enums include:

  • AiImageClassificationModels
  • AiTranslationModels
  • AiTextGenerationModels
  • AiSpeechRecognitionModels
  • AiTextToImageModels
  • TranslationLanguages

Contributing

If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Submit a pull request with a clear description of your changes.

License

Mozilla Public License Version 2.0 (MPL-2.0) - See LICENSE for more information.

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

cloudflareai-0.6.0.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

cloudflareai-0.6.0-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file cloudflareai-0.6.0.tar.gz.

File metadata

  • Download URL: cloudflareai-0.6.0.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for cloudflareai-0.6.0.tar.gz
Algorithm Hash digest
SHA256 b9344e2257ee586e77a40ecb6bc6c0cdbe7d158f9f7f668d0f2ea8a28fa36906
MD5 4434f9b8e8845b29f3ea1231c2e30dd9
BLAKE2b-256 d7a82175e260c15b57c5b8fefe547cb03bb64b5b4a71950838f353e79933e0bb

See more details on using hashes here.

File details

Details for the file cloudflareai-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cloudflareai-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 276cadb3ce854ecee44335d1b147c40e3fd1b9cf000d467a9b582c346faa63b1
MD5 1f13414fed8f25fd83728cb4e1f92dd9
BLAKE2b-256 7539c6c5fcb0a53fb1a283258de60b62cc99653aa3de2e53331c98b52f4822f3

See more details on using hashes here.

Supported by

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