configure

opik.configure(api_key: str | None = None, workspace: str | None = None, url: str | None = None, use_local: bool = False, force: bool = False) → None

Create a local configuration file for the Python SDK. If a configuration file already exists, it will not be overwritten unless the force parameter is set to True.

Parameters:

• api_key – The API key if using an Opik Cloud.

• workspace – The workspace name if using an Opik Cloud.

• url – The URL of the Opik instance if you are using a local deployment.

• use_local – Whether to use a local deployment.

• force – If true, the configuration file will be recreated and existing settings will be overwritten with passed parameters.

Raises:

ConfigurationError –