Skip to main content

A Python SDK for PromptStudio

Project description

PromptStudio Python SDK

A Python SDK for interacting with PromptStudio API and AI platforms directly.

Installation

From PyPI (Coming Soon)

pip install promptstudio-sdk

From Source

git clone https://github.com/your-repo/promptstudio-sdk.git
cd promptstudio-sdk
pip install -e .

Development Setup

  1. Create a virtual environment:
python -m venv venv
  1. Activate the virtual environment:
# On Windows
venv\Scripts\activate

# On Unix or MacOS
source venv/bin/activate
  1. Install dependencies:
pip install -r requirements.txt

Usage

Initializing the SDK

from promptstudio_sdk import PromptStudio

client = PromptStudio({
    'api_key': 'YOUR_API_KEY',
    'env': 'test'  # Use 'prod' for production environment
})

Getting All Prompts

# Get all prompts from a specific folder
prompts = client.get_all_prompts("your_folder_id")
print(prompts)

Chatting with a Prompt

response = client.chat_with_prompt(
    prompt_id="your_prompt_id",
    user_message=[
        {
            "type": "text",
            "text": "Hello, how are you?"
        }
    ],
    memory_type="fullMemory",
    window_size=10,
    session_id="test_session",
    variables={}
)

print(response)

Complete Example

from promptstudio_sdk import PromptStudio

def main():
    # Initialize the client
    client = PromptStudio({
        'api_key': 'YOUR_API_KEY',
        'env': 'test'
    })

    try:
        # Get all prompts
        prompts = client.get_all_prompts("your_folder_id")
        print("Available prompts:", prompts)

        # Chat with a specific prompt
        response = client.chat_with_prompt(
            prompt_id="your_prompt_id",
            user_message=[
                {
                    "type": "text",
                    "text": "Hello, how are you?"
                }
            ],
            memory_type="windowMemory",
            window_size=10,
            session_id="test_session",
            variables={}
        )
        print("Chat response:", response)

    except Exception as e:
        print(f"An error occurred: {e}")

if __name__ == "__main__":
    main()

Testing

Setting Up Tests

  1. Install test dependencies:
pip install pytest pytest-cov
  1. Create a .env file in the root directory with your test credentials:
PROMPTSTUDIO_API_KEY=your_test_api_key
PROMPTSTUDIO_ENV=test

Running Tests

Run all tests:

pytest

Run tests with coverage:

pytest --cov=promptstudio_sdk

Writing Tests

Create test files in the tests directory. Here's an example test:

import pytest
from promptstudio_sdk import PromptStudio

def test_chat_with_prompt():
    client = PromptStudio({
        'api_key': 'test_api_key',
        'env': 'test'
    })

    response = client.chat_with_prompt(
        prompt_id="test_prompt",
        user_message=[{"type": "text", "text": "Hello"}],
        memory_type="fullMemory",
        window_size=10,
        session_id="test_session",
        variables={}
    )

    assert isinstance(response, dict)
    assert 'response' in response

Type Hints

The SDK uses Python type hints for better IDE support and code documentation. Here are some key types:

from typing import Dict, List, Union, Optional

# Message types
ImageMessage = Dict[str, Union[str, Dict[str, str]]]  # {"type": "image_url", "image_url": {"url": "..."}}
TextMessage = Dict[str, str]  # {"type": "text", "text": "..."}
UserMessage = List[Union[ImageMessage, TextMessage]]

# Memory types
Memory = Literal["fullMemory", "windowMemory", "summarizedMemory"]

# Request payload
RequestPayload = Dict[str, Union[UserMessage, Memory, int, str, Dict[str, str], Optional[int]]]

Error Handling

The SDK raises exceptions for various error cases:

from promptstudio_sdk import PromptStudio

try:
    client = PromptStudio({
        'api_key': 'YOUR_API_KEY',
        'env': 'test'
    })
    response = client.chat_with_prompt(...)
except requests.exceptions.HTTPError as e:
    print(f"HTTP error occurred: {e}")
except requests.exceptions.RequestException as e:
    print(f"Network error occurred: {e}")
except Exception as e:
    print(f"An error occurred: {e}")

Contributing

  1. Fork the repository
  2. Create a new branch for your feature
  3. Make your changes
  4. Run the tests to ensure everything works
  5. Submit a pull request

License

This SDK is released under the MIT License.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

promptstudio_sdk-0.1.0.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

promptstudio_sdk-0.1.0-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file promptstudio_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: promptstudio_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for promptstudio_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 22aeaac74662368aa936edfb3ee9a0f9b6da61edc85e7fd87f3d44f12c214023
MD5 57eac3c63f4bc9e5c0784c4d1bf1611a
BLAKE2b-256 7a1c1d6348d59e8dee3d7edfb8dd48fa93d35ffdce2ed279505b7f505dd476d4

See more details on using hashes here.

File details

Details for the file promptstudio_sdk-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for promptstudio_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1fdd509e8186bd295d7ee6ac94340511b445ab0e02592a24fb61d14b512f25c8
MD5 fe844f99349d86a7f431d0410daa4da1
BLAKE2b-256 220304bcb82b48b6549ffa23250b9a111bd3a0a9a1ab981769a0fc3879ad1031

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