yera.setup.provider_setup.openai

Obtain and validate OpenAI provider configuration.

Symbols

class OpenAIProviderSetup — Provide presentation-independent OpenAI setup operations.

OpenAIProviderSetup

Inherits: ProviderSetup[OpenAIConnection]

Provide presentation-independent OpenAI setup operations.

Configuration discovery looks for the conventional OpenAI API-key environment variable. Validation checks that the configured variable exists and contains a plausibly formatted OpenAI API key.

Attributes

provider_type

Configuration key for the OpenAI provider.

dependencies

Python modules required by the integration.

Methods

get_config — Obtain OpenAI configuration from the process environment.

validate — Validate an OpenAI API-key environment variable.

OpenAIProviderSetup.get_config

get_config() → SetupResult[tuple[OpenAIConnection, ...]]

Obtain OpenAI configuration from the process environment.

Returns

type: SetupResult[tuple[OpenAIConnection, ...]]

A result containing one connection candidate referencing OPENAI_API_KEY when it is present. Otherwise, the result contains an empty candidate tuple.

OpenAIProviderSetup.validate

validate(
    config: OpenAIConnection,
) → SetupResult[OpenAIConnection]

Validate an OpenAI API-key environment variable.

Parameters

config

type: OpenAIConnection

OpenAI connection containing the environment-variable name.

Returns

type: SetupResult[OpenAIConnection]

The supplied configuration with errors describing a missing, empty, or implausibly formatted API key.