AIStudio Python SDK

0.3.8 · active · verified Sun Apr 12

The `aistudio-sdk` is a Python client library for interacting with the AIStudio API. It provides convenient access to AI models for tasks like text generation. Currently at version 0.3.8, it receives frequent updates aligning with the underlying API's evolution.

Warnings

breaking As the library is in its 0.x.x version, breaking changes to the API surface (class names, method signatures, return types) may occur in minor releases without a full major version bump.
Fix: Always review release notes for `aistudio-sdk` when upgrading. Pin your dependency to a specific minor version (e.g., `aistudio-sdk~=0.3.0`) in production to control updates.
gotcha The SDK primarily relies on the `AISTUDIO_API_KEY` environment variable for authentication. While a `Client` object can be instantiated with an `api_key` argument, service classes like `TextGeneration` do not directly accept `api_key` in their constructor.
Fix: Ensure `AISTUDIO_API_KEY` is consistently set in your environment. If you need to manage multiple keys or explicitly pass one, instantiate `aistudio.Client(api_key="...")` first and then pass that client to service classes if they support it, or set the environment variable programmatically with `os.environ['AISTUDIO_API_KEY'] = '...'` before initializing the service.
gotcha The example models provided in the documentation (e.g., 'gpt-3.5-turbo') are illustrative. The actual availability and names of models depend on the AIStudio API itself and may change. Using an unsupported model will result in an API error.
Fix: Consult the official AIStudio API documentation or SDK methods (if available) to get a list of currently supported models before making API calls.
gotcha API responses may contain detailed error messages or specific structures beyond just `response.text` for generation results. Ignoring these can lead to missed debugging opportunities.
Fix: When an API call fails, inspect the full exception object or response object for `status_code`, `error` fields, or other diagnostic information to understand the cause (e.g., rate limits, invalid input, authentication issues).

Install

pip install aistudio-sdk Install stable version

Imports

TextGeneration
```
from aistudio import TextGeneration
```
Client
```
from aistudio import Client
```
The primary `Client` class is exposed at the top-level `aistudio` package.

Quickstart

This quickstart demonstrates how to perform text generation using the `TextGeneration` class. The SDK automatically picks up the `AISTUDIO_API_KEY` from environment variables. Remember to replace 'gpt-3.5-turbo' with an actual model supported by the AIStudio API.

import os
from aistudio import TextGeneration

# Ensure the AISTUDIO_API_KEY environment variable is set.
# Example: export AISTUDIO_API_KEY="your_secret_key"
# For local testing without setting a real key (will likely fail API calls):
# os.environ['AISTUDIO_API_KEY'] = 'sk-aistudio-dummy-key'

try:
    # The SDK automatically picks up AISTUDIO_API_KEY from environment variables.
    gen = TextGeneration()
    response = gen.create(
        prompt="Hello, my name is",
        model="gpt-3.5-turbo", # Replace with an available model on AIStudio
        temperature=0.7,
        max_tokens=20
    )
    print("Generated text:", response.text)
except Exception as e:
    print(f"An error occurred: {e}")
    print("Please ensure AISTUDIO_API_KEY is set and valid, and the model specified is available.")

view raw JSON →