llama-stack-client 0.3.4 → 0.4.0-rc1

package/src/resources/datasets.ts

@@ -1,413 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-// All rights reserved.
-//
-// This source code is licensed under the terms described in the LICENSE file in
-// the root directory of this source tree.
-
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as Core from '../core';
-
-export class Datasets extends APIResource {
-  /**
-   * Get a dataset by its ID.
-   */
-  retrieve(datasetId: string, options?: Core.RequestOptions): Core.APIPromise<DatasetRetrieveResponse> {
-    return this._client.get(`/v1/datasets/${datasetId}`, options);
-  }
-
-  /**
-   * List all datasets.
-   */
-  list(options?: Core.RequestOptions): Core.APIPromise<DatasetListResponse> {
-    return (
-      this._client.get('/v1/datasets', options) as Core.APIPromise<{ data: DatasetListResponse }>
-    )._thenUnwrap((obj) => obj.data);
-  }
-
-  /**
-   * Append rows to a dataset.
-   */
-  appendrows(
-    datasetId: string,
-    body: DatasetAppendrowsParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<void> {
-    return this._client.post(`/v1/datasetio/append-rows/${datasetId}`, {
-      body,
-      ...options,
-      headers: { Accept: '*/*', ...options?.headers },
-    });
-  }
-
-  /**
-   * Get a paginated list of rows from a dataset. Uses offset-based pagination where:
-   *
-   * - start_index: The starting index (0-based). If None, starts from beginning.
-   * - limit: Number of items to return. If None or -1, returns all items.
-   *
-   * The response includes:
-   *
-   * - data: List of items for the current page.
-   * - has_more: Whether there are more items available after this set.
-   */
-  iterrows(
-    datasetId: string,
-    query?: DatasetIterrowsParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<DatasetIterrowsResponse>;
-  iterrows(datasetId: string, options?: Core.RequestOptions): Core.APIPromise<DatasetIterrowsResponse>;
-  iterrows(
-    datasetId: string,
-    query: DatasetIterrowsParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<DatasetIterrowsResponse> {
-    if (isRequestOptions(query)) {
-      return this.iterrows(datasetId, {}, query);
-    }
-    return this._client.get(`/v1/datasetio/iterrows/${datasetId}`, { query, ...options });
-  }
-
-  /**
-   * Register a new dataset.
-   */
-  register(
-    body: DatasetRegisterParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<DatasetRegisterResponse> {
-    return this._client.post('/v1/datasets', { body, ...options });
-  }
-
-  /**
-   * Unregister a dataset by its ID.
-   */
-  unregister(datasetId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.delete(`/v1/datasets/${datasetId}`, {
-      ...options,
-      headers: { Accept: '*/*', ...options?.headers },
-    });
-  }
-}
-
-/**
- * Response from listing datasets.
- */
-export interface ListDatasetsResponse {
-  /**
-   * List of datasets
-   */
-  data: DatasetListResponse;
-}
-
-/**
- * Dataset resource for storing and accessing training or evaluation data.
- */
-export interface DatasetRetrieveResponse {
-  identifier: string;
-
-  /**
-   * Additional metadata for the dataset
-   */
-  metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
-
-  provider_id: string;
-
-  /**
-   * Purpose of the dataset indicating its intended use
-   */
-  purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
-
-  /**
-   * Data source configuration for the dataset
-   */
-  source: DatasetRetrieveResponse.UriDataSource | DatasetRetrieveResponse.RowsDataSource;
-
-  /**
-   * Type of resource, always 'dataset' for datasets
-   */
-  type: 'dataset';
-
-  provider_resource_id?: string;
-}
-
-export namespace DatasetRetrieveResponse {
-  /**
-   * A dataset that can be obtained from a URI.
-   */
-  export interface UriDataSource {
-    type: 'uri';
-
-    /**
-     * The dataset can be obtained from a URI. E.g. -
-     * "https://mywebsite.com/mydata.jsonl" - "lsfs://mydata.jsonl" -
-     * "data:csv;base64,{base64_content}"
-     */
-    uri: string;
-  }
-
-  /**
-   * A dataset stored in rows.
-   */
-  export interface RowsDataSource {
-    /**
-     * The dataset is stored in rows. E.g. - [ {"messages": [{"role": "user",
-     * "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}
-     * ]
-     */
-    rows: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
-
-    type: 'rows';
-  }
-}
-
-/**
- * List of datasets
- */
-export type DatasetListResponse = Array<DatasetListResponse.DatasetListResponseItem>;
-
-export namespace DatasetListResponse {
-  /**
-   * Dataset resource for storing and accessing training or evaluation data.
-   */
-  export interface DatasetListResponseItem {
-    identifier: string;
-
-    /**
-     * Additional metadata for the dataset
-     */
-    metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
-
-    provider_id: string;
-
-    /**
-     * Purpose of the dataset indicating its intended use
-     */
-    purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
-
-    /**
-     * Data source configuration for the dataset
-     */
-    source: DatasetListResponseItem.UriDataSource | DatasetListResponseItem.RowsDataSource;
-
-    /**
-     * Type of resource, always 'dataset' for datasets
-     */
-    type: 'dataset';
-
-    provider_resource_id?: string;
-  }
-
-  export namespace DatasetListResponseItem {
-    /**
-     * A dataset that can be obtained from a URI.
-     */
-    export interface UriDataSource {
-      type: 'uri';
-
-      /**
-       * The dataset can be obtained from a URI. E.g. -
-       * "https://mywebsite.com/mydata.jsonl" - "lsfs://mydata.jsonl" -
-       * "data:csv;base64,{base64_content}"
-       */
-      uri: string;
-    }
-
-    /**
-     * A dataset stored in rows.
-     */
-    export interface RowsDataSource {
-      /**
-       * The dataset is stored in rows. E.g. - [ {"messages": [{"role": "user",
-       * "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}
-       * ]
-       */
-      rows: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
-
-      type: 'rows';
-    }
-  }
-}
-
-/**
- * A generic paginated response that follows a simple format.
- */
-export interface DatasetIterrowsResponse {
-  /**
-   * The list of items for the current page
-   */
-  data: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
-
-  /**
-   * Whether there are more items available after this set
-   */
-  has_more: boolean;
-
-  /**
-   * The URL for accessing this list
-   */
-  url?: string;
-}
-
-/**
- * Dataset resource for storing and accessing training or evaluation data.
- */
-export interface DatasetRegisterResponse {
-  identifier: string;
-
-  /**
-   * Additional metadata for the dataset
-   */
-  metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
-
-  provider_id: string;
-
-  /**
-   * Purpose of the dataset indicating its intended use
-   */
-  purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
-
-  /**
-   * Data source configuration for the dataset
-   */
-  source: DatasetRegisterResponse.UriDataSource | DatasetRegisterResponse.RowsDataSource;
-
-  /**
-   * Type of resource, always 'dataset' for datasets
-   */
-  type: 'dataset';
-
-  provider_resource_id?: string;
-}
-
-export namespace DatasetRegisterResponse {
-  /**
-   * A dataset that can be obtained from a URI.
-   */
-  export interface UriDataSource {
-    type: 'uri';
-
-    /**
-     * The dataset can be obtained from a URI. E.g. -
-     * "https://mywebsite.com/mydata.jsonl" - "lsfs://mydata.jsonl" -
-     * "data:csv;base64,{base64_content}"
-     */
-    uri: string;
-  }
-
-  /**
-   * A dataset stored in rows.
-   */
-  export interface RowsDataSource {
-    /**
-     * The dataset is stored in rows. E.g. - [ {"messages": [{"role": "user",
-     * "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}
-     * ]
-     */
-    rows: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
-
-    type: 'rows';
-  }
-}
-
-export interface DatasetAppendrowsParams {
-  /**
-   * The rows to append to the dataset.
-   */
-  rows: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
-}
-
-export interface DatasetIterrowsParams {
-  /**
-   * The number of rows to get.
-   */
-  limit?: number;
-
-  /**
-   * Index into dataset for the first row to get. Get all rows if None.
-   */
-  start_index?: number;
-}
-
-export interface DatasetRegisterParams {
-  /**
-   * The purpose of the dataset. One of: - "post-training/messages": The dataset
-   * contains a messages column with list of messages for post-training. {
-   * "messages": [ {"role": "user", "content": "Hello, world!"}, {"role":
-   * "assistant", "content": "Hello, world!"}, ] } - "eval/question-answer": The
-   * dataset contains a question column and an answer column for evaluation. {
-   * "question": "What is the capital of France?", "answer": "Paris" } -
-   * "eval/messages-answer": The dataset contains a messages column with list of
-   * messages and an answer column for evaluation. { "messages": [ {"role": "user",
-   * "content": "Hello, my name is John Doe."}, {"role": "assistant", "content":
-   * "Hello, John Doe. How can I help you today?"}, {"role": "user", "content":
-   * "What's my name?"}, ], "answer": "John Doe" }
-   */
-  purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
-
-  /**
-   * The data source of the dataset. Ensure that the data source schema is compatible
-   * with the purpose of the dataset. Examples: - { "type": "uri", "uri":
-   * "https://mywebsite.com/mydata.jsonl" } - { "type": "uri", "uri":
-   * "lsfs://mydata.jsonl" } - { "type": "uri", "uri":
-   * "data:csv;base64,{base64_content}" } - { "type": "uri", "uri":
-   * "huggingface://llamastack/simpleqa?split=train" } - { "type": "rows", "rows": [
-   * { "messages": [ {"role": "user", "content": "Hello, world!"}, {"role":
-   * "assistant", "content": "Hello, world!"}, ] } ] }
-   */
-  source: DatasetRegisterParams.UriDataSource | DatasetRegisterParams.RowsDataSource;
-
-  /**
-   * The ID of the dataset. If not provided, an ID will be generated.
-   */
-  dataset_id?: string;
-
-  /**
-   * The metadata for the dataset. - E.g. {"description": "My dataset"}.
-   */
-  metadata?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
-}
-
-export namespace DatasetRegisterParams {
-  /**
-   * A dataset that can be obtained from a URI.
-   */
-  export interface UriDataSource {
-    type: 'uri';
-
-    /**
-     * The dataset can be obtained from a URI. E.g. -
-     * "https://mywebsite.com/mydata.jsonl" - "lsfs://mydata.jsonl" -
-     * "data:csv;base64,{base64_content}"
-     */
-    uri: string;
-  }
-
-  /**
-   * A dataset stored in rows.
-   */
-  export interface RowsDataSource {
-    /**
-     * The dataset is stored in rows. E.g. - [ {"messages": [{"role": "user",
-     * "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}
-     * ]
-     */
-    rows: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
-
-    type: 'rows';
-  }
-}
-
-export declare namespace Datasets {
-  export {
-    type ListDatasetsResponse as ListDatasetsResponse,
-    type DatasetRetrieveResponse as DatasetRetrieveResponse,
-    type DatasetListResponse as DatasetListResponse,
-    type DatasetIterrowsResponse as DatasetIterrowsResponse,
-    type DatasetRegisterResponse as DatasetRegisterResponse,
-    type DatasetAppendrowsParams as DatasetAppendrowsParams,
-    type DatasetIterrowsParams as DatasetIterrowsParams,
-    type DatasetRegisterParams as DatasetRegisterParams,
-  };
-}