openai 4.97.0 → 4.99.0

package/src/resources/evals/index.ts

@@ -4,10 +4,7 @@ export {
   EvalListResponsesPage,
   Evals,
   type EvalCustomDataSourceConfig,
-  type EvalLabelModelGrader,
   type EvalStoredCompletionsDataSourceConfig,
-  type EvalStringCheckGrader,
-  type EvalTextSimilarityGrader,
   type EvalCreateResponse,
   type EvalRetrieveResponse,
   type EvalUpdateResponse,

package/src/resources/evals/runs/runs.ts

@@ -356,7 +356,7 @@ export interface RunCreateResponse {
   data_source:
     | CreateEvalJSONLRunDataSource
     | CreateEvalCompletionsRunDataSource
-    | RunCreateResponse.Completions;
+    | RunCreateResponse.Responses;
 
   /**
    * An object representing an error response from the Eval API.
@@ -423,28 +423,28 @@ export namespace RunCreateResponse {
   /**
    * A ResponsesRunDataSource object describing a model sampling configuration.
    */
-  export interface Completions {
+  export interface Responses {
     /**
      * A EvalResponsesSource object describing a run data source configuration.
      */
-    source: Completions.FileContent | Completions.FileID | Completions.Responses;
+    source: Responses.FileContent | Responses.FileID | Responses.Responses;
 
     /**
-     * The type of run data source. Always `completions`.
+     * The type of run data source. Always `responses`.
      */
-    type: 'completions';
+    type: 'responses';
 
-    input_messages?: Completions.Template | Completions.ItemReference;
+    input_messages?: Responses.Template | Responses.ItemReference;
 
     /**
      * The name of the model to use for generating completions (e.g. "o3-mini").
      */
     model?: string;
 
-    sampling_params?: Completions.SamplingParams;
+    sampling_params?: Responses.SamplingParams;
   }
 
-  export namespace Completions {
+  export namespace Responses {
     export interface FileContent {
       /**
        * The content of the jsonl file.
@@ -486,12 +486,6 @@ export namespace RunCreateResponse {
        */
       type: 'responses';
 
-      /**
-       * Whether to allow parallel tool calls. This is a query parameter used to select
-       * responses.
-       */
-      allow_parallel_tool_calls?: boolean | null;
-
       /**
        * Only include items created after this timestamp (inclusive). This is a query
        * parameter used to select responses.
@@ -511,8 +505,8 @@ export namespace RunCreateResponse {
       has_tool_calls?: boolean | null;
 
       /**
-       * Optional search string for instructions. This is a query parameter used to
-       * select responses.
+       * Optional string to search the 'instructions' field. This is a query parameter
+       * used to select responses.
        */
       instructions_search?: string | null;
 
@@ -539,6 +533,11 @@ export namespace RunCreateResponse {
        */
       temperature?: number | null;
 
+      /**
+       * List of tool names. This is a query parameter used to select responses.
+       */
+      tools?: Array<string> | null;
+
       /**
        * Nucleus sampling parameter. This is a query parameter used to select responses.
        */
@@ -749,7 +748,7 @@ export interface RunRetrieveResponse {
   data_source:
     | CreateEvalJSONLRunDataSource
     | CreateEvalCompletionsRunDataSource
-    | RunRetrieveResponse.Completions;
+    | RunRetrieveResponse.Responses;
 
   /**
    * An object representing an error response from the Eval API.
@@ -816,28 +815,28 @@ export namespace RunRetrieveResponse {
   /**
    * A ResponsesRunDataSource object describing a model sampling configuration.
    */
-  export interface Completions {
+  export interface Responses {
     /**
      * A EvalResponsesSource object describing a run data source configuration.
      */
-    source: Completions.FileContent | Completions.FileID | Completions.Responses;
+    source: Responses.FileContent | Responses.FileID | Responses.Responses;
 
     /**
-     * The type of run data source. Always `completions`.
+     * The type of run data source. Always `responses`.
      */
-    type: 'completions';
+    type: 'responses';
 
-    input_messages?: Completions.Template | Completions.ItemReference;
+    input_messages?: Responses.Template | Responses.ItemReference;
 
     /**
      * The name of the model to use for generating completions (e.g. "o3-mini").
      */
     model?: string;
 
-    sampling_params?: Completions.SamplingParams;
+    sampling_params?: Responses.SamplingParams;
   }
 
-  export namespace Completions {
+  export namespace Responses {
     export interface FileContent {
       /**
        * The content of the jsonl file.
@@ -879,12 +878,6 @@ export namespace RunRetrieveResponse {
        */
       type: 'responses';
 
-      /**
-       * Whether to allow parallel tool calls. This is a query parameter used to select
-       * responses.
-       */
-      allow_parallel_tool_calls?: boolean | null;
-
       /**
        * Only include items created after this timestamp (inclusive). This is a query
        * parameter used to select responses.
@@ -904,8 +897,8 @@ export namespace RunRetrieveResponse {
       has_tool_calls?: boolean | null;
 
       /**
-       * Optional search string for instructions. This is a query parameter used to
-       * select responses.
+       * Optional string to search the 'instructions' field. This is a query parameter
+       * used to select responses.
        */
       instructions_search?: string | null;
 
@@ -932,6 +925,11 @@ export namespace RunRetrieveResponse {
        */
       temperature?: number | null;
 
+      /**
+       * List of tool names. This is a query parameter used to select responses.
+       */
+      tools?: Array<string> | null;
+
       /**
        * Nucleus sampling parameter. This is a query parameter used to select responses.
        */
@@ -1139,10 +1137,7 @@ export interface RunListResponse {
   /**
    * Information about the run's data source.
    */
-  data_source:
-    | CreateEvalJSONLRunDataSource
-    | CreateEvalCompletionsRunDataSource
-    | RunListResponse.Completions;
+  data_source: CreateEvalJSONLRunDataSource | CreateEvalCompletionsRunDataSource | RunListResponse.Responses;
 
   /**
    * An object representing an error response from the Eval API.
@@ -1209,28 +1204,28 @@ export namespace RunListResponse {
   /**
    * A ResponsesRunDataSource object describing a model sampling configuration.
    */
-  export interface Completions {
+  export interface Responses {
     /**
      * A EvalResponsesSource object describing a run data source configuration.
      */
-    source: Completions.FileContent | Completions.FileID | Completions.Responses;
+    source: Responses.FileContent | Responses.FileID | Responses.Responses;
 
     /**
-     * The type of run data source. Always `completions`.
+     * The type of run data source. Always `responses`.
      */
-    type: 'completions';
+    type: 'responses';
 
-    input_messages?: Completions.Template | Completions.ItemReference;
+    input_messages?: Responses.Template | Responses.ItemReference;
 
     /**
      * The name of the model to use for generating completions (e.g. "o3-mini").
      */
     model?: string;
 
-    sampling_params?: Completions.SamplingParams;
+    sampling_params?: Responses.SamplingParams;
   }
 
-  export namespace Completions {
+  export namespace Responses {
     export interface FileContent {
       /**
        * The content of the jsonl file.
@@ -1272,12 +1267,6 @@ export namespace RunListResponse {
        */
       type: 'responses';
 
-      /**
-       * Whether to allow parallel tool calls. This is a query parameter used to select
-       * responses.
-       */
-      allow_parallel_tool_calls?: boolean | null;
-
       /**
        * Only include items created after this timestamp (inclusive). This is a query
        * parameter used to select responses.
@@ -1297,8 +1286,8 @@ export namespace RunListResponse {
       has_tool_calls?: boolean | null;
 
       /**
-       * Optional search string for instructions. This is a query parameter used to
-       * select responses.
+       * Optional string to search the 'instructions' field. This is a query parameter
+       * used to select responses.
        */
       instructions_search?: string | null;
 
@@ -1325,6 +1314,11 @@ export namespace RunListResponse {
        */
       temperature?: number | null;
 
+      /**
+       * List of tool names. This is a query parameter used to select responses.
+       */
+      tools?: Array<string> | null;
+
       /**
        * Nucleus sampling parameter. This is a query parameter used to select responses.
        */
@@ -1543,7 +1537,7 @@ export interface RunCancelResponse {
   data_source:
     | CreateEvalJSONLRunDataSource
     | CreateEvalCompletionsRunDataSource
-    | RunCancelResponse.Completions;
+    | RunCancelResponse.Responses;
 
   /**
    * An object representing an error response from the Eval API.
@@ -1610,28 +1604,28 @@ export namespace RunCancelResponse {
   /**
    * A ResponsesRunDataSource object describing a model sampling configuration.
    */
-  export interface Completions {
+  export interface Responses {
     /**
      * A EvalResponsesSource object describing a run data source configuration.
      */
-    source: Completions.FileContent | Completions.FileID | Completions.Responses;
+    source: Responses.FileContent | Responses.FileID | Responses.Responses;
 
     /**
-     * The type of run data source. Always `completions`.
+     * The type of run data source. Always `responses`.
      */
-    type: 'completions';
+    type: 'responses';
 
-    input_messages?: Completions.Template | Completions.ItemReference;
+    input_messages?: Responses.Template | Responses.ItemReference;
 
     /**
      * The name of the model to use for generating completions (e.g. "o3-mini").
      */
     model?: string;
 
-    sampling_params?: Completions.SamplingParams;
+    sampling_params?: Responses.SamplingParams;
   }
 
-  export namespace Completions {
+  export namespace Responses {
     export interface FileContent {
       /**
        * The content of the jsonl file.
@@ -1673,12 +1667,6 @@ export namespace RunCancelResponse {
        */
       type: 'responses';
 
-      /**
-       * Whether to allow parallel tool calls. This is a query parameter used to select
-       * responses.
-       */
-      allow_parallel_tool_calls?: boolean | null;
-
       /**
        * Only include items created after this timestamp (inclusive). This is a query
        * parameter used to select responses.
@@ -1698,8 +1686,8 @@ export namespace RunCancelResponse {
       has_tool_calls?: boolean | null;
 
       /**
-       * Optional search string for instructions. This is a query parameter used to
-       * select responses.
+       * Optional string to search the 'instructions' field. This is a query parameter
+       * used to select responses.
        */
       instructions_search?: string | null;
 
@@ -1726,6 +1714,11 @@ export namespace RunCancelResponse {
        */
       temperature?: number | null;
 
+      /**
+       * List of tool names. This is a query parameter used to select responses.
+       */
+      tools?: Array<string> | null;
+
       /**
        * Nucleus sampling parameter. This is a query parameter used to select responses.
        */
@@ -1955,9 +1948,9 @@ export namespace RunCreateParams {
       | CreateEvalResponsesRunDataSource.Responses;
 
     /**
-     * The type of run data source. Always `completions`.
+     * The type of run data source. Always `responses`.
      */
-    type: 'completions';
+    type: 'responses';
 
     input_messages?:
       | CreateEvalResponsesRunDataSource.Template
@@ -2013,12 +2006,6 @@ export namespace RunCreateParams {
        */
       type: 'responses';
 
-      /**
-       * Whether to allow parallel tool calls. This is a query parameter used to select
-       * responses.
-       */
-      allow_parallel_tool_calls?: boolean | null;
-
       /**
        * Only include items created after this timestamp (inclusive). This is a query
        * parameter used to select responses.
@@ -2038,8 +2025,8 @@ export namespace RunCreateParams {
       has_tool_calls?: boolean | null;
 
       /**
-       * Optional search string for instructions. This is a query parameter used to
-       * select responses.
+       * Optional string to search the 'instructions' field. This is a query parameter
+       * used to select responses.
        */
       instructions_search?: string | null;
 
@@ -2066,6 +2053,11 @@ export namespace RunCreateParams {
        */
       temperature?: number | null;
 
+      /**
+       * List of tool names. This is a query parameter used to select responses.
+       */
+      tools?: Array<string> | null;
+
       /**
        * Nucleus sampling parameter. This is a query parameter used to select responses.
        */

package/src/resources/fine-tuning/alpha/alpha.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as GradersAPI from './graders';
+import {
+  GraderRunParams,
+  GraderRunResponse,
+  GraderValidateParams,
+  GraderValidateResponse,
+  Graders,
+} from './graders';
+
+export class Alpha extends APIResource {
+  graders: GradersAPI.Graders = new GradersAPI.Graders(this._client);
+}
+
+Alpha.Graders = Graders;
+
+export declare namespace Alpha {
+  export {
+    Graders as Graders,
+    type GraderRunResponse as GraderRunResponse,
+    type GraderValidateResponse as GraderValidateResponse,
+    type GraderRunParams as GraderRunParams,
+    type GraderValidateParams as GraderValidateParams,
+  };
+}

package/src/resources/fine-tuning/alpha/graders.ts

@@ -0,0 +1,168 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as Core from '../../../core';
+import * as GraderModelsAPI from '../../graders/grader-models';
+
+export class Graders extends APIResource {
+  /**
+   * Run a grader.
+   *
+   * @example
+   * ```ts
+   * const response = await client.fineTuning.alpha.graders.run({
+   *   grader: {
+   *     input: 'input',
+   *     name: 'name',
+   *     operation: 'eq',
+   *     reference: 'reference',
+   *     type: 'string_check',
+   *   },
+   *   model_sample: 'model_sample',
+   *   reference_answer: 'string',
+   * });
+   * ```
+   */
+  run(body: GraderRunParams, options?: Core.RequestOptions): Core.APIPromise<GraderRunResponse> {
+    return this._client.post('/fine_tuning/alpha/graders/run', { body, ...options });
+  }
+
+  /**
+   * Validate a grader.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.fineTuning.alpha.graders.validate({
+   *     grader: {
+   *       input: 'input',
+   *       name: 'name',
+   *       operation: 'eq',
+   *       reference: 'reference',
+   *       type: 'string_check',
+   *     },
+   *   });
+   * ```
+   */
+  validate(
+    body: GraderValidateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<GraderValidateResponse> {
+    return this._client.post('/fine_tuning/alpha/graders/validate', { body, ...options });
+  }
+}
+
+export interface GraderRunResponse {
+  metadata: GraderRunResponse.Metadata;
+
+  model_grader_token_usage_per_model: Record<string, unknown>;
+
+  reward: number;
+
+  sub_rewards: Record<string, unknown>;
+}
+
+export namespace GraderRunResponse {
+  export interface Metadata {
+    errors: Metadata.Errors;
+
+    execution_time: number;
+
+    name: string;
+
+    sampled_model_name: string | null;
+
+    scores: Record<string, unknown>;
+
+    token_usage: number | null;
+
+    type: string;
+  }
+
+  export namespace Metadata {
+    export interface Errors {
+      formula_parse_error: boolean;
+
+      invalid_variable_error: boolean;
+
+      model_grader_parse_error: boolean;
+
+      model_grader_refusal_error: boolean;
+
+      model_grader_server_error: boolean;
+
+      model_grader_server_error_details: string | null;
+
+      other_error: boolean;
+
+      python_grader_runtime_error: boolean;
+
+      python_grader_runtime_error_details: string | null;
+
+      python_grader_server_error: boolean;
+
+      python_grader_server_error_type: string | null;
+
+      sample_parse_error: boolean;
+
+      truncated_observation_error: boolean;
+
+      unresponsive_reward_error: boolean;
+    }
+  }
+}
+
+export interface GraderValidateResponse {
+  /**
+   * The grader used for the fine-tuning job.
+   */
+  grader?:
+    | GraderModelsAPI.StringCheckGrader
+    | GraderModelsAPI.TextSimilarityGrader
+    | GraderModelsAPI.PythonGrader
+    | GraderModelsAPI.ScoreModelGrader
+    | GraderModelsAPI.MultiGrader;
+}
+
+export interface GraderRunParams {
+  /**
+   * The grader used for the fine-tuning job.
+   */
+  grader:
+    | GraderModelsAPI.StringCheckGrader
+    | GraderModelsAPI.TextSimilarityGrader
+    | GraderModelsAPI.PythonGrader
+    | GraderModelsAPI.ScoreModelGrader
+    | GraderModelsAPI.MultiGrader;
+
+  /**
+   * The model sample to be evaluated.
+   */
+  model_sample: string;
+
+  /**
+   * The reference answer for the evaluation.
+   */
+  reference_answer: string | unknown | Array<unknown> | number;
+}
+
+export interface GraderValidateParams {
+  /**
+   * The grader used for the fine-tuning job.
+   */
+  grader:
+    | GraderModelsAPI.StringCheckGrader
+    | GraderModelsAPI.TextSimilarityGrader
+    | GraderModelsAPI.PythonGrader
+    | GraderModelsAPI.ScoreModelGrader
+    | GraderModelsAPI.MultiGrader;
+}
+
+export declare namespace Graders {
+  export {
+    type GraderRunResponse as GraderRunResponse,
+    type GraderValidateResponse as GraderValidateResponse,
+    type GraderRunParams as GraderRunParams,
+    type GraderValidateParams as GraderValidateParams,
+  };
+}

package/src/resources/fine-tuning/alpha/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Alpha } from './alpha';
+export {
+  Graders,
+  type GraderRunResponse,
+  type GraderValidateResponse,
+  type GraderRunParams,
+  type GraderValidateParams,
+} from './graders';

package/src/resources/fine-tuning/alpha.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './alpha/index';

package/src/resources/fine-tuning/checkpoints/permissions.ts

@@ -11,6 +11,17 @@ export class Permissions extends APIResource {
    *
    * This enables organization owners to share fine-tuned models with other projects
    * in their organization.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const permissionCreateResponse of client.fineTuning.checkpoints.permissions.create(
+   *   'ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd',
+   *   { project_ids: ['string'] },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   create(
     fineTunedModelCheckpoint: string,
@@ -29,6 +40,14 @@ export class Permissions extends APIResource {
    *
    * Organization owners can use this endpoint to view all permissions for a
    * fine-tuned model checkpoint.
+   *
+   * @example
+   * ```ts
+   * const permission =
+   *   await client.fineTuning.checkpoints.permissions.retrieve(
+   *     'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
+   *   );
+   * ```
    */
   retrieve(
     fineTunedModelCheckpoint: string,
@@ -58,6 +77,15 @@ export class Permissions extends APIResource {
    *
    * Organization owners can use this endpoint to delete a permission for a
    * fine-tuned model checkpoint.
+   *
+   * @example
+   * ```ts
+   * const permission =
+   *   await client.fineTuning.checkpoints.permissions.del(
+   *     'ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd',
+   *     'cp_zc4Q7MP6XxulcVzj4MZdwsAB',
+   *   );
+   * ```
    */
   del(
     fineTunedModelCheckpoint: string,

package/src/resources/fine-tuning/fine-tuning.ts

@@ -1,6 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as MethodsAPI from './methods';
+import {
+  DpoHyperparameters,
+  DpoMethod,
+  Methods,
+  ReinforcementHyperparameters,
+  ReinforcementMethod,
+  SupervisedHyperparameters,
+  SupervisedMethod,
+} from './methods';
+import * as AlphaAPI from './alpha/alpha';
+import { Alpha } from './alpha/alpha';
 import * as CheckpointsAPI from './checkpoints/checkpoints';
 import { Checkpoints } from './checkpoints/checkpoints';
 import * as JobsAPI from './jobs/jobs';
@@ -19,16 +31,30 @@ import {
 } from './jobs/jobs';
 
 export class FineTuning extends APIResource {
+  methods: MethodsAPI.Methods = new MethodsAPI.Methods(this._client);
   jobs: JobsAPI.Jobs = new JobsAPI.Jobs(this._client);
   checkpoints: CheckpointsAPI.Checkpoints = new CheckpointsAPI.Checkpoints(this._client);
+  alpha: AlphaAPI.Alpha = new AlphaAPI.Alpha(this._client);
 }
 
+FineTuning.Methods = Methods;
 FineTuning.Jobs = Jobs;
 FineTuning.FineTuningJobsPage = FineTuningJobsPage;
 FineTuning.FineTuningJobEventsPage = FineTuningJobEventsPage;
 FineTuning.Checkpoints = Checkpoints;
+FineTuning.Alpha = Alpha;
 
 export declare namespace FineTuning {
+  export {
+    Methods as Methods,
+    type DpoHyperparameters as DpoHyperparameters,
+    type DpoMethod as DpoMethod,
+    type ReinforcementHyperparameters as ReinforcementHyperparameters,
+    type ReinforcementMethod as ReinforcementMethod,
+    type SupervisedHyperparameters as SupervisedHyperparameters,
+    type SupervisedMethod as SupervisedMethod,
+  };
+
   export {
     Jobs as Jobs,
     type FineTuningJob as FineTuningJob,
@@ -44,4 +70,6 @@ export declare namespace FineTuning {
   };
 
   export { Checkpoints as Checkpoints };
+
+  export { Alpha as Alpha };
 }