import { APIResource } from '../../core/resource.js'; import * as ComparativeAPI from '../datasets/comparative.js'; import * as DatasetsAPI from '../datasets/datasets.js'; import * as FeedbackAPI from '../feedback/feedback.js'; import { FeedbackSchemasOffsetPaginationTopLevelArray } from '../feedback/feedback.js'; import * as SessionsAPI from '../sessions/sessions.js'; import { TracerSessionsOffsetPaginationTopLevelArray } from '../sessions/sessions.js'; import { APIPromise } from '../../core/api-promise.js'; import { OffsetPaginationTopLevelArray, type OffsetPaginationTopLevelArrayParams, PagePromise } from '../../core/pagination.js'; import { RequestOptions } from '../../internal/request-options.js'; export declare class Datasets extends APIResource { /** * Get dataset by ids or the shared dataset if not specifed. */ list(shareToken: string, query?: DatasetListParams | null | undefined, options?: RequestOptions): APIPromise; /** * Get all comparative experiments for a given dataset. */ listComparative(shareToken: string, query?: DatasetListComparativeParams | null | undefined, options?: RequestOptions): PagePromise; /** * Get feedback for runs in projects run over a dataset that has been shared. */ listFeedback(shareToken: string, query?: DatasetListFeedbackParams | null | undefined, options?: RequestOptions): PagePromise; /** * Get projects run on a dataset that has been shared. */ listSessions(shareToken: string, params?: DatasetListSessionsParams | null | undefined, options?: RequestOptions): PagePromise; /** * Get sessions from multiple datasets using share tokens. */ retrieveSessionsBulk(query: DatasetRetrieveSessionsBulkParams, options?: RequestOptions): APIPromise; } export type DatasetListComparativeResponsesOffsetPaginationTopLevelArray = OffsetPaginationTopLevelArray; /** * Public schema for datasets. * * Doesn't currently include session counts/stats since public test project sharing * is not yet shipped */ export interface DatasetListResponse { id: string; example_count: number; name: string; created_at?: string; /** * Enum for dataset data types. */ data_type?: DatasetsAPI.DataType | null; description?: string | null; externally_managed?: boolean | null; inputs_schema_definition?: { [key: string]: unknown; } | null; outputs_schema_definition?: { [key: string]: unknown; } | null; transformations?: Array | null; } /** * Publicly-shared ComparativeExperiment schema. */ export interface DatasetListComparativeResponse { id: string; created_at: string; experiments_info: Array; modified_at: string; description?: string | null; extra?: { [key: string]: unknown; } | null; feedback_stats?: { [key: string]: unknown; } | null; name?: string | null; } export type DatasetRetrieveSessionsBulkResponse = Array; export interface DatasetListParams { limit?: number; offset?: number; /** * Enum for available dataset columns to sort by. */ sort_by?: DatasetsAPI.SortByDatasetColumn; sort_by_desc?: boolean; } export interface DatasetListComparativeParams extends OffsetPaginationTopLevelArrayParams { name?: string | null; name_contains?: string | null; /** * Enum for available comparative experiment columns to sort by. */ sort_by?: ComparativeAPI.SortByComparativeExperimentColumn; sort_by_desc?: boolean; } export interface DatasetListFeedbackParams extends OffsetPaginationTopLevelArrayParams { has_comment?: boolean | null; has_score?: boolean | null; key?: Array | null; /** * Enum for feedback levels. */ level?: FeedbackAPI.FeedbackLevel | null; run?: Array | null; session?: Array | null; source?: Array | null; user?: Array | null; } export interface DatasetListSessionsParams extends OffsetPaginationTopLevelArrayParams { /** * Query param */ id?: Array | null; /** * Query param */ dataset_version?: string | null; /** * Query param */ facets?: boolean; /** * Query param */ name?: string | null; /** * Query param */ name_contains?: string | null; /** * Query param */ sort_by?: SessionsAPI.SessionSortableColumns; /** * Query param */ sort_by_desc?: boolean; /** * Query param */ sort_by_feedback_key?: string | null; /** * Header param */ accept?: string; } export interface DatasetRetrieveSessionsBulkParams { share_tokens: Array; } export declare namespace Datasets { export { type DatasetListResponse as DatasetListResponse, type DatasetListComparativeResponse as DatasetListComparativeResponse, type DatasetRetrieveSessionsBulkResponse as DatasetRetrieveSessionsBulkResponse, type DatasetListComparativeResponsesOffsetPaginationTopLevelArray as DatasetListComparativeResponsesOffsetPaginationTopLevelArray, type DatasetListParams as DatasetListParams, type DatasetListComparativeParams as DatasetListComparativeParams, type DatasetListFeedbackParams as DatasetListFeedbackParams, type DatasetListSessionsParams as DatasetListSessionsParams, type DatasetRetrieveSessionsBulkParams as DatasetRetrieveSessionsBulkParams, }; } export { type FeedbackSchemasOffsetPaginationTopLevelArray, type TracerSessionsOffsetPaginationTopLevelArray, };