promptscan-sdk 0.1.0

No project description provided

PromptScan Python SDK

The PromptScan Python SDK provides a simple way to integrate PromptScan's monitoring and analytics capabilities into your LLM application.

Installation

pip install promptscan-sdk

Quick Start

import promptscan_sdk
from promptscan_sdk.client import GenerationInput, GenerationMessageInput, UsageInput
from datetime import datetime, UTC

# Initialize the SDK
promptscan_sdk.configure(api_key="your-project-api-key")

# Collect generation data
promptscan_sdk.collect(
    GenerationInput(
        session_id="unique-session-id",
        id="generation-id",
        model="gpt-4",
        messages=[
            GenerationMessageInput(role="system", content="You are a helpful assistant.")
        ],
        usage=UsageInput(
            prompt_tokens=100,
            completion_tokens=50,
            total_tokens=150
        ),
        created=datetime.now(tz=UTC),
        duration=0.5,
        time_to_first_token=0.15
    )
)

# Close the SDK on application exit, since it uses background threads for non-blocking flushing of the generations that should be stopped and generation buffer flushed.
promptscan_sdk.close()

Multiple api-key support

You can log generations for different projects by using multiple project api-keys.

collect(generation_a_input, api_key="your-project-A-api-key")
collect(generation_b_input, api_key="your-project-B-api-key")