Client

Initialize the Elluminate SDK client.

Parameters:

Name	Type	Description	Default
base_url	str	Base URL of the Elluminate API. Defaults to "https://elluminate.de".	None
api_key	str | None	API key for authentication. If not provided, will look for key in environment variable given by api_key_env.	None
api_key_env	str	Name of environment variable containing API key. Defaults to "ELLUMINATE_API_KEY".	'ELLUMINATE_API_KEY'
base_url_env	str	Name of environment variable containing base URL. Defaults to "ELLUMINATE_BASE_URL". If set, overrides base_url.	'ELLUMINATE_BASE_URL'
timeout	float	Timeout in seconds for API requests. Defaults to 120.0.	120.0

Raises:

Type	Description
ValueError	If no API key is provided or found in environment.

prompt_templates instance-attribute

prompt_templates = PromptTemplatesResource(self)

collections instance-attribute

collections = TemplateVariablesCollectionsResource(self)

template_variables instance-attribute

template_variables = TemplateVariablesResource(self)

responses instance-attribute

responses = ResponsesResource(self)

criteria instance-attribute

criteria = CriteriaResource(self)

criterion_sets instance-attribute

criterion_sets = CriterionSetsResource(self)

llm_configs instance-attribute

llm_configs = LLMConfigsResource(self)

experiments instance-attribute

experiments = ExperimentsResource(self)

ratings instance-attribute

ratings = RatingsResource(self)

check_version

check_version() -> None

Check if the SDK version is compatible with the required version.