@atlanai/sdk 0.1.1 → 0.2.2

package/dist/raw/eval/apis/DatasetsApi.d.ts

@@ -0,0 +1,344 @@
+/**
+ * Evaluation catalog
+ * The evaluation loop as registry artifacts: curated `dataset`s of examples pinned from production sessions and traces, `experiment` run snapshots with create-only per-case `experiment_result`s, and versioned `scorer` definitions. Finalizing an experiment derives its durable score `summary` from the uploaded result rows. The gateway executes and scores nothing — external harnesses, CI, and judges run the evals, emit score spans, and upload results here.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type EvalArtifactSearchRequest } from '../models/EvalArtifactSearchRequest';
+import { type EvalBulkDatasetRecordResponse } from '../models/EvalBulkDatasetRecordResponse';
+import { type EvalDatasetArtifactView } from '../models/EvalDatasetArtifactView';
+import { type EvalDatasetCreate } from '../models/EvalDatasetCreate';
+import { type EvalDatasetPatch } from '../models/EvalDatasetPatch';
+import { type EvalDatasetRecordArtifactView } from '../models/EvalDatasetRecordArtifactView';
+import { type EvalDatasetRecordBulkCreate } from '../models/EvalDatasetRecordBulkCreate';
+import { type EvalDatasetRecordCreate } from '../models/EvalDatasetRecordCreate';
+import { type EvalDatasetRecordPatch } from '../models/EvalDatasetRecordPatch';
+import { type EvalPageDatasetArtifactView } from '../models/EvalPageDatasetArtifactView';
+import { type EvalPageDatasetRecordArtifactView } from '../models/EvalPageDatasetRecordArtifactView';
+import { type EvalRecordSource } from '../models/EvalRecordSource';
+export interface EvalArchiveDatasetRequest {
+    datasetId: string;
+}
+export interface EvalArchiveDatasetRecordRequest {
+    datasetId: string;
+    recordId: string;
+}
+export interface EvalCreateDatasetRequest {
+    evalDatasetCreate: EvalDatasetCreate;
+    contentEncoding?: EvalCreateDatasetContentEncodingEnum;
+}
+export interface EvalCreateDatasetRecordRequest {
+    datasetId: string;
+    evalDatasetRecordCreate: EvalDatasetRecordCreate;
+    contentEncoding?: EvalCreateDatasetRecordContentEncodingEnum;
+}
+export interface EvalCreateDatasetRecordsBulkRequest {
+    datasetId: string;
+    evalDatasetRecordBulkCreate: EvalDatasetRecordBulkCreate;
+    contentEncoding?: EvalCreateDatasetRecordsBulkContentEncodingEnum;
+}
+export interface EvalGetDatasetRequest {
+    datasetId: string;
+}
+export interface EvalGetDatasetRecordRequest {
+    datasetId: string;
+    recordId: string;
+}
+export interface EvalGetDatasetRecordVersionRequest {
+    datasetId: string;
+    recordId: string;
+    versionOrdinal: number;
+}
+export interface EvalListDatasetRecordVersionsRequest {
+    datasetId: string;
+    recordId: string;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+}
+export interface EvalListDatasetRecordsRequest {
+    datasetId: string;
+    limit?: number;
+    offset?: number;
+    q?: string;
+    label?: string;
+    category?: string;
+    sourceKind?: EvalRecordSource;
+    sourceRef?: string;
+    sort?: string;
+}
+export interface EvalListDatasetsRequest {
+    limit?: number;
+    offset?: number;
+    sort?: string;
+}
+export interface EvalPatchDatasetRequest {
+    datasetId: string;
+    evalDatasetPatch: EvalDatasetPatch;
+    contentEncoding?: EvalPatchDatasetContentEncodingEnum;
+}
+export interface EvalPatchDatasetRecordRequest {
+    datasetId: string;
+    recordId: string;
+    evalDatasetRecordPatch: EvalDatasetRecordPatch;
+    contentEncoding?: EvalPatchDatasetRecordContentEncodingEnum;
+}
+export interface EvalSearchDatasetsRequest {
+    evalArtifactSearchRequest: EvalArtifactSearchRequest;
+    contentEncoding?: EvalSearchDatasetsContentEncodingEnum;
+}
+/**
+ *
+ */
+export declare class DatasetsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for evalArchiveDataset without sending the request
+     */
+    evalArchiveDatasetRequestOpts(requestParameters: EvalArchiveDatasetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Soft-delete the dataset and cascade its records. Deliberately **not** refused while experiments reference it: an experiment is a historical snapshot whose results carry their own input/expected copies, so its `dataset_id` pointer going stale is honest history rather than a dangling reference.
+     * Archive a dataset
+     */
+    evalArchiveDatasetRaw(requestParameters: EvalArchiveDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetArtifactView>>;
+    /**
+     * Soft-delete the dataset and cascade its records. Deliberately **not** refused while experiments reference it: an experiment is a historical snapshot whose results carry their own input/expected copies, so its `dataset_id` pointer going stale is honest history rather than a dangling reference.
+     * Archive a dataset
+     */
+    evalArchiveDataset(requestParameters: EvalArchiveDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetArtifactView>;
+    /**
+     * Creates request options for evalArchiveDatasetRecord without sending the request
+     */
+    evalArchiveDatasetRecordRequestOpts(requestParameters: EvalArchiveDatasetRecordRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Soft-delete one row. Past experiment results that sampled it keep their own input/expected snapshots, so nothing dangles.
+     * Archive a record
+     */
+    evalArchiveDatasetRecordRaw(requestParameters: EvalArchiveDatasetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetRecordArtifactView>>;
+    /**
+     * Soft-delete one row. Past experiment results that sampled it keep their own input/expected snapshots, so nothing dangles.
+     * Archive a record
+     */
+    evalArchiveDatasetRecord(requestParameters: EvalArchiveDatasetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetRecordArtifactView>;
+    /**
+     * Creates request options for evalCreateDataset without sending the request
+     */
+    evalCreateDatasetRequestOpts(requestParameters: EvalCreateDatasetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a curated collection of evaluation examples — a golden set, a repro set, a labeled traffic sample. Rows are added afterwards as dataset records, pinned from production sessions and traces or supplied manually.
+     * Create a dataset
+     */
+    evalCreateDatasetRaw(requestParameters: EvalCreateDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetArtifactView>>;
+    /**
+     * Create a curated collection of evaluation examples — a golden set, a repro set, a labeled traffic sample. Rows are added afterwards as dataset records, pinned from production sessions and traces or supplied manually.
+     * Create a dataset
+     */
+    evalCreateDataset(requestParameters: EvalCreateDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetArtifactView>;
+    /**
+     * Creates request options for evalCreateDatasetRecord without sending the request
+     */
+    evalCreateDatasetRecordRequestOpts(requestParameters: EvalCreateDatasetRecordRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Append one example row. The parent comes from the path, so `dataset_id` is not a body field. Provenance says where the row was pinned from: a `session` source resolves against the gateway\'s own session artifacts, a `trace` source records an OTel trace id verbatim, and a `manual` row names no source.
+     * Add a record to a dataset
+     */
+    evalCreateDatasetRecordRaw(requestParameters: EvalCreateDatasetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetRecordArtifactView>>;
+    /**
+     * Append one example row. The parent comes from the path, so `dataset_id` is not a body field. Provenance says where the row was pinned from: a `session` source resolves against the gateway\'s own session artifacts, a `trace` source records an OTel trace id verbatim, and a `manual` row names no source.
+     * Add a record to a dataset
+     */
+    evalCreateDatasetRecord(requestParameters: EvalCreateDatasetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetRecordArtifactView>;
+    /**
+     * Creates request options for evalCreateDatasetRecordsBulk without sending the request
+     */
+    evalCreateDatasetRecordsBulkRequestOpts(requestParameters: EvalCreateDatasetRecordsBulkRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create up to 100 records in one call — the \"add all matching\" curation flow. **207 Multi-Status**: one index-aligned slot per submitted item, so a single rejected row does not fail the batch.
+     * Add many records to a dataset
+     */
+    evalCreateDatasetRecordsBulkRaw(requestParameters: EvalCreateDatasetRecordsBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalBulkDatasetRecordResponse>>;
+    /**
+     * Create up to 100 records in one call — the \"add all matching\" curation flow. **207 Multi-Status**: one index-aligned slot per submitted item, so a single rejected row does not fail the batch.
+     * Add many records to a dataset
+     */
+    evalCreateDatasetRecordsBulk(requestParameters: EvalCreateDatasetRecordsBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalBulkDatasetRecordResponse>;
+    /**
+     * Creates request options for evalGetDataset without sending the request
+     */
+    evalGetDatasetRequestOpts(requestParameters: EvalGetDatasetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Read one dataset.
+     * Get a dataset
+     */
+    evalGetDatasetRaw(requestParameters: EvalGetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetArtifactView>>;
+    /**
+     * Read one dataset.
+     * Get a dataset
+     */
+    evalGetDataset(requestParameters: EvalGetDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetArtifactView>;
+    /**
+     * Creates request options for evalGetDatasetRecord without sending the request
+     */
+    evalGetDatasetRecordRequestOpts(requestParameters: EvalGetDatasetRecordRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Read one dataset record with its full typed metadata. The record must belong to the dataset named in the path; a mismatched parent is returned as 404.
+     * Get one record
+     */
+    evalGetDatasetRecordRaw(requestParameters: EvalGetDatasetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetRecordArtifactView>>;
+    /**
+     * Read one dataset record with its full typed metadata. The record must belong to the dataset named in the path; a mismatched parent is returned as 404.
+     * Get one record
+     */
+    evalGetDatasetRecord(requestParameters: EvalGetDatasetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetRecordArtifactView>;
+    /**
+     * Creates request options for evalGetDatasetRecordVersion without sending the request
+     */
+    evalGetDatasetRecordVersionRequestOpts(requestParameters: EvalGetDatasetRecordVersionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Use this operation to get a record version.
+     * Get a record version
+     */
+    evalGetDatasetRecordVersionRaw(requestParameters: EvalGetDatasetRecordVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetRecordArtifactView>>;
+    /**
+     * Use this operation to get a record version.
+     * Get a record version
+     */
+    evalGetDatasetRecordVersion(requestParameters: EvalGetDatasetRecordVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetRecordArtifactView>;
+    /**
+     * Creates request options for evalListDatasetRecordVersions without sending the request
+     */
+    evalListDatasetRecordVersionsRequestOpts(requestParameters: EvalListDatasetRecordVersionsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Use this operation to list record versions.
+     * List record versions
+     */
+    evalListDatasetRecordVersionsRaw(requestParameters: EvalListDatasetRecordVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalPageDatasetRecordArtifactView>>;
+    /**
+     * Use this operation to list record versions.
+     * List record versions
+     */
+    evalListDatasetRecordVersions(requestParameters: EvalListDatasetRecordVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalPageDatasetRecordArtifactView>;
+    /**
+     * Creates request options for evalListDatasetRecords without sending the request
+     */
+    evalListDatasetRecordsRequestOpts(requestParameters: EvalListDatasetRecordsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Page the dataset\'s rows, each with its typed metadata. `q` narrows to rows whose input, expected outcome, label, or categories contain the term — a case-insensitive substring within this dataset, not a ranked search.
+     * List a dataset\'s records
+     */
+    evalListDatasetRecordsRaw(requestParameters: EvalListDatasetRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalPageDatasetRecordArtifactView>>;
+    /**
+     * Page the dataset\'s rows, each with its typed metadata. `q` narrows to rows whose input, expected outcome, label, or categories contain the term — a case-insensitive substring within this dataset, not a ranked search.
+     * List a dataset\'s records
+     */
+    evalListDatasetRecords(requestParameters: EvalListDatasetRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalPageDatasetRecordArtifactView>;
+    /**
+     * Creates request options for evalListDatasets without sending the request
+     */
+    evalListDatasetsRequestOpts(requestParameters: EvalListDatasetsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Page the account\'s datasets.
+     * List datasets
+     */
+    evalListDatasetsRaw(requestParameters: EvalListDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalPageDatasetArtifactView>>;
+    /**
+     * Page the account\'s datasets.
+     * List datasets
+     */
+    evalListDatasets(requestParameters?: EvalListDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalPageDatasetArtifactView>;
+    /**
+     * Creates request options for evalPatchDataset without sending the request
+     */
+    evalPatchDatasetRequestOpts(requestParameters: EvalPatchDatasetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Partially update a dataset by RFC 7396 JSON Merge Patch. An omitted key means no change, and an explicit `null` clears a nullable one. Send `If-Match` with a prior read\'s `content_hash_hex` to make the write conditional.
+     * Update a dataset
+     */
+    evalPatchDatasetRaw(requestParameters: EvalPatchDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetArtifactView>>;
+    /**
+     * Partially update a dataset by RFC 7396 JSON Merge Patch. An omitted key means no change, and an explicit `null` clears a nullable one. Send `If-Match` with a prior read\'s `content_hash_hex` to make the write conditional.
+     * Update a dataset
+     */
+    evalPatchDataset(requestParameters: EvalPatchDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetArtifactView>;
+    /**
+     * Creates request options for evalPatchDatasetRecord without sending the request
+     */
+    evalPatchDatasetRecordRequestOpts(requestParameters: EvalPatchDatasetRecordRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Curate a row by RFC 7396 JSON Merge Patch: the input, the expected outcome, the label, the extra bag. The owning dataset and the provenance triple are pinned — a row moving datasets would rewrite what past experiments sampled, and provenance is a fact recorded at pin time.
+     * Update a record
+     */
+    evalPatchDatasetRecordRaw(requestParameters: EvalPatchDatasetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalDatasetRecordArtifactView>>;
+    /**
+     * Curate a row by RFC 7396 JSON Merge Patch: the input, the expected outcome, the label, the extra bag. The owning dataset and the provenance triple are pinned — a row moving datasets would rewrite what past experiments sampled, and provenance is a fact recorded at pin time.
+     * Update a record
+     */
+    evalPatchDatasetRecord(requestParameters: EvalPatchDatasetRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalDatasetRecordArtifactView>;
+    /**
+     * Creates request options for evalSearchDatasets without sending the request
+     */
+    evalSearchDatasetsRequestOpts(requestParameters: EvalSearchDatasetsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Full-text and semantic discovery over dataset names and descriptions. Results are summary-only and carry no `metadata`.
+     * Search datasets
+     */
+    evalSearchDatasetsRaw(requestParameters: EvalSearchDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvalPageDatasetArtifactView>>;
+    /**
+     * Full-text and semantic discovery over dataset names and descriptions. Results are summary-only and carry no `metadata`.
+     * Search datasets
+     */
+    evalSearchDatasets(requestParameters: EvalSearchDatasetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvalPageDatasetArtifactView>;
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export declare enum EvalCreateDatasetContentEncodingEnum {
+    Base64 = "base64",
+    GzipBase64 = "gzip, base64"
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export declare enum EvalCreateDatasetRecordContentEncodingEnum {
+    Base64 = "base64",
+    GzipBase64 = "gzip, base64"
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export declare enum EvalCreateDatasetRecordsBulkContentEncodingEnum {
+    Base64 = "base64",
+    GzipBase64 = "gzip, base64"
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export declare enum EvalPatchDatasetContentEncodingEnum {
+    Base64 = "base64",
+    GzipBase64 = "gzip, base64"
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export declare enum EvalPatchDatasetRecordContentEncodingEnum {
+    Base64 = "base64",
+    GzipBase64 = "gzip, base64"
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export declare enum EvalSearchDatasetsContentEncodingEnum {
+    Base64 = "base64",
+    GzipBase64 = "gzip, base64"
+}