Workspaces Client¶

The Workspaces client provides methods for managing workspaces in the Opik platform.

class opik.rest_api.workspaces.client.WorkspacesClient(*, client_wrapper: SyncClientWrapper)¶

Bases: object

costs_summary(*, interval_start: datetime, interval_end: datetime, project_ids: Sequence[str] | None = OMIT, start_before_end: bool | None = OMIT, request_options: RequestOptions | None = None) → Result¶

Get costs summary

Parameters:

interval_start (dt.datetime)
interval_end (dt.datetime)
project_ids (Optional[Sequence[str]])
start_before_end (Optional[bool])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Workspace Metrics

Return type:

Result

get_workspace_configuration(*, request_options: RequestOptions | None = None) → WorkspaceConfiguration¶

Get workspace configuration

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: Workspace Configuration
Return type:: WorkspaceConfiguration

upsert_workspace_configuration(*, timeout_to_mark_thread_as_inactive: str | None = OMIT, request_options: RequestOptions | None = None) → WorkspaceConfiguration¶

Upsert workspace configuration

Parameters:

timeout_to_mark_thread_as_inactive (Optional[str]) – Duration in ISO-8601 format (e.g., PT30M for 30 minutes, PT2H for 2 hours, P1D for 1 day). Minimum precision supported is seconds, please use a duration with seconds precision or higher. Also, the max duration allowed is 7 days.
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Configuration Updated

Return type:

WorkspaceConfiguration

delete_workspace_configuration(*, request_options: RequestOptions | None = None) → None¶

Delete workspace configuration

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Return type:: None

get_cost(*, interval_start: datetime, interval_end: datetime, project_ids: Sequence[str] | None = OMIT, start_before_end: bool | None = OMIT, request_options: RequestOptions | None = None) → WorkspaceMetricResponse¶

Get cost daily data

Parameters:

interval_start (dt.datetime)
interval_end (dt.datetime)
project_ids (Optional[Sequence[str]])
start_before_end (Optional[bool])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Workspace cost data by days

Return type:

WorkspaceMetricResponse

get_metric(*, interval_start: datetime, interval_end: datetime, project_ids: Sequence[str] | None = OMIT, start_before_end: bool | None = OMIT, request_options: RequestOptions | None = None) → WorkspaceMetricResponse¶

Get metric daily data

Parameters:

interval_start (dt.datetime)
interval_end (dt.datetime)
project_ids (Optional[Sequence[str]])
start_before_end (Optional[bool])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Workspace metric data by days

Return type:

WorkspaceMetricResponse

metrics_summary(*, interval_start: datetime, interval_end: datetime, project_ids: Sequence[str] | None = OMIT, start_before_end: bool | None = OMIT, request_options: RequestOptions | None = None) → WorkspaceMetricsSummaryResponse¶

Get metrics summary

Parameters:

interval_start (dt.datetime)
interval_end (dt.datetime)
project_ids (Optional[Sequence[str]])
start_before_end (Optional[bool])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Workspace Metrics

Return type:

WorkspaceMetricsSummaryResponse

Usage Example¶

import opik

client = opik.Opik()

# Get workspace information
workspace = client.rest_client.workspaces.get_workspace()

# Get workspace statistics
stats = client.rest_client.workspaces.get_workspace_stats()