Redirect Client¶
The Redirect client provides methods for handling URL redirects in the Opik platform.
- class opik.rest_api.redirect.client.RedirectClient(*, client_wrapper: SyncClientWrapper)¶
Bases:
object
- datasets_redirect(*, dataset_id: str, path: str, workspace_name: str | None = None, request_options: RequestOptions | None = None) None ¶
Create dataset redirect url
- Parameters:
dataset_id (str)
path (str)
workspace_name (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.
- Return type:
None
Examples
from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.redirect.datasets_redirect(dataset_id=’dataset_id’, path=’path’, )
- experiments_redirect(*, dataset_id: str, experiment_id: str, path: str, workspace_name: str | None = None, request_options: RequestOptions | None = None) None ¶
Create experiment redirect url
- Parameters:
dataset_id (str)
experiment_id (str)
path (str)
workspace_name (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.
- Return type:
None
Examples
from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.redirect.experiments_redirect(dataset_id=’dataset_id’, experiment_id=’experiment_id’, path=’path’, )
- optimizations_redirect(*, dataset_id: str, optimization_id: str, path: str, workspace_name: str | None = None, request_options: RequestOptions | None = None) None ¶
Create optimization redirect url
- Parameters:
dataset_id (str)
optimization_id (str)
path (str)
workspace_name (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.
- Return type:
None
Examples
from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.redirect.optimizations_redirect(dataset_id=’dataset_id’, optimization_id=’optimization_id’, path=’path’, )
- projects_redirect(*, trace_id: str, path: str, workspace_name: str | None = None, request_options: RequestOptions | None = None) None ¶
Create project redirect url
- Parameters:
trace_id (str)
path (str)
workspace_name (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.
- Return type:
None
Examples
from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.redirect.projects_redirect(trace_id=’trace_id’, path=’path’, )
Usage Example¶
import opik
client = opik.Opik()
# Handle redirect operations
result = client.rest_client.redirect.redirect(
target_url="https://example.com/target"
)