llama-stack-client 0.0.1-alpha.0

package/src/resources/post-training/jobs.ts

@@ -0,0 +1,192 @@
+// 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';
+import * as JobsAPI from './jobs';
+import * as PostTrainingAPI from './post-training';
+
+export class Jobs extends APIResource {
+  list(
+    params?: JobListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PostTrainingAPI.PostTrainingJob>;
+  list(options?: Core.RequestOptions): Core.APIPromise<PostTrainingAPI.PostTrainingJob>;
+  list(
+    params: JobListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PostTrainingAPI.PostTrainingJob> {
+    if (isRequestOptions(params)) {
+      return this.list({}, params);
+    }
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData } = params;
+    return this._client.get('/post_training/jobs', {
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  artifacts(
+    params: JobArtifactsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PostTrainingJobArtifacts> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...query } = params;
+    return this._client.get('/post_training/job/artifacts', {
+      query,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  cancel(params: JobCancelParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/post_training/job/cancel', {
+      body,
+      ...options,
+      headers: {
+        Accept: '*/*',
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  logs(params: JobLogsParams, options?: Core.RequestOptions): Core.APIPromise<PostTrainingJobLogStream> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...query } = params;
+    return this._client.get('/post_training/job/logs', {
+      query,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  status(params: JobStatusParams, options?: Core.RequestOptions): Core.APIPromise<PostTrainingJobStatus> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...query } = params;
+    return this._client.get('/post_training/job/status', {
+      query,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface PostTrainingJobArtifacts {
+  checkpoints: Array<unknown>;
+
+  job_uuid: string;
+}
+
+export interface PostTrainingJobLogStream {
+  job_uuid: string;
+
+  log_lines: Array<string>;
+}
+
+export interface PostTrainingJobStatus {
+  checkpoints: Array<unknown>;
+
+  job_uuid: string;
+
+  status: 'running' | 'completed' | 'failed' | 'scheduled';
+
+  completed_at?: string;
+
+  resources_allocated?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  scheduled_at?: string;
+
+  started_at?: string;
+}
+
+export interface JobListParams {
+  /**
+   * JSON-encoded provider data which will be made available to the adapter servicing
+   * the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export interface JobArtifactsParams {
+  /**
+   * Query param:
+   */
+  job_uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export interface JobCancelParams {
+  /**
+   * Body param:
+   */
+  job_uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export interface JobLogsParams {
+  /**
+   * Query param:
+   */
+  job_uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export interface JobStatusParams {
+  /**
+   * Query param:
+   */
+  job_uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace Jobs {
+  export import PostTrainingJobArtifacts = JobsAPI.PostTrainingJobArtifacts;
+  export import PostTrainingJobLogStream = JobsAPI.PostTrainingJobLogStream;
+  export import PostTrainingJobStatus = JobsAPI.PostTrainingJobStatus;
+  export import JobListParams = JobsAPI.JobListParams;
+  export import JobArtifactsParams = JobsAPI.JobArtifactsParams;
+  export import JobCancelParams = JobsAPI.JobCancelParams;
+  export import JobLogsParams = JobsAPI.JobLogsParams;
+  export import JobStatusParams = JobsAPI.JobStatusParams;
+}

package/src/resources/post-training/post-training.ts

@@ -0,0 +1,285 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as PostTrainingAPI from './post-training';
+import * as DatasetsAPI from '../datasets';
+import * as JobsAPI from './jobs';
+
+export class PostTraining extends APIResource {
+  jobs: JobsAPI.Jobs = new JobsAPI.Jobs(this._client);
+
+  preferenceOptimize(
+    params: PostTrainingPreferenceOptimizeParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PostTrainingJob> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/post_training/preference_optimize', {
+      body,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  supervisedFineTune(
+    params: PostTrainingSupervisedFineTuneParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PostTrainingJob> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/post_training/supervised_fine_tune', {
+      body,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface PostTrainingJob {
+  job_uuid: string;
+}
+
+export interface PostTrainingPreferenceOptimizeParams {
+  /**
+   * Body param:
+   */
+  algorithm: 'dpo';
+
+  /**
+   * Body param:
+   */
+  algorithm_config: PostTrainingPreferenceOptimizeParams.AlgorithmConfig;
+
+  /**
+   * Body param:
+   */
+  dataset: DatasetsAPI.TrainEvalDataset;
+
+  /**
+   * Body param:
+   */
+  finetuned_model: string;
+
+  /**
+   * Body param:
+   */
+  hyperparam_search_config: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * Body param:
+   */
+  job_uuid: string;
+
+  /**
+   * Body param:
+   */
+  logger_config: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * Body param:
+   */
+  optimizer_config: PostTrainingPreferenceOptimizeParams.OptimizerConfig;
+
+  /**
+   * Body param:
+   */
+  training_config: PostTrainingPreferenceOptimizeParams.TrainingConfig;
+
+  /**
+   * Body param:
+   */
+  validation_dataset: DatasetsAPI.TrainEvalDataset;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace PostTrainingPreferenceOptimizeParams {
+  export interface AlgorithmConfig {
+    epsilon: number;
+
+    gamma: number;
+
+    reward_clip: number;
+
+    reward_scale: number;
+  }
+
+  export interface OptimizerConfig {
+    lr: number;
+
+    lr_min: number;
+
+    optimizer_type: 'adam' | 'adamw' | 'sgd';
+
+    weight_decay: number;
+  }
+
+  export interface TrainingConfig {
+    batch_size: number;
+
+    enable_activation_checkpointing: boolean;
+
+    fsdp_cpu_offload: boolean;
+
+    memory_efficient_fsdp_wrap: boolean;
+
+    n_epochs: number;
+
+    n_iters: number;
+
+    shuffle: boolean;
+  }
+}
+
+export interface PostTrainingSupervisedFineTuneParams {
+  /**
+   * Body param:
+   */
+  algorithm: 'full' | 'lora' | 'qlora' | 'dora';
+
+  /**
+   * Body param:
+   */
+  algorithm_config:
+    | PostTrainingSupervisedFineTuneParams.LoraFinetuningConfig
+    | PostTrainingSupervisedFineTuneParams.QLoraFinetuningConfig
+    | PostTrainingSupervisedFineTuneParams.DoraFinetuningConfig;
+
+  /**
+   * Body param:
+   */
+  dataset: DatasetsAPI.TrainEvalDataset;
+
+  /**
+   * Body param:
+   */
+  hyperparam_search_config: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * Body param:
+   */
+  job_uuid: string;
+
+  /**
+   * Body param:
+   */
+  logger_config: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * Body param:
+   */
+  model: string;
+
+  /**
+   * Body param:
+   */
+  optimizer_config: PostTrainingSupervisedFineTuneParams.OptimizerConfig;
+
+  /**
+   * Body param:
+   */
+  training_config: PostTrainingSupervisedFineTuneParams.TrainingConfig;
+
+  /**
+   * Body param:
+   */
+  validation_dataset: DatasetsAPI.TrainEvalDataset;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace PostTrainingSupervisedFineTuneParams {
+  export interface LoraFinetuningConfig {
+    alpha: number;
+
+    apply_lora_to_mlp: boolean;
+
+    apply_lora_to_output: boolean;
+
+    lora_attn_modules: Array<string>;
+
+    rank: number;
+  }
+
+  export interface QLoraFinetuningConfig {
+    alpha: number;
+
+    apply_lora_to_mlp: boolean;
+
+    apply_lora_to_output: boolean;
+
+    lora_attn_modules: Array<string>;
+
+    rank: number;
+  }
+
+  export interface DoraFinetuningConfig {
+    alpha: number;
+
+    apply_lora_to_mlp: boolean;
+
+    apply_lora_to_output: boolean;
+
+    lora_attn_modules: Array<string>;
+
+    rank: number;
+  }
+
+  export interface OptimizerConfig {
+    lr: number;
+
+    lr_min: number;
+
+    optimizer_type: 'adam' | 'adamw' | 'sgd';
+
+    weight_decay: number;
+  }
+
+  export interface TrainingConfig {
+    batch_size: number;
+
+    enable_activation_checkpointing: boolean;
+
+    fsdp_cpu_offload: boolean;
+
+    memory_efficient_fsdp_wrap: boolean;
+
+    n_epochs: number;
+
+    n_iters: number;
+
+    shuffle: boolean;
+  }
+}
+
+export namespace PostTraining {
+  export import PostTrainingJob = PostTrainingAPI.PostTrainingJob;
+  export import PostTrainingPreferenceOptimizeParams = PostTrainingAPI.PostTrainingPreferenceOptimizeParams;
+  export import PostTrainingSupervisedFineTuneParams = PostTrainingAPI.PostTrainingSupervisedFineTuneParams;
+  export import Jobs = JobsAPI.Jobs;
+  export import PostTrainingJobArtifacts = JobsAPI.PostTrainingJobArtifacts;
+  export import PostTrainingJobLogStream = JobsAPI.PostTrainingJobLogStream;
+  export import PostTrainingJobStatus = JobsAPI.PostTrainingJobStatus;
+  export import JobListParams = JobsAPI.JobListParams;
+  export import JobArtifactsParams = JobsAPI.JobArtifactsParams;
+  export import JobCancelParams = JobsAPI.JobCancelParams;
+  export import JobLogsParams = JobsAPI.JobLogsParams;
+  export import JobStatusParams = JobsAPI.JobStatusParams;
+}

package/src/resources/reward-scoring.ts

@@ -0,0 +1,82 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as RewardScoringAPI from './reward-scoring';
+import * as Shared from './shared';
+
+export class RewardScoringResource extends APIResource {
+  score(params: RewardScoringScoreParams, options?: Core.RequestOptions): Core.APIPromise<RewardScoring> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/reward_scoring/score', {
+      body,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface RewardScoring {
+  scored_generations: Array<ScoredDialogGenerations>;
+}
+
+export interface ScoredDialogGenerations {
+  dialog: Array<
+    Shared.UserMessage | Shared.SystemMessage | Shared.ToolResponseMessage | Shared.CompletionMessage
+  >;
+
+  scored_generations: Array<ScoredDialogGenerations.ScoredGeneration>;
+}
+
+export namespace ScoredDialogGenerations {
+  export interface ScoredGeneration {
+    message:
+      | Shared.UserMessage
+      | Shared.SystemMessage
+      | Shared.ToolResponseMessage
+      | Shared.CompletionMessage;
+
+    score: number;
+  }
+}
+
+export interface RewardScoringScoreParams {
+  /**
+   * Body param:
+   */
+  dialog_generations: Array<RewardScoringScoreParams.DialogGeneration>;
+
+  /**
+   * Body param:
+   */
+  model: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace RewardScoringScoreParams {
+  export interface DialogGeneration {
+    dialog: Array<
+      Shared.UserMessage | Shared.SystemMessage | Shared.ToolResponseMessage | Shared.CompletionMessage
+    >;
+
+    sampled_generations: Array<
+      Shared.UserMessage | Shared.SystemMessage | Shared.ToolResponseMessage | Shared.CompletionMessage
+    >;
+  }
+}
+
+export namespace RewardScoringResource {
+  export import RewardScoring = RewardScoringAPI.RewardScoring;
+  export import ScoredDialogGenerations = RewardScoringAPI.ScoredDialogGenerations;
+  export import RewardScoringScoreParams = RewardScoringAPI.RewardScoringScoreParams;
+}

package/src/resources/safety.ts

@@ -0,0 +1,66 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as SafetyAPI from './safety';
+import * as Shared from './shared';
+
+export class Safety extends APIResource {
+  runShield(params: SafetyRunShieldParams, options?: Core.RequestOptions): Core.APIPromise<RunSheidResponse> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/safety/run_shield', {
+      body,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface RunSheidResponse {
+  violation?: RunSheidResponse.Violation;
+}
+
+export namespace RunSheidResponse {
+  export interface Violation {
+    metadata: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+    violation_level: 'info' | 'warn' | 'error';
+
+    user_message?: string;
+  }
+}
+
+export interface SafetyRunShieldParams {
+  /**
+   * Body param:
+   */
+  messages: Array<
+    Shared.UserMessage | Shared.SystemMessage | Shared.ToolResponseMessage | Shared.CompletionMessage
+  >;
+
+  /**
+   * Body param:
+   */
+  params: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * Body param:
+   */
+  shield_type: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace Safety {
+  export import RunSheidResponse = SafetyAPI.RunSheidResponse;
+  export import SafetyRunShieldParams = SafetyAPI.SafetyRunShieldParams;
+}

package/src/resources/shared.ts

@@ -0,0 +1,75 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export interface Attachment {
+  content: string | Array<string>;
+
+  mime_type: string;
+}
+
+export interface BatchCompletion {
+  completion_message_batch: Array<CompletionMessage>;
+}
+
+export interface CompletionMessage {
+  content: string | Array<string>;
+
+  role: 'assistant';
+
+  stop_reason: 'end_of_turn' | 'end_of_message' | 'out_of_tokens';
+
+  tool_calls: Array<ToolCall>;
+}
+
+export interface SamplingParams {
+  strategy: 'greedy' | 'top_p' | 'top_k';
+
+  max_tokens?: number;
+
+  repetition_penalty?: number;
+
+  temperature?: number;
+
+  top_k?: number;
+
+  top_p?: number;
+}
+
+export interface SystemMessage {
+  content: string | Array<string>;
+
+  role: 'system';
+}
+
+export interface ToolCall {
+  arguments: Record<
+    string,
+    | string
+    | number
+    | boolean
+    | Array<string | number | boolean | null>
+    | Record<string, string | number | boolean | null>
+    | null
+  >;
+
+  call_id: string;
+
+  tool_name: 'brave_search' | 'wolfram_alpha' | 'photogen' | 'code_interpreter' | (string & {});
+}
+
+export interface ToolResponseMessage {
+  call_id: string;
+
+  content: string | Array<string>;
+
+  role: 'ipython';
+
+  tool_name: 'brave_search' | 'wolfram_alpha' | 'photogen' | 'code_interpreter' | (string & {});
+}
+
+export interface UserMessage {
+  content: string | Array<string>;
+
+  role: 'user';
+
+  context?: string | Array<string>;
+}