llama-stack-client 0.4.3 → 0.4.4

package/dist/src/resources/alpha/benchmarks.ts

@@ -0,0 +1,116 @@
+// 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 * as Core from '../../core';
+
+export class Benchmarks extends APIResource {
+  /**
+   * Get a benchmark by its ID.
+   */
+  retrieve(benchmarkId: string, options?: Core.RequestOptions): Core.APIPromise<Benchmark> {
+    return this._client.get(`/v1alpha/eval/benchmarks/${benchmarkId}`, options);
+  }
+
+  /**
+   * List all benchmarks.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<BenchmarkListResponse> {
+    return (
+      this._client.get('/v1alpha/eval/benchmarks', options) as Core.APIPromise<{
+        data: BenchmarkListResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+
+  /**
+   * Register a benchmark.
+   *
+   * @deprecated
+   */
+  register(body: BenchmarkRegisterParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/v1alpha/eval/benchmarks', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Unregister a benchmark.
+   *
+   * @deprecated
+   */
+  unregister(benchmarkId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1alpha/eval/benchmarks/${benchmarkId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+/**
+ * A benchmark resource for evaluating model performance.
+ */
+export interface Benchmark {
+  dataset_id: string;
+
+  /**
+   * Unique identifier for this resource in llama stack
+   */
+  identifier: string;
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
+
+  scoring_functions: Array<string>;
+
+  /**
+   * Metadata for this evaluation task
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Unique identifier for this resource in the provider
+   */
+  provider_resource_id?: string | null;
+
+  type?: 'benchmark';
+}
+
+export interface ListBenchmarksResponse {
+  data: BenchmarkListResponse;
+}
+
+export type BenchmarkListResponse = Array<Benchmark>;
+
+export interface BenchmarkRegisterParams {
+  benchmark_id: string;
+
+  dataset_id: string;
+
+  scoring_functions: Array<string>;
+
+  metadata?: { [key: string]: unknown } | null;
+
+  provider_benchmark_id?: string | null;
+
+  provider_id?: string | null;
+}
+
+export declare namespace Benchmarks {
+  export {
+    type Benchmark as Benchmark,
+    type ListBenchmarksResponse as ListBenchmarksResponse,
+    type BenchmarkListResponse as BenchmarkListResponse,
+    type BenchmarkRegisterParams as BenchmarkRegisterParams,
+  };
+}

package/dist/src/resources/alpha/eval/eval.ts

@@ -0,0 +1,234 @@
+// 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 * as Core from '../../../core';
+import * as Shared from '../../shared';
+import * as JobsAPI from './jobs';
+import { Jobs } from './jobs';
+
+export class Eval extends APIResource {
+  jobs: JobsAPI.Jobs = new JobsAPI.Jobs(this._client);
+
+  /**
+   * Evaluate a list of rows on a benchmark.
+   */
+  evaluateRows(
+    benchmarkId: string,
+    body: EvalEvaluateRowsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EvaluateResponse> {
+    return this._client.post(`/v1alpha/eval/benchmarks/${benchmarkId}/evaluations`, { body, ...options });
+  }
+
+  /**
+   * Evaluate a list of rows on a benchmark.
+   */
+  evaluateRowsAlpha(
+    benchmarkId: string,
+    body: EvalEvaluateRowsAlphaParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EvaluateResponse> {
+    return this._client.post(`/v1alpha/eval/benchmarks/${benchmarkId}/evaluations`, { body, ...options });
+  }
+
+  /**
+   * Run an evaluation on a benchmark.
+   */
+  runEval(benchmarkId: string, body: EvalRunEvalParams, options?: Core.RequestOptions): Core.APIPromise<Job> {
+    return this._client.post(`/v1alpha/eval/benchmarks/${benchmarkId}/jobs`, { body, ...options });
+  }
+
+  /**
+   * Run an evaluation on a benchmark.
+   */
+  runEvalAlpha(
+    benchmarkId: string,
+    body: EvalRunEvalAlphaParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Job> {
+    return this._client.post(`/v1alpha/eval/benchmarks/${benchmarkId}/jobs`, { body, ...options });
+  }
+}
+
+/**
+ * A benchmark configuration for evaluation.
+ */
+export interface BenchmarkConfig {
+  /**
+   * A model candidate for evaluation.
+   */
+  eval_candidate: BenchmarkConfig.EvalCandidate;
+
+  /**
+   * Number of examples to evaluate (useful for testing), if not provided, all
+   * examples in the dataset will be evaluated
+   */
+  num_examples?: number | null;
+
+  /**
+   * Map between scoring function id and parameters for each scoring function you
+   * want to run
+   */
+  scoring_params?: {
+    [key: string]:
+      | BenchmarkConfig.LlmAsJudgeScoringFnParams
+      | BenchmarkConfig.RegexParserScoringFnParams
+      | BenchmarkConfig.BasicScoringFnParams;
+  };
+}
+
+export namespace BenchmarkConfig {
+  /**
+   * A model candidate for evaluation.
+   */
+  export interface EvalCandidate {
+    model: string;
+
+    /**
+     * Sampling parameters.
+     */
+    sampling_params: Shared.SamplingParams;
+
+    /**
+     * A system message providing instructions or context to the model.
+     */
+    system_message?: Shared.SystemMessage | null;
+
+    type?: 'model';
+  }
+
+  /**
+   * Parameters for LLM-as-judge scoring function configuration.
+   */
+  export interface LlmAsJudgeScoringFnParams {
+    judge_model: string;
+
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    /**
+     * Regexes to extract the answer from generated response
+     */
+    judge_score_regexes?: Array<string>;
+
+    prompt_template?: string | null;
+
+    type?: 'llm_as_judge';
+  }
+
+  /**
+   * Parameters for regex parser scoring function configuration.
+   */
+  export interface RegexParserScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    /**
+     * Regex to extract the answer from generated response
+     */
+    parsing_regexes?: Array<string>;
+
+    type?: 'regex_parser';
+  }
+
+  /**
+   * Parameters for basic scoring function configuration.
+   */
+  export interface BasicScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    type?: 'basic';
+  }
+}
+
+/**
+ * The response from an evaluation.
+ */
+export interface EvaluateResponse {
+  generations: Array<{ [key: string]: unknown }>;
+
+  scores: { [key: string]: Shared.ScoringResult };
+}
+
+/**
+ * A job execution instance with status tracking.
+ */
+export interface Job {
+  job_id: string;
+
+  /**
+   * Status of a job execution.
+   */
+  status: 'completed' | 'in_progress' | 'failed' | 'scheduled' | 'cancelled';
+}
+
+export interface EvalEvaluateRowsParams {
+  /**
+   * A benchmark configuration for evaluation.
+   */
+  benchmark_config: BenchmarkConfig;
+
+  input_rows: Array<{ [key: string]: unknown }>;
+
+  scoring_functions: Array<string>;
+}
+
+export interface EvalEvaluateRowsAlphaParams {
+  /**
+   * A benchmark configuration for evaluation.
+   */
+  benchmark_config: BenchmarkConfig;
+
+  input_rows: Array<{ [key: string]: unknown }>;
+
+  scoring_functions: Array<string>;
+}
+
+export interface EvalRunEvalParams {
+  /**
+   * A benchmark configuration for evaluation.
+   */
+  benchmark_config: BenchmarkConfig;
+}
+
+export interface EvalRunEvalAlphaParams {
+  /**
+   * A benchmark configuration for evaluation.
+   */
+  benchmark_config: BenchmarkConfig;
+}
+
+Eval.Jobs = Jobs;
+
+export declare namespace Eval {
+  export {
+    type BenchmarkConfig as BenchmarkConfig,
+    type EvaluateResponse as EvaluateResponse,
+    type Job as Job,
+    type EvalEvaluateRowsParams as EvalEvaluateRowsParams,
+    type EvalEvaluateRowsAlphaParams as EvalEvaluateRowsAlphaParams,
+    type EvalRunEvalParams as EvalRunEvalParams,
+    type EvalRunEvalAlphaParams as EvalRunEvalAlphaParams,
+  };
+
+  export { Jobs as Jobs };
+}

package/dist/src/resources/alpha/eval/index.ts

@@ -0,0 +1,19 @@
+// 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 {
+  Eval,
+  type BenchmarkConfig,
+  type EvaluateResponse,
+  type Job,
+  type EvalEvaluateRowsParams,
+  type EvalEvaluateRowsAlphaParams,
+  type EvalRunEvalParams,
+  type EvalRunEvalAlphaParams,
+} from './eval';
+export { Jobs } from './jobs';

package/dist/src/resources/alpha/eval/jobs.ts

@@ -0,0 +1,41 @@
+// 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 * as Core from '../../../core';
+import * as EvalAPI from './eval';
+
+export class Jobs extends APIResource {
+  /**
+   * Get the result of a job.
+   */
+  retrieve(
+    benchmarkId: string,
+    jobId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EvalAPI.EvaluateResponse> {
+    return this._client.get(`/v1alpha/eval/benchmarks/${benchmarkId}/jobs/${jobId}/result`, options);
+  }
+
+  /**
+   * Cancel a job.
+   */
+  cancel(benchmarkId: string, jobId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1alpha/eval/benchmarks/${benchmarkId}/jobs/${jobId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Get the status of a job.
+   */
+  status(benchmarkId: string, jobId: string, options?: Core.RequestOptions): Core.APIPromise<EvalAPI.Job> {
+    return this._client.get(`/v1alpha/eval/benchmarks/${benchmarkId}/jobs/${jobId}`, options);
+  }
+}

package/dist/src/resources/alpha/eval.ts

@@ -0,0 +1,10 @@
+// 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 * from './eval/index';

package/dist/src/resources/alpha/index.ts

@@ -0,0 +1,34 @@
+// 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 { Alpha } from './alpha';
+export {
+  Benchmarks,
+  type Benchmark,
+  type ListBenchmarksResponse,
+  type BenchmarkListResponse,
+  type BenchmarkRegisterParams,
+} from './benchmarks';
+export {
+  Eval,
+  type BenchmarkConfig,
+  type EvaluateResponse,
+  type Job,
+  type EvalEvaluateRowsParams,
+  type EvalEvaluateRowsAlphaParams,
+  type EvalRunEvalParams,
+  type EvalRunEvalAlphaParams,
+} from './eval/index';
+export { Inference, type InferenceRerankResponse, type InferenceRerankParams } from './inference';
+export {
+  PostTraining,
+  type AlgorithmConfig,
+  type PostTrainingJob,
+  type PostTrainingPreferenceOptimizeParams,
+  type PostTrainingSupervisedFineTuneParams,
+} from './post-training/index';

package/dist/src/resources/alpha/inference.ts

@@ -0,0 +1,132 @@
+// 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 * as Core from '../../core';
+
+export class Inference extends APIResource {
+  /**
+   * Rerank a list of documents based on their relevance to a query.
+   */
+  rerank(
+    body: InferenceRerankParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InferenceRerankResponse> {
+    return (
+      this._client.post('/v1alpha/inference/rerank', { body, ...options }) as Core.APIPromise<{
+        data: InferenceRerankResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+}
+
+export type InferenceRerankResponse = Array<InferenceRerankResponse.InferenceRerankResponseItem>;
+
+export namespace InferenceRerankResponse {
+  /**
+   * A single rerank result from a reranking response.
+   */
+  export interface InferenceRerankResponseItem {
+    index: number;
+
+    relevance_score: number;
+  }
+}
+
+export interface InferenceRerankParams {
+  items: Array<
+    | string
+    | InferenceRerankParams.OpenAIChatCompletionContentPartTextParam
+    | InferenceRerankParams.OpenAIChatCompletionContentPartImageParam
+  >;
+
+  model: string;
+
+  /**
+   * Text content part for OpenAI-compatible chat completion messages.
+   */
+  query:
+    | string
+    | InferenceRerankParams.OpenAIChatCompletionContentPartTextParam
+    | InferenceRerankParams.OpenAIChatCompletionContentPartImageParam;
+
+  max_num_results?: number | null;
+}
+
+export namespace InferenceRerankParams {
+  /**
+   * Text content part for OpenAI-compatible chat completion messages.
+   */
+  export interface OpenAIChatCompletionContentPartTextParam {
+    text: string;
+
+    type?: 'text';
+  }
+
+  /**
+   * Image content part for OpenAI-compatible chat completion messages.
+   */
+  export interface OpenAIChatCompletionContentPartImageParam {
+    /**
+     * Image URL specification for OpenAI-compatible chat completion messages.
+     */
+    image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
+
+    type?: 'image_url';
+  }
+
+  export namespace OpenAIChatCompletionContentPartImageParam {
+    /**
+     * Image URL specification for OpenAI-compatible chat completion messages.
+     */
+    export interface ImageURL {
+      url: string;
+
+      detail?: string | null;
+    }
+  }
+
+  /**
+   * Text content part for OpenAI-compatible chat completion messages.
+   */
+  export interface OpenAIChatCompletionContentPartTextParam {
+    text: string;
+
+    type?: 'text';
+  }
+
+  /**
+   * Image content part for OpenAI-compatible chat completion messages.
+   */
+  export interface OpenAIChatCompletionContentPartImageParam {
+    /**
+     * Image URL specification for OpenAI-compatible chat completion messages.
+     */
+    image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
+
+    type?: 'image_url';
+  }
+
+  export namespace OpenAIChatCompletionContentPartImageParam {
+    /**
+     * Image URL specification for OpenAI-compatible chat completion messages.
+     */
+    export interface ImageURL {
+      url: string;
+
+      detail?: string | null;
+    }
+  }
+}
+
+export declare namespace Inference {
+  export {
+    type InferenceRerankResponse as InferenceRerankResponse,
+    type InferenceRerankParams as InferenceRerankParams,
+  };
+}

package/dist/src/resources/alpha/post-training/index.ts

@@ -0,0 +1,25 @@
+// 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 {
+  Job,
+  type ListPostTrainingJobsResponse,
+  type JobListResponse,
+  type JobArtifactsResponse,
+  type JobStatusResponse,
+  type JobArtifactsParams,
+  type JobCancelParams,
+  type JobStatusParams,
+} from './job';
+export {
+  PostTraining,
+  type AlgorithmConfig,
+  type PostTrainingJob,
+  type PostTrainingPreferenceOptimizeParams,
+  type PostTrainingSupervisedFineTuneParams,
+} from './post-training';