@arizeai/phoenix-client/dist/esm/types/datasets.d.ts

A client for the Phoenix API

import { Node } from "./core.js";
/**
 * A dataset can be identified by its datasetId, datasetName, or datasetVersionId
 */
export type DatasetSelector = {
    datasetId: string;
} | {
    datasetName: string;
};
/**
 * Parameters for selecting a specific version of a dataset
 */
export interface DatasetVersionSelector {
    dataset: DatasetSelector;
    versionId?: string;
}
/**
 * Overview information about a dataset
 */
export interface DatasetInfo extends Node {
    name: string;
    description?: string | null;
    metadata?: Record<string, unknown>;
}
/**
 * Information about a dataset version
 */
export interface DatasetVersionInfo extends Node {
    description?: string | null;
    metadata?: Record<string, unknown>;
    createdAt: Date;
}
/**
 * A dataset's examples
 */
export interface DatasetExamples {
    examples: ExampleWithId[];
    /**
     * The version ID of the dataset examples
     */
    versionId: string;
}
/**
 * An example is a record to feed into an AI task
 */
export interface Example {
    input: Record<string, unknown>;
    output: Record<string, unknown> | null;
    metadata: Record<string, unknown>;
}
/**
 * An example that has been synced to the server
 */
export interface ExampleWithId extends Example, Node {
    updatedAt: Date;
}
/**
 * A dataset is a collection of examples for an AI task
 */
export interface Dataset extends DatasetInfo, DatasetExamples, Node {
}
/**
 * A dataset with its version information
 */
export interface DatasetWithVersion extends Dataset {
    versionInfo: DatasetVersionInfo;
}
//# sourceMappingURL=datasets.d.ts.map