haiku module

Haiku Generation Module

A client interface for AI-powered haiku poem generation.

This module provides the core functionality for communicating with an Ollama-based AI service to generate three-line haiku poems. It handles the entire generation process, from sending properly formatted requests to processing and validating the returned poems.

Classes

Haiku

A dataclass representation of a haiku poem, providing structure for storage, manipulation and serialization of poem data.

Methods:

  • to_json(): Converts a haiku instance to JSON format for API

    responses

  • generate_haiku(seed_text): Creates a new haiku using

    the AI service

Constants

AI_SERVICE_URL

The endpoint URL for the Ollama API service.

AI_MODEL_NAME

The specific AI model used for haiku generation.

REQUEST_TIMEOUT

The maximum time (in seconds) to wait for AI service responses.

Dependencies

  • requests: HTTP client library for API communication

  • dataclasses: Support for the Haiku data structure

  • logging: Error and diagnostic information capture

  • json: Processing of API responses

Implementation Details

The module implements a robust communication pattern with the AI service, including:

  1. Proper request formatting with seed text integration

  2. Multiple retry attempts for handling temporary service issues

  3. Response validation to ensure the returned text follows haiku structure

  4. Fallback mechanisms when the AI service returns unsuitable content

  5. JSON serialization for consistent data exchange

When communicating with the AI service, the module maintains appropriate error handling and logging to help diagnose any generation issues. It aims to provide a reliable haiku generation experience even when dealing with the inherent unpredictability of AI-generated content.

class haiku.Haiku(lines: list[str])

Bases: object

A class representing a haiku poem with three lines.

Variables:

lines – A list containing the three lines of the haiku.

Parameters:

lines (list[str])

get_json()

Converts the haiku lines to a JSON string.

Returns:

A JSON string representation of the haiku lines.

Return type:

str

lines: list[str]
static request_haiku(seed: str, url='http://ollama:11434/api/generate') → Haiku

Generates a haiku using an AI model based on the provided seed text.

This function prompts the AI to generate a haiku based on the user input. It validates that the response contains exactly 3 lines. The function will retry until a valid haiku is generated.

Parameters:

  • seed (str) – The input text used to inspire the haiku generation.

  • url – The URL to the AI endpoint

Returns:

A new Haiku object containing the generated three lines.

Return type:

Haiku

Raises:

Exception if took the llm too many tries to write a fitting haiku or JSONDecodeError if working with JSON failed