yera.cli.setup_handlers.openai

OpenAI provider setup handler.

Symbols

class OpenAISetup — Handler for configuring OpenAI provider connections.

OpenAISetup

Inherits: BaseProviderSetup

Handler for configuring OpenAI provider connections.

This class implements the logic required to discover, prompt for, and validate the environment variables used to authenticate with OpenAI's API.

Methods

detect_config — Attempts to automatically detect an OpenAI API key from the environment.
ask_for_config — Interactively prompts the user to configure an OpenAI connection.
validate — Validates the provided OpenAI connection configuration.

OpenAISetup.detect_config

detect_config() → OpenAIConnection | None

Attempts to automatically detect an OpenAI API key from the environment.

Checks for the presence of the default OpenAI environment variable. If found, it returns a connection configuration pointing to that variable.

Returns

type: OpenAIConnection | None

An OpenAIConnection instance if the default environment variable is detected; otherwise, None.

OpenAISetup.ask_for_config

ask_for_config() → OpenAIConnection | None

Interactively prompts the user to configure an OpenAI connection.

First asks the user for confirmation to proceed, then prompts for the name of the environment variable that holds the API key.

Returns

type: OpenAIConnection | None

An OpenAIConnection instance containing the user-specified environment variable name, or None if the user declines the setup.

OpenAISetup.validate

validate(
    config: OpenAIConnection,
) → None

Validates the provided OpenAI connection configuration.

This method ensures that the specified environment variable is actually set and that its value matches the expected format of an OpenAI API key (starting with 'sk-' and meeting minimum length requirements).

Parameters

config
type: OpenAIConnection

The OpenAI connection configuration to validate.

Raises

ValueError

If the environment variable is not set or if the API key format is invalid.