@arizeai/phoenix-client
Version:
A client for the Phoenix API
39 lines • 1.47 kB
TypeScript
/**
* Utility functions for constructing URLs to Phoenix resources
*/
/**
* Get the URL to view a specific experiment in the Phoenix web UI
* @param params - The parameters for generating the experiment URL
* @param params.baseUrl - The base URL of the Phoenix API
* @param params.datasetId - The ID of the dataset
* @param params.experimentId - The ID of the experiment
* @returns The URL to view the experiment
*/
export declare function getExperimentUrl({ baseUrl, datasetId, experimentId, }: {
baseUrl: string;
datasetId: string;
experimentId: string;
}): string;
/**
* Get the URL to view experiments for a dataset in the Phoenix web UI
* @param params - The parameters for generating the dataset experiments URL
* @param params.baseUrl - The base URL of the Phoenix API
* @param params.datasetId - The ID of the dataset
* @returns The URL to view dataset experiments
*/
export declare function getDatasetExperimentsUrl({ baseUrl, datasetId, }: {
baseUrl: string;
datasetId: string;
}): string;
/**
* Get the URL to view a dataset in the Phoenix web UI
* @param params - The parameters for generating the dataset URL
* @param params.baseUrl - The base URL of the Phoenix API
* @param params.datasetId - The ID of the dataset
* @returns The URL to view the dataset
*/
export declare function getDatasetUrl({ baseUrl, datasetId, }: {
baseUrl: string;
datasetId: string;
}): string;
//# sourceMappingURL=urlUtils.d.ts.map