llama-stack-client 0.3.4 → 0.4.0-rc1

package/src/resources/beta/datasets.ts

@@ -0,0 +1,350 @@
+// 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(`/v1beta/datasets/${datasetId}`, options);
+  }
+
+  /**
+   * List all datasets.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<DatasetListResponse> {
+    return (
+      this._client.get('/v1beta/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(`/v1beta/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(`/v1beta/datasetio/iterrows/${datasetId}`, { query, ...options });
+  }
+
+  /**
+   * Register a new dataset.
+   *
+   * @deprecated
+   */
+  register(
+    body: DatasetRegisterParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DatasetRegisterResponse> {
+    return this._client.post('/v1beta/datasets', { body, ...options });
+  }
+
+  /**
+   * Unregister a dataset by its ID.
+   *
+   * @deprecated
+   */
+  unregister(datasetId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1beta/datasets/${datasetId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+/**
+ * Response from listing datasets.
+ */
+export interface ListDatasetsResponse {
+  data: DatasetListResponse;
+}
+
+/**
+ * Dataset resource for storing and accessing training or evaluation data.
+ */
+export interface DatasetRetrieveResponse {
+  /**
+   * Unique identifier for this resource in llama stack
+   */
+  identifier: string;
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
+
+  /**
+   * Purpose of the dataset. Each purpose has a required input data schema.
+   */
+  purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
+
+  /**
+   * A dataset that can be obtained from a URI.
+   */
+  source: DatasetRetrieveResponse.UriDataSource | DatasetRetrieveResponse.RowsDataSource;
+
+  /**
+   * Any additional metadata for this dataset
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Unique identifier for this resource in the provider
+   */
+  provider_resource_id?: string | null;
+
+  type?: 'dataset';
+}
+
+export namespace DatasetRetrieveResponse {
+  /**
+   * A dataset that can be obtained from a URI.
+   */
+  export interface UriDataSource {
+    uri: string;
+
+    type?: 'uri';
+  }
+
+  /**
+   * A dataset stored in rows.
+   */
+  export interface RowsDataSource {
+    rows: Array<{ [key: string]: unknown }>;
+
+    type?: 'rows';
+  }
+}
+
+export type DatasetListResponse = Array<DatasetListResponse.DatasetListResponseItem>;
+
+export namespace DatasetListResponse {
+  /**
+   * Dataset resource for storing and accessing training or evaluation data.
+   */
+  export interface DatasetListResponseItem {
+    /**
+     * Unique identifier for this resource in llama stack
+     */
+    identifier: string;
+
+    /**
+     * ID of the provider that owns this resource
+     */
+    provider_id: string;
+
+    /**
+     * Purpose of the dataset. Each purpose has a required input data schema.
+     */
+    purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
+
+    /**
+     * A dataset that can be obtained from a URI.
+     */
+    source: DatasetListResponseItem.UriDataSource | DatasetListResponseItem.RowsDataSource;
+
+    /**
+     * Any additional metadata for this dataset
+     */
+    metadata?: { [key: string]: unknown };
+
+    /**
+     * Unique identifier for this resource in the provider
+     */
+    provider_resource_id?: string | null;
+
+    type?: 'dataset';
+  }
+
+  export namespace DatasetListResponseItem {
+    /**
+     * A dataset that can be obtained from a URI.
+     */
+    export interface UriDataSource {
+      uri: string;
+
+      type?: 'uri';
+    }
+
+    /**
+     * A dataset stored in rows.
+     */
+    export interface RowsDataSource {
+      rows: Array<{ [key: string]: unknown }>;
+
+      type?: 'rows';
+    }
+  }
+}
+
+/**
+ * A generic paginated response that follows a simple format.
+ */
+export interface DatasetIterrowsResponse {
+  data: Array<{ [key: string]: unknown }>;
+
+  has_more: boolean;
+
+  url?: string | null;
+}
+
+/**
+ * Dataset resource for storing and accessing training or evaluation data.
+ */
+export interface DatasetRegisterResponse {
+  /**
+   * Unique identifier for this resource in llama stack
+   */
+  identifier: string;
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
+
+  /**
+   * Purpose of the dataset. Each purpose has a required input data schema.
+   */
+  purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
+
+  /**
+   * A dataset that can be obtained from a URI.
+   */
+  source: DatasetRegisterResponse.UriDataSource | DatasetRegisterResponse.RowsDataSource;
+
+  /**
+   * Any additional metadata for this dataset
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Unique identifier for this resource in the provider
+   */
+  provider_resource_id?: string | null;
+
+  type?: 'dataset';
+}
+
+export namespace DatasetRegisterResponse {
+  /**
+   * A dataset that can be obtained from a URI.
+   */
+  export interface UriDataSource {
+    uri: string;
+
+    type?: 'uri';
+  }
+
+  /**
+   * A dataset stored in rows.
+   */
+  export interface RowsDataSource {
+    rows: Array<{ [key: string]: unknown }>;
+
+    type?: 'rows';
+  }
+}
+
+export interface DatasetAppendrowsParams {
+  rows: Array<{ [key: string]: unknown }>;
+}
+
+export interface DatasetIterrowsParams {
+  limit?: number | null;
+
+  start_index?: number | null;
+}
+
+export interface DatasetRegisterParams {
+  /**
+   * Purpose of the dataset. Each purpose has a required input data schema.
+   */
+  purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
+
+  /**
+   * A dataset that can be obtained from a URI.
+   */
+  source: DatasetRegisterParams.UriDataSource | DatasetRegisterParams.RowsDataSource;
+
+  dataset_id?: string | null;
+
+  metadata?: { [key: string]: unknown } | null;
+}
+
+export namespace DatasetRegisterParams {
+  /**
+   * A dataset that can be obtained from a URI.
+   */
+  export interface UriDataSource {
+    uri: string;
+
+    type?: 'uri';
+  }
+
+  /**
+   * A dataset stored in rows.
+   */
+  export interface RowsDataSource {
+    rows: Array<{ [key: string]: unknown }>;
+
+    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,
+  };
+}

package/src/resources/beta/index.ts

@@ -0,0 +1,20 @@
+// 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.
+
+export { Beta } from './beta';
+export {
+  Datasets,
+  type ListDatasetsResponse,
+  type DatasetRetrieveResponse,
+  type DatasetListResponse,
+  type DatasetIterrowsResponse,
+  type DatasetRegisterResponse,
+  type DatasetAppendrowsParams,
+  type DatasetIterrowsParams,
+  type DatasetRegisterParams,
+} from './datasets';

package/src/resources/{agents.ts → beta.ts}

@@ -3,7 +3,7 @@
 //
 // 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.
 
-export * from './agents/index';
+export * from './beta/index';

package/src/resources/chat/chat.ts

@@ -3,7 +3,7 @@
 //
 // 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';
@@ -15,7 +15,6 @@ import {
   CompletionCreateResponse,
   CompletionListParams,
   CompletionListResponse,
-  CompletionListResponsesOpenAICursorPage,
   CompletionRetrieveResponse,
   Completions,
 } from './completions';
@@ -28,30 +27,20 @@ export class Chat extends APIResource {
  * Chunk from a streaming response to an OpenAI-compatible chat completion request.
  */
 export interface ChatCompletionChunk {
-  /**
-   * The ID of the chat completion
-   */
   id: string;
 
-  /**
-   * List of choices
-   */
   choices: Array<ChatCompletionChunk.Choice>;
 
-  /**
-   * The Unix timestamp in seconds when the chat completion was created
-   */
   created: number;
 
-  /**
-   * The model that was used to generate the chat completion
-   */
   model: string;
 
+  object?: 'chat.completion.chunk';
+
   /**
-   * The object type, which will be "chat.completion.chunk"
+   * Usage information for OpenAI chat completion.
    */
-  object: 'chat.completion.chunk';
+  usage?: ChatCompletionChunk.Usage | null;
 }
 
 export namespace ChatCompletionChunk {
@@ -60,50 +49,35 @@ export namespace ChatCompletionChunk {
    */
   export interface Choice {
     /**
-     * The delta from the chunk
+     * A delta from an OpenAI-compatible chat completion streaming response.
      */
     delta: Choice.Delta;
 
-    /**
-     * The reason the model stopped generating
-     */
     finish_reason: string;
 
-    /**
-     * The index of the choice
-     */
     index: number;
 
     /**
-     * (Optional) The log probabilities for the tokens in the message
+     * The log probabilities for the tokens in the message from an OpenAI-compatible
+     * chat completion response.
      */
-    logprobs?: Choice.Logprobs;
+    logprobs?: Choice.Logprobs | null;
   }
 
   export namespace Choice {
     /**
-     * The delta from the chunk
+     * A delta from an OpenAI-compatible chat completion streaming response.
      */
     export interface Delta {
-      /**
-       * (Optional) The content of the delta
-       */
-      content?: string;
+      content?: string | null;
 
-      /**
-       * (Optional) The refusal of the delta
-       */
-      refusal?: string;
+      reasoning_content?: string | null;
 
-      /**
-       * (Optional) The role of the delta
-       */
-      role?: string;
+      refusal?: string | null;
 
-      /**
-       * (Optional) The tool calls of the delta
-       */
-      tool_calls?: Array<Delta.ToolCall>;
+      role?: string | null;
+
+      tool_calls?: Array<Delta.ToolCall> | null;
     }
 
     export namespace Delta {
@@ -111,64 +85,47 @@ export namespace ChatCompletionChunk {
        * Tool call specification for OpenAI-compatible chat completion responses.
        */
       export interface ToolCall {
-        /**
-         * Must be "function" to identify this as a function call
-         */
-        type: 'function';
+        id?: string | null;
 
         /**
-         * (Optional) Unique identifier for the tool call
+         * Function call details for OpenAI-compatible tool calls.
          */
-        id?: string;
+        function?: ToolCall.Function | null;
 
-        /**
-         * (Optional) Function call details
-         */
-        function?: ToolCall.Function;
+        index?: number | null;
 
-        /**
-         * (Optional) Index of the tool call in the list
-         */
-        index?: number;
+        type?: 'function';
       }
 
       export namespace ToolCall {
         /**
-         * (Optional) Function call details
+         * Function call details for OpenAI-compatible tool calls.
          */
         export interface Function {
-          /**
-           * (Optional) Arguments to pass to the function as a JSON string
-           */
-          arguments?: string;
-
-          /**
-           * (Optional) Name of the function to call
-           */
-          name?: string;
+          arguments?: string | null;
+
+          name?: string | null;
         }
       }
     }
 
     /**
-     * (Optional) The log probabilities for the tokens in the message
+     * The log probabilities for the tokens in the message from an OpenAI-compatible
+     * chat completion response.
      */
     export interface Logprobs {
-      /**
-       * (Optional) The log probabilities for the tokens in the message
-       */
-      content?: Array<Logprobs.Content>;
+      content?: Array<Logprobs.Content> | null;
 
-      /**
-       * (Optional) The log probabilities for the tokens in the message
-       */
-      refusal?: Array<Logprobs.Refusal>;
+      refusal?: Array<Logprobs.Refusal> | null;
     }
 
     export namespace Logprobs {
       /**
        * The log probability for a token from an OpenAI-compatible chat completion
        * response.
+       *
+       * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
+       * probability of the token :top_logprobs: The top log probabilities for the token
        */
       export interface Content {
         token: string;
@@ -177,26 +134,32 @@ export namespace ChatCompletionChunk {
 
         top_logprobs: Array<Content.TopLogprob>;
 
-        bytes?: Array<number>;
+        bytes?: Array<number> | null;
       }
 
       export namespace Content {
         /**
          * The top log probability for a token from an OpenAI-compatible chat completion
          * response.
+         *
+         * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
+         * probability of the token
          */
         export interface TopLogprob {
           token: string;
 
           logprob: number;
 
-          bytes?: Array<number>;
+          bytes?: Array<number> | null;
         }
       }
 
       /**
        * The log probability for a token from an OpenAI-compatible chat completion
        * response.
+       *
+       * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
+       * probability of the token :top_logprobs: The top log probabilities for the token
        */
       export interface Refusal {
         token: string;
@@ -205,28 +168,67 @@ export namespace ChatCompletionChunk {
 
         top_logprobs: Array<Refusal.TopLogprob>;
 
-        bytes?: Array<number>;
+        bytes?: Array<number> | null;
       }
 
       export namespace Refusal {
         /**
          * The top log probability for a token from an OpenAI-compatible chat completion
          * response.
+         *
+         * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
+         * probability of the token
          */
         export interface TopLogprob {
           token: string;
 
           logprob: number;
 
-          bytes?: Array<number>;
+          bytes?: Array<number> | null;
         }
       }
     }
   }
+
+  /**
+   * Usage information for OpenAI chat completion.
+   */
+  export interface Usage {
+    completion_tokens: number;
+
+    prompt_tokens: number;
+
+    total_tokens: number;
+
+    /**
+     * Token details for output tokens in OpenAI chat completion usage.
+     */
+    completion_tokens_details?: Usage.CompletionTokensDetails | null;
+
+    /**
+     * Token details for prompt tokens in OpenAI chat completion usage.
+     */
+    prompt_tokens_details?: Usage.PromptTokensDetails | null;
+  }
+
+  export namespace Usage {
+    /**
+     * Token details for output tokens in OpenAI chat completion usage.
+     */
+    export interface CompletionTokensDetails {
+      reasoning_tokens?: number | null;
+    }
+
+    /**
+     * Token details for prompt tokens in OpenAI chat completion usage.
+     */
+    export interface PromptTokensDetails {
+      cached_tokens?: number | null;
+    }
+  }
 }
 
 Chat.Completions = Completions;
-Chat.CompletionListResponsesOpenAICursorPage = CompletionListResponsesOpenAICursorPage;
 
 export declare namespace Chat {
   export { type ChatCompletionChunk as ChatCompletionChunk };
@@ -236,7 +238,6 @@ export declare namespace Chat {
     type CompletionCreateResponse as CompletionCreateResponse,
     type CompletionRetrieveResponse as CompletionRetrieveResponse,
     type CompletionListResponse as CompletionListResponse,
-    CompletionListResponsesOpenAICursorPage as CompletionListResponsesOpenAICursorPage,
     type CompletionCreateParams as CompletionCreateParams,
     type CompletionCreateParamsNonStreaming as CompletionCreateParamsNonStreaming,
     type CompletionCreateParamsStreaming as CompletionCreateParamsStreaming,